Spring 統一異常處理有3 種方式,分別為:
使用@ ExceptionHandler註解、實作HandlerExceptionResolver介面、使用@controlleradvice 註解
#使用@ ExceptionHandler 註解
使用這個註解有一個不好的地方就是:進行異常處理的方法必須與出錯的方法在同一個Controller裡面。使用如下:
@Controller public class GlobalController { /** * 用于处理异常的 * @return */ @ExceptionHandler({MyException.class}) public String exception(MyException e) { System.out.println(e.getMessage()); e.printStackTrace(); return "exception"; } @RequestMapping("test") public void test() { throw new MyException("出错了!"); } }
可以看到,這種方式最大的缺陷就是不能全域控制異常。每個類別都要寫一遍。
實作 HandlerExceptionResolver 介面
這種方式可以進行全域的異常控制。例如:
@Component public class ExceptionTest implements HandlerExceptionResolver{ /** * TODO 简单描述该方法的实现功能(可选). * @see org.springframework.web.servlet.HandlerExceptionResolver#resolveException(javax.servlet.http.HttpServletRequest, javax.servlet.http.HttpServletResponse, java.lang.Object, java.lang.Exception) */ public ModelAndView resolveException(HttpServletRequest request, HttpServletResponse response, Object handler, Exception ex) { System.out.println("This is exception handler method!"); return null; } }
使用 @ControllerAdvice @ ExceptionHandler 註解
上文說到 @ ExceptionHandler 需要進行例外處理的方法必須與出錯的方法在同一個Controller裡面。那麼當程式碼加入了 @ControllerAdvice,則不需要必須在同一個 controller 中了。這也是 Spring 3.2 帶來的新功能。從名字可以看出大致意思是控制器增強。也就是說,@controlleradvice @ ExceptionHandler 也可以實現全域的例外擷取。
請確保此WebExceptionHandle 類別能被掃描到並裝載進 Spring 容器中。
@ControllerAdvice @ResponseBody public class WebExceptionHandle { private static Logger logger = LoggerFactory.getLogger(WebExceptionHandle.class); /** * 400 - Bad Request */ @ResponseStatus(HttpStatus.BAD_REQUEST) @ExceptionHandler(HttpMessageNotReadableException.class) public ServiceResponse handleHttpMessageNotReadableException(HttpMessageNotReadableException e) { logger.error("参数解析失败", e); return ServiceResponseHandle.failed("could_not_read_json"); } /** * 405 - Method Not Allowed */ @ResponseStatus(HttpStatus.METHOD_NOT_ALLOWED) @ExceptionHandler(HttpRequestMethodNotSupportedException.class) public ServiceResponse handleHttpRequestMethodNotSupportedException(HttpRequestMethodNotSupportedException e) { logger.error("不支持当前请求方法", e); return ServiceResponseHandle.failed("request_method_not_supported"); } /** * 415 - Unsupported Media Type */ @ResponseStatus(HttpStatus.UNSUPPORTED_MEDIA_TYPE) @ExceptionHandler(HttpMediaTypeNotSupportedException.class) public ServiceResponse handleHttpMediaTypeNotSupportedException(Exception e) { logger.error("不支持当前媒体类型", e); return ServiceResponseHandle.failed("content_type_not_supported"); } /** * 500 - Internal Server Error */ @ResponseStatus(HttpStatus.INTERNAL_SERVER_ERROR) @ExceptionHandler(Exception.class) public ServiceResponse handleException(Exception e) { if (e instanceof BusinessException){ return ServiceResponseHandle.failed("BUSINESS_ERROR", e.getMessage()); } logger.error("服务运行异常", e); e.printStackTrace(); return ServiceResponseHandle.failed("server_error"); } }
如果 @ExceptionHandler 註解中未宣告要處理的例外類型,則預設為參數清單中的例外類型。所以還可以寫成這樣:
@ControllerAdvice public class GlobalExceptionHandler { @ExceptionHandler() @ResponseBody String handleException(Exception e){ return "Exception Deal! " + e.getMessage(); } }
參數物件就是 Controller 層拋出的例外物件!
繼承 ResponseEntityExceptionHandler 類別來實作針對 Rest 介面 的全域異常捕獲,並且可以傳回自訂格式:
@Slf4j @ControllerAdvice public class ExceptionHandlerBean extends ResponseEntityExceptionHandler { /** * 数据找不到异常 * @param ex * @param request * @return * @throws IOException */ @ExceptionHandler({DataNotFoundException.class}) public ResponseEntity<Object> handleDataNotFoundException(RuntimeException ex, WebRequest request) throws IOException { return getResponseEntity(ex,request,ReturnStatusCode.DataNotFoundException); } /** * 根据各种异常构建 ResponseEntity 实体. 服务于以上各种异常 * @param ex * @param request * @param specificException * @return */ private ResponseEntity<Object> getResponseEntity(RuntimeException ex, WebRequest request, ReturnStatusCode specificException) { ReturnTemplate returnTemplate = new ReturnTemplate(); returnTemplate.setStatusCode(specificException); returnTemplate.setErrorMsg(ex.getMessage()); return handleExceptionInternal(ex, returnTemplate, new HttpHeaders(), HttpStatus.OK, request); } }
以上是Spring MVC異常統一處理的三種方式的詳細內容。更多資訊請關注PHP中文網其他相關文章!