摘要：在本講中，通過(guò)一個(gè)精簡(jiǎn)的項(xiàng)目，著重介紹一些的異常處理技巧?，F(xiàn)在，為了快熟實(shí)現(xiàn)自定義異常信息處理類，并讓其正常工作，我們可以直接擴(kuò)展提供的類來(lái)定義用戶異常信息處理類。將異常報(bào)告封裝到對(duì)象中，并回傳給。

能夠正確的處理REST API程序拋出的異常以及返回友好的異常信息是一件非常重要的事情，因?yàn)樗梢詭椭鶤PI客戶端正確的對(duì)服務(wù)端的問(wèn)題作出正確的響應(yīng)。這有助于提高REST API的服務(wù)質(zhì)量。Spring Boot默認(rèn)返回的異常信息對(duì)于API客戶端來(lái)說(shuō)是晦澀難懂的，只有開(kāi)發(fā)者才會(huì)關(guān)注那些堆棧異常報(bào)告。在本講中，將對(duì)如何處理好Spring REST API異常信息做一個(gè)梳理。

最近一段時(shí)間，Spring Boot成為了Java開(kāi)發(fā)圈子的網(wǎng)紅，越來(lái)越多的開(kāi)發(fā)者選擇Spring Boot來(lái)構(gòu)建REST API。使用Spring Boot，能夠幫助開(kāi)發(fā)者減少模板代碼和配置文件的編寫(xiě)工作量。Spring Boot開(kāi)箱即用的特性，受到廣大開(kāi)發(fā)者的熱寵。在本講中，通過(guò)一個(gè)精簡(jiǎn)的Demo項(xiàng)目，著重介紹一些Spring Boot REST API的異常處理技巧。

如果你不想閱讀本次內(nèi)容，只是想快速獲得相關(guān)的源碼，那你可以直接跳轉(zhuǎn)到文章的結(jié)尾，找到Gihub倉(cāng)庫(kù)鏈接，通過(guò)該鏈接，你可以輕松的獲得本次內(nèi)容的全部源碼。

1. 定義明確的異常信息

當(dāng)程序發(fā)送錯(cuò)誤時(shí)，不應(yīng)該將晦澀的堆棧報(bào)告信息返回給API客戶端，從某種意義將，這是一種不禮貌的和不負(fù)責(zé)任的行為?，F(xiàn)在，我們將模擬這樣一個(gè)需求，API客戶端可以向服務(wù)端發(fā)送請(qǐng)求以獲取一個(gè)或者多個(gè)用戶信息，同時(shí)還可以發(fā)送請(qǐng)求創(chuàng)建一個(gè)新的用戶信息。下面是大致的一個(gè)API信息：

Spring MVC為我們提供了一些很有用的功能，以幫助我們解決系統(tǒng)的異常信息，并將有用的提示信息返回給API客戶端。

以 POST /users 創(chuàng)建一個(gè)新用戶為例，當(dāng)我們提供正常的用戶數(shù)據(jù)并請(qǐng)求此接口時(shí)，REST API將返回如下的提示信息：

{
  "id": 2,
  "username": "wukong",
  "age": 52,
  "height": 170
}

現(xiàn)在，將用戶年齡修改為200歲，身高修改為500厘米，用戶名為rulai ,在此請(qǐng)求此REST API，觀察API的返回信息：

{
  "restapierror": {
    "status": "BAD_REQUEST",
    "timestamp": "2019-05-19 06:04:47",
    "message": "Validation error",
    "subErrors": [
      {
        "object": "user",
        "field": "height",
        "rejectedValue": 500,
        "message": "用戶身高不能超過(guò)250厘米"
      },
      {
        "object": "user",
        "field": "age",
        "rejectedValue": 200,
        "message": "用戶年齡不能超過(guò)120歲"
      }
    ]
  }
}

如上所示，當(dāng)API客戶端提供不正確的數(shù)據(jù)時(shí)，REST API返回了格式良好的異常提示信息，timestamp由原來(lái)的整形時(shí)間戳格式化為一個(gè)可讀的日期+時(shí)間，同時(shí)還詳細(xì)列舉了詳細(xì)的錯(cuò)誤報(bào)告。

2. 包裝異常信息

為了能夠提供一個(gè)可讀的JSON格式異常信息給API客戶端，我們需要在項(xiàng)目中引入Jackson JSR 310的依賴包，使用其提供的@JsonFormat注解將Java中的日期和時(shí)間按照我們給定的日期和時(shí)間模板進(jìn)行格式化。現(xiàn)在，將下面的依賴包加入的Maven pom.xml文件中：

    com.fasterxml.jackson.datatype
    jackson-datatype-jsr310
    2.9.8

依賴就緒后，我們需要提供一個(gè)異常信息的包裝類：RestApiError。它將負(fù)責(zé)對(duì)REST API拋出的異常信息進(jìn)行封裝：

public class RestApiError {

    private HttpStatus status;

    @JsonFormat(shape = JsonFormat.Shape.STRING,pattern = "yyyy-MM-dd hh:mm:ss")
    private LocalDateTime timestamp;

    private String message;

    private String debugMessage;

    private List subErrors;

    private RestApiError(){
        timestamp = LocalDateTime.now();
    }

    RestApiError(HttpStatus status){
        this();
        this.status = status;
    }

    RestApiError(HttpStatus status,Throwable ex){
        this();
        this.status = status;
        this.message = "Unexpected error";
        this.debugMessage = ex.getLocalizedMessage();
    }

    RestApiError(HttpStatus status,String message,Throwable ex){
        this();
        this.status = status;
        this.message = message;
        this.debugMessage = ex.getLocalizedMessage();
    }
}    

status 屬性用于記錄響應(yīng)狀態(tài)。它沿用了HttpStatus的所有狀態(tài)嗎，如4xx和5xx。

timestamp屬性用于記錄發(fā)送錯(cuò)誤的時(shí)間

message屬性用于記錄自定義的異常消息，通常是對(duì)API客戶端友好的提示信息

debugMessage屬性用于記錄更為詳細(xì)的錯(cuò)誤報(bào)告

subErrors屬性用于記錄異常附帶的子異常信息，如用戶實(shí)體中字段校驗(yàn)信息等

RestApiSubError類用于記錄更為細(xì)致的異常信息，通常為實(shí)體類中字段校驗(yàn)失敗的異常報(bào)告：

abstract class RestApiSubError{}
@Data
@EqualsAndHashCode(callSuper = false)
@AllArgsConstructor
class RestApiValidationError extends RestApiSubError{
    private String object;
    private String field;
    private Object rejectedValue;
    private String message;

    RestApiValidationError(String object,String message){
        this.object = object;
        this.message = message;
    }
}

RestApiSubError類是一個(gè)抽象的空類，具體的擴(kuò)展將在RestApiValidationError中進(jìn)行實(shí)現(xiàn)。RestApiValidationError類將記錄實(shí)體類中（如本講中的User對(duì)象）屬性校驗(yàn)失敗報(bào)告。

現(xiàn)在，我們來(lái)校驗(yàn)GET /users/1 API,檢索用戶ID為1的用戶信息：

{
  "id": 1,
  "username": "ramostear",
  "age": 28,
  "height": 170
}

REST API成功的返回了用戶信息，接下來(lái)我們傳入一個(gè)系統(tǒng)不存在的用戶ID，看看REST API返回什么信息：

GET /users/100

{
  "restapierror": {
    "status": "NOT_FOUND",
    "timestamp": "2019-05-19 06:31:17",
    "message": "User was not found for parameters {id=100}"
  }
}

通過(guò)上述的JSON信息我們可以看到，檢索不存在的用戶信息，REST API返回了友好的提示信息。在一開(kāi)始的時(shí)候我們測(cè)試提供不合符規(guī)范的用戶年齡和身高信息，接下來(lái)我們?cè)趤?lái)測(cè)試一下提供一個(gè)空的用戶名，觀察REST API返回的信息：

{
  "restapierror": {
    "status": "BAD_REQUEST",
    "timestamp": "2019-05-19 06:37:46",
    "message": "Validation error",
    "subErrors": [
      {
        "object": "user",
        "field": "username",
        "rejectedValue": "",
        "message": "不能為空"
      }
    ]
  }
}

3. Spring Boot 處理異常信息的流程

Spring Boot 處理REST API異常信息將會(huì)涉及到三個(gè)注解：

@RestController : 負(fù)責(zé)處理REST API具體操作邏輯的注解

@ExceptionHandler : 負(fù)責(zé)處理@RestController標(biāo)注的類中拋出的異常的注解

@ControllerAdvice : 能夠?qū)ExceptionHandler標(biāo)注的方法集中到一個(gè)地方進(jìn)行處理的注解

@ControllerAdivice注解是在Spring 3.2版本中新增的一個(gè)注解，它能夠?qū)蝹€(gè)由@ExceptionHandler注解標(biāo)注的方法應(yīng)用到多個(gè)控制器中。使用它的好處是我們可以在一個(gè)統(tǒng)一的地方同時(shí)處理多個(gè)控制器拋出的異常，當(dāng)控制器有異常拋出時(shí)，ControllerAdvice會(huì)根據(jù)當(dāng)前拋出的異常類型，自動(dòng)匹配對(duì)應(yīng)的ExceptionHandler;當(dāng)沒(méi)有特定的Exception可用時(shí)，將調(diào)用默認(rèn)的異常信息處理類來(lái)處理控制器拋出的異常（默認(rèn)的異常信息處理類）。

下面，我們通過(guò)一張流程示例圖，更為直觀的了解Spring Application處理控制器異常信息的全部過(guò)程：

在圖中，藍(lán)色箭頭表示正常的請(qǐng)求和響應(yīng)過(guò)程，紅色箭頭表示發(fā)生異常的請(qǐng)求和響應(yīng)過(guò)程。

4. 自定義異常信息處理類

Spring Framework自帶的異常信息處理類往往不能滿足我們實(shí)際的業(yè)務(wù)需求，這就需要我們定義符合具體情況的異常信息處理類,在自定義異常信息處理類中，我們可以封裝更為詳細(xì)的異常報(bào)告。

自定義異常信息處理類，我們可以站在“巨人”的肩膀上，快速封裝自己的異常信息處理類，而不必要從頭開(kāi)始造“輪子”?，F(xiàn)在，為了快熟實(shí)現(xiàn)自定義異常信息處理類，并讓其正常工作，我們可以直接擴(kuò)展Spring 提供的ResponseEntityExceptionHandler類來(lái)定義用戶異常信息處理類。ResponseEntityExceptionHandler已經(jīng)提供了很多可用的功能，我們只需要擴(kuò)展該類或者覆蓋其提供的方法即可。

打開(kāi)ResponseEntityExceptionHandler類，我們可以看到如下的源碼：

public abstract class ResponseEntityExceptionHandler {
    
 //不支持的HTTP請(qǐng)求方法異常信息處理方法
 protected ResponseEntity