1 什么是 RESTful
百度一下 RESTful，查到的資料很多都講得不清楚，看完了都不知道說(shuō)的是啥，導(dǎo)致很多人對(duì) RESTful 不甚了解。來(lái)看一下常見(jiàn)的解釋：
（1）神一樣的描述
REST 并不是“休息”的意思，而是 Representational State Transfer 的簡(jiǎn)稱，即 表現(xiàn)層狀態(tài)轉(zhuǎn)移。
“表現(xiàn)層狀態(tài)轉(zhuǎn)移”是什么鬼？
（2）云里霧里的描述
- REST 指的是 一組架構(gòu)約束條件和原則，如果一個(gè)架構(gòu)符合 REST 的約束條件和原則，就稱之為 RESTful 架構(gòu)。
- RESTful 是一種軟件架構(gòu)風(fēng)格，而不是標(biāo)準(zhǔn)。
這能看懂一點(diǎn)了，但還是云里霧里的。
（3）大神的總結(jié)
再看知乎大神 Ivony 的一句話精辟概括：
用 URL 定位資源，用 HTTP 動(dòng)詞（GET，POST，DELETE，PUT）描述操作。
RESTful 是一種 web 服務(wù)設(shè)計(jì)風(fēng)格，風(fēng)格意思就是大家默認(rèn)的但不是強(qiáng)制的。
2 RESTful 詳解
2.1 用 URL 定位資源
REST 的主體是資源，所謂“資源”，就是網(wǎng)絡(luò)上的一個(gè)具體信息，例如：一張圖片，一段文字、一種服務(wù)。總之就是一個(gè)實(shí)際存在的東西，而 URL 就是用來(lái)指向這個(gè)資源的。
例如：
https://api.example.com/users
這個(gè) URL 一看就知道是對(duì) user 資源的操作。URL 中只使用名詞來(lái)指定資源，不包含操作。為什么呢？
如果要包含操作，那至少有增刪改查四種，那么上例中的一個(gè)接口至少要變成四個(gè)：
https://api.example.com/add_user
https://api.example.com/delete_user
https://api.example.com/update_use
https://api.example.com/get_user
太多了，不夠簡(jiǎn)潔。
2.2 用 HTTP 動(dòng)詞描述操作
那怎么描述操作呢？答案就是用 HTTP 動(dòng)詞。
HTTP 動(dòng)詞，可能很多人第一眼看到的時(shí)候有點(diǎn)蒙，不知道是啥，其實(shí)就是我們請(qǐng)求網(wǎng)頁(yè)時(shí)用的 GET、POST 等操作。我們平時(shí)用的最多的就是 GET 和 POST（例如寫爬蟲的時(shí)候，基本都是這兩種），常用的還有 PUT、PATCH、DELETE 。
對(duì)資源的操作，無(wú)外乎 CRUD（增刪改查），RESTful 中，每個(gè) HTTP 動(dòng)詞對(duì)應(yīng)一個(gè) CRUD 操作。
- GET：對(duì)應(yīng) Retrieve 操作（查詢操作）
- POST：對(duì)應(yīng) Create 操作
- DELETE：對(duì)應(yīng) Delete 操作
- PUT：對(duì)應(yīng) Update 操作
- PATCH：對(duì)應(yīng) Update 操作
2.3 POST 和 PUT 的區(qū)別
一般說(shuō)到 HTTP 動(dòng)詞對(duì)應(yīng) CRUD 的時(shí)候，PUT 都是對(duì)應(yīng) Update 操作的。但其實(shí)，PUT 也可以做 Create 操作。二者的區(qū)別在于：
- URL：POST 不需要指定到個(gè)體，例如新增 user 的接口
POST /api/users。 PUT 的 URL 需要指定到具體的個(gè)體，例如PUT /api/users/1，如果1這個(gè) user 存在，則 Update，否則 Create。這個(gè)很好理解，POST 確定是新增，insert 的時(shí)候是不需要 where 條件的；PUT 則不行，update 的時(shí)候不加 where，干過(guò)的小伙伴請(qǐng)舉手。另外，PUT 的時(shí)候，也不是每個(gè) user 就要建一個(gè)接口的，這里需要用到的就是路由，一般是寫成PUT /api/users/{id}，這樣就具有一般性了。路由在這里就不展開講了。 - 冪等性：PUT 是冪等的，而 POST 是非冪等的。關(guān)于冪等性，見(jiàn)下文。
2.4 PATCH 和 PUT 的區(qū)別
PATCH 是 2010 后成為的正式 http 方法，它是對(duì) PUT 的補(bǔ)充。在沒(méi)有 PATCH 之前，都是用 PUT 進(jìn)行更新操作，這時(shí)候我們的接口中通常會(huì)有一個(gè)邏輯規(guī)則，如：如果對(duì)象的一個(gè)屬性值為null，那么就不更新該屬性（字段）值，通過(guò)這種方式來(lái)避免全部覆蓋的操作。現(xiàn)在有了 PATCH 就解決了這種判斷，在 PUT 操作中不管屬性是不是 null，都進(jìn)行更新，在 PATCH 接口中就對(duì)非 null 的進(jìn)行更新。另外，PATCH 是非冪等的。
2.5 變通的 POST
按照 REST 建議，查詢操作要使用 GET 方法，但是實(shí)際情況中處理起來(lái)比較麻煩，如：報(bào)表統(tǒng)計(jì)查詢，需要傳遞的參數(shù)很多，如果采用 GET 方法，那么接口接收的參數(shù)非常多，接口很難看，通常會(huì)封裝為 java 對(duì)象，但 GET 方法又不支持對(duì)象傳參，所以很蛋疼；
對(duì)于這種情況，最簡(jiǎn)單的方式就是改成 POST 方式，而且很多公司都是這么干的。可見(jiàn) REST 只是建議，并非強(qiáng)制約束。
補(bǔ)充：冪等性
冪等（Idempotence）本來(lái)是一個(gè)數(shù)學(xué)上的概念，定義就不說(shuō)了，看了頭暈。
后來(lái)拓展到計(jì)算機(jī)領(lǐng)域，描述為：
一個(gè)操作、方法或者服務(wù)，其任意多次執(zhí)行所產(chǎn)生的影響均與一次執(zhí)行的影響相同。
一個(gè)冪等的方法，使用同樣的參數(shù)，對(duì)它進(jìn)行多次調(diào)用和一次調(diào)用，對(duì)系統(tǒng)產(chǎn)生的影響是一樣的。所以，對(duì)于冪等的方法，不用擔(dān)心重復(fù)執(zhí)行會(huì)對(duì)系統(tǒng)造成任何改變。
舉個(gè)例子，用戶 X 的手機(jī)話費(fèi)余額為 2 元，他用支付寶給手機(jī)充了 100 元話費(fèi)，如果將這個(gè)操作描述為“給 X 的賬戶余額增加 100 元”那就是非冪等的，重復(fù)操作幾次運(yùn)營(yíng)商就虧大了。但是，如果將這個(gè)操作描述為“將 X 的賬戶余額設(shè)置為 102 元”，那這個(gè)操作就是冪等的。簡(jiǎn)單來(lái)說(shuō)：
- 冪等操作：將賬戶 X 的余額設(shè)置為 102 元；
- 非冪等操作：將賬戶 X 的余額增加 100 元。
注意：這里的冪等性的例子并不嚴(yán)謹(jǐn)，本文主要不是講冪等性的，所以只是舉個(gè)簡(jiǎn)單的例子，不做深入探討。
3 RESTful 的其他細(xì)節(jié)
3.1 命名規(guī)則
- （1）全部小寫，用
_或-線連接。
例如我在上面給出的例子 ：
https://api.example.com/add_user
之所以不用駝峰命名法，是因?yàn)樵缙诘?URI 一般都是表示服務(wù)器上的文件路徑，而不同服務(wù)器對(duì)大小寫的敏感性是不同的，為了兼容不同服務(wù)器所以才規(guī)定不能混用大小寫字母。
- （2）URL 中只用名詞指定資源，因?yàn)?REST 的核心是資源，而表示資源的詞語(yǔ)天然就是名詞。
- （3）資源用復(fù)數(shù)表示。
3.2 版本
一種方法是在 URL 中添加版本號(hào)，例如：
https://api.example.com/v1/users
另一種方法是將版本號(hào)加在 HTTP 請(qǐng)求頭信息的 Accept 字段中，例如：
Accept: version=1.0
雖然有很多博客里推薦里說(shuō)是推薦在 header 里添加版本信息，因?yàn)椴煌陌姹颈硎镜馁Y源依然是同一個(gè)，所以不應(yīng)該用不同的 URL。但是以我目前了解到的情況來(lái)看，絕大多數(shù)公司都是將版本號(hào)放在 URL 中的，并且推薦這么做，簡(jiǎn)單直觀。
網(wǎng)上能找到的版本號(hào)加在 URL 中的例子，都是如我上例所示的寫法。但是 Jack_Zeng 指出，這樣寫容易有歧義，會(huì)讓人誤以為 v1 也是資源的一部分，一般都是這么寫：
https://api.example.com/users?api-version=1
3.3 HTTP 狀態(tài)碼
知乎上另一大神對(duì) RESTful 的解釋，相比于 Ivony 多了一句話，他用了三句話來(lái)描述：
- 看 Url 就知道要什么
- 看 http method 就知道干什么
- 看 http status code 就知道結(jié)果如何
前兩句和 Ivony 的是一個(gè)意思。這第三句我覺(jué)得總結(jié)得也很經(jīng)典。
http 狀態(tài)碼有 100 多種，我們并不需要全部用到，只需要了解其中常用的就可以了
- 200 – OK – 一切正常
- 201 – OK – 新資源已經(jīng)被創(chuàng)建
- 204 – OK – 資源刪除成功
- 304 – 沒(méi)有變化，客戶端可以使用緩存數(shù)據(jù)
- 400 – Bad Request – 調(diào)用不合法，確切的錯(cuò)誤應(yīng)該在 error payload 中描述
- 401 – 未認(rèn)證，調(diào)用需要用戶通過(guò)認(rèn)證
- 403 – 不允許的，服務(wù)端正常解析和請(qǐng)求，但是調(diào)用被回絕或者不被允許
- 404 – 未找到，指定的資源不存在
- 422 – 不可指定的請(qǐng)求體 – 只有服務(wù)器不能處理實(shí)體時(shí)使用，比如圖像不能被格式化，或者重要字段丟失
- 500 – Internal Server Error – 標(biāo)準(zhǔn)服務(wù)端錯(cuò)誤，開發(fā)人員應(yīng)該盡量避開這種錯(cuò)誤
參考資料：
- https://www.zhihu.com/question/28557115
- https://blog.csdn.net/mingjia1987/article/details/79651241
專注于SEO培訓(xùn)，快速排名黑帽SEO https://www.heimao.wiki