Spring Boot HTTP over JSON 的錯誤碼異常處理

摘要: 原創出處:www.bysocket.com 泥瓦匠BYSocket 希望轉載，保留摘要，謝謝！

“年輕人不要怕表現，要敢于出來表現，但還是那句話，要有正确的度，你的表現是分析問題和解決問題的能力。”

– 《你憑什麼做好網際網路》

本文提綱

一、異常統一處理的使用場景

二、運作 springboot-validation-over-json 工程

三、springboot-validation-over-json 工程代碼詳解

在前後端分離開發中，經常用 HTTP over JSON 作為服務進行前後端聯調對接。這裡簡單介紹下為啥前後端分離開發？我想到如下：

1.低耦合，責權分離，子產品化。前後端之間利用輕量級協定對接耦合。

2.便于靈活開發：後端給出 api 文檔 -> 前端根據文檔，mock出資料開發 ；同時，後端實作業務邏輯。

3.微服務尤其适用

這時候 HTTP over JSON 形式中很多涉及到傳回碼，錯誤碼相關的處理。比如xxx參數不完整，權限不足，使用者不存在等。

怎麼統一處理認為是異常的場景呢？

利用的是 Spring 4.x 提供的 RestControllerAdvice。這裡做下說明，也可以根據 ControllerAdvice 去實作。這裡案例是 HTTP over JSON 模式，是以直接利用

RestControllerAdvice ，控制層通知器，這裡用于統一攔截異常，進行響應處理。工作模式，如圖：

運作環境：JDK 7 或 8，Maven 3.0+

技術棧：SpringBoot 1.5+（内涵 Spring 4.x)

1.git clone 下載下傳工程 springboot-learning-example

項目位址見 GitHub – https://github.com/JeffLi1993/springboot-learning-example：

1	git clone [email protected]:JeffLi1993 /springboot-learning-example .git

然後，Maven 編譯安裝這個工程：

2	cd springboot-learning-example mvn clean install

2.運作 springboot-validation-over-json 工程

右鍵運作 springboot-validation-over-json 工程 Application 應用啟動類的 main 函數。預設端口 8080

3.通路案例

a. 參數不完整案例：

通路浏覽器打開下面連結，可得到以下 JSON 傳回

http://localhost:8080/api/city?cityName=

3 4 5

{ "code" : "000001" , "message" : "params no complete" , "result" : null }

b. 成功案例：

http://localhost:8080/api/city?cityName=%E6%B8%A9%E5%B2%AD%E5%B8%82

6 7 8 9 10

{ "code" : "0" , "message" : "success" , "result" : { "id" : 1, "provinceId" : 2, "cityName" : "溫嶺" , "description" : "是我的故鄉" } }

代碼詳解提綱：

a.控制層通知器

b.響應碼設計

同樣，代碼共享在我的 GitHub 上：

https://github.com/JeffLi1993/springboot-learning-example/tree/master/springboot-validation-over-json

首先，工程代碼目錄如下：

11 12 13 14 15 16 17 18 19

├── pom.xml └── src └── main └── java └── org └── spring └── springboot ├── Application.java ├── constant │   └── CityErrorInfoEnum.java ├── result │   ├── ErrorInfoInterface.java │   ├── GlobalErrorInfoEnum.java │   ├── GlobalErrorInfoException.java │   ├── GlobalErrorInfoHandler.java │   └── ResultBody.java └── web ├── City.java └── ErrorJsonController.java

GlobalErrorInfoHandler.java 代碼如下：

@RestControllerAdvice public class GlobalErrorInfoHandler { @ExceptionHandler (value = GlobalErrorInfoException. class ) public ResultBody errorHandlerOverJson(HttpServletRequest request, GlobalErrorInfoException exception) { ErrorInfoInterface errorInfo = exception.getErrorInfo(); ResultBody result = new ResultBody(errorInfo); return result; } }

@ExceptionHandler 注解，标記了使用 errorHandlerOverJson() 方法來處理 GlobalErrorInfoException 異常。

@RestControllerAdvice 是 @ControllerAdvice 和 @ResponseBody 的語義結合。是控制器增強，直接傳回對象。這裡用于統一攔截異常，然後傳回錯誤碼對象體。

@ResponseBody 作用： 該注解用于将 Controller 的方法傳回的對象，通過适當的 HttpMessageConverter 轉換為指定格式後，寫入到 Response 對象的 body 資料區。

簡單講講，這裡定義了一個錯誤碼接口，全局錯誤碼枚舉和各個業務錯誤碼枚舉去實作接口，并用枚舉值枚舉出錯誤碼及錯誤碼消息清單。如圖：

四、小結

如果實戰中，大家遇到什麼，或者建議《Spring boot 那些事》還需要一起交流的。請點選留言。

推薦書《騰訊傳》，其中幾章寫的很不錯。

歡迎掃一掃我的公衆号關注 — 及時得到部落格訂閱哦！

— http://www.bysocket.com/ —

— https://github.com/JeffLi1993 —