Spring Boot提供RESTful接口時的錯誤處理實踐

本文首發于個人網站:http://www.javaadu.online/,如需轉載,請注明出處

使用Spring Boot開發微服務的過程中,我們會使用別人提供的接口,也會設計接口給別人使用,這時候微服務應用之間的協作就需要有一定的規范。

  • 基于rpc協議,我們一般有兩種思路:(1)提供服務的應用統一將異常包起來,然后用錯誤碼交互;(2)提供服務的應用將運行時異常拋出,拋出自定義的業務異常,服務的調用者通過異常catch來處理異常情況。

  • 基于HTTP協議,那么最流行的就是RESTful協議,服務提供方會自己處理所有異常,并且返回的結果中會跟HTTP的狀態碼相結合,這篇文章我們就用一個例子來說明RESTful接口的錯誤處理如何做。

首先我們需要新建一個簡單的Controller,代碼如下:

@RestController
class GreetingController {

    @RequestMapping("/greet")
    String sayHello(@RequestParam("name") String name) {
        if (name == null || name.isEmpty()) {
            throw new IllegalArgumentException("The 'name' parameter must not be null or empty");
        }
        return String.format("Hello %s!", name);
    }
}

通過http請求客戶端——httpie發送HTTP請求,這個工具比curl的好處是:返回值信息有語法高亮、對返回的JSON字符串自動格式化。啟動服務器,使用命令http http://127.0.0.1:8080/greet?name=duqi發起請求,結果如下:

HTTP/1.1 200 OK
Content-Length: 11
Content-Type: text/plain;charset=UTF-8
Date: Sat, 05 Dec 2015 05:45:03 GMT
Server: Apache-Coyote/1.1
X-Application-Context: application

現在我們制造一個錯誤的請求,@RequestParam是獲取URL中的參數,如果這個參數不提供則會出錯。因此,我們發送一個命令http http://127.0.0.1:8080,看結果如何。

HTTP/1.1 400 Bad Request
Connection: close
Content-Type: application/json;charset=UTF-8
Date: Sat, 05 Dec 2015 05:54:06 GMT
Server: Apache-Coyote/1.1
Transfer-Encoding: chunked
X-Application-Context: application

{
    "error": "Bad Request",
    "exception": "org.springframework.web.bind.MissingServletRequestParameterException",
    "message": "Required String parameter 'name' is not present",
    "path": "/greet",
    "status": 400,
    "timestamp": 1449294846060
}

可以看到,由于沒有提供name參數,服務器返回的狀態碼是400:錯誤的請求。在響應體中的內容依次如下:

  • error : 錯誤信息;
  • exception:異常的類型,MissingServletRequestParameterExeption,見名知意,說明是缺少了某個請求參數;
  • message:對異常的說明
  • path:顯示請求的URL路徑;
  • status:表示返回的錯誤碼
  • timestamp:錯誤發生的時間戳,調用System.currentMills()

如果我們給定name參數,卻不給它賦值,又會如何?發送命令http http:127.0.0.1:8080/greet?name,則服務器的返回值如下:

HTTP/1.1 500 Internal Server Error
Connection: close
Content-Type: application/json;charset=UTF-8
Date: Sat, 05 Dec 2015 06:01:24 GMT
Server: Apache-Coyote/1.1
Transfer-Encoding: chunked
X-Application-Context: application

{
    "error": "Internal Server Error",
    "exception": "java.lang.IllegalArgumentException",
    "message": "The 'name' parameter must not be null or empty",
    "path": "/greet",
    "status": 500,
    "timestamp": 1449295284160
}

對比上面,可以看出,這次返回的錯誤碼是500,表示服務器內部錯誤;返回的異常類型是java.lang.IllegalArgumentException,表示參數不合法。服務器內部錯誤表示服務器拋出了異常缺沒有處理,我們更愿意API返回400,告訴調用者自己哪里做錯了。如何實現呢?利用@ExceptionHandler注解即可。

在GreetingController控制器中加入如下處理函數,用于捕獲這個控制器的異常。

@ExceptionHandler
void handleIllegalArgumentException(IllegalArgumentException e, 
                        HttpServletResponse response) throws IOException {    
      response.sendError(HttpStatus.BAD_REQUEST.value());
}

再次發送命令http http:127.0.0.1:8080/greet?name,則返回下面的結果:

HTTP/1.1 400 Bad Request
Connection: close
Content-Type: application/json;charset=UTF-8
Date: Sat, 05 Dec 2015 06:08:50 GMT
Server: Apache-Coyote/1.1
Transfer-Encoding: chunked
X-Application-Context: application

{
    "error": "Bad Request",
    "exception": "java.lang.IllegalArgumentException",
    "message": "The 'name' parameter must not be null or empty",
    "path": "/greet",
    "status": 400,
    "timestamp": 1449295729978
}

說明我們在服務器端捕獲了IllegalArgumentException這個異常,并設置response的返回碼為400。如果你想對多個異常都進行一樣的處理,則上述異常處理代碼可以修改為下面這樣(給@ExceptionHandler傳入參數):

@ExceptionHandler({IllegalArgumentException.class, NullPointerException.class})
void handleIllegalArgumentException(HttpServletResponse response) throws IOException {
    response.sendError(HttpStatus.BAD_REQUEST.value());
}

現在這個異常處理代碼是加在當前的這個控制器中,因此它只處理屬于這個控制器的響應,如果我們新建一個類,并用注解@ControllerAdvice修飾,并在這個類中定義上述的異常處理代碼,則它會負責處理所有的請求。

Spring Boot 1.2.0以后,還支持在response修改對應的message,只要將對應的message信息傳入sendError函數即可,例如:

@ExceptionHandler({IllegalArgumentException.class, NullPointerException.class})
void handleIllegalArgumentException(HttpServletResponse response) throws IOException {
    response.sendError(HttpStatus.BAD_REQUEST.value(), 
         "Please try again and with a non empty string as 'name'");
}

再次執行同樣的命令,會收到下列反饋:

HTTP/1.1 400 Bad Request
Connection: close
Content-Type: application/json;charset=UTF-8
Date: Sat, 05 Dec 2015 06:21:05 GMT
Server: Apache-Coyote/1.1
Transfer-Encoding: chunked
X-Application-Context: application

{
    "error": "Bad Request",
    "exception": "java.lang.IllegalArgumentException",
    "message": "Please try again and with a non empty string as 'name'",
    "path": "/greet",
    "status": 400,
    "timestamp": 1449296465060
}

如果希望驗證請求的參數,可以使用JSR-303 Bean Validation API,并參考Spring Validation。在spring.io上還有一個驗證表單輸入的例子Validating Form Input

參考資料

  1. 模擬GET/POST請求的工具
  2. Spring Boot Error Response

Spring Boot 1.x系列

  1. Spring Boot的自動配置、Command-line-Runner
  2. 了解Spring Boot的自動配置
  3. Spring Boot的@PropertySource注解在整合Redis中的使用
  4. Spring Boot項目中如何定制HTTP消息轉換器
  5. Spring Boot整合Mongodb提供Restful接口
  6. Spring中bean的scope
  7. Spring Boot項目中使用事件派發器模式

本號專注于后端技術、JVM問題排查和優化、Java面試題、個人成長和自我管理等主題,為讀者提供一線開發者的工作和成長經驗,期待你能在這里有所收獲。
javaadu

posted @ 2019-10-26 12:54  javaadu  閱讀(...)  評論(... 編輯 收藏
三d开奖结果走势图