在移動互聯(lián)網(wǎng)路捧，分布式关霸、微服務(wù)盛行的今天，現(xiàn)在項目絕大部分都采用的微服務(wù)框架杰扫，前后端分離方式队寇，（題外話：前后端的工作職責(zé)越來越明確，現(xiàn)在的前端都稱之為大前端章姓，技術(shù)棧以及生態(tài)圈都已經(jīng)非常成熟佳遣；以前后端人員瞧不起前端人員，那現(xiàn)在后端人員要重新認(rèn)識一下前端凡伊，前端已經(jīng)很成體系了）零渐。

一般系統(tǒng)的大致整體架構(gòu)圖如下：

image

需要說明的是，有些小伙伴會回復(fù)說系忙，這個架構(gòu)太簡單了吧相恃，太low了，什么網(wǎng)關(guān)啊笨觅，緩存啊，消息中間件啊耕腾，都沒有见剩。因?yàn)檫@篇主要介紹的是API接口，所以我們聚焦點(diǎn)扫俺，其他的模塊小伙伴們自行去補(bǔ)充苍苞。

接口交互

前端和后端進(jìn)行交互，前端按照約定請求URL路徑狼纬，并傳入相關(guān)參數(shù)羹呵，后端服務(wù)器接收請求，進(jìn)行業(yè)務(wù)處理疗琉，返回數(shù)據(jù)給前端冈欢。

針對URL路徑的restful風(fēng)格，以及傳入?yún)?shù)的公共請求頭的要求（如：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ā)的時候需要什么邻吭，就添加什么餐弱。

如接口要返回用戶權(quán)限異常，我們加一個狀態(tài)碼為101吧囱晴，下一次又要加一個數(shù)據(jù)參數(shù)異常膏蚓，就加一個102的狀態(tài)碼。這樣雖然能夠照常滿足業(yè)務(wù)速缆，但狀態(tài)碼太凌亂了

我們應(yīng)該可以參考HTTP請求返回的狀態(tài)碼

：下面是常見的HTTP狀態(tài)碼：
200 - 請求成功
301 - 資源（網(wǎng)頁等）被永久轉(zhuǎn)移到其它URL
404 - 請求的資源（網(wǎng)頁等）不存在
500 - 內(nèi)部服務(wù)器錯誤

image

我們可以參考這樣的設(shè)計降允，這樣的好處就把錯誤類型歸類到某個區(qū)間內(nèi)，如果區(qū)間不夠艺糜，可以設(shè)計成4位數(shù)剧董。

#1000～1999 區(qū)間表示參數(shù)錯誤
#2000～2999 區(qū)間表示用戶錯誤
#3000～3999 區(qū)間表示接口異常

這樣前端開發(fā)人員在得到返回值后，根據(jù)狀態(tài)碼就可以知道破停，大概什么錯誤翅楼，再根據(jù)message相關(guān)的信息描述，可以快速定位真慢。

Message

這個字段相對理解比較簡單毅臊，就是發(fā)生錯誤時，如何友好的進(jìn)行提示黑界。一般的設(shè)計是和code狀態(tài)碼一起設(shè)計管嬉，如

image

再在枚舉中定義，狀態(tài)碼

image

狀態(tài)碼和信息就會一一對應(yīng)朗鸠，比較好維護(hù)蚯撩。

Data

返回數(shù)據(jù)體，JSON格式烛占，根據(jù)不同的業(yè)務(wù)又不同的JSON體胎挎。

我們要設(shè)計一個返回體類Result

image

控制層Controller

我們會在controller層處理業(yè)務(wù)請求，并返回給前端忆家，以order訂單為例

image

我們看到在獲得order對象之后犹菇，我們是用的Result構(gòu)造方法進(jìn)行包裝賦值，然后進(jìn)行返回芽卿。小伙伴們有沒有發(fā)現(xiàn)揭芍，構(gòu)造方法這樣的包裝是不是很麻煩，我們可以優(yōu)化一下卸例。

美觀優(yōu)化

我們可以在Result類中沼沈，加入靜態(tài)方法流酬，一看就懂

image

那我們來改造一下Controller

image

代碼是不是比較簡潔了，也美觀了列另。

優(yōu)雅優(yōu)化

上面我們看到在Result類中增加了靜態(tài)方法芽腾，使得業(yè)務(wù)處理代碼簡潔了。但小伙伴們有沒有發(fā)現(xiàn)這樣有幾個問題：

1页衙、每個方法的返回都是Result封裝對象摊滔，沒有業(yè)務(wù)含義
2、在業(yè)務(wù)代碼中店乐，成功的時候我們調(diào)用Result.success艰躺，異常錯誤調(diào)用Result.failure。是不是很多余
3眨八、上面的代碼腺兴，判斷id是否為null，其實(shí)我們可以使用hibernate validate做校驗(yàn)廉侧，沒有必要在方法體中做判斷页响。

我們最好的方式直接返回真實(shí)業(yè)務(wù)對象，最好不要改變之前的業(yè)務(wù)方式段誊，如下圖

image

這個和我們平時的代碼是一樣的闰蚕，非常直觀，直接返回order對象连舍，這樣是不是很完美没陡。那實(shí)現(xiàn)方案是什么呢？

實(shí)現(xiàn)方案

小伙伴們怎么去實(shí)現(xiàn)是不是有點(diǎn)思路索赏，在這個過程中盼玄，我們需要做幾個事情

1、定義一個注解@ResponseResult潜腻，表示這個接口返回的值需要包裝一下
2埃儿、攔截請求，判斷此請求是否需要被@ResponseResult注解
3砾赔、核心步驟就是實(shí)現(xiàn)接口ResponseBodyAdvice和@ControllerAdvice，判斷是否需要包裝返回值青灼，如果需要暴心，就把Controller接口的返回值進(jìn)行重寫。

注解類

用來標(biāo)記方法的返回值杂拨，是否需要包裝