SpringMVC異常處理注解@ExceptionHandler@ControllerAdvice@ResponseStatus

參考：

http://blog.csdn.net/w372426096/article/details/78429132

http://blog.csdn.net/w372426096/article/details/78429141

@ExceptionHandler：統一處理某一類異常，從而能夠減少代碼重復率和復雜度

源碼如下：

1 @Target({ElementType.METHOD})
2 @Retention(RetentionPolicy.RUNTIME)
3 @Documented
4 public @interface ExceptionHandler {
5     Class<? extends Throwable>[] value() default {};
6 }

注解作用對象為方法，並且在運行時有效，value()可以指定異常類。由該注解注釋的方法可以具有靈活的輸入參數（詳細參見Spring API）：

• 異常參數：包括一般的異常或特定的異常（即自定義異常），如果注解沒有指定異常類，會默認進行映射。
• 請求或響應對象 (Servlet API or Portlet API)： 你可以選擇不同的類型，如ServletRequest/HttpServletRequest或PortleRequest/ActionRequest/RenderRequest。
• Session對象(Servlet API or Portlet API)： HttpSession或PortletSession。
• WebRequest或NativeWebRequest 
• Locale
• InputStream/Reader 
• OutputStream/Writer 
• Model


方法返回值可以為：

• ModelAndView對象
• Model對象
• Map對象
• View對象
• String對象
• 還有@ResponseBody、HttpEntity<?>或ResponseEntity<?>，以及void

@ControllerAdvice

源碼如下：

 1 @Target({ElementType.TYPE})
 2 @Retention(RetentionPolicy.RUNTIME)
 3 @Documented
 4 @Component
 5 public @interface ControllerAdvice {
 6     @AliasFor("basePackages")
 7     String[] value() default {};
 8 
 9     @AliasFor("value")
10     String[] basePackages() default {};
11 
12     Class<?>[] basePackageClasses() default {};
13 
14     Class<?>[] assignableTypes() default {};
15 
16     Class<? extends Annotation>[] annotations() default {};
17 }

該注解作用對象為TYPE，包括類、接口和枚舉等，在運行時有效，並且可以通過Spring掃描為bean組件。其可以包含由@ExceptionHandler、@InitBinder 和@ModelAttribute標注的方法，可以處理多個Controller類，這樣所有控制器的異常可以在一個地方進行處理

@ResponseStatus：可以將某種異常映射為HTTP狀態碼

 

 

---

無論是普通的WEB項目，還是用SpringMVC實現的restful服務，都曾經歷過下面兩個問題：

 

1. @PostMapping(path = "/selectByAcctcode")
2. public MerAccountQueryResponse selectByAcctcode(@Valid @RequestBody MerAccountQueryRequest request,BindingResult result) {
3.  
4. log.info(Constants.REQUEST_MSG, JSON.toJSONString(request));
5.  
6. MerAccountQueryResponse response = new MerAccountQueryResponse();
7.  
8. try {
9. Pageable pageable = new PageRequest(request.getPageNum(), request.getPageSize());
10. response = merAccountService.selectByAcctcode(request, pageable);
11. // 返回成功報文
12. MessageUtil.createCommMsg(response);
13. } catch (BizException e) {
14. log.error(Constants.BUSINESS_ERROR, e);
15. // 組織錯誤報文
16. MessageUtil.errRetrunInAction(response, e);
17. } catch (Exception ex) {
18. log.error(Constants.EXCEPTION_ERROR, ex);
19. // 組織錯誤報文
20. MessageUtil.createErrorMsg(response,ex);
21. }
22. log.info(Constants.REPONSE_MSG, JSON.toJSONString(response));
23. return response;
24. }

 

當你有100個接口的時候，就得重復100次，如果你覺得代碼量也就那么點，copy就copy吧，反正我是代碼的搬運工，只是你有曾想過我可以抽取出來嗎？

 

我們在寫Controller的時候，如果沒有出現過異常固然沒問題，但一旦出現異常了，如果你處理了，那就需要你手動指定跳轉到事先定義好的界面，如果你沒處理，那將得到是一個非常丑陋的界面，如下：

如何避免這種問題呢？？？

 

1. @Controller
2. @RequestMapping(value = "exception")
3. public class ExceptionHandlerController {
4.  
5. @ExceptionHandler({ ArithmeticException.class })
6. public String handleArithmeticException(Exception e) {
7. e.printStackTrace();
8. return "error";
9. }
10.  
11. @RequestMapping(value = "e/{id}", method = { RequestMethod.GET })
12. @ResponseBody
13. public String testExceptionHandle(@PathVariable(value = "id") Integer id) {
14. System.out.println(10 / id);
15. return id.toString();
16. }
17. }

當訪問exception/e/0的時候，會拋出ArithmeticException異常，@ExceptionHandler就會處理並響應error.jsp

 

1. @Controller
2. @RequestMapping(value = "exception")
3. public class ExceptionHandlerController {
4.  
5. @ExceptionHandler({ ArithmeticException.class })
6. @ResponseBody
7. public String handleArithmeticException(Exception e) {
8. e.printStackTrace();
9. JSONObject jo = new JSONObject();
10. jo.put("resCode","999999");
11. jo.put("resMsg","系統異常");
12. return jo.toString();
13. }
14.  
15. @RequestMapping(value = "e/{id}", method = { RequestMethod.GET })
16. @ResponseBody
17. public String testExceptionHandle(@PathVariable(value = "id") Integer id) {
18. System.out.println(10 / id);
19. return id.toString();
20. }
21. }

 

當然實際項目中，並不會像我這里寫的這么簡陋，我這里只是拋磚引玉，給你一個思路。

在實際項目中，可能碰到這種情況，我們提供的服務，調用方並不需要json報文中的消息，調用方只關注響應碼，比如200，代表調用正常；404，代表請求資源不存在；502，代表系統異常。。。等等。我們又該如何去做？

1. package com.somnus.exception;
2.  
3. import org.springframework.http.HttpStatus;
4. import org.springframework.web.bind.annotation.ResponseStatus;
5.  
6. @ResponseStatus(value=HttpStatus.BAD_GATEWAY)
7. public class HttpStatusException extends RuntimeException {
8.  
9. private static final long serialVersionUID = 1L;
10.  
11. public HttpStatusException() {
12. super();
13. }
14.  
15. public HttpStatusException(String message, Throwable cause) {
16. super(message, cause);
17. }
18.  
19. public HttpStatusException(String message) {
20. super(message);
21. }
22.  
23. public HttpStatusException(Throwable cause) {
24. super(cause);
25. }
26.  
27. }

1. @Controller
2. @RequestMapping(value = "status")
3. public class ResponseStatusController {
4.  
5. @RequestMapping(value = "e/{id}", method = { RequestMethod.GET })
6. @ResponseBody
7. public String status(@PathVariable(value = "id") Integer id){
8. if(id % 2 != 0){
9. throw new HttpStatusException();
10. }
11. return id.toString();
12. }
13. }

 

 

效果如下：

另外這里不得不提一點需要注意的，不要輕易把@ResponseStatus修飾目標方法，因為無論它執行方法過程中有沒有異常產生，用戶都會得到異常的界面，而目標方法正常執行。

1. package com.somnus.controller;
2.  
3. import org.springframework.http.HttpStatus;
4. import org.springframework.stereotype.Controller;
5. import org.springframework.web.bind.annotation.PathVariable;
6. import org.springframework.web.bind.annotation.RequestMapping;
7. import org.springframework.web.bind.annotation.RequestMethod;
8. import org.springframework.web.bind.annotation.ResponseBody;
9. import org.springframework.web.bind.annotation.ResponseStatus;
10.  
11. import com.somnus.exception.HttpStatusException;
12.  
13. @Controller
14. @RequestMapping(value = "status")
15. public class ResponseStatusController {
16.  
17. /**
18. * ResponseStatus修飾目標方法，無論它執行方法過程中有沒有異常產生，用戶都會得到異常的界面。而目標方法正常執行
19. * @param id
20. * @return
21. */
22. @RequestMapping(value = "e2/{id}", method = { RequestMethod.GET })
23. @ResponseStatus(value=HttpStatus.BAD_GATEWAY)
24. @ResponseBody
25. public String status2(@PathVariable(value = "id") Integer id){
26. System.out.println(10 / id);
27. return id.toString();
28. }
29.  
30. }

 

 

可以看到哪怕是響應2了，但是響應碼其實還是502

---

如果我們要給jdk自帶的異常提供一個響應碼呢，我們又不可能去改源碼，這時候@ResponseStatus就得配和@ControllerAdvice一起使用了，如下：

 

1. @Controller
2. @RequestMapping(value = "exception")
3. public class ExceptionHandlerController {
4.  
5. @ExceptionHandler({ NullPointerException.class })
6. @ResponseStatus(value=HttpStatus.NOT_FOUND)
7. public void handleNullPointerException(Exception e) {
8. e.printStackTrace();
9. }
10.  
11. @RequestMapping(value = "e3/{id}", method = { RequestMethod.GET })
12. @ResponseBody
13. public String testExceptionHandle3(@PathVariable(value = "id") Integer id) {
14. List<String> list = 4 % id == 0 ? null : Arrays.asList(new String[]{"a","b","c","d"});
15. return list.get(id);
16. }
17. }

 

當我們拋出NullPointerException異常的時候會發生什么呢

• 當一個Controller中有多個@ExceptionHandler注解出現時，那么異常被哪個方法捕捉呢？這就存在一個優先級的問題，@ExceptionHandler的優先級是：在異常的體系結構中，哪個異常與目標方法拋出的異常血緣關系越緊密，就會被哪個捕捉到

• @ExceptionHandler這個只會是在當前的Controller里面起作用，如果想在所有的Controller里面統一處理異常的話，可以用@ControllerAdvice來創建一個專門處理的類，我們在下一篇做介紹。

 

@ControllerAdvice，是Spring3.2提供的新注解，從名字上可以看出大體意思是控制器增強。讓我們先看看@ControllerAdvice的實現：

1. package org.springframework.web.bind.annotation;
2.  
3. @Target(ElementType.TYPE)
4. @Retention(RetentionPolicy.RUNTIME)
5. @Documented
6. @Component
7. public @interface ControllerAdvice {
8.  
9. @AliasFor("basePackages")
10. String[] value() default {};
11.  
12. @AliasFor("value")
13. String[] basePackages() default {};
14.  
15. Class<?>[] basePackageClasses() default {};
16.  
17. Class<?>[] assignableTypes() default {};
18.  
19. Class<? extends Annotation>[] annotations() default {};

 

 

沒什么特別之處，該注解使用@Component注解，這樣的話當我們使用<context:component-scan>掃描時也能掃描到。

再一起看看官方提供的comment。

 

 

大致意思是：

• @ControllerAdvice是一個@Component，用於定義@ExceptionHandler，@InitBinder和@ModelAttribute方法，適用於所有使用@RequestMapping方法。

• Spring4之前，@ControllerAdvice在同一調度的Servlet中協助所有控制器。Spring4已經改變：@ControllerAdvice支持配置控制器的子集，而默認的行為仍然可以利用。

• 在Spring4中， @ControllerAdvice通過annotations(), basePackageClasses(), basePackages()方法定制用於選擇控制器子集。

不過據經驗之談，只有配合@ExceptionHandler最有用，其它兩個不常用。

在SpringMVC重要注解（一）@ExceptionHandler和@ResponseStatus我們提到，如果單使用@ExceptionHandler，只能在當前Controller中處理異常。但當配合@ControllerAdvice一起使用的時候，就可以擺脫那個限制了。

 

1. package com.somnus.advice;
2.  
3. import org.springframework.web.bind.annotation.ControllerAdvice;
4. import org.springframework.web.bind.annotation.ExceptionHandler;
5. import org.springframework.web.bind.annotation.ResponseBody;
6.  
7. @ControllerAdvice
8. public class ExceptionAdvice {
9.  
10. @ExceptionHandler({ ArrayIndexOutOfBoundsException.class })
11. @ResponseBody
12. public String handleArrayIndexOutOfBoundsException(Exception e) {
13. e.printStackTrace();
14. return "testArrayIndexOutOfBoundsException";
15. }
16.  
17. }

1. @Controller
2. @RequestMapping(value = "exception")
3. public class ExceptionHandlerController {
4.  
5. @RequestMapping(value = "e2/{id}", method = { RequestMethod.GET })
6. @ResponseBody
7. public String testExceptionHandle2(@PathVariable(value = "id") Integer id) {
8. List<String> list = Arrays.asList(new String[]{"a","b","c","d"});
9. return list.get(id-1);
10. }
11.  
12. }

 

當我們訪問http://localhost:8080/SpringMVC/exception/e2/5的時候會拋出ArrayIndexOutOfBoundsException異常，這時候定義在@ControllerAdvice中的@ExceptionHandler就開始發揮作用了。

如果我們想定義一個處理全局的異常

1. package com.somnus.advice;
2.  
3. import javax.servlet.http.HttpServletRequest;
4.  
5. import org.springframework.core.annotation.AnnotationUtils;
6. import org.springframework.web.bind.annotation.ControllerAdvice;
7. import org.springframework.web.bind.annotation.ExceptionHandler;
8. import org.springframework.web.bind.annotation.ResponseBody;
9. import org.springframework.web.bind.annotation.ResponseStatus;
10.  
11. @ControllerAdvice
12. public class ExceptionAdvice {
13.  
14. @ExceptionHandler({ Exception.class })
15. @ResponseBody
16. public String handException(HttpServletRequest request ,Exception e) throws Exception {
17. e.printStackTrace();
18.  
19. return e.getMessage();
20. }
21.  
22. }

 

乍一眼看上去毫無問題，但這里有一個紕漏，由於Exception是異常的父類，如果你的項目中出現過在自定義異常中使用@ResponseStatus的情況，你的初衷是碰到那個自定義異常響應對應的狀態碼，而這個控制器增強處理類，會首先進入，並直接返回，不會再有@ResponseStatus的事情了，這里為了解決這種紕漏，我提供了一種解決方式。

 

1. package com.somnus.advice;
2.  
3. import javax.servlet.http.HttpServletRequest;
4.  
5. import org.springframework.core.annotation.AnnotationUtils;
6. import org.springframework.web.bind.annotation.ControllerAdvice;
7. import org.springframework.web.bind.annotation.ExceptionHandler;
8. import org.springframework.web.bind.annotation.ResponseBody;
9. import org.springframework.web.bind.annotation.ResponseStatus;
10.  
11. @ControllerAdvice
12. public class ExceptionAdvice {
13.  
14.  
15. @ExceptionHandler({ Exception.class })
16. @ResponseBody
17. public String handException(HttpServletRequest request ,Exception e) throws Exception {
18. e.printStackTrace();
19. //If the exception is annotated with @ResponseStatus rethrow it and let
20. // the framework handle it - like the OrderNotFoundException example
21. // at the start of this post.
22. // AnnotationUtils is a Spring Framework utility class.
23. if (AnnotationUtils.findAnnotation(e.getClass(), ResponseStatus.class) != null){
24. throw e;
25. }
26. // Otherwise setup and send the user to a default error-view.
27. /*ModelAndView mav = new ModelAndView();
28. mav.addObject("exception", e);
29. mav.addObject("url", request.getRequestURL());
30. mav.setViewName(DEFAULT_ERROR_VIEW);
31. return mav;*/
32. return e.getMessage();
33. }
34.  
35. }

如果碰到了某個自定義異常加上了@ResponseStatus，就繼續拋出，這樣就不會讓自定義異常失去加上@ResponseStatus的初衷。