來源：老顧聊技術(shù)
前言
在移動(dòng)互聯(lián)網(wǎng)，分布式瓢省、微服務(wù)盛行的今天，現(xiàn)在項(xiàng)目絕大部分都采用的微服務(wù)框架痊班，前后端分離方式勤婚。
一般系統(tǒng)的大致整體架構(gòu)圖如下：
接口交互
前端和后端進(jìn)行交互，前端按照約定請(qǐng)求URL路徑涤伐，并傳入相關(guān)參數(shù)馒胆，后端服務(wù)器接收請(qǐng)求，進(jìn)行業(yè)務(wù)處理凝果，返回?cái)?shù)據(jù)給前端祝迂。
針對(duì)URL路徑的restful風(fēng)格，以及傳入?yún)?shù)的公共請(qǐng)求頭的要求（如：app_version,api_version,device等）器净，這里就不介紹了型雳，注重介紹一下后端服務(wù)器如何實(shí)現(xiàn)把數(shù)據(jù)返回給前端
返回格式
后端返回給前端我們一般用JSON體方式，定義如下：
{
#返回狀態(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)碼太凌亂了
我們應(yīng)該可以參考HTTP請(qǐng)求返回的狀態(tài)碼
：下面是常見的HTTP狀態(tài)碼：
200 – 請(qǐng)求成功
301 – 資源（網(wǎng)頁等）被永久轉(zhuǎn)移到其它URL
404 – 請(qǐng)求的資源（網(wǎng)頁等）不存在
500 – 內(nèi)部服務(wù)器錯(cuò)誤
我們可以參考這樣的設(shè)計(jì)乌妒，這樣的好處就把錯(cuò)誤類型歸類到某個(gè)區(qū)間內(nèi)，如果區(qū)間不夠外邓，可以設(shè)計(jì)成4位數(shù)芥被。
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ì)顶捷，如
再在枚舉中定義，狀態(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)行返回隧土。小伙伴們有沒有發(fā)現(xiàn)提针，構(gòu)造方法這樣的包裝是不是很麻煩，我們可以優(yōu)化一下曹傀。
美觀優(yōu)化
我們可以在Result類中辐脖，加入靜態(tài)方法，一看就懂
那我們來改造一下Controller
代碼是不是比較簡潔了皆愉，也美觀了嗜价。
優(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)方案
小伙伴們?cè)趺慈?shí)現(xiàn)是不是有點(diǎn)思路神得，在這個(gè)過程中厘惦，我們需要做幾個(gè)事情
1、定義一個(gè)注解@ResponseResult哩簿，表示這個(gè)接口返回的值需要包裝一下
2宵蕉、攔截請(qǐng)求，判斷此請(qǐng)求是否需要被@ResponseResult注解
3节榜、核心步驟就是實(shí)現(xiàn)接口ResponseBodyAdvice和@ControllerAdvice羡玛，判斷是否需要包裝返回值，如果需要全跨，就把Controller接口的返回值進(jìn)行重寫缝左。
注解類
用來標(biāo)記方法的返回值，是否需要包裝
攔截器
攔截請(qǐng)求浓若，是否此請(qǐng)求返回的值需要包裝，其實(shí)就是運(yùn)行的時(shí)候蛇数，解析@ResponseResult注解
此代碼核心思想挪钓，就是獲取此請(qǐng)求，是否需要返回值包裝耳舅，設(shè)置一個(gè)屬性標(biāo)記碌上。
重寫返回體
上面代碼就是判斷是否需要返回值包裝倚评，如果需要就直接包裝。這里我們只處理了正常成功的包裝馏予，如果方法體報(bào)異常怎么辦天梧？處理異常也比較簡單，只要判斷body是否為異常類霞丧。
怎么做全局的異常處理呢岗，篇幅原因，老顧這里就不做介紹了蛹尝，只要思路理清楚了后豫，自行改造就行。
重寫Controller
在控制器類上或者方法體上加上@ResponseResult注解突那，這樣就ok了挫酿，簡單吧。到此返回的設(shè)計(jì)思路完成愕难，是不是又簡潔早龟，又優(yōu)雅。
總結(jié)
這個(gè)方案還有沒有別的優(yōu)化空間猫缭，當(dāng)然是有的葱弟。如：每次請(qǐng)求都要反射一下，獲取請(qǐng)求的方法是否需要包裝饵骨，其實(shí)可以做個(gè)緩存翘悉，不需要每次都需要解析。當(dāng)然整體思路了解居触，小伙伴們就可以在此基礎(chǔ)上面自行擴(kuò)展妖混。謝謝！Ｂ盅蟆制市！
