如何理解 RESTful 的冪等性
理解RESTful的冪等性,并且設(shè)計(jì)符合冪等規(guī)范的高質(zhì)量RESTful API。
怎么理解冪等性
HTTP冪等方法,是指無(wú)論調(diào)用多少次都不會(huì)有不同結(jié)果的 HTTP 方法。不管你調(diào)用一次,還是調(diào)用一百次,一千次,結(jié)果都是相同的。
還是以之前的博文的例子為例。
GET /tickets # 獲取ticket列表GET /tickets/12 # 查看某個(gè)具體的ticketPOST /tickets # 新建一個(gè)ticketPUT /tickets/12 # 更新ticket 12PATCH /tickets/12 # 更新ticket 12DELETE /tickets/12 # 刪除ticekt 12
HTTP GET方法
HTTP GET方法,用于獲取資源,不管調(diào)用多少次接口,結(jié)果都不會(huì)改變,所以是冪等的。
GET /tickets # 獲取ticket列表GET /tickets/12 # 查看某個(gè)具體的ticket
只是查詢數(shù)據(jù),不會(huì)影響到資源的變化,因此我們認(rèn)為它冪等。
值得注意,冪等性指的是作用于結(jié)果而非資源本身。怎么理解呢?例如,這個(gè)HTTP GET方法可能會(huì)每次得到不同的返回內(nèi)容,但并不影響資源。
可能你會(huì)問有這種情況么?當(dāng)然有咯。例如,我們有一個(gè)接口獲取當(dāng)前時(shí)間,我們就應(yīng)該設(shè)計(jì)成
GET /service_time # 獲取服務(wù)器當(dāng)前時(shí)間
它本身不會(huì)對(duì)資源本身產(chǎn)生影響,因此滿足冪等性。
HTTP POST方法
HTTP POST方法是一個(gè)非冪等方法,因?yàn)檎{(diào)用多次,都將產(chǎn)生新的資源。
POST /tickets # 新建一個(gè)ticket
因?yàn)樗鼤?huì)對(duì)資源本身產(chǎn)生影響,每次調(diào)用都會(huì)有新的資源產(chǎn)生,因此不滿足冪等性。
HTTP PUT方法
HTTP PUT方法是不是冪等的呢?我們來(lái)看下
PUT /tickets/12 # 更新ticket 12
因?yàn)樗苯影褜?shí)體部分的數(shù)據(jù)替換到服務(wù)器的資源,我們多次調(diào)用它,只會(huì)產(chǎn)生一次影響,但是有相同結(jié)果的 HTTP 方法,所以滿足冪等性。
HTTP PATCH方法
HTTP PATCH方法是非冪等的。HTTP POST方法和HTTP PUT方法可能比較好理解,但是HTTP PATCH方法只是更新部分資源,怎么是非冪等的呢?
因?yàn)椋琍ATCH提供的實(shí)體則需要根據(jù)程序或其它協(xié)議的定義,解析后在服務(wù)器上執(zhí)行,以此來(lái)修改服務(wù)器上的資源。換句話說(shuō),PATCH請(qǐng)求是會(huì)執(zhí)行某個(gè)程序的,如果重復(fù)提交,程序可能執(zhí)行多次,對(duì)服務(wù)器上的資源就可能造成額外的影響,這就可以解釋它為什么是非冪等的了。
可能你還不能理解這點(diǎn)。我們舉個(gè)例子
PATCH /tickets/12 # 更新ticket 12
此時(shí),我們服務(wù)端對(duì)方法的處理是,當(dāng)調(diào)用一次方法,更新部分字段,將這條ticket記錄的操作記錄加一,這次,每次調(diào)用的資源是不是變了呢,所以它是有可能是非冪等的操作。
HTTP DELETE方法
HTTP DELETE方法用于刪除資源,會(huì)將資源刪除。
DELETE /tickets/12 # 刪除ticekt 12
調(diào)用一次和多次對(duì)資源產(chǎn)生影響是相同的,所以也滿足冪等性。
如何設(shè)計(jì)符合冪等性的高質(zhì)量RESTful API
HTTP GET方法 vs HTTP POST方法
也許,你會(huì)想起一個(gè)面試題。HTTP請(qǐng)求的GET與POST方式有什么區(qū)別?你可能會(huì)回答到:GET方式通過(guò)URL提交數(shù)據(jù),數(shù)據(jù)在URL中可以看到;POST方式,數(shù)據(jù)放置在HTML HEADER內(nèi)提交。但是,我們現(xiàn)在從RESTful的資源角度來(lái)看待問題,HTTP GET方法是冪等的,所以它適合作為查詢操作,HTTP POST方法是非冪等的,所以用來(lái)表示新增操作。
但是,也有例外,我們有的時(shí)候可能需要把查詢方法改造成HTTP POST方法。比如,超長(zhǎng)(1k)的GET URL使用POST方法來(lái)替代,因?yàn)镚ET受到URL長(zhǎng)度的限制。雖然,它不符合冪等性,但是它是一種折中的方案。
HTTP POST方法 vs HTTP PUT方法
對(duì)于HTTP POST方法和TTP PUT方法,我們一般的理解是POST表示創(chuàng)建資源,PUT表示更新資源。當(dāng)然,這個(gè)是正確的理解。
但是,實(shí)際上,兩個(gè)方法都用于創(chuàng)建資源,更為本質(zhì)的差別是在冪等性。HTTP POST方法是非冪等,所以用來(lái)表示創(chuàng)建資源,HTTP PUT方法是冪等的,因此表示更新資源更加貼切。
HTTP PUT方法 vs HTTP PATCH方法
此時(shí),你看會(huì)有另外一個(gè)問題。HTTP PUT方法和HTTP PATCH方法,都是用來(lái)表述更新資源,它們之間有什么區(qū)別呢?我們一般的理解是PUT表示更新全部資源,PATCH表示更新部分資源。首先,這個(gè)是我們遵守的第一準(zhǔn)則。根據(jù)上面的描述,PATCH方法是非冪等的,因此我們?cè)谠O(shè)計(jì)我們服務(wù)端的RESTful API的時(shí)候,也需要考慮。如果,我們想要明確的告訴調(diào)用者我們的資源是冪等的,我的設(shè)計(jì)更傾向于使用 HTTP PUT 方法。
免責(zé)聲明:本文內(nèi)容由21ic獲得授權(quán)后發(fā)布,版權(quán)歸原作者所有,本平臺(tái)僅提供信息存儲(chǔ)服務(wù)。文章僅代表作者個(gè)人觀點(diǎn),不代表本平臺(tái)立場(chǎng),如有問題,請(qǐng)聯(lián)系我們,謝謝!