Spring 異常處理的各種姿勢總結
本文實例總結了Spring 異常處理的各種姿勢。分享給大家供大家參考,具體如下:
1. 前言統一的異常處理對于應用的重要性不言而喻。今天我們來介紹一下 Spring 如何來進行統一的 Rest 異常處理。同時我們也會簡單比較一下它們之間的優劣。
2. @Controller 結合 @ExceptionHandler在控制器中聲明一個方法然后用 @ExceptionHandler 注解標記即可:
@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())); } }
優點:
優先級最高。 @ExceptionHandler 標記的方法返回值類型支持多種。可以是視圖,也可以是 json 等。缺點:
一個 Controller 中的 @ExceptionHandler 注解上的異常類型不能出現相同的,否則運行時拋異常。 需要顯式的聲明處理的異常類型。 作用域僅僅是該 Controller 并不是真正意義上的全局異常。如果要想作用于全局需要將其放入所有控制器的父類中。3. @ControllerAdvice 結合 @ExceptionHandler這是 2. 的改進型,通過定義 @ControllerAdvice 類并在方法上標記 @ExceptionHandler ,達到了全局異常處理的目的:
@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())); } }
優點:
全局的異常處理。 完全控制響應的主體以及狀態碼 將多個異常映射到同一方法,以一起處理,并且它充分利用了更新的 Restful ResponseEntity 響應缺點:
一個 Controller 中的 @ExceptionHandler 注解上的異常類型不能出現相同的,否則運行時拋異常。 需要顯式的聲明處理的異常類型。一般情況下也建議使用該方式進行異常處理。大多數情況下都是兼容的。
4. HandlerExceptionResolver 接口實現 HandlerExceptionResolver 接口,這里我們繼承其抽象實現 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(); } }
優點:
這是一個全局的異常處理器。 這種方式全局異常處理返回JSP、velocity 等模板視圖比較方便。 支持多種格式的響應,雖然覆寫的方法返回的是 ModelAndView 但是因為參數中有 HttpServletResponse, 我們可以利用它來進行定制響應結果。例如,如果客戶端要求輸入application / json,那么在出現錯誤情況時,我們要確保我們返回一個以application / json編碼的響應。缺點:
我們需要與低級的 HttpServletResponse 交互才能實現各種形式的響應體。 優先級比較低5. Spring Boot 中的異常處理如果你用的框架是 Spring Boot 。 我們還可以用它獨特的處理方式。優點是屏蔽了低級的API,缺點也比較明顯,無法捕捉到具體的異常。
5.1 實現 ErrorControllerSpring Boot 在默認情況下,提供了 /error 映射來處理所有錯誤,在 Servlet 容器里注冊了全局的錯誤頁面(Whitelabel Error Page)并返回客戶端。通過實現 ErrorController 接口并注冊為 Bean。這里不再舉例。可參考 BasicErrorController 。
5.2 添加 ErrorAttributes我們也可以添加 ErrorAttributes 類型的 Bean 來替換替換默認的異常處理。
@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 自動配置還提供了實現 ErrorController 接口異常處理的基類 BasicErrorController,默認是處理 text/html類型請求的錯誤,可以繼承該基類自定義處理更多的請求類型,添加公共方法并使用 @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 } }6. Spring 5 的 ResponseStatusException
另外在最新的 Spring 5 中你還可以通過 拋出 ResponseStatusException 異常來進行處理。
好處:
使用比較方便 一種類型,多種狀態代碼:一種異常類型可以導致多種不同的響應。與@ExceptionHandler相比,這減少了緊密耦合 我們將不必創建那么多的自定義異常類 由于可以通過編程方式創建異常,因此可以更好地控制異常處理缺點:
沒有統一的異常處理方式,強制執行某些應用程序范圍的約定更加困難 可能會有大量的重復代碼。7. 總結我們對常用的、不常用的 Spring 處理異常的方式進行了總結和優劣上的分析。 相信你可以從中找到適合你的處理方式。如果對你有用請幫忙點一個贊,您的鼓勵,我的動力!
更多關于java相關內容感興趣的讀者可查看本站專題:《Spring框架入門與進階教程》、《Java數據結構與算法教程》、《Java操作DOM節點技巧總結》、《Java文件與目錄操作技巧匯總》和《Java緩存操作技巧匯總》
希望本文所述對大家java程序設計有所幫助。
相關文章: