533
Spring Boot HTTP over JSON 的錯誤碼異常處理
本文提綱
一、異常統一處理的使用場景
二、運行 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 ，控製層通知器，這裏用於統一攔截異常，進行響應處理。工作模式，如圖：
二、運行 springboot-validation-over-json 工程
運行環境：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：
git clone git@github.com:JeffLi1993/springboot-learning-example.git
然後，Maven 編譯安裝這個工程：
cd springboot-learning-example mvn clean install
2.運行 springboot-validation-over-json 工程
右鍵運行 springboot-validation-over-json 工程 Application 應用啟動類的 main 函數。默認端口 8080
3.訪問案例
a. 參數不完整案例：
訪問瀏覽器打開下麵鏈接，可得到以下 JSON 返回
https://localhost:8080/api/city?cityName=
{
"code": "000001",
"message": "params no complete",
"result": null
}
b. 成功案例：
訪問瀏覽器打開下麵鏈接，可得到以下 JSON 返回
https://localhost:8080/api/city?cityName=%E6%B8%A9%E5%B2%AD%E5%B8%82
{
"code": "0",
"message": "success",
"result": {
"id": 1,
"provinceId": 2,
"cityName": "溫嶺",
"description": "是我的故鄉"
}
}
三、springboot-validation-over-json 工程代碼詳解
代碼詳解提綱：
a.控製層通知器
b.響應碼設計
同樣，代碼共享在我的 GitHub 上：
https://github.com/JeffLi1993/springboot-learning-example/tree/master/springboot-validation-over-json
首先，工程代碼目錄如下：
├── 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
a.控製層通知器
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 數據區。
b.響應碼設計
簡單講講，這裏定義了一個錯誤碼接口，全局錯誤碼枚舉和各個業務錯誤碼枚舉去實現接口，並用枚舉值枚舉出錯誤碼及錯誤碼消息列表。如圖：
四、小結
如果實戰中，大家遇到什麼，或者建議《Spring boot 那些事》還需要一起交流的。請點擊留言。
最後更新：2017-05-19 09:31:20