當(dāng)前位置:首頁(yè) > 公眾號(hào)精選 > 架構(gòu)師社區(qū)
[導(dǎo)讀]理解RESTful的冪等性,并且設(shè)計(jì)符合冪等規(guī)范的高質(zhì)量RESTful API。

理解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)系我們,謝謝!

本站聲明: 本文章由作者或相關(guān)機(jī)構(gòu)授權(quán)發(fā)布,目的在于傳遞更多信息,并不代表本站贊同其觀點(diǎn),本站亦不保證或承諾內(nèi)容真實(shí)性等。需要轉(zhuǎn)載請(qǐng)聯(lián)系該專欄作者,如若文章內(nèi)容侵犯您的權(quán)益,請(qǐng)及時(shí)聯(lián)系本站刪除。
換一批
延伸閱讀

9月2日消息,不造車的華為或?qū)⒋呱龈蟮莫?dú)角獸公司,隨著阿維塔和賽力斯的入局,華為引望愈發(fā)顯得引人矚目。

關(guān)鍵字: 阿維塔 塞力斯 華為

倫敦2024年8月29日 /美通社/ -- 英國(guó)汽車技術(shù)公司SODA.Auto推出其旗艦產(chǎn)品SODA V,這是全球首款涵蓋汽車工程師從創(chuàng)意到認(rèn)證的所有需求的工具,可用于創(chuàng)建軟件定義汽車。 SODA V工具的開發(fā)耗時(shí)1.5...

關(guān)鍵字: 汽車 人工智能 智能驅(qū)動(dòng) BSP

北京2024年8月28日 /美通社/ -- 越來(lái)越多用戶希望企業(yè)業(yè)務(wù)能7×24不間斷運(yùn)行,同時(shí)企業(yè)卻面臨越來(lái)越多業(yè)務(wù)中斷的風(fēng)險(xiǎn),如企業(yè)系統(tǒng)復(fù)雜性的增加,頻繁的功能更新和發(fā)布等。如何確保業(yè)務(wù)連續(xù)性,提升韌性,成...

關(guān)鍵字: 亞馬遜 解密 控制平面 BSP

8月30日消息,據(jù)媒體報(bào)道,騰訊和網(wǎng)易近期正在縮減他們對(duì)日本游戲市場(chǎng)的投資。

關(guān)鍵字: 騰訊 編碼器 CPU

8月28日消息,今天上午,2024中國(guó)國(guó)際大數(shù)據(jù)產(chǎn)業(yè)博覽會(huì)開幕式在貴陽(yáng)舉行,華為董事、質(zhì)量流程IT總裁陶景文發(fā)表了演講。

關(guān)鍵字: 華為 12nm EDA 半導(dǎo)體

8月28日消息,在2024中國(guó)國(guó)際大數(shù)據(jù)產(chǎn)業(yè)博覽會(huì)上,華為常務(wù)董事、華為云CEO張平安發(fā)表演講稱,數(shù)字世界的話語(yǔ)權(quán)最終是由生態(tài)的繁榮決定的。

關(guān)鍵字: 華為 12nm 手機(jī) 衛(wèi)星通信

要點(diǎn): 有效應(yīng)對(duì)環(huán)境變化,經(jīng)營(yíng)業(yè)績(jī)穩(wěn)中有升 落實(shí)提質(zhì)增效舉措,毛利潤(rùn)率延續(xù)升勢(shì) 戰(zhàn)略布局成效顯著,戰(zhàn)新業(yè)務(wù)引領(lǐng)增長(zhǎng) 以科技創(chuàng)新為引領(lǐng),提升企業(yè)核心競(jìng)爭(zhēng)力 堅(jiān)持高質(zhì)量發(fā)展策略,塑強(qiáng)核心競(jìng)爭(zhēng)優(yōu)勢(shì)...

關(guān)鍵字: 通信 BSP 電信運(yùn)營(yíng)商 數(shù)字經(jīng)濟(jì)

北京2024年8月27日 /美通社/ -- 8月21日,由中央廣播電視總臺(tái)與中國(guó)電影電視技術(shù)學(xué)會(huì)聯(lián)合牽頭組建的NVI技術(shù)創(chuàng)新聯(lián)盟在BIRTV2024超高清全產(chǎn)業(yè)鏈發(fā)展研討會(huì)上宣布正式成立。 活動(dòng)現(xiàn)場(chǎng) NVI技術(shù)創(chuàng)新聯(lián)...

關(guān)鍵字: VI 傳輸協(xié)議 音頻 BSP

北京2024年8月27日 /美通社/ -- 在8月23日舉辦的2024年長(zhǎng)三角生態(tài)綠色一體化發(fā)展示范區(qū)聯(lián)合招商會(huì)上,軟通動(dòng)力信息技術(shù)(集團(tuán))股份有限公司(以下簡(jiǎn)稱"軟通動(dòng)力")與長(zhǎng)三角投資(上海)有限...

關(guān)鍵字: BSP 信息技術(shù)
關(guān)閉
關(guān)閉