SpringBoot 接口冪等性實(shí)現(xiàn)的 4 種方案

1,什么是接口冪????

在HTTP/1.1中,對(duì)冪等性進(jìn)行了定義。它描述了一次和多次請(qǐng)求某一個(gè)資源對(duì)于資源本身應(yīng)該具有同樣的結(jié)果(網(wǎng)絡(luò)超時(shí)等問題除外),即第一次請(qǐng)求的時(shí)候?qū)Y源產(chǎn)生了副作用,但是以后的多次請(qǐng)求都不會(huì)再對(duì)資源產(chǎn)生副作用。這里的副作用是不會(huì)對(duì)結(jié)果產(chǎn)生破壞或者產(chǎn)生不可預(yù)料的結(jié)果。也就是說(shuō),其任意多次執(zhí)行對(duì)資源本身所產(chǎn)生的影響均與一次執(zhí)行的影響相同。

2,為什么要實(shí)現(xiàn)接口冪等性

在接口調(diào)用時(shí)一般情況下都能正常返回信息不會(huì)重復(fù)提交,不過(guò)在遇見以下情況時(shí)可以就會(huì)出現(xiàn)問題,如:

前端重復(fù)提交表單:?在填寫一些表格時(shí)候,用戶填寫完成提交,很多時(shí)候會(huì)因網(wǎng)絡(luò)波動(dòng)沒有及時(shí)對(duì)用戶做出提交成功響應(yīng),致使用戶認(rèn)為沒有成功提交,然后一直點(diǎn)提交按鈕,這時(shí)就會(huì)發(fā)生重復(fù)提交表單請(qǐng)求。

用戶惡意進(jìn)行刷單:?例如在實(shí)現(xiàn)用戶投票這種功能時(shí),如果用戶針對(duì)一個(gè)用戶進(jìn)行重復(fù)提交投票,這樣會(huì)導(dǎo)致接口接收到用戶重復(fù)提交的投票信息,這樣會(huì)使投票結(jié)果與事實(shí)嚴(yán)重不符。

接口超時(shí)重復(fù)提交:?很多時(shí)候 HTTP 客戶端工具都默認(rèn)開啟超時(shí)重試的機(jī)制,尤其是第三方調(diào)用接口時(shí)候,為了防止網(wǎng)絡(luò)波動(dòng)超時(shí)等造成的請(qǐng)求失敗,都會(huì)添加重試機(jī)制,導(dǎo)致一個(gè)請(qǐng)求提交多次。

消息進(jìn)行重復(fù)消費(fèi):?當(dāng)使用 MQ 消息中間件時(shí)候,如果發(fā)生消息中間件出現(xiàn)錯(cuò)誤未及時(shí)提交消費(fèi)信息,導(dǎo)致發(fā)生重復(fù)消費(fèi)。

使用冪等性最大的優(yōu)勢(shì)在于使接口保證任何冪等性操作,免去因重試等造成系統(tǒng)產(chǎn)生的未知的問題。

3,引入冪等性后對(duì)系統(tǒng)的影響

冪等性是為了簡(jiǎn)化客戶端邏輯處理,能放置重復(fù)提交等操作,但卻增加了服務(wù)端的邏輯復(fù)雜性和成本,其主要是:

把并行執(zhí)行的功能改為串行執(zhí)行,降低了執(zhí)行效率。

增加了額外控制冪等的業(yè)務(wù)邏輯,復(fù)雜化了業(yè)務(wù)功能;

所以在使用時(shí)候需要考慮是否引入冪等性的必要性,根據(jù)實(shí)際業(yè)務(wù)場(chǎng)景具體分析,除了業(yè)務(wù)上的特殊要求外,一般情況下不需要引入的接口冪等性。

4,如何實(shí)現(xiàn)冪等性

(1)數(shù)據(jù)庫(kù)唯一主鍵

方案描述

數(shù)據(jù)庫(kù)唯一主鍵的實(shí)現(xiàn)主要是利用數(shù)據(jù)庫(kù)中主鍵唯一約束的特性,一般來(lái)說(shuō)唯一主鍵比較適用于“插入”時(shí)的冪等性,其能保證一張表中只能存在一條帶該唯一主鍵的記錄。

使用數(shù)據(jù)庫(kù)唯一主鍵完成冪等性時(shí)需要注意的是,該主鍵一般來(lái)說(shuō)并不是使用數(shù)據(jù)庫(kù)中自增主鍵,而是使用分布式 ID 充當(dāng)主鍵(可以參考 Java 中分布式 ID 的設(shè)計(jì)方案 這篇文章),這樣才能能保證在分布式環(huán)境下 ID 的全局唯一性。

適用操作:

插入操作

刪除操作

使用限制:

需要生成全局唯一主鍵 ID;



? ? 主要流程:

① 客戶端執(zhí)行創(chuàng)建請(qǐng)求,調(diào)用服務(wù)端接口。

② 服務(wù)端執(zhí)行業(yè)務(wù)邏輯,生成一個(gè)分布式 ID,將該 ID 充當(dāng)待插入數(shù)據(jù)的主鍵,然后執(zhí)數(shù)據(jù)插入操作,運(yùn)行對(duì)應(yīng)的 SQL 語(yǔ)句。

③ 服務(wù)端將該條數(shù)據(jù)插入數(shù)據(jù)庫(kù)中,如果插入成功則表示沒有重復(fù)調(diào)用接口。如果拋出主鍵重復(fù)異常,則表示數(shù)據(jù)庫(kù)中已經(jīng)存在該條記錄,返回錯(cuò)誤信息到客戶端。

(2)數(shù)據(jù)庫(kù)樂觀鎖

方案描述:

數(shù)據(jù)庫(kù)樂觀鎖方案一般只能適用于執(zhí)行“更新操作”的過(guò)程,我們可以提前在對(duì)應(yīng)的數(shù)據(jù)表中多添加一個(gè)字段,充當(dāng)當(dāng)前數(shù)據(jù)的版本標(biāo)識(shí)。這樣每次對(duì)該數(shù)據(jù)庫(kù)該表的這條數(shù)據(jù)執(zhí)行更新時(shí),都會(huì)將該版本標(biāo)識(shí)作為一個(gè)條件,值為上次待更新數(shù)據(jù)中的版本標(biāo)識(shí)的值。

適用操作:

更新操作

使用限制:

需要數(shù)據(jù)庫(kù)對(duì)應(yīng)業(yè)務(wù)表中添加額外字段;


為了每次執(zhí)行更新時(shí)防止重復(fù)更新,確定更新的一定是要更新的內(nèi)容,我們通常都會(huì)添加一個(gè) version 字段記錄當(dāng)前的記錄版本,這樣在更新時(shí)候?qū)⒃撝祹?,那么只要?zhí)行更新操作就能確定一定更新的是某個(gè)對(duì)應(yīng)版本下的信息。

這樣每次執(zhí)行更新時(shí)候,都要指定要更新的版本號(hào),這樣就能保住更新的冪等,多次更新對(duì)結(jié)果不會(huì)產(chǎn)生影響;

(3)防重token令牌

方案描述:

針對(duì)客戶端連續(xù)點(diǎn)擊或者調(diào)用方的超時(shí)重試等情況,例如提交訂單,此種操作就可以用 Token 的機(jī)制實(shí)現(xiàn)防止重復(fù)提交。簡(jiǎn)單的說(shuō)就是調(diào)用方在調(diào)用接口的時(shí)候先向后端請(qǐng)求一個(gè)全局 ID(Token),請(qǐng)求的時(shí)候攜帶這個(gè)全局 ID 一起請(qǐng)求(Token 最好將其放到 Headers 中),后端需要對(duì)這個(gè) Token 作為 Key,用戶信息作為 Value 到 Redis 中進(jìn)行鍵值內(nèi)容校驗(yàn),如果 Key 存在且 Value 匹配就執(zhí)行刪除命令,然后正常執(zhí)行后面的業(yè)務(wù)邏輯。如果不存在對(duì)應(yīng)的 Key 或 Value 不匹配就返回重復(fù)執(zhí)行的錯(cuò)誤信息,這樣來(lái)保證冪等操作。

適用操作:

插入操作

更新操作

刪除操作

使用限制:

需要生成全局唯一 Token 串;

需要使用第三方組件 Redis 進(jìn)行數(shù)據(jù)效驗(yàn);

主要流程:


① 服務(wù)端提供獲取 Token 的接口,該 Token 可以是一個(gè)序列號(hào),也可以是一個(gè)分布式 ID 或者 UUID 串。

② 客戶端調(diào)用接口獲取 Token,這時(shí)候服務(wù)端會(huì)生成一個(gè) Token 串。

③ 然后將該串存入 Redis 數(shù)據(jù)庫(kù)中,以該 Token 作為 Redis 的鍵(注意設(shè)置過(guò)期時(shí)間)。

④ 將 Token 返回到客戶端,客戶端拿到后應(yīng)存到表單隱藏域中。

⑤ 客戶端在執(zhí)行提交表單時(shí),把 Token 存入到 Headers 中,執(zhí)行業(yè)務(wù)請(qǐng)求帶上該 Headers。

⑥ 服務(wù)端接收到請(qǐng)求后從 Headers 中拿到 Token,然后根據(jù) Token 到 Redis 中查找該 key 是否存在。

⑦ 服務(wù)端根據(jù) Redis 中是否存該 key 進(jìn)行判斷,如果存在就將該 key 刪除,然后正常執(zhí)行業(yè)務(wù)邏輯。如果不存在就拋異常,返回重復(fù)提交的錯(cuò)誤信息。

注意,在并發(fā)情況下,執(zhí)行 Redis 查找數(shù)據(jù)與刪除需要保證原子性,否則很可能在并發(fā)下無(wú)法保證冪等性。其實(shí)現(xiàn)方法可以使用分布式鎖或者使用 Lua 表達(dá)式來(lái)注銷查詢與刪除操作。

(4)下游傳遞唯一序列號(hào)

方案描述:

所謂請(qǐng)求序列號(hào),其實(shí)就是每次向服務(wù)端請(qǐng)求時(shí)候附帶一個(gè)短時(shí)間內(nèi)唯一不重復(fù)的序列號(hào),該序列號(hào)可以是一個(gè)有序 ID,也可以是一個(gè)訂單號(hào),一般由下游生成,在調(diào)用上游服務(wù)端接口時(shí)附加該序列號(hào)和用于認(rèn)證的 ID。

當(dāng)上游服務(wù)器收到請(qǐng)求信息后拿取該 序列號(hào) 和下游 認(rèn)證ID 進(jìn)行組合,形成用于操作 Redis 的 Key,然后到 Redis 中查詢是否存在對(duì)應(yīng)的 Key 的鍵值對(duì),根據(jù)其結(jié)果:

如果存在,就說(shuō)明已經(jīng)對(duì)該下游的該序列號(hào)的請(qǐng)求進(jìn)行了業(yè)務(wù)處理,這時(shí)可以直接響應(yīng)重復(fù)請(qǐng)求的錯(cuò)誤信息。

如果不存在,就以該 Key 作為 Redis 的鍵,以下游關(guān)鍵信息作為存儲(chǔ)的值(例如下游商傳遞的一些業(yè)務(wù)邏輯信息),將該鍵值對(duì)存儲(chǔ)到 Redis 中 ,然后再正常執(zhí)行對(duì)應(yīng)的業(yè)務(wù)邏輯即可。

適用操作:

插入操作

更新操作

刪除操作

使用限制:

要求第三方傳遞唯一序列號(hào);

需要使用第三方組件 Redis 進(jìn)行數(shù)據(jù)效驗(yàn);

流程:


主要步驟:

① 下游服務(wù)生成分布式 ID 作為序列號(hào),然后執(zhí)行請(qǐng)求調(diào)用上游接口,并附帶“唯一序列號(hào)”與請(qǐng)求的“認(rèn)證憑據(jù)ID”。

② 上游服務(wù)進(jìn)行安全效驗(yàn),檢測(cè)下游傳遞的參數(shù)中是否存在“序列號(hào)”和“憑據(jù)ID”。

③ 上游服務(wù)到 Redis 中檢測(cè)是否存在對(duì)應(yīng)的“序列號(hào)”與“認(rèn)證ID”組成的 Key,如果存在就拋出重復(fù)執(zhí)行的異常信息,然后響應(yīng)下游對(duì)應(yīng)的錯(cuò)誤信息。如果不存在就以該“序列號(hào)”和“認(rèn)證ID”組合作為 Key,以下游關(guān)鍵信息作為 Value,進(jìn)而存儲(chǔ)到 Redis 中,然后正常執(zhí)行接來(lái)來(lái)的業(yè)務(wù)邏輯。

上面步驟中插入數(shù)據(jù)到 Redis 一定要設(shè)置過(guò)期時(shí)間。這樣能保證在這個(gè)時(shí)間范圍內(nèi),如果重復(fù)調(diào)用接口,則能夠進(jìn)行判斷識(shí)別。如果不設(shè)置過(guò)期時(shí)間,很可能導(dǎo)致數(shù)據(jù)無(wú)限量的存入 Redis,致使 Redis 不能正常工作。


5,總結(jié):

冪等性是開發(fā)當(dāng)中很常見也很重要的一個(gè)需求,尤其是支付、訂單等與金錢掛鉤的服務(wù),保證接口冪等性尤其重要。在實(shí)際開發(fā)中,我們需要針對(duì)不同的業(yè)務(wù)場(chǎng)景我們需要靈活的選擇冪等性的實(shí)現(xiàn)方式:

對(duì)于下單等存在唯一主鍵的,可以使用“唯一主鍵方案”的方式實(shí)現(xiàn)。

對(duì)于更新訂單狀態(tài)等相關(guān)的更新場(chǎng)景操作,使用“樂觀鎖方案”實(shí)現(xiàn)更為簡(jiǎn)單。

對(duì)于上下游這種,下游請(qǐng)求上游,上游服務(wù)可以使用“下游傳遞唯一序列號(hào)方案”更為合理。

類似于前端重復(fù)提交、重復(fù)下單、沒有唯一ID號(hào)的場(chǎng)景,可以通過(guò) Token 與 Redis 配合的“防重 Token 方案”實(shí)現(xiàn)更為快捷

對(duì)于更新訂單狀態(tài)等相關(guān)的更新場(chǎng)景操作,使用“樂觀鎖方案”實(shí)現(xiàn)更為簡(jiǎn)單。

對(duì)于上下游這種,下游請(qǐng)求上游,上游服務(wù)可以使用“下游傳遞唯一序列號(hào)方案”更為合理。

類似于前端重復(fù)提交、重復(fù)下單、沒有唯一ID號(hào)的場(chǎng)景,可以通過(guò) Token 與 Redis 配合的“防重 Token 方案”實(shí)現(xiàn)更為快捷。


?著作權(quán)歸作者所有,轉(zhuǎn)載或內(nèi)容合作請(qǐng)聯(lián)系作者
【社區(qū)內(nèi)容提示】社區(qū)部分內(nèi)容疑似由AI輔助生成,瀏覽時(shí)請(qǐng)結(jié)合常識(shí)與多方信息審慎甄別。
平臺(tái)聲明:文章內(nèi)容(如有圖片或視頻亦包括在內(nèi))由作者上傳并發(fā)布,文章內(nèi)容僅代表作者本人觀點(diǎn),簡(jiǎn)書系信息發(fā)布平臺(tái),僅提供信息存儲(chǔ)服務(wù)。

相關(guān)閱讀更多精彩內(nèi)容

友情鏈接更多精彩內(nèi)容