SpringMVC 三種異常處理方式
在 SpringMVC， SpringBoot 處理 web 請求時， 若遇到錯誤或者異常，返回給用戶一個良好的錯誤信息比 Whitelabel Error Page 好的多。 SpringMVC 提供了三種異常處理方式， 良好的運用它們可以給用戶提供可讀的錯誤信息。
1. 實現 HandlerExceptionResolver
public class AppHandlerExceptionResolver implements HandlerExceptionResolver {
@Override
public ModelAndView resolveException(HttpServletRequest request, HttpServletResponse response, Object handler, Exception ex) {
ModelAndView mav = new ModelAndView();
mav.addObject("message", ex.getMessage());
// 可以設置視圖名導向錯誤頁面
mav.setViewName("/error");
// 直接返回視圖
// 如果返回 null，則會調用下一個 HandlerExceptionResolver
return mav;
}
}
然后配置一個 HandlerExceptionResolver
@Bean
public AppHandlerExceptionResolver appHandlerExceptionResolver() {
return new AppHandlerExceptionResolver();
}
HandlerExceptionResolver 的實現類會 catch 到 @Controller 方法執行時發生的異常，處理后返回 ModelAndView 作為結果視圖，因此可以通過它來定制異常視圖。
HandlerExceptionResolver 只能捕獲 @Controller 層發生的異常（包括 @Controller 調用 @Service 發生的異常），其他地方的異常，比如訪問了一個不存在的路徑，不會被 HandlerExceptionResolver 捕獲，此時會跳到 ErrorController 處理， 下面會說到。
2. 通過 @ControllerAdvice 和 @ExceptionHandler 注解
// 可以配置攔截指定的類或者包等
// @RestControllerAdvice 使 @ExceptionHandler 注解的方法默認具有 @ResponseBody 注解
@RestControllerAdvice(basePackageClasses = HelloWorldController.class)
public class AppExceptionHandlerAdvice {
// 配置攔截的錯誤類型
// 這里也可以返回 ModelAndView 導向錯誤視圖
@ExceptionHandler(Exception.class)
public ResponseEntity<Object> responseEntity(Exception e) {
HttpHeaders headers = new HttpHeaders();
headers.setContentType(MediaType.APPLICATION_JSON_UTF8);
Map<String, Object> map = new HashMap<>();
map.put("status", 400);
map.put("message", e.getMessage());
// 直接返回結果
return new ResponseEntity<>(map, headers, HttpStatus.BAD_REQUEST);
}
}
這種方式配置的異常處理由 HandlerExceptionResolver 的默認實現類 HandlerExceptionResolverComposite 處理，因此也只能捕獲 @Controller 層的異常。
@ExceptionHandler 可以返回 ModelAndView 定制異常視圖。
@ControllerAdvice 可以攔截特定的類，@ExceptionHandler 可以攔截特定的異常，因此可以更精確的配置異常處理邏輯。
@ExceptionHandler 可以在 @Controller 類中聲明，此時只能處理同一個類的異常
3. 自定義 ErrorController bean
@RestController
@RequestMapping("/error")
public class AppErrorController extends AbstractErrorController {
public AppErrorController(ErrorAttributes errorAttributes) {
super(errorAttributes);
}
@RequestMapping
public ResponseEntity<Map<String, Object>> error(HttpServletRequest request) {
Map<String, Object> body = getErrorAttributes(request, false);
HttpStatus status = getStatus(request);
// 返回響應體
return new ResponseEntity<>(body, status);
}
@Override
public String getErrorPath() {
return "/error";
}
}
如果沒有配置 ErrorController, SpringBoot 會通過 ErrorMvcAutoConfiguration 自動配置一個，默認的實現類為 BasicErrorController。
ErrorController 可以處理非 @Controller 層拋出的異常，例如常見的訪問了一個不存在的路徑。
ErrorController 可以進行統一的錯誤處理，即讓 HandlerExceptionResolver 返回的 ModelAndView 導向錯誤頁面。