在盛行分布式、微服務(wù)的移動(dòng)互聯(lián)網(wǎng)時(shí)代，微服務(wù)框架和前后端分離方式已經(jīng)成為項(xiàng)目的主流趨勢(shì)。近日有很多小伙伴想了解java統(tǒng)一返回類的設(shè)計(jì)，今天小千就為大家?guī)?lái)了關(guān)于API接口的設(shè)計(jì)內(nèi)容，感興趣的小伙伴快來(lái)收藏啦！
系統(tǒng)架構(gòu)圖
接口交互
前端和后端進(jìn)行交互，前端按照約定請(qǐng)求URL路徑，并傳入相關(guān)參數(shù)，后端服務(wù)器接收請(qǐng)求，進(jìn)行業(yè)務(wù)處理，返回?cái)?shù)據(jù)給前端。后端服務(wù)器如何實(shí)現(xiàn)把數(shù)據(jù)返回給前端？
返回格式
后端返回給前端我們一般用JSON體方式，定義如下：
CODE狀態(tài)碼
code返回狀態(tài)碼，一般小伙伴們是在開(kāi)發(fā)的時(shí)候需要什么，就添加什么。
如接口要返回用戶權(quán)限異常，我們加一個(gè)狀態(tài)碼為101吧，下一次又要加一個(gè)數(shù)據(jù)參數(shù)異常，就加一個(gè)102的狀態(tài)碼。這樣雖然能夠照常滿足業(yè)務(wù)，但狀態(tài)碼太凌亂了
我們應(yīng)該可以參考HTTP請(qǐng)求返回的狀態(tài)碼
我們可以參考這樣的設(shè)計(jì)，這樣的好處就把錯(cuò)誤類型歸類到某個(gè)區(qū)間內(nèi)，如果區(qū)間不夠，可以設(shè)計(jì)成4位數(shù)。
這樣前端開(kāi)發(fā)人員在得到返回值后，根據(jù)狀態(tài)碼就可以知道，大概什么錯(cuò)誤，再根據(jù)message相關(guān)的信息描述，可以快速定位。
Message
這個(gè)字段相對(duì)理解比較簡(jiǎn)單，就是發(fā)生錯(cuò)誤時(shí)，如何友好的進(jìn)行提示。一般的設(shè)計(jì)是和code狀態(tài)碼一起設(shè)計(jì)，如：
再在枚舉中定義，狀態(tài)碼
狀態(tài)碼和信息就會(huì)一一對(duì)應(yīng)，比較好維護(hù)。
Data
返回?cái)?shù)據(jù)體，JSON格式，根據(jù)不同的業(yè)務(wù)又不同的JSON體。
我們要設(shè)計(jì)一個(gè)返回體類Result
控制層Controller
我們會(huì)在controller層處理業(yè)務(wù)請(qǐng)求，并返回給前端，以order訂單為例
我們看到在獲得order對(duì)象之后，我們是用的Result構(gòu)造方法進(jìn)行包裝賦值，然后進(jìn)行返回。小伙伴們有沒(méi)有發(fā)現(xiàn)，構(gòu)造方法這樣的包裝是不是很麻煩，我們可以優(yōu)化一下。
美觀美化
我們可以在Result類中，加入靜態(tài)方法，一看就懂
那我們來(lái)改造一下Controller
代碼是不是比較簡(jiǎn)潔了，也美觀了。
優(yōu)雅優(yōu)化
上面我們看到在Result類中增加了靜態(tài)方法，使得業(yè)務(wù)處理代碼簡(jiǎn)潔了。但小伙伴們有沒(méi)有發(fā)現(xiàn)這樣有幾個(gè)問(wèn)題：
每個(gè)方法的返回都是Result封裝對(duì)象，沒(méi)有業(yè)務(wù)含義
在業(yè)務(wù)代碼中，成功的時(shí)候我們調(diào)用Result.success，異常錯(cuò)誤調(diào)用Result.failure。是不是很多余
上面的代碼，判斷id是否為null，其實(shí)我們可以使用hibernate validate做校驗(yàn)，沒(méi)有必要在方法體中做判斷。
我們最好的方式直接返回真實(shí)業(yè)務(wù)對(duì)象，最好不要改變之前的業(yè)務(wù)方式，如下圖：
這個(gè)和我們平時(shí)的代碼是一樣的，非常直觀，直接返回order對(duì)象，這樣是不是很完美。那實(shí)現(xiàn)方案是什么呢？
實(shí)現(xiàn)方案
小伙伴們?cè)趺慈?shí)現(xiàn)是不是有點(diǎn)思路，在這個(gè)過(guò)程中，我們需要做幾個(gè)事情：
定義一個(gè)注解@ResponseResult，表示這個(gè)接口返回的值需要包裝一下
攔截請(qǐng)求，判斷此請(qǐng)求是否需要被@ResponseResult注解
核心步驟就是實(shí)現(xiàn)接口ResponseBodyAdvice和@ControllerAdvice，判斷是否需要包裝返回值，如果需要，就把Controller接口的返回值進(jìn)行重寫。
注解類
用來(lái)標(biāo)記方法的返回值，是否需要包裝
攔截器
攔截請(qǐng)求，是否此請(qǐng)求返回的值需要包裝，其實(shí)就是運(yùn)行的時(shí)候，解析@ResponseResult注解
此代碼核心思想，就是獲取此請(qǐng)求，是否需要返回值包裝，設(shè)置一個(gè)屬性標(biāo)記。
重寫返回體
上面代碼就是判斷是否需要返回值包裝，如果需要就直接包裝。
這里我們只處理了正常成功的包裝，如果方法體報(bào)異常怎么辦？處理異常也比較簡(jiǎn)單，只要判斷body是否為異常類。
怎么做全局的異常處理，篇幅原因，老顧這里就不做介紹了，只要思路理清楚了，自行改造就行。
重寫Controller
在控制器類上或者方法體上加上@ResponseResult注解，這樣就ok了，簡(jiǎn)單吧。到此返回的設(shè)計(jì)思路完成，是不是又簡(jiǎn)潔，又優(yōu)雅。
這個(gè)方案還有沒(méi)有別的優(yōu)化空間，當(dāng)然是有的。
如：每次請(qǐng)求都要反射一下，獲取請(qǐng)求的方法是否需要包裝，其實(shí)可以做個(gè)緩存，不需要每次都需要解析。當(dāng)然整體思路了解，小伙伴們就可以在此基礎(chǔ)上面自行擴(kuò)展。
注：本文部分文字和圖片來(lái)源于網(wǎng)絡(luò)，如有侵權(quán)，請(qǐng)聯(lián)系刪除。版權(quán)歸原作者所有!
京公網(wǎng)安備 11010802030320號(hào)