SpringMVC中的統一異常處理-自定義異常

時間 2019-11-08

原文原文鏈接

https://www.cnblogs.com/shanheyongmu/p/5872442.htmlhtml

咱們知道，系統中異常包括：編譯時異常和運行時異常RuntimeException，前者經過捕獲異常從而獲取異常信息，後者主要經過規範代碼開發、測試經過手段減小運行時異常的發生。在開發中，不論是dao層、service層仍是controller層，都有可能拋出異常，在springmvc中，能將全部類型的異常處理從各處理過程解耦出來，既保證了相關處理過程的功能較單一，也實現了異常信息的統一處理和維護。這篇博文主要總結一下SpringMVC中如何統一處理異常。前端

1. 異常處理思路

　　首先來看一下在springmvc中，異常處理的思路（我已盡力畫好看點了，不要噴我~）： java

　　如上圖所示，系統的dao、service、controller出現異常都經過throws Exception向上拋出，最後由springmvc前端控制器交由異常處理器進行異常處理。springmvc提供全局異常處理器（一個系統只有一個異常處理器）進行統一異常處理。明白了springmvc中的異常處理機制，下面就開始分析springmvc中的異常處理。web

2. springmvc中自帶的簡單異常處理器（方式一）

　　springmvc中自帶了一個異常處理器叫SimpleMappingExceptionResolver，該處理器實現了HandlerExceptionResolver 接口，全局異常處理器都須要實現該接口。咱們要使用這個自帶的異常處理器，首先得在springmvc.xml文件中配置該處理器：spring

<!-- springmvc提供的簡單異常處理器 -->
<bean class="org.springframework.web.servlet.handler.SimpleMappingExceptionResolver">
     <!-- 定義默認的異常處理頁面 -->
    <property name="defaultErrorView" value="/WEB-INF/jsp/error.jsp"/>
    <!-- 定義異常處理頁面用來獲取異常信息的變量名，也可不定義，默認名爲exception --> 
    <property name="exceptionAttribute" value="ex"/>
    <!-- 定義須要特殊處理的異常，這是重要點 --> 
    <property name="exceptionMappings">
        <props>
            <prop key="ssm.exception.CustomException">/WEB-INF/jsp/custom_error.jsp</prop>
        </props>
        <!-- 還能夠定義其餘的自定義異常 -->
    </property>
</bean>

從上面的配置來看，最重要的是要配置特殊處理的異常，這些異常通常都是咱們自定義的，根據實際狀況來自定義的異常，而後也會跳轉到不一樣的錯誤顯示頁面顯示不一樣的錯誤信息。這裏就用一個自定義異常CustomException來講明問題，定義以下：數據庫

本身定義本身拋出throw new Exception();json

//定義一個簡單的異常類
public class CustomException extends Exception {

    //異常信息
    public String message;

    public CustomException(String message) {
        super(message);
        this.message = message;
    }

    public String getMessage() {
        return message;
    }

    public void setMessage(String message) {
        this.message = message;
    }

}

接下來就是寫測試程序了，仍是使用查詢的例子，以下：

　　而後咱們在前臺輸入url來測試：http://localhost:8080/SpringMVC_Study/editItems.action?id=11，故意傳一個id爲11，個人數據庫中沒有id爲11的項，因此確定查不到，反正讓它查不到便可。這樣它就會拋出自定義的異常，而後被上面配置的全局異常處理器捕獲並執行，跳轉到咱們指定的頁面，而後顯示一下該商品不存在便可。因此這個流程是很清晰的。
　　從上面的過程可知，使用SimpleMappingExceptionResolver進行異常處理，具備集成簡單、有良好的擴展性（能夠任意增長自定義的異常和異常顯示頁面）、對已有代碼沒有入侵性等優勢，但該方法僅能獲取到異常信息，若在出現異常時，對須要獲取除異常之外的數據的狀況不適用。mvc

3. 自定義全局異常處理器(方式二與方式一相似)

　　全局異常處理器處理思路：app

解析出異常類型
若是該異常類型是系統自定義的異常，直接取出異常信息，在錯誤頁面展現
若是該異常類型不是系統自定義的異常，構造一個自定義的異常類型（信息爲「未知錯誤」）

springmvc提供一個HandlerExceptionResolver接口，自定義全局異常處理器必需要實現這個接口，以下：jsp

配置上方本身定義的異常

public class CustomExceptionResolver implements HandlerExceptionResolver {

    @Override
    public ModelAndView resolveException(HttpServletRequest request,
            HttpServletResponse response, Object handler, Exception ex) {

        ex.printStackTrace();
        CustomException customException = null;

        //若是拋出的是系統自定義的異常則直接轉換,也就是本身拋出的throw new Exception();
        if(ex instanceof CustomException) {
            customException = (CustomException) ex;
        } else {
            //若是拋出的不是系統自定義的異常則從新構造一個未知錯誤異常
            //這裏我就也有CustomException省事了，實際中應該要再定義一個新的異常
            customException = new CustomException("系統未知錯誤");
        }

        //向前臺返回錯誤信息
        ModelAndView modelAndView = new ModelAndView();
        modelAndView.addObject("message", customException.getMessage());
        modelAndView.setViewName("/WEB-INF/jsp/error.jsp");

        return modelAndView;
    }
}

全局異常處理器中的邏輯很清楚，我就再也不多說了，而後就是在springmvc.xml中配置這個自定義的異常處理器：

<!-- 自定義的全局異常處理器 
只要實現HandlerExceptionResolver接口就是全局異常處理器-->
<bean class="ssm.exception.CustomExceptionResolver"></bean>

而後就可使用上面那個測試用例再次測試了。能夠看出在自定義的異常處理器中能獲取致使出現異常的對象，有利於提供更詳細的異常處理信息。通常用這種自定義的全局異常處理器比較多。

4. 使用 @ 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("出錯了！");       
     }                    
 }

能夠看到，這種方式最大的缺陷就是不能全局控制異常。每一個類都要寫一遍。

5.使用 @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 處理程序統一異常的三種方式。