在盛行分布式、微服務的移動互聯網時代，微服務框架和前后端分離方式已經成為項目的主流趨勢。近日有很多小伙伴想了解java統一返回類的設計，今天小千就為大家帶來了關于API接口的設計內容，感興趣的小伙伴快來收藏啦！

　　系統架構圖

　　接口交互

　　前端和后端進行交互，前端按照約定請求URL路徑，并傳入相關參數，后端服務器接收請求，進行業務處理，返回數據給前端。后端服務器如何實現把數據返回給前端？

　　返回格式

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

　　CODE狀態碼

　　code返回狀態碼，一般小伙伴們是在開發的時候需要什么，就添加什么。

　　如接口要返回用戶權限異常，我們加一個狀態碼為101吧，下一次又要加一個數據參數異常，就加一個102的狀態碼。這樣雖然能夠照常滿足業務，但狀態碼太凌亂了

　　我們應該可以參考HTTP請求返回的狀態碼

　　我們可以參考這樣的設計，這樣的好處就把錯誤類型歸類到某個區間內，如果區間不夠，可以設計成4位數。

　　這樣前端開發人員在得到返回值后，根據狀態碼就可以知道，大概什么錯誤，再根據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了，簡單吧。到此返回的設計思路完成，是不是又簡潔，又優雅。

　　這個方案還有沒有別的優化空間，當然是有的。

　　如：每次請求都要反射一下，獲取請求的方法是否需要包裝，其實可以做個緩存，不需要每次都需要解析。當然整體思路了解，小伙伴們就可以在此基礎上面自行擴展。

　　注：本文部分文字和圖片來源于網絡，如有侵權，請聯系刪除。版權歸原作者所有!