Spring Boot HTTP over JSON 的錯誤碼異常處理 | 泥瓦匠BYSocket

– 《你憑什么做好互聯(lián)網(wǎng)》

本文提綱
一、異常統(tǒng)一處理的使用場景
二、運行 springboot-validation-over-json 工程
三、springboot-validation-over-json 工程代碼詳解

一、異常統(tǒng)一處理的使用場景

在前后端分離開發(fā)中，經(jīng)常用 HTTP over JSON 作為服務(wù)進行前后端聯(lián)調(diào)對接。這里簡單介紹下為啥前后端分離開發(fā)？我想到如下：

1.低耦合，責(zé)權(quán)分離，模塊化。前后端之間利用輕量級協(xié)議對接耦合。
2.便于敏捷開發(fā)：后端給出 api 文檔 -> 前端根據(jù)文檔，mock出數(shù)據(jù)開發(fā) ；同時，后端實現(xiàn)業(yè)務(wù)邏輯。
3.微服務(wù)尤其適用

這時候 HTTP over JSON 形式中很多涉及到返回碼，錯誤碼相關(guān)的處理。比如xxx參數(shù)不完整，權(quán)限不足，用戶不存在等。

怎么統(tǒng)一處理認(rèn)為是異常的場景呢？
利用的是 Spring 4.x 提供的 RestControllerAdvice。這里做下說明，也可以根據(jù) ControllerAdvice 去實現(xiàn)。這里案例是 HTTP over JSON 模式，所以直接利用
RestControllerAdvice ，控制層通知器，這里用于統(tǒng)一攔截異常，進行響應(yīng)處理。工作模式，如圖：

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

運行環(huán)境：JDK 7 或 8，Maven 3.0+
技術(shù)棧：SpringBoot 1.5+（內(nèi)涵 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 cleaninstall

2.運行 springboot-validation-over-json 工程
右鍵運行 springboot-validation-over-json 工程 Application 應(yīng)用啟動類的 main 函數(shù)。默認(rèn)端口 8080

3.訪問案例
a. 參數(shù)不完整案例：
訪問瀏覽器打開下面鏈接，可得到以下 JSON 返回
http://localhost:8080/api/city?cityName=

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

b. 成功案例：
訪問瀏覽器打開下面鏈接，可得到以下 JSON 返回
http://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":"是我的故鄉(xiāng)"
    }
}

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

代碼詳解提綱：
a.控制層通知器
b.響應(yīng)碼設(shè)計

同樣，代碼共享在我的 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 注解，標(biāo)記了使用 errorHandlerOverJson() 方法來處理 GlobalErrorInfoException 異常。
@RestControllerAdvice 是 @ControllerAdvice 和 @ResponseBody 的語義結(jié)合。是控制器增強，直接返回對象。這里用于統(tǒng)一攔截異常，然后返回錯誤碼對象體。
@ResponseBody 作用： 該注解用于將 Controller 的方法返回的對象，通過適當(dāng)?shù)?HttpMessageConverter 轉(zhuǎn)換為指定格式后，寫入到 Response 對象的 body 數(shù)據(jù)區(qū)。

b.響應(yīng)碼設(shè)計
簡單講講，這里定義了一個錯誤碼接口，全局錯誤碼枚舉和各個業(yè)務(wù)錯誤碼枚舉去實現(xiàn)接口，并用枚舉值枚舉出錯誤碼及錯誤碼消息列表。如圖：

四、小結(jié)

如果實戰(zhàn)中，大家遇到什么，或者建議《Spring boot 那些事》還需要一起交流的。請點擊留言。

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

歡迎掃一掃我的公眾號關(guān)注 — 及時得到博客訂閱哦！
— http://www.bysocket.com/ —
— https://github.com/JeffLi1993 —