看看人家接口寫得,那叫一個(gè)優(yōu)雅!
點(diǎn)擊上方?java項(xiàng)目開發(fā),選擇?設(shè)為星標(biāo)
優(yōu)質(zhì)文章,及時(shí)送達(dá)
來源:https://zhuanlan.zhihu.com/p/265318078

需要說明的是,有些小伙伴會(huì)回復(fù)說,這個(gè)架構(gòu)太簡單了吧,太low了,什么網(wǎng)關(guān)啊,緩存啊,消息中間件啊,都沒有。因?yàn)槔项欉@篇主要介紹的是API接口,所以我們聚焦點(diǎn),其他的模塊小伙伴們自行去補(bǔ)充。
接口交互
前端和后端進(jìn)行交互,前端按照約定請求URL路徑,并傳入相關(guān)參數(shù),后端服務(wù)器接收請求,進(jìn)行業(yè)務(wù)處理,返回?cái)?shù)據(jù)給前端。
針對(duì)URL路徑的restful風(fēng)格,以及傳入?yún)?shù)的公共請求頭的要求(如:app_version,api_version,device等),老顧這里就不介紹了,小伙伴們可以自行去了解,也比較簡單。
著重介紹一下后端服務(wù)器如何實(shí)現(xiàn)把數(shù)據(jù)返回給前端?
返回格式
{
#返回狀態(tài)碼
code:integer,
#返回信息描述
message:string,
#返回值
data:object
}
CODE狀態(tài)碼
code返回狀態(tài)碼,一般小伙伴們是在開發(fā)的時(shí)候需要什么,就添加什么。
如接口要返回用戶權(quán)限異常,我們加一個(gè)狀態(tài)碼為101吧,下一次又要加一個(gè)數(shù)據(jù)參數(shù)異常,就加一個(gè)102的狀態(tài)碼。這樣雖然能夠照常滿足業(yè)務(wù),但狀態(tài)碼太凌亂了
下面是常見的HTTP狀態(tài)碼:
200 - 請求成功
301 - 資源(網(wǎng)頁等)被永久轉(zhuǎn)移到其它URL
404 - 請求的資源(網(wǎng)頁等)不存在
500 - 內(nèi)部服務(wù)器錯(cuò)誤

#1000~1999 區(qū)間表示參數(shù)錯(cuò)誤
#2000~2999 區(qū)間表示用戶錯(cuò)誤
#3000~3999 區(qū)間表示接口異常
這樣前端開發(fā)人員在得到返回值后,根據(jù)狀態(tài)碼就可以知道,大概什么錯(cuò)誤,再根據(jù)message相關(guān)的信息描述,可以快速定位。
Message
這個(gè)字段相對(duì)理解比較簡單,就是發(fā)生錯(cuò)誤時(shí),如何友好的進(jìn)行提示。一般的設(shè)計(jì)是和code狀態(tài)碼一起設(shè)計(jì),如:


Data
返回?cái)?shù)據(jù)體,JSON格式,根據(jù)不同的業(yè)務(wù)又不同的JSON體。

控制層Controller
我們會(huì)在controller層處理業(yè)務(wù)請求,并返回給前端,以order訂單為例

我們看到在獲得order對(duì)象之后,我們是用的Result構(gòu)造方法進(jìn)行包裝賦值,然后進(jìn)行返回。小伙伴們有沒有發(fā)現(xiàn),構(gòu)造方法這樣的包裝是不是很麻煩,我們可以優(yōu)化一下。
美觀優(yōu)化
我們可以在Result類中,加入靜態(tài)方法,一看就懂


優(yōu)雅優(yōu)化
上面我們看到在Result類中增加了靜態(tài)方法,使得業(yè)務(wù)處理代碼簡潔了。但小伙伴們有沒有發(fā)現(xiàn)這樣有幾個(gè)問題:
1、每個(gè)方法的返回都是Result封裝對(duì)象,沒有業(yè)務(wù)含義
2、在業(yè)務(wù)代碼中,成功的時(shí)候我們調(diào)用Result.success,異常錯(cuò)誤調(diào)用Result.failure。是不是很多余
3、上面的代碼,判斷id是否為null,其實(shí)我們可以使用hibernate validate做校驗(yàn),沒有必要在方法體中做判斷。
我們最好的方式直接返回真實(shí)業(yè)務(wù)對(duì)象,最好不要改變之前的業(yè)務(wù)方式,如下圖

這個(gè)和我們平時(shí)的代碼是一樣的,非常直觀,直接返回order對(duì)象,這樣是不是很完美。那實(shí)現(xiàn)方案是什么呢?
實(shí)現(xiàn)方案
2、攔截請求,判斷此請求是否需要被@ResponseResult注解
3、核心步驟就是實(shí)現(xiàn)接口ResponseBodyAdvice和@ControllerAdvice,判斷是否需要包裝返回值,如果需要,就把Controller接口的返回值進(jìn)行重寫。
用來標(biāo)記方法的返回值,是否需要包裝

攔截器



重寫Controller

在控制器類上或者方法體上加上@ResponseResult注解,這樣就ok了,簡單吧。到此返回的設(shè)計(jì)思路完成,是不是又簡潔,又優(yōu)雅。
總結(jié)
推薦案例
溫暖提示

請長按識(shí)別二維碼
想學(xué)習(xí)更多的java功能案例請關(guān)注
Java項(xiàng)目開發(fā)

如果你覺得這個(gè)案例以及我們的分享思路不錯(cuò),對(duì)你有幫助,請分享給身邊更多需要學(xué)習(xí)的朋友。別忘了《留言+點(diǎn)在看》給作者一個(gè)鼓勵(lì)哦!
