怎么保證接口的冪等性

本篇內(nèi)容介紹了“怎么保證接口的冪等性”的有關(guān)知識(shí)，在實(shí)際案例的操作過程中，不少人都會(huì)遇到這樣的困境，接下來就讓小編帶領(lǐng)大家學(xué)習(xí)一下如何處理這些情況吧！希望大家仔細(xì)閱讀，能夠?qū)W有所成！

前言

不知道你有沒有遇到過這些場景：

1. 有時(shí)我們?cè)谔顚懩承?strong>form表單時(shí)，保存按鈕不小心快速點(diǎn)了兩次，表中竟然產(chǎn)生了兩條重復(fù)的數(shù)據(jù)，只是id不一樣。

2. 我們?cè)陧?xiàng)目中為了解決接口超時(shí)問題，通常會(huì)引入了重試機(jī)制。第一次請(qǐng)求接口超時(shí)了，請(qǐng)求方?jīng)]能及時(shí)獲取返回結(jié)果(此時(shí)有可能已經(jīng)成功了)，為了避免返回錯(cuò)誤的結(jié)果(這種情況不可能直接返回失敗吧?)，于是會(huì)對(duì)該請(qǐng)求重試幾次，這樣也會(huì)產(chǎn)生重復(fù)的數(shù)據(jù)。

3. mq消費(fèi)者在讀取消息時(shí)，有時(shí)候會(huì)讀取到重復(fù)消息(至于什么原因這里先不說，有興趣的小伙伴，可以找我私聊)，如果處理不好，也會(huì)產(chǎn)生重復(fù)的數(shù)據(jù)。

沒錯(cuò)，這些都是冪等性問題。

接口冪等性是指用戶對(duì)于同一操作發(fā)起的一次請(qǐng)求或者多次請(qǐng)求的結(jié)果是一致的，不會(huì)因?yàn)槎啻吸c(diǎn)擊而產(chǎn)生了副作用。

這類問題多發(fā)于接口的：

• insert操作，這種情況下多次請(qǐng)求，可能會(huì)產(chǎn)生重復(fù)數(shù)據(jù)。

• update操作，如果只是單純的更新數(shù)據(jù)，比如：update user set status=1 where  id=1，是沒有問題的。如果還有計(jì)算，比如：update user set status=status+1 where  id=1，這種情況下多次請(qǐng)求，可能會(huì)導(dǎo)致數(shù)據(jù)錯(cuò)誤。

1.  insert前先select

通常情況下，在保存數(shù)據(jù)的接口中，我們?yōu)榱朔乐巩a(chǎn)生重復(fù)數(shù)據(jù)，一般會(huì)在insert前，先根據(jù)name或code字段select一下數(shù)據(jù)。如果該數(shù)據(jù)已存在，則執(zhí)行update操作，如果不存在，才執(zhí)行  insert操作。

該方案可能是我們平時(shí)在防止產(chǎn)生重復(fù)數(shù)據(jù)時(shí)，使用最多的方案。但是該方案不適用于并發(fā)場景，在并發(fā)場景中，要配合其他方案一起使用，否則同樣會(huì)產(chǎn)生重復(fù)數(shù)據(jù)。我在這里提一下，是為了避免大家踩坑。

2. 加悲觀鎖

在支付場景中，用戶A的賬號(hào)余額有150元，想轉(zhuǎn)出100元，正常情況下用戶A的余額只剩50元。一般情況下，sql是這樣的：

update user amount = amount-100 where id=123;

如果出現(xiàn)多次相同的請(qǐng)求，可能會(huì)導(dǎo)致用戶A的余額變成負(fù)數(shù)。這種情況，用戶A來可能要哭了。于此同時(shí)，系統(tǒng)開發(fā)人員可能也要哭了，因?yàn)檫@是很嚴(yán)重的系統(tǒng)bug。

為了解決這個(gè)問題，可以加悲觀鎖，將用戶A的那行數(shù)據(jù)鎖住，在同一時(shí)刻只允許一個(gè)請(qǐng)求獲得鎖，更新數(shù)據(jù)，其他的請(qǐng)求則等待。

通常情況下通過如下sql鎖住單行數(shù)據(jù)：

select * from user id=123 for update;

具體流程如下：

具體步驟：

1. 鴻蒙官方戰(zhàn)略合作共建——HarmonyOS技術(shù)社區(qū)

2. 多個(gè)請(qǐng)求同時(shí)根據(jù)id查詢用戶信息。

3. 判斷余額是否不足100，如果余額不足，則直接返回余額不足。

4. 如果余額充足，則通過for update再次查詢用戶信息，并且嘗試獲取鎖。

5. 只有第一個(gè)請(qǐng)求能獲取到行鎖，其余沒有獲取鎖的請(qǐng)求，則等待下一次獲取鎖的機(jī)會(huì)。

6. 第一個(gè)請(qǐng)求獲取到鎖之后，判斷余額是否不足100，如果余額足夠，則進(jìn)行update操作。

7. 如果余額不足，說明是重復(fù)請(qǐng)求，則直接返回成功。

需要特別注意的是：如果使用的是mysql數(shù)據(jù)庫，存儲(chǔ)引擎必須用innodb，因?yàn)樗胖С质聞?wù)。此外，這里id字段一定要是主鍵或者唯一索引，不然會(huì)鎖住整張表。

悲觀鎖需要在同一個(gè)事務(wù)操作過程中鎖住一行數(shù)據(jù)，如果事務(wù)耗時(shí)比較長，會(huì)造成大量的請(qǐng)求等待，影響接口性能。此外，每次請(qǐng)求接口很難保證都有相同的返回值，所以不適合冪等性設(shè)計(jì)場景，但是在防重場景中是可以的使用的。在這里順便說一下，防重設(shè)計(jì)  和 冪等設(shè)計(jì)，其實(shí)是有區(qū)別的。防重設(shè)計(jì)主要為了避免產(chǎn)生重復(fù)數(shù)據(jù)，對(duì)接口返回沒有太多要求。而冪等設(shè)計(jì)除了避免產(chǎn)生重復(fù)數(shù)據(jù)之外，還要求每次請(qǐng)求都返回一樣的結(jié)果。3.  加樂觀鎖既然悲觀鎖有性能問題，為了提升接口性能，我們可以使用樂觀鎖。需要在表中增加一個(gè)timestamp或者version字段，這里以version字段為例。

在更新數(shù)據(jù)之前先查詢一下數(shù)據(jù)：

select id,amount,version from user id=123;

如果數(shù)據(jù)存在，假設(shè)查到的version等于1，再使用id和version字段作為查詢條件更新數(shù)據(jù)：

update user set amount=amount+100,version=version+1 where id=123 and version=1;

更新數(shù)據(jù)的同時(shí)version+1，然后判斷本次update操作的影響行數(shù)，如果大于0，則說明本次更新成功，如果等于0，則說明本次更新沒有讓數(shù)據(jù)變更。

由于第一次請(qǐng)求version等于1是可以成功的，操作成功后version變成2了。這時(shí)如果并發(fā)的請(qǐng)求過來，再執(zhí)行相同的sql：

update user set amount=amount+100,version=version+1 here id=123 and version=1;

該update操作不會(huì)真正更新數(shù)據(jù)，最終sql的執(zhí)行結(jié)果影響行數(shù)是0，因?yàn)関ersion已經(jīng)變成2了，where中的version=1肯定無法滿足條件。但為了保證接口冪等性，接口可以直接返回成功，因?yàn)関ersion值已經(jīng)修改了，那么前面必定已經(jīng)成功過一次，后面都是重復(fù)的請(qǐng)求。

具體流程如下：

具體步驟：

1. 鴻蒙官方戰(zhàn)略合作共建——HarmonyOS技術(shù)社區(qū)

2. 先根據(jù)id查詢用戶信息，包含version字段

3. 根據(jù)id和version字段值作為where條件的參數(shù)，更新用戶信息，同時(shí)version+1

4. 判斷操作影響行數(shù)，如果影響1行，則說明是一次請(qǐng)求，可以做其他數(shù)據(jù)操作。

5. 如果影響0行，說明是重復(fù)請(qǐng)求，則直接返回成功。

4. 加唯一索引

絕大數(shù)情況下，為了防止重復(fù)數(shù)據(jù)的產(chǎn)生，我們都會(huì)在表中加唯一索引，這是一個(gè)非常簡單，并且有效的方案。

alter table `order` add UNIQUE KEY `un_code` (`code`);

加了唯一索引之后，第一次請(qǐng)求數(shù)據(jù)可以插入成功。但后面的相同請(qǐng)求，插入數(shù)據(jù)時(shí)會(huì)報(bào)Duplicate entry '002' for key  'order.un_code異常，表示唯一索引有沖突。

雖說拋異常對(duì)數(shù)據(jù)來說沒有影響，不會(huì)造成錯(cuò)誤數(shù)據(jù)。但是為了保證接口冪等性，我們需要對(duì)該異常進(jìn)行捕獲，然后返回成功。

如果是java程序需要捕獲：DuplicateKeyException異常，如果使用了spring框架還需要捕獲：MySQLIntegrityConstraintViolationException異常。

具體流程圖如下：

具體步驟：

1. 鴻蒙官方戰(zhàn)略合作共建——HarmonyOS技術(shù)社區(qū)

2. 用戶通過瀏覽器發(fā)起請(qǐng)求，服務(wù)端收集數(shù)據(jù)。

3. 將該數(shù)據(jù)插入mysql

4. 判斷是否執(zhí)行成功，如果成功，則操作其他數(shù)據(jù)(可能還有其他的業(yè)務(wù)邏輯)。

5. 如果執(zhí)行失敗，捕獲唯一索引沖突異常，直接返回成功。

5. 建防重表

有時(shí)候表中并非所有的場景都不允許產(chǎn)生重復(fù)的數(shù)據(jù)，只有某些特定場景才不允許。這時(shí)候，直接在表中加唯一索引，顯然是不太合適的。

針對(duì)這種情況，我們可以通過建防重表來解決問題。

該表可以只包含兩個(gè)字段：id 和 唯一索引，唯一索引可以是多個(gè)字段比如：name、code等組合起來的唯一標(biāo)識(shí)，例如：susan_0001。

具體流程圖如下：

具體步驟：

1. 鴻蒙官方戰(zhàn)略合作共建——HarmonyOS技術(shù)社區(qū)

2. 用戶通過瀏覽器發(fā)起請(qǐng)求，服務(wù)端收集數(shù)據(jù)。

3. 將該數(shù)據(jù)插入mysql防重表

4. 判斷是否執(zhí)行成功，如果成功，則做mysql其他的數(shù)據(jù)操作(可能還有其他的業(yè)務(wù)邏輯)。

5. 如果執(zhí)行失敗，捕獲唯一索引沖突異常，直接返回成功。

需要特別注意的是：防重表和業(yè)務(wù)表必須在同一個(gè)數(shù)據(jù)庫中，并且操作要在同一個(gè)事務(wù)中。

6.  根據(jù)狀態(tài)機(jī)

很多時(shí)候業(yè)務(wù)表是有狀態(tài)的，比如訂單表中有：1-下單、2-已支付、3-完成、4-撤銷等狀態(tài)。如果這些狀態(tài)的值是有規(guī)律的，按照業(yè)務(wù)節(jié)點(diǎn)正好是從小到大，我們就能通過它來保證接口的冪等性。

假如id=123的訂單狀態(tài)是已支付，現(xiàn)在要變成完成狀態(tài)。

update `order` set status=3 where id=123 and status=2;

第一次請(qǐng)求時(shí)，該訂單的狀態(tài)是已支付，值是2，所以該update語句可以正常更新數(shù)據(jù)，sql執(zhí)行結(jié)果的影響行數(shù)是1，訂單狀態(tài)變成了3。

后面有相同的請(qǐng)求過來，再執(zhí)行相同的sql時(shí)，由于訂單狀態(tài)變成了3，再用status=2作為條件，無法查詢出需要更新的數(shù)據(jù)，所以最終sql執(zhí)行結(jié)果的影響行數(shù)是0，即不會(huì)真正的更新數(shù)據(jù)。但為了保證接口冪等性，影響行數(shù)是0時(shí)，接口也可以直接返回成功。

具體流程圖如下：

具體步驟：

1. 鴻蒙官方戰(zhàn)略合作共建——HarmonyOS技術(shù)社區(qū)

2. 用戶通過瀏覽器發(fā)起請(qǐng)求，服務(wù)端收集數(shù)據(jù)。

3. 根據(jù)id和當(dāng)前狀態(tài)作為條件，更新成下一個(gè)狀態(tài)

4. 判斷操作影響行數(shù)，如果影響了1行，說明當(dāng)前操作成功，可以進(jìn)行其他數(shù)據(jù)操作。

5. 如果影響了0行，說明是重復(fù)請(qǐng)求，直接返回成功。

主要特別注意的是，該方案僅限于要更新的表有狀態(tài)字段，并且剛好要更新狀態(tài)字段的這種特殊情況，并非所有場景都適用。

7.  加分布式鎖

其實(shí)前面介紹過的加唯一索引或者加防重表，本質(zhì)是使用了數(shù)據(jù)庫的分布式鎖，也屬于分布式鎖的一種。但由于數(shù)據(jù)庫分布式鎖的性能不太好，我們可以改用：redis或zookeeper。

鑒于現(xiàn)在很多公司分布式配置中心改用apollo或nacos，已經(jīng)很少用zookeeper了，我們以redis為例介紹分布式鎖。

目前主要有三種方式實(shí)現(xiàn)redis的分布式鎖：

1. 鴻蒙官方戰(zhàn)略合作共建——HarmonyOS技術(shù)社區(qū)

2. setNx命令

3. set命令

4. Redission框架

每種方案各有利弊，具體實(shí)現(xiàn)細(xì)節(jié)我就不說了，有興趣的朋友可以加我微信找我私聊。

具體流程圖如下：

具體步驟：

• 用戶通過瀏覽器發(fā)起請(qǐng)求，服務(wù)端會(huì)收集數(shù)據(jù)，并且生成訂單號(hào)code作為唯一業(yè)務(wù)字段。

• 使用redis的set命令，將該訂單code設(shè)置到redis中，同時(shí)設(shè)置超時(shí)時(shí)間。

• 判斷是否設(shè)置成功，如果設(shè)置成功，說明是第一次請(qǐng)求，則進(jìn)行數(shù)據(jù)操作。

• 如果設(shè)置失敗，說明是重復(fù)請(qǐng)求，則直接返回成功。

需要特別注意的是：分布式鎖一定要設(shè)置一個(gè)合理的過期時(shí)間，如果設(shè)置過短，無法有效的防止重復(fù)請(qǐng)求。如果設(shè)置過長，可能會(huì)浪費(fèi)redis的存儲(chǔ)空間，需要根據(jù)實(shí)際業(yè)務(wù)情況而定。

8. 獲取token

除了上述方案之外，還有最后一種使用token的方案。該方案跟之前的所有方案都有點(diǎn)不一樣，需要兩次請(qǐng)求才能完成一次業(yè)務(wù)操作。

1. 鴻蒙官方戰(zhàn)略合作共建——HarmonyOS技術(shù)社區(qū)

2. 第一次請(qǐng)求獲取token

3. 第二次請(qǐng)求帶著這個(gè)token，完成業(yè)務(wù)操作。

具體流程圖如下：

第一步，先獲取token。

第二步，做具體業(yè)務(wù)操作。

具體步驟：

1. 鴻蒙官方戰(zhàn)略合作共建——HarmonyOS技術(shù)社區(qū)

2. 用戶訪問頁面時(shí)，瀏覽器自動(dòng)發(fā)起獲取token請(qǐng)求。

3. 服務(wù)端生成token，保存到redis中，然后返回給瀏覽器。

4. 用戶通過瀏覽器發(fā)起請(qǐng)求時(shí)，攜帶該token。

5. 在redis中查詢?cè)搕oken是否存在，如果不存在，說明是第一次請(qǐng)求，做則后續(xù)的數(shù)據(jù)操作。

6. 如果存在，說明是重復(fù)請(qǐng)求，則直接返回成功。

7. 在redis中token會(huì)在過期時(shí)間之后，被自動(dòng)刪除。

以上方案是針對(duì)冪等設(shè)計(jì)的。

如果是防重設(shè)計(jì)，流程圖要改改：

需要特別注意的是：token必須是全局唯一的。

“怎么保證接口的冪等性”的內(nèi)容就介紹到這里了，感謝大家的閱讀。如果想了解更多行業(yè)相關(guān)的知識(shí)可以關(guān)注億速云網(wǎng)站，小編將為大家輸出更多高質(zhì)量的實(shí)用文章！