如何理解RESTfull的冪等性

2021-09-27 13:30:39 字數 2505 閱讀 6173

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

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

還是以之前的博文的例子為例。如何設計良好的api

【get】          /users                # 查詢使用者資訊列表

【get】 /users/1001 # 檢視某個使用者資訊

【post】 /users # 新建使用者資訊

【put】 /users/1001 # 更新使用者資訊(全部字段)

【patch】 /users/1001 # 更新使用者資訊(部分字段)

【delete】 /users/1001 # 刪除使用者資訊

http get方法,用於獲取資源,不管呼叫多少次介面,結果都不會改變,所以是冪等的。

【get】          /users                # 查詢使用者資訊列表

【get】 /users/1001 # 檢視某個使用者資訊

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

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

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

get     /service_time # 獲取伺服器當前時間
它本身不會對資源本身產生影響,因此滿足冪等性。

http post方法是乙個非冪等方法,因為呼叫多次,都將產生新的資源。

【post】         /users                # 新建使用者資訊
因為它會對資源本身產生影響,每次呼叫都會有新的資源產生,因此不滿足冪等性。

http put方法是不是冪等的呢?我們來看下

【put】          /users/1001           # 更新使用者資訊(全部字段)
因為它直接把實體部分的資料替換到伺服器的資源,我們多次呼叫它,只會產生一次影響,但是有相同結果的 http 方法,所以滿足冪等性。

http patch方法是非冪等的。http post方法和http put方法可能比較好理解,但是http patch方法只是更新部分資源,怎麼是非冪等的呢?

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

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

【patch】        /users/1001           # 更新使用者資訊(部分字段)
此時,我們服務端對方法的處理是,當呼叫一次方法,更新部分字段,將這條user記錄的操作記錄加一,這次,每次呼叫的資源是不是變了呢,所以它是有可能是非冪等的操作。

http delete方法用於刪除資源,會將資源刪除。

【delete】       /users/1001           # 刪除使用者資訊
呼叫一次和多次對資源產生影響是相同的,所以也滿足冪等性。

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

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

對於http post方法和ttp put方法,我們一般的理解是post表示建立資源,put表示更新資源。當然,這個是正確的理解。

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

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

如何理解 RESTful 的冪等性

如何設計符合冪等性的高質量restful api 理解restful的冪等性,並且設計符合冪等規範的高質量restful api。http冪等方法,是指無論呼叫多少次都不會有不同結果的 http 方法。不管你呼叫一次,還是呼叫一百次,一千次,結果都是相同的。還是以之前的博文的例子為例。get tic...

理解http的冪等性

冪等性是什麼?冪等性 是系統的介面對外一種承諾 而不是實現 承諾只要呼叫介面成功,外部多次呼叫對系統的影響是一致的。乙個冪等的操作典型如 把編號為5的記錄的a欄位設定為0,這種操作不管執行多少次都是冪等的。乙個非冪等的操作典型如 把編號為5的記錄的a欄位增加1,這種操作顯然就不是冪等的。要做到冪等性...

深入理解冪等技術

冪等 idempotent 是乙個數學與計算機學概念,常見於抽象代數中。在程式設計中,乙個冪等操作的特點是,其任意多次執行所產生的影響均與一次執行的影響相同。冪等函式,或冪等方法,是指可以使用相同引數重複執行,並能獲得相同結果的函式。冪等函式可以改變系統的狀態。例如,settrue 就是乙個冪等函式...