歡迎光臨
每天分享高質量文章

如何理解 RESTful 的冪等性

  • 怎麼理解冪等性
    • HTTP GET方法
    • HTTP POST方法
    • HTTP PUT方法
    • HTTP PATCH方法
    • HTTP DELETE方法
  • 如何設計符合冪等性的高質量RESTful API
    • HTTP GET方法 vs HTTP POST方法
    • HTTP POST方法 vs HTTP PUT方法
    • HTTP PUT方法 vs HTTP PATCH方法

理解RESTful的冪等性,並且設計符合冪等規範的高質量RESTful API。

怎麼理解冪等性

HTTP冪等方法,是指無論呼叫多少次都不會有不同結果的 HTTP 方法。不管你呼叫一次,還是呼叫一百次,一千次,結果都是相同的。

還是以之前的博文的例子為例。

GET     /tickets       # 獲取ticket串列GET     /tickets/12    # 查看某個具體的ticketPOST    /tickets       # 新建一個ticketPUT     /tickets/12    # 更新ticket 12PATCH   /tickets/12    # 更新ticket 12DELETE  /tickets/12    # 刪除ticekt 12

HTTP GET方法

HTTP GET方法,用於獲取資源,不管呼叫多少次接口,結果都不會改變,所以是冪等的。

GET     /tickets       # 獲取ticket串列GET     /tickets/12    # 查看某個具體的ticket

只是查詢資料,不會影響到資源的變化,因此我們認為它冪等。

值得註意,冪等性指的是作用於結果而非資源本身。怎麼理解呢?例如,這個HTTP GET方法可能會每次得到不同的傳回內容,但並不影響資源。

可能你會問有這種情況麽?當然有咯。例如,我們有一個接口獲取當前時間,我們就應該設計成

GET     /service_time # 獲取服務器當前時間

它本身不會對資源本身產生影響,因此滿足冪等性。

HTTP POST方法

HTTP POST方法是一個非冪等方法,因為呼叫多次,都將產生新的資源。

POST    /tickets       # 新建一個ticket

因為它會對資源本身產生影響,每次呼叫都會有新的資源產生,因此不滿足冪等性。

HTTP PUT方法

HTTP PUT方法是不是冪等的呢?我們來看下

PUT     /tickets/12    # 更新ticket 12

因為它直接把物體部分的資料替換到服務器的資源,我們多次呼叫它,只會產生一次影響,但是有相同結果的 HTTP 方法,所以滿足冪等性。

HTTP PATCH方法

HTTP PATCH方法是非冪等的。HTTP POST方法和HTTP PUT方法可能比較好理解,但是HTTP PATCH方法只是更新部分資源,怎麼是非冪等的呢?

因為,PATCH提供的物體則需要根據程式或其它協議的定義,解析後在服務器上執行,以此來修改服務器上的資源。換句話說,PATCH請求是會執行某個程式的,如果重覆提交,程式可能執行多次,對服務器上的資源就可能造成額外的影響,這就可以解釋它為什麼是非冪等的了。

可能你還不能理解這點。我們舉個例子

PATCH   /tickets/12    # 更新ticket 12

此時,我們服務端對方法的處理是,當呼叫一次方法,更新部分欄位,將這條ticket記錄的操作記錄加一,這次,每次呼叫的資源是不是變了呢,所以它是有可能是非冪等的操作。

HTTP DELETE方法

HTTP DELETE方法用於刪除資源,會將資源刪除。

DELETE  /tickets/12    # 刪除ticekt 12

呼叫一次和多次對資源產生影響是相同的,所以也滿足冪等性。

如何設計符合冪等性的高質量RESTful API

HTTP GET方法 vs HTTP POST方法

也許,你會想起一個面試題。HTTP請求的GET與POST方式有什麼區別?你可能會回答到:GET方式通過URL提交資料,資料在URL中可以看到;POST方式,資料放置在HTML HEADER內提交。但是,我們現在從RESTful的資源角度來看待問題,HTTP GET方法是冪等的,所以它適合作為查詢操作,HTTP POST方法是非冪等的,所以用來表示新增操作。

但是,也有例外,我們有的時候可能需要把查詢方法改造成HTTP POST方法。比如,超長(1k)的GET URL使用POST方法來替代,因為GET受到URL長度的限制。雖然,它不符合冪等性,但是它是一種折中的方案。

HTTP POST方法 vs HTTP PUT方法

對於HTTP POST方法和TTP PUT方法,我們一般的理解是POST表示創建資源,PUT表示更新資源。當然,這個是正確的理解。

但是,實際上,兩個方法都用於創建資源,更為本質的差別是在冪等性。HTTP POST方法是非冪等,所以用來表示創建資源,HTTP PUT方法是冪等的,因此表示更新資源更加貼切。

HTTP PUT方法 vs HTTP PATCH方法

此時,你看會有另外一個問題。HTTP PUT方法和HTTP PATCH方法,都是用來表述更新資源,它們之間有什麼區別呢?我們一般的理解是PUT表示更新全部資源,PATCH表示更新部分資源。首先,這個是我們遵守的第一准則。根據上面的描述,PATCH方法是非冪等的,因此我們在設計我們服務端的RESTful API的時候,也需要考慮。如果,我們想要明確的告訴呼叫者我們的資源是冪等的,我的設計更傾向於使用 HTTP PUT 方法。

    赞(0)

    分享創造快樂