1. 程式人生 > >SpringBoot進階之統一異常處理(含原始碼)

SpringBoot進階之統一異常處理(含原始碼)

淺談異常處理

在J2EE專案的開發中,不管是對底層的資料庫操作過程,還是業務層的處理過程,還是控制層的處理過程,都不可避免會遇到各種可預知的、不可預知的異常需要處理。每個過程都單獨處理異常,系統的程式碼耦合度高,工作量大且不好統一,維護的工作量也很大。 所以我們會進行統一異常處理,進而去避免這些問題。

預設異常處理

Spring Boot提供了一個預設的對映:/error,當處理中丟擲異常之後,會轉到該請求中處理,並且該請求有一個全域性的錯誤頁面用來展示異常內容。

啟動該應用,訪問一個不存在的URL。

錯誤頁面

統一異常處理,場景1 返回HTML頁面

編寫全域性異常處理類 GlobalExceptionHandler.java

// 通過使用@ControllerAdvice定義統一的異常處理類,而不是在每個Controller中逐個定義。
@ControllerAdvice
public class GlobalExceptionHandler {

    public static final String DEFAULT_ERROR_VIEW = "error";
    // @ExceptionHandler用來定義函式針對的異常型別,最後將Exception物件和請求URL對映到error.html中
    @ExceptionHandler(value = Exception.class)
    public
ModelAndView defaultErrorHandler(HttpServletRequest request, Exception e) throws Exception { ModelAndView mav = new ModelAndView() ; mav.addObject("errorname", "統一異常處理頁面") ; mav.addObject("exception", e) ; mav.addObject("url", request.getRequestURL()) ; mav.setViewName(DEFAULT_ERROR_VIEW) ; return
mav ; } }

編寫異常類 ExceptionController.java

@Controller
public class ExceptionController {

    @RequestMapping("/nException")
    public String nException() throws Exception {
        throw new Exception("這裡有個錯誤異常") ;
    }
}

編寫error.html頁面

<div class="container">
    <br></br>
    <div class="alert alert-warning alert-dismissible" role="alert">
      <button type="button" class="close" data-dismiss="alert" aria-label="Close"><span aria-hidden="true">&times;</span></button>
      <h2 th:text="${errorname }"></h2>
      <p th:text="${exception.message }"></p>
      <p th:text="${url }"></p>
    </div>
</div>

統一異常處理頁面

統一異常處理,場景2 返回JSON頁面

編寫ErrorInfo.java實體類

package com.javazhan.domain;

public class ErrorInfo<T> {
    public static final Integer OK = 0000 ;
    public static final Integer ERROR = 9999 ;

    private Integer code ;
    private String message ;
    private String url ;
    private T data ;
    public Integer getCode() {
        return code;
    }
    public void setCode(Integer code) {
        this.code = code;
    }
    public String getMessage() {
        return message;
    }
    public void setMessage(String message) {
        this.message = message;
    }
    public String getUrl() {
        return url;
    }
    public void setUrl(String url) {
        this.url = url;
    }
    public T getData() {
        return data;
    }
    public void setData(T data) {
        this.data = data;
    }  
}

在全域性異常處理類 GlobalExceptionHandler.java編寫jsonErrorHandler方法

@ExceptionHandler(value = MyException.class)
@ResponseBody
public ErrorInfo<String> jsonErrorHandler(HttpServletRequest request, MyException e) throws Exception {
    ErrorInfo<String> r = new ErrorInfo<>() ;
    r.setMessage(e.getMessage()) ;
    r.setCode(ErrorInfo.ERROR) ;
    r.setData("Some Data") ;
    r.setUrl(request.getRequestURL().toString()) ;
    return r ;
}

在ExceptionController.java新增jsonException方法

@RequestMapping("/jsonException")
public String jsonException() throws MyException {
    throw new MyException("這裡有個錯誤異常");
}

返回JSON頁面

原始碼下載