老顧聊技術(shù)2019-05-24 09:49:02

前言

在移動互聯(lián)網(wǎng)媒吗，分布式似扔、微服務(wù)盛行的今天留凭，現(xiàn)在項目絕大部分都采用的微服務(wù)框架，前后端分離方式辕漂，（題外話：前后端的工作職責(zé)越來越明確，現(xiàn)在的前端都稱之為大前端厨喂，技術(shù)棧以及生態(tài)圈都已經(jīng)非常成熟；以前后端人員瞧不起前端人員庄呈，那現(xiàn)在后端人員要重新認識一下前端蜕煌，前端已經(jīng)很成體系了）。

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

需要說明的是诬留，有些小伙伴會回復(fù)說幌绍，這個架構(gòu)太簡單了吧，太low了故响，什么網(wǎng)關(guān)啊傀广，緩存啊，消息中間件啊彩届，都沒有伪冰。因為老顧這篇主要介紹的是API接口，所以我們聚焦點樟蠕，其他的模塊小伙伴們自行去補充贮聂。

接口交互

前端和后端進行交互，前端按照約定請求URL路徑寨辩，并傳入相關(guān)參數(shù)吓懈，后端服務(wù)器接收請求，進行業(yè)務(wù)處理靡狞，返回數(shù)據(jù)給前端耻警。

針對URL路徑的restful風(fēng)格，以及傳入?yún)?shù)的公共請求頭的要求（如：app_version,api_version,device等）甸怕，老顧這里就不介紹了甘穿，小伙伴們可以自行去了解，也比較簡單梢杭。

老顧注重介紹一下后端服務(wù)器如何實現(xiàn)把數(shù)據(jù)返回給前端温兼？

返回格式

后端返回給前端我們一般用JSON體方式，定義如下：

<pre>{
#返回狀態(tài)碼
code:integer,
#返回信息描述
message:string,
#返回值
data:object
}
</pre>

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)碼

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

我們可以參考這樣的設(shè)計，這樣的好處就把錯誤類型歸類到某個區(qū)間內(nèi)恨溜，如果區(qū)間不夠符衔，可以設(shè)計成4位數(shù)找前。

<pre>#1000～1999 區(qū)間表示參數(shù)錯誤

2000～2999 區(qū)間表示用戶錯誤

3000～3999 區(qū)間表示接口異常

</pre>

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

Message

這個字段相對理解比較簡單槽惫，就是發(fā)生錯誤時，如何友好的進行提示辩撑。一般的設(shè)計是和code狀態(tài)碼一起設(shè)計量九，如

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

狀態(tài)碼和信息就會一一對應(yīng)色徘，比較好維護业岁。

Data

返回數(shù)據(jù)體，JSON格式君躺，根據(jù)不同的業(yè)務(wù)又不同的JSON體峭判。

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

控制層Controller

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

我們看到在獲得order對象之后林螃，我們是用的Result構(gòu)造方法進行包裝賦值，然后進行返回俺泣。小伙伴們有沒有發(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)這樣有幾個問題：

1、每個方法的返回都是Result封裝對象鹏秋，沒有業(yè)務(wù)含義

2尊蚁、在業(yè)務(wù)代碼中，成功的時候我們調(diào)用Result.success侣夷，異常錯誤調(diào)用Result.failure横朋。是不是很多余

3、上面的代碼百拓，判斷id是否為null琴锭，其實我們可以使用hibernate validate做校驗晰甚，沒有必要在方法體中做判斷。

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

這個和我們平時的代碼是一樣的，非常直觀地回，直接返回order對象扁远，這樣是不是很完美。那實現(xiàn)方案是什么呢刻像？

實現(xiàn)方案

小伙伴們怎么去實現(xiàn)是不是有點思路畅买，在這個過程中，我們需要做幾個事情

1细睡、定義一個注解@ResponseResult谷羞，表示這個接口返回的值需要包裝一下

2、攔截請求纹冤，判斷此請求是否需要被@ResponseResult注解

3洒宝、核心步驟就是實現(xiàn)接口ResponseBodyAdvice和@ControllerAdvice，判斷是否需要包裝返回值萌京，如果需要雁歌，就把Controller接口的返回值進行重寫。

注解類

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