文章來源：https://www.toutiao.com/article/6694404645827117572
在移動網際網路，分散式、微服務盛行的今天，現在專案絕大部分都採用的微服務框架，前後端分離方式，（題外話：前後端的工作職責越來越明確，現在的前端都稱之為大前端，技術棧以及生態圈都已經非常成熟；以前後端人員瞧不起前端人員，那現在後端人員要重新認識一下前端，前端已經很成體系了）。
一般系統的大致整體架構圖如下：
需要說明的是，有些小夥伴會回覆說，這個架構太簡單了吧，太low了，什麼閘道器啊，快取啊，訊息中介軟體啊，都沒有。因為老顧這篇主要介紹的是API介面，所以我們聚焦點，其他的模組小夥伴們自行去補充。
介面互動
前端和後端進行互動，前端按照約定請求URL路徑，並傳入相關引數，後端伺服器接收請求，進行業務處理，返回資料給前端。
針對URL路徑的restful風格，以及傳入引數的公共請求頭的要求（如：app_version,api_version,device等），老顧這裡就不介紹了，小夥伴們可以自行去了解，也比較簡單。
後端伺服器如何實現把資料返回給前端？
推薦一個開源免費的 Spring Boot 實戰專案：
https://github.com/javastacks/spring-boot-best-practice
返回格式
後端返回給前端我們一般用JSON體方式，定義如下：
{
#返回狀態碼
code:integer,
#返回資訊描述
message:string,
#返回值
data:object
}
CODE狀態碼
code返回狀態碼，一般小夥伴們是在開發的時候需要什麼，就新增什麼。
如介面要返回使用者許可權異常，我們加一個狀態碼為101吧，下一次又要加一個資料引數異常，就加一個102的狀態碼。這樣雖然能夠照常滿足業務，但狀態碼太凌亂了
我們應該可以參考HTTP請求返回的狀態碼
：下面是常見的HTTP狀態碼：
200 - 請求成功
301 - 資源（網頁等）被永久轉移到其它URL
404 - 請求的資源（網頁等）不存在
500 - 內部伺服器錯誤
我們可以參考這樣的設計，這樣的好處就把錯誤型別歸類到某個區間內，如果區間不夠，可以設計成4位數。
#1000～1999 區間表示引數錯誤
#2000～2999 區間表示使用者錯誤
#3000～3999 區間表示介面異常
這樣前端開發人員在得到返回值後，根據狀態碼就可以知道，大概什麼錯誤，再根據message相關的資訊描述，可以快速定位。
Message
這個欄位相對理解比較簡單，就是發生錯誤時，如何友好的進行提示。一般的設計是和code狀態碼一起設計，如
再在列舉中定義，狀態碼
狀態碼和資訊就會一一對應，比較好維護。
Data
返回資料體，JSON格式，根據不同的業務又不同的JSON體。
我們要設計一個返回體類Result
控制層Controller
我們會在controller層處理業務請求，並返回給前端，以order訂單為例
我們看到在獲得order物件之後，我們是用的Result構造方法進行包裝賦值，然後進行返回。小夥伴們有沒有發現，構造方法這樣的包裝是不是很麻煩，我們可以最佳化一下。
美觀美化
我們可以在Result類中，加入靜態方法，一看就懂
那我們來改造一下Controller
程式碼是不是比較簡潔了，也美觀了。
優雅最佳化
上面我們看到在Result類中增加了靜態方法，使得業務處理程式碼簡潔了。但小夥伴們有沒有發現這樣有幾個問題：
1、每個方法的返回都是Result封裝物件，沒有業務含義
2、在業務程式碼中，成功的時候我們呼叫Result.success，異常錯誤呼叫Result.failure。是不是很多餘
3、上面的程式碼，判斷id是否為null，其實我們可以使用hibernate validate做校驗，沒有必要在方法體中做判斷。
我們最好的方式直接返回真實業務物件，最好不要改變之前的業務方式，如下圖
這個和我們平時的程式碼是一樣的，非常直觀，直接返回order物件，這樣是不是很完美。那實現方案是什麼呢？
實現方案
小夥伴們怎麼去實現是不是有點思路，在這個過程中，我們需要做幾個事情
1、定義一個註解@ResponseResult，表示這個介面返回的值需要包裝一下
2、攔截請求，判斷此請求是否需要被@ResponseResult註解
3、核心步驟就是實現介面ResponseBodyAdvice和@ControllerAdvice，判斷是否需要包裝返回值，如果需要，就把Controller介面的返回值進行重寫。
註解類
用來標記方法的返回值，是否需要包裝
攔截器
攔截請求，是否此請求返回的值需要包裝，其實就是執行的時候，解析@ResponseResult註解
此程式碼核心思想，就是獲取此請求，是否需要返回值包裝，設定一個屬性標記。
重寫返回體
上面程式碼就是判斷是否需要返回值包裝，如果需要就直接包裝。這裡我們只處理了正常成功的包裝，如果方法體報異常怎麼辦？處理異常也比較簡單，只要判斷body是否為異常類。
怎麼做全域性的異常處理，篇幅原因，老顧這裡就不做介紹了，只要思路理清楚了，自行改造就行。
重寫Controller
在控制器類上或者方法體上加上@ResponseResult註解，這樣就ok了，簡單吧。到此返回的設計思路完成，是不是又簡潔，又優雅。
總結
這個方案還有沒有別的最佳化空間，當然是有的。如：每次請求都要反射一下，獲取請求的方法是否需要包裝，其實可以做個快取，不需要每次都需要解析。當然整體思路瞭解，小夥伴們就可以在此基礎上面自行擴充套件。
更多文章推薦：
1.Spring Boot 3.x 教程，太全了！
2.2,000+ 道 Java面試題及答案整理(2024最新版)
3.免費獲取 IDEA 啟用碼的 7 種方式（2024最新版）
覺得不錯，別忘了隨手點贊+轉發哦！