SpringBoot全局異常處理與訂製404頁面

一、錯誤處理原理分析

使用SpringBoot創建的web項目中，當我們請求的頁面不存在(http狀態碼為404)，或者器發生異常(http狀態碼一般為500)時，SpringBoot就會給我們返回錯誤資訊。

也就是說，在SpringBoot的web項目中，會自動創建一個/error的錯誤介面，來返回錯誤資訊。但是針對不同的訪問方式，會有以下兩種不同的返回資訊。這主要取決於你訪問時的http頭部資訊的Accept這個值來指定你可以接收的類型有哪些

  • 使用瀏覽器訪問時的頭資訊及其返回結果
Accept: text/html

  • 使用其他設備，如手機客戶端等訪問時頭部資訊及其返回結果（一般是在前後端分離的架構中）
Accept: */*

二、進行錯誤處理

處理異常主要有兩種方式：

1. 使用SpringBoot的自動配置原理進行異常處理

SpringBoot自動配置了一個類ErrorMvcAutoConfiguration來處理處理異常，有興趣的可以去看一下，然後在這個類中定義一個錯誤的BasicErrorController類，主要程式碼有如下：

@Controller
@RequestMapping({"${server.error.path:${error.path:/error}}"})
public class BasicErrorController extends AbstractErrorController {

  	/**
  	 * 錯誤的頁面響應 
  	 */
    @RequestMapping(produces = {"text/html"})
    public ModelAndView errorHtml(HttpServletRequest request, HttpServletResponse response) {
        HttpStatus status = this.getStatus(request);
        Map<String, Object> model = Collections.unmodifiableMap(this.getErrorAttributes(request, this.isIncludeStackTrace(request, MediaType.TEXT_HTML)));
        response.setStatus(status.value());
      	// 得到一個modelAndView對象
        ModelAndView modelAndView = this.resolveErrorView(request, response, status, model);
        return modelAndView != null ? modelAndView : new ModelAndView("error", model);
    }
		
  /**
   * 錯誤的json響應
   */
    @RequestMapping
    public ResponseEntity<Map<String, Object>> error(HttpServletRequest request) {
        HttpStatus status = this.getStatus(request);
        if (status == HttpStatus.NO_CONTENT) {
            return new ResponseEntity(status);
        } else {
            Map<String, Object> body = this.getErrorAttributes(request, this.isIncludeStackTrace(request, MediaType.ALL));
            return new ResponseEntity(body, status);
        }
    }
}

多的程式碼就不深究了，感興趣的可以去看一下。上邊的程式碼也就是說，針對不同的請求方式，會返回不同的結果，其關鍵在於 @RequestMapping註解的produces = {"text/html"}屬性上

1）、返回一個錯誤頁面，如404、500等。

  • 有模板引擎的情況（可以用於渲染頁面）

項目中使用的了模板引擎，如：thymeleaf 、freemarker等做為頁面的渲染時。在templates創建/error文件夾並添加錯誤的狀態碼對應的.html文件，如下圖：

這裡的404和500就是確定的錯誤狀態碼，而4xx表示其他的4開頭的錯誤，如400，401等。當然可以為每一個狀態碼都設置對應的錯誤頁面，但是這樣做，並沒有什麼好處，所以就直接使用4xx.html這樣的泛指代替了。

可以在我們錯誤頁面中獲取到如下資訊（就是ModelAndView對象中的內容）：

欄位名 說明
timstamp 時間戳
status 錯誤狀態碼
error 錯誤提示
exception 異常對象
message 異常消息
path 頁面路徑

細心的小夥伴會發現，這個其實就是當你用手機請求時返回的json內容

比如：在程式碼中加入上邊資訊，然後在在後端寫一個錯誤程式碼：

@RequestMapping("haserror")
@ResponseBody
public Object myError(){
  int i =10/0;
  return "something is error";
}

這是一個錯誤頁面：
<ul>
    <li>錯誤狀態碼：[[${status}]]</li>
    <li>錯誤消息：[[${error}]]</li>
    <li>異常對象：[[${exception}]]</li>
    <li>異常消息：[[${message}]]</li>
    <li>當前時間：[[${timestamp}]]</li>
</ul>

  • 沒有模板引擎的情況

當項目中沒有使用模板引擎的時候，就將整個error文件夾移到static文件夾下就可以了。

不過此時並不能獲取上邊的那些資訊了，因為這本就是靜態資源，沒有模板引擎進行渲染

2）、返回對應的json串

這個並沒有什麼好說的，返回的就是一個json字元串。格式如下：

{
"timestamp": "2020-04-22T16:13:37.506+0000",
"status": 500,
"error": "Internal Server Error",
"message": "/ by zero",
"path": "/hello/haserror",
"reason": "完了，你寫的程式碼又產生了一次線上事故"
}

3）、自定義頁面返回資訊

這才是最重要的內容，因為這個資訊不僅是做為json返回的，也是可以在上邊的錯誤頁面中拿到，也可以直接返回一個json。其實也很簡單，就是在Spring容器中添加一個ErrorAttributes對象就可以了，這裡我選擇繼承它的一個子類。

@Component
public class MyErrorAttributes extends DefaultErrorAttributes {
    @Override
    public Map<String, Object> getErrorAttributes(WebRequest webRequest, boolean includeStackTrace) {
        //調用父類的方法，會自動獲取內置的那些屬性，如果你不想要，可以不調用這個
        Map<String, Object> errorAttributes = super.getErrorAttributes(webRequest, includeStackTrace);

        //添加自定義的屬性
        errorAttributes.put("reason","完了，你寫的程式碼又產生了一次線上事故");
        // 你可以看一下這個方法的參數webRequest這個對象，我相信你肯定能發現好東西

        return errorAttributes;
    }
}

這就可以了，用兩種請求方式分別測試一個我們的這個自定義屬性是否可用：

2. 使用AOP的異常通知進行處理（推薦）

它的原理就是獲取一個全局的異常通知，然後進行處理。我們只需要在項目中寫下邊程式碼就可以了（其實上邊也只是寫了一個自定義異常資訊的類）

@ControllerAdvice
public class ErrroAcvice {

    /**
     * 全局捕獲異常的切面類
     * @param request 請求對象，可不傳
     * @param response 響應對象，可不傳
     * @param e 異常類(這個要和你當前捕獲的異常類是同一個)
     */
    @ExceptionHandler(Exception.class) //也可以只對一個類進行捕獲
    public void errorHandler(HttpServletRequest request, HttpServletResponse response,Exception e){
      	/*
      	 * You can do everything you want to do
         * 這裡你拿到了request和response對象，你可以做任何你想做的事
         * 比如：
         *	1.用request從頭資訊中拿到Accept來判斷是請求方可接收的類型從而進行第一個方法的判斷
         *	2.如果你也想返回一個頁面，使用response對象進行重定向到自己的錯誤頁面就可以了
         *  3.你甚至還拿到了異常對象
      	 */
      
        String accept = request.getHeader("Accept");
				// 根據這個字元串來判斷做出什麼響應	
      
        try {
            response.setStatus(500);
            response.getWriter().write("hello");
        } catch (IOException ex) {
            ex.printStackTrace();
        }
      
    }
}

3. 兩種方法對比：

  • 第一種方法，就是在當前項目中放置一些錯誤狀態碼的頁面讓SpringBoot去查找。也支援自定義返回的錯誤資訊
  • 第二種方法，就是直接使用AOP的思想，進行異常通知處理，自由性很大。
  • 我個人建議使用第二種方法，因為自由度很高，可以根據自己的業務邏輯進行隨時改變，而且還有一個很大的用處。下一篇文章會有個很好的例子
  • 使用了第二種方式後，通過第一種方式放置的錯誤頁面和自定義錯誤資訊全部失效

三、程式碼地址：

關注微信公眾號:小魚與Java，後台回復"2000"獲取

Tags:

VirMach 便宜 VPS