快捷導(dǎo)航

Spring 異常處理的各種姿勢總結(jié)

更新時(shí)間：2020年05月13日 11:46:12 作者：碼農(nóng)小胖哥

這篇文章主要介紹了Spring 異常處理,總結(jié)分析了Spring 異常處理的各種常見操作技巧與相關(guān)使用注意事項(xiàng),需要的朋友可以參考下

1. 前言

統(tǒng)一的異常處理對于應(yīng)用的重要性不言而喻。今天我們來介紹一下 Spring 如何來進(jìn)行統(tǒng)一的 Rest 異常處理。同時(shí)我們也會(huì)簡單比較一下它們之間的優(yōu)劣。

2. @Controller 結(jié)合 @ExceptionHandler

在控制器中聲明一個(gè)方法然后用 @ExceptionHandler 注解標(biāo)記即可：

 @Controller
 @RequestMapping("/test")
 public class TestController {
 
   @RequestMapping("/err")
   @ResponseBody
   public Object demo1(){
     int i = 1 / 0;
     return new Date();
   }
 
   @ExceptionHandler({RuntimeException.class})
   public ModelAndView fix(Exception ex){
     System.out.println(ex.getMessage());
     return new ModelAndView("error",new ModelMap("ex",ex.getMessage()));
   }
 }

優(yōu)點(diǎn)：

優(yōu)先級最高。
@ExceptionHandler 標(biāo)記的方法返回值類型支持多種。可以是視圖，也可以是 json 等。

缺點(diǎn)：

一個(gè) Controller 中的 @ExceptionHandler 注解上的異常類型不能出現(xiàn)相同的，否則運(yùn)行時(shí)拋異常。
需要顯式的聲明處理的異常類型。
作用域僅僅是該 Controller 并不是真正意義上的全局異常。如果要想作用于全局需要將其放入所有控制器的父類中。

3. @ControllerAdvice 結(jié)合 @ExceptionHandler

這是 2. 的改進(jìn)型，通過定義 @ControllerAdvice 類并在方法上標(biāo)記 @ExceptionHandler ，達(dá)到了全局異常處理的目的：

 @ControllerAdvice
 public class TestController {
 
 
   @ExceptionHandler({RuntimeException.class})
   public ModelAndView fix(Exception ex){
     System.out.println(ex.getMessage());
     return new ModelAndView("error",new ModelMap("ex",ex.getMessage()));
   }
 }

優(yōu)點(diǎn)：

全局的異常處理。
完全控制響應(yīng)的主體以及狀態(tài)碼
將多個(gè)異常映射到同一方法，以一起處理，并且它充分利用了更新的 Restful ResponseEntity 響應(yīng)

缺點(diǎn)：

一個(gè) Controller 中的 @ExceptionHandler 注解上的異常類型不能出現(xiàn)相同的，否則運(yùn)行時(shí)拋異常。
需要顯式的聲明處理的異常類型。

一般情況下也建議使用該方式進(jìn)行異常處理。大多數(shù)情況下都是兼容的。

4. HandlerExceptionResolver 接口

實(shí)現(xiàn) HandlerExceptionResolver 接口，這里我們繼承其抽象實(shí)現(xiàn) AbstractHandlerExceptionResolver :

 @Component
 public class RestResponseStatusExceptionResolver extends AbstractHandlerExceptionResolver {
 
   @Override
   protected ModelAndView doResolveException(
    HttpServletRequest request, 
    HttpServletResponse response, 
    Object handler, 
    Exception ex) {
     try {
       if (ex instanceof IllegalArgumentException) {
         return handleIllegalArgument((IllegalArgumentException) ex, response, handler);
       }
      //todo more exception
     } catch (Exception handlerException) {
        //todo 
     }
     return null;
   }
 
   private ModelAndView 
    handleIllegalArgument(IllegalArgumentException ex, HttpServletResponse response) 
    throws IOException {
     response.sendError(HttpServletResponse.SC_CONFLICT);
     String accept = request.getHeader(HttpHeaders.ACCEPT);
      //todo more response
     return new ModelAndView();
   }
 }

優(yōu)點(diǎn)：

這是一個(gè)全局的異常處理器。
這種方式全局異常處理返回JSP、velocity 等模板視圖比較方便。
支持多種格式的響應(yīng)，雖然覆寫的方法返回的是 ModelAndView 但是因?yàn)閰?shù)中有 HttpServletResponse，我們可以利用它來進(jìn)行定制響應(yīng)結(jié)果。例如，如果客戶端要求輸入application / json，那么在出現(xiàn)錯(cuò)誤情況時(shí)，我們要確保我們返回一個(gè)以application / json編碼的響應(yīng)。

缺點(diǎn)：

我們需要與低級的 HttpServletResponse 交互才能實(shí)現(xiàn)各種形式的響應(yīng)體。
優(yōu)先級比較低

5. Spring Boot 中的異常處理

如果你用的框架是 Spring Boot 。我們還可以用它獨(dú)特的處理方式。優(yōu)點(diǎn)是屏蔽了低級的API,缺點(diǎn)也比較明顯，無法捕捉到具體的異常。

5.1 實(shí)現(xiàn) ErrorController

Spring Boot 在默認(rèn)情況下，提供了 /error 映射來處理所有錯(cuò)誤，在 Servlet 容器里注冊了全局的錯(cuò)誤頁面(Whitelabel Error Page)并返回客戶端。
通過實(shí)現(xiàn) ErrorController 接口并注冊為 Bean。這里不再舉例。可參考 BasicErrorController 。

5.2 添加 `ErrorAttributes`

我們也可以添加 ErrorAttributes 類型的 Bean 來替換替換默認(rèn)的異常處理。

 @Component
 public class MyCustomErrorAttributes extends DefaultErrorAttributes {
 
   @Override
   public Map<String, Object> getErrorAttributes(
    WebRequest webRequest, boolean includeStackTrace) {
     Map<String, Object> errorAttributes = 
      super.getErrorAttributes(webRequest, includeStackTrace);
     errorAttributes.put("locale", webRequest.getLocale()
       .toString());
     errorAttributes.remove("error");
 
     //todo your business
 
     return errorAttributes;
   }
 }

5.3 繼承基類 BasicErrorController

Spring Boot 自動(dòng)配置還提供了實(shí)現(xiàn) ErrorController 接口異常處理的基類 BasicErrorController，默認(rèn)是處理 text/html類型請求的錯(cuò)誤，可以繼承該基類自定義處理更多的請求類型，添加公共方法并使用 @RequestMapping 注解的 produce屬性指定處理類型。

 @Component
 public class MyErrorController extends BasicErrorController {
 
   public MyErrorController(ErrorAttributes errorAttributes) {
     super(errorAttributes, new ErrorProperties());
   }
 
   @RequestMapping(produces = MediaType.APPLICATION_XML_VALUE)
   public ResponseEntity<Map<String, Object>> xmlError(HttpServletRequest request) {
     
   //todo your business
 
   }
 }