1. 程式人生 > >Spring MVC全域性異常後返回JSON異常資料

Spring MVC全域性異常後返回JSON異常資料

問題:

        當前專案是作為手機APP後臺支援,使用spring mvc + mybaits + shiro進行開發。後臺服務與手機端互動是傳送JSON資料。如果後臺發生異常,會直接返回異常頁面,顯示異常內容,如果是404請求不到資源或者500這類伺服器的問題,可能會導致返回404和500異常頁面,手機端的處理就非常麻煩,為了解決這個問題,就需要做全域性的異常處理。

解決方案:(1)自定義或者使用spring自帶的各種異常處理器

       例如spring基於註解的異常解析器AnnotationHandlerMethodExceptionResolver 、spring自帶全域性異常處理器SimpleMappingExceptionResolver、自定義實現spring的全域性異常解析器HandlerExceptionResolver來處理。

       AnnotationHandlerMethodExceptionResolver目前我所知道的是需要在方法上定義異常的型別,如果異常型別多了,寫起程式碼太麻煩,所以我認為不好用。(那位大俠知道不用定義異常型別就處理所有異常,可以留言告訴我,謝謝!)

       spring自帶全域性異常處理器SimpleMappingExceptionResolver也是比較繁瑣的,需要配置的地方太多了,不喜歡用。

       自定義實現spring的全域性異常解析器HandlerExceptionResolver來處理我認為是最方便的,當然,這個是針對我目前的業務場景而言,並不是絕對的。

        由於Java的異常機制,如果發生大量異常,對jvm的效能會產生很大的影響,輕則效能下降10%,重則導致jvm記憶體溢位,我個人認為能不拋異常就最好不拋,所以,我主要使用自定義實現spring的全域性異常解析器HandlerExceptionResolver來處理業務問題。

(2)自定義實現spring的全域性異常解析器HandlerExceptionResolver

       2.1 只需要在spring-mvc的配置檔案中定義一個全域性異常處理類 

  1. <!-- 全域性異常處理 -->  
  2. <bean id="exceptionHandler" class="com.aaa.bbb.exception.DefaultExceptionHandler" />  

      2.2  實現HandlerExceptionResolver(第一種實現方式)

             這種方式需要下載溫少寫的fastjson,我用的是1.2.6版本,可以百度後自己下載。

  1. public class DefaultExceptionHandler implements HandlerExceptionResolver {    
  2.     private static Logger log = LoggerFactory.getLogger(DefaultExceptionHandler.class);  
  3.     public ModelAndView resolveException(HttpServletRequest request, HttpServletResponse response, Object handler,  Exception ex) {    
  4.             ModelAndView mv = new ModelAndView();  
  5.             /*  使用FastJson提供的FastJsonJsonView檢視返回,不需要捕獲異常   */  
  6.             FastJsonJsonView view = new FastJsonJsonView();  
  7.             Map<String, Object> attributes = new HashMap<String, Object>();  
  8.             attributes.put("code", "1000001");  
  9.             attributes.put("msg", ex.getMessage());  
  10.             view.setAttributesMap(attributes);  
  11.             mv.setView(view);   
  12.             log.debug("異常:" + ex.getMessage(), ex);  
  13.             return mv;  
  14.     }  
  15. }   

       2.2  實現HandlerExceptionResolver(第二種實現方式)

  1. public class DefaultExceptionHandler implements HandlerExceptionResolver {    
  2.     private static Logger log = LoggerFactory.getLogger(DefaultExceptionHandler.class);  
  3.     public ModelAndView resolveException(HttpServletRequest request, HttpServletResponse response, Object handler,  Exception ex) {    
  4.             ModelAndView mv = new ModelAndView();             
  5.             /*  使用response返回    */  
  6.             response.setStatus(HttpStatus.OK.value()); //設定狀態碼  
  7.             response.setContentType(MediaType.APPLICATION_JSON_VALUE); //設定ContentType  
  8.             response.setCharacterEncoding("UTF-8"); //避免亂碼  
  9.             response.setHeader("Cache-Control", "no-cache, must-revalidate");  
  10.             try {  
  11.                 response.getWriter().write("{\"success\":false,\"msg\":\"" + ex.getMessage() + "\"}");  
  12.             } catch (IOException e) {  
  13.                log.error("與客戶端通訊異常:"+ e.getMessage(), e);  
  14.             }  
  15.             log.debug("異常:" + ex.getMessage(), ex);  
  16.             return mv;  
  17.     }  
  18. }  


到此,spring mvc全域性異常處理返回json就搞定了,發生異常後,返回的都是json資料,不會再有煩人的異常內容。不過這還不算完整,需要在web.xml中加入異常程式碼404或者500的處理才能算完。

(1)web頁面異常處理配置

 1.1  <exception-type>java.lang.Throwable</exception-type>表示發生java.lang.Throwable型別的異常,<location>/error_500</location>表示到/error_500地址處理,

    例如使用者請求【http://www.a.com/user/login/getUser】 ,應用名稱是user,如果請求發生java.lang.Throwable,那麼請求會轉到【http://www.a.com/user/error_500】

 1.2 <error-code>404</error-code>表示發生404請求失敗,<location>/error_404</location>表示到/error_404處理,

    例如使用者請求【http://www.a.com/user/login/getUser】,應用名稱是user ,如果使用者請求發生404異常,請求資源找不到,那麼請求會轉到【http://www.a.com/user/error_404】

  1. <!-- web異常頁面處理 -->  
  2. <error-page>  
  3.     <exception-type>java.lang.Throwable</exception-type>  
  4.     <location>/error_500</location>  
  5. </error-page>  
  6. <error-page>  
  7.     <exception-type>java.lang.Exception</exception-type>  
  8.     <location>/error_404</location>  
  9. </error-page>  
  10. <error-page>  
  11.     <error-code>500</error-code>  
  12.     <location>/error_500</location>  
  13. </error-page>  
  14. <error-page>  
  15.     <error-code>501</error-code>  
  16.     <location>/error_500</location>  
  17. </error-page>  
  18. <error-page>  
  19.     <error-code>502</error-code>  
  20.     <location>/error_500</location>  
  21. </error-page>  
  22. <error-page>  
  23.     <error-code>404</error-code>  
  24.     <location>/error_404</location>  
  25. </error-page>  
  26. <error-page>  
  27.     <error-code>403</error-code>  
  28.     <location>/error_404</location>  
  29. </error-page>  
  30. <error-page>  
  31.     <error-code>400</error-code>  
  32.     <location>/error_404</location>  
  33. </error-page>  


(2)後臺處理

  如果發生以上異常,請求會轉到【http://www.a.com/user/error_404】,那麼在後臺就需要做相應的處理,處理方式就是在Controller層定義處理異常的方法

  1. /** 
  2.  * 請求異常 
  3.  * @return 
  4.  * @throws Exception 
  5.  * String 
  6.  */  
  7. @RequestMapping(value = "/error_404", produces = "text/html;charset=UTF-8")  
  8. @ResponseBody  
  9. public String error_404() throws Exception {   
  10.      return "{\"msg\":\"找不到頁面\",\"code\":\"1000001\"}";  
  11. }  
  12. /** 
  13.  * 伺服器異常 
  14.  * @return 
  15.  * String 
  16.  */  
  17. @RequestMapping(value ="/error_500", produces = "text/html;charset=UTF-8")  
  18. public String error_500() {     <pre name="code" class="java">                return "{\"msg\":\"伺服器處理失敗\",\"code\":\"1000002\"}";  
  19. }  


最後,基本上所有的異常都能被捕獲,能夠出現異常時,友好的提示使用者端,也能避免伺服器端拋異常導致的問題。