后端API接口如何寫得巴適！！！

需要說明的是，有些小伙伴會(huì)回復(fù)說，這個(gè)架構(gòu)太簡單了吧，太 low 了，什么網(wǎng)關(guān)啊，緩存啊，消息中間件啊，都沒有。

因?yàn)檫@篇我主要介紹的是 API 接口，所以我們聚焦點(diǎn)，其他的模塊小伙伴們自行去補(bǔ)充。

前端和后端進(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ù)返回給前端？

{
????#返回狀態(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)碼太凌亂了。

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

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

③Data

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

我們看到在獲得 Order 對(duì)象之后，我們是用的 Result 構(gòu)造方法進(jìn)行包裝賦值，然后進(jìn)行返回。另外，搜索公眾號(hào)技術(shù)社區(qū)后臺(tái)回復(fù)“算法”，獲取一份驚喜禮包。

小伙伴們有沒有發(fā)現(xiàn)，構(gòu)造方法這樣的包裝是不是很麻煩，我們可以優(yōu)化一下。

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

上面我們看到在 Result 類中增加了靜態(tài)方法，使得業(yè)務(wù)處理代碼簡潔了。

但小伙伴們有沒有發(fā)現(xiàn)這樣有幾個(gè)問題：

• 每個(gè)方法的返回都是 Result 封裝對(duì)象，沒有業(yè)務(wù)含義。

• 在業(yè)務(wù)代碼中，成功的時(shí)候我們調(diào)用 Result.success，異常錯(cuò)誤調(diào)用 Result.failure。是不是很多余。

• 上面的代碼，判斷 id 是否為 null，其實(shí)我們可以使用 hibernate validate 做校驗(yàn)，沒有必要在方法體中做判斷。
  

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

小伙伴們?cè)趺慈?shí)現(xiàn)是不是有點(diǎn)思路，在這個(gè)過程中，我們需要做幾個(gè)事情：

• 定義一個(gè)注解 @ResponseResult，表示這個(gè)接口返回的值需要包裝一下。

• 攔截請(qǐng)求，判斷此請(qǐng)求是否需要被 @ResponseResult 注解。
  

• 核心步驟就是實(shí)現(xiàn)接口 ResponseBodyAdvice 和 @ControllerAdvice，判斷是否需要包裝返回值，如果需要，就把 Controller 接口的返回值進(jìn)行重寫。

①注解類

②攔截器

此代碼核心思想，就是獲取此請(qǐng)求，是否需要返回值包裝，設(shè)置一個(gè)屬性標(biāo)記。

怎么做全局的異常處理，篇幅原因，老顧這里就不做介紹了，只要思路理清楚了，自行改造就行。

④重寫 Controller

在控制器類上或者方法體上加上 @ResponseResult 注解，這樣就 OK 了，簡單吧。到此返回的設(shè)計(jì)思路完成，是不是又簡潔，又優(yōu)雅。

這個(gè)方案還有沒有別的優(yōu)化空間，當(dāng)然是有的。如：每次請(qǐng)求都要反射一下，獲取請(qǐng)求的方法是否需要包裝，其實(shí)可以做個(gè)緩存，不需要每次都需要解析。

當(dāng)然整體思路了解，小伙伴們就可以在此基礎(chǔ)上面自行擴(kuò)展。謝謝！！！