API 接口，統(tǒng)一格式返回！你學(xué)到了么

猿友 2020-09-18 15:11:32 瀏覽數(shù) (2950)

反饋

文章來源于公眾號(hào)：Java旅途

前言

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

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

系統(tǒng)的大致整體架構(gòu)圖

需要說明的是，有些小伙伴會(huì)回復(fù)說，這個(gè)架構(gòu)太簡(jiǎn)單了吧，太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等），老顧這里就不介紹了，小伙伴們可以自行去了解，也比較簡(jiǎn)單。

后端服務(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ò)誤

HTTP請(qǐng)求返回的狀態(tài)碼

我們可以參考這樣的設(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ì)理解比較簡(jiǎn)單，就是發(fā)生錯(cuò)誤時(shí)，如何友好的進(jìn)行提示。一般的設(shè)計(jì)是和code狀態(tài)碼一起設(shè)計(jì)，如

發(fā)生錯(cuò)誤提示

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

發(fā)生錯(cuò)誤狀態(tài)碼

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

Data

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

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

返回體類Result

控制層Controller

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

處理業(yè)務(wù)請(qǐng)求

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

美觀美化

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

Result類加入靜態(tài)方法

那我們來改造一下 Controller

改造一下Controller

代碼是不是比較簡(jiǎn)潔了，也美觀了。

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

上面我們看到在 Result 類中增加了靜態(tài)方法，使得業(yè)務(wù)處理代碼簡(jiǎn)潔了。但小伙伴們有沒有發(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ù)方式，如下圖

直接返回真實(shí)業(yè)務(wù)對(duì)象

這個(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)記方法的返回值，是否需要包裝

標(biāo)記方法的返回值