你寫得API接口代碼這麼差，難道不能對返回格式統一處理一下嗎？

隨着互聯網各崗位精細化分工的普及，出現了不少的系統架構設計，好比常見的先後端分離架構，後端提供接口給前端，前端根據接口的數據進行渲染，你們各執其職，效率也很是的高，可是隨着接口的增長，若是不統一的規範就會額外的增長大量的溝通成本以及學習成本，對管理者而言是很是的不利。

爲此，我在這篇文章分享給你們一個Java生鮮電商平臺中如何返回統一格式的API的總體架構設計。

通常系統的大體總體架構圖以下：

須要說明的是，有些小夥伴會回覆說，這個架構太簡單了吧，太low了，什麼網關啊，緩存啊，消息中間件啊，都沒有。由於這篇主要介紹的是API接口，因此咱們聚焦點，其餘的模塊小夥伴們自行去補充。

接口交互

前端和後端進行交互，前端按照約定請求URL路徑，並傳入相關參數，後端服務器接收請求，進行業務處理，返回數據給前端。

針對URL路徑的restful風格，以及傳入參數的公共請求頭的要求（如：app_version,api_version,device等），老顧這裏就不介紹了，小夥伴們能夠自行去了解，也比較簡單。

後端服務器如何實現把數據返回給前端？

返回格式

後端返回給前端咱們通常用JSON體方式，定義以下：

{  #返回狀態碼  code:integer,      #返回信息描述  message:string,  #返回值  data:object}

CODE狀態碼

code返回狀態碼，通常小夥伴們是在開發的時候須要什麼，就添加什麼。如接口要返回用戶權限異常，咱們加一個狀態碼爲101吧，下一次又要加一個數據參數異常，就加一個102的狀態碼。這樣雖然可以照常知足業務，但狀態碼太凌亂了咱們應該能夠參考HTTP請求返回的狀態碼：下面是常見的HTTP狀態碼：

200 - 請求成功
301 - 資源（網頁等）被永久轉移到其它URL
404 - 請求的資源（網頁等）不存在
500 - 內部服務器錯誤</pre>

咱們能夠參考這樣的設計，這樣的好處就把錯誤類型歸類到某個區間內，若是區間不夠，能夠設計成4位數。

#1000～1999 區間表示參數錯誤
#2000～2999 區間表示用戶錯誤
#3000～3999 區間表示接口異常</pre>

這樣前端開發人員在獲得返回值後，根據狀態碼就能夠知道，大概什麼錯誤，再根據message相關的信息描述，能夠快速定位。Message這個字段相對理解比較簡單，就是發生錯誤時，如何友好的進行提示。通常的設計是和code狀態碼一塊兒設計，如

再在枚舉中定義，狀態碼

狀態碼和信息就會一一對應，比較好維護。Data返回數據體，JSON格式，根據不一樣的業務又不一樣的JSON體。咱們要設計一個返回體類Result

控制層Controller

咱們會在controller層處理業務請求，並返回給前端，以order訂單爲例

咱們看到在得到order對象以後，咱們是用的Result構造方法進行包裝賦值，而後進行返回。小夥伴們有沒有發現，構造方法這樣的包裝是否是很麻煩，咱們能夠優化一下。美觀美化咱們能夠在Result類中，加入靜態方法，一看就懂。

那咱們來改造一下Controller

代碼是否是比較簡潔了，也美觀了。優雅優化上面咱們看到在Result類中增長了靜態方法，使得業務處理代碼簡潔了。但小夥伴們有沒有發現這樣有幾個問題：

一、每一個方法的返回都是Result封裝對象，沒有業務含義

二、在業務代碼中，成功的時候咱們調用Result.success，異常錯誤調用Result.failure。是否是不少餘

三、上面的代碼，判斷id是否爲null，其實咱們可使用hibernate validate作校驗，沒有必要在方法體中作判斷。

咱們最好的方式直接返回真實業務對象，最好不要改變以前的業務方式，以下圖

這個和咱們平時的代碼是同樣的，很是直觀，直接返回order對象，這樣是否是很完美。那實現方案是什麼呢？

實現方案

小夥伴們怎麼去實現是否是有點思路，在這個過程當中，咱們須要作幾個事情

一、定義一個註解@ResponseResult，表示這個接口返回的值須要包裝一下

二、攔截請求，判斷此請求是否須要被@ResponseResult註解

三、核心步驟就是實現接口ResponseBodyAdvice和@ControllerAdvice，判斷是否須要包裝返回值，若是須要，就把Controller接口的返回值進行重寫。

註解類用來標記方法的返回值，是否須要包裝

攔截器

攔截請求，是否此請求返回的值須要包裝，其實就是運行的時候，解析@ResponseResult註解

此代碼核心思想，就是獲取此請求，是否須要返回值包裝，設置一個屬性標記。重寫返回體

上面代碼就是判斷是否須要返回值包裝，若是須要就直接包裝。這裏咱們只處理了正常成功的包裝，若是方法體報異常怎麼辦？處理異常也比較簡單，只要判斷body是否爲異常類。

怎麼作全局的異常處理，篇幅緣由，這裏就不作介紹了，只要思路理清楚了，自行改造就行。

重寫Controller

在控制器類上或者方法體上加上@ResponseResult註解，這樣就ok了，簡單吧。到此返回的設計思路完成，是否是又簡潔，又優雅。這個方案還有沒有別的優化空間，固然是有的。如：每次請求都要反射一下，獲取請求的方法是否須要包裝，其實能夠作個緩存，不須要每次都須要解析。

固然總體思路瞭解，小夥伴們就能夠在此基礎上面自行擴展，若有收穫，請幫忙轉發，您的鼓勵是做者最大的動力。

寫在最後

歡迎你們關注個人公衆號【風平浪靜如碼】，海量Java相關文章，學習資料都會在裏面更新，整理的資料也會放在裏面。

以爲寫的還不錯的就點個贊，加個關注唄！點關注，不迷路，持續更新！！！