SpringBoot自定義錯誤處理邏輯詳解

2022-10-22 14:00:08

1. 自定義錯誤頁面

將自定義錯誤頁面放在 templates 的 error 資料夾下，SpringBoot 精確匹配錯誤資訊，使用 4xx.html 或者 5xx.html 頁面可以列印錯誤資訊

4xx —— 列印 status 及 message 資訊

  <h2 th:text="${status}">page not found</h2>
  <h3 th:text="${#message}">We Couldn't Find This Page</h3>

5xx—— 列印 message 及 trace 資訊

	<h3 th:text="${message}">Something went wrong.</h3>
	<p class="nrml-txt" th:text="${trace}">Why not try refreshing you page? Or you can <a href="#" rel="external nofollow" >contact our support</a> if the problem persists.</p>

2. @ControllerAdvice+@ExceptionHandler

自定義全域性例外處理類，處理 ArithmeticException 及 NullPointerException 異常

package com.wanqing.admin.exception;
import lombok.extern.slf4j.Slf4j;
import org.springframework.web.bind.annotation.ControllerAdvice;
import org.springframework.web.bind.annotation.ExceptionHandler;
@Slf4j
@ControllerAdvice // 使用此註釋
public class GlobalExceptionHandler {
    @ExceptionHandler({ArithmeticException.class, NullPointerException.class
    }) // 使用此註釋，大括號內為可以處理的異常資訊
    public String handleArithException(Exception e){
        log.info("異常是：" + e);
        return "login"; // 返回一個檢視地址（ModelAndView）
    }
}

原理：

使用 ExceptionHandlerExceptionResolver 例外處理器處理用 @ExceptionHandler 註釋的異常

3. 使用@ResponseStatus處理自定義異常

自定義異常類範例程式碼：

import org.springframework.http.HttpStatus;
import org.springframework.web.bind.annotation.ResponseStatus;
@ResponseStatus(value = HttpStatus.FORBIDDEN, reason = "使用者數量太多~~") // 異常可以返回狀態碼資訊
public class userToMany extends  RuntimeException{
    // 有參構造器
    public userToMany(String message){
        super(message);
    }
    public userToMany(){
    }
}

原理：

ResponseStatusExceptionResolver 處理器可以處理 @ResponseStatus 註解的異常，得到 @ResponseStatus 註解的資訊，呼叫 response.sendError(statusCode) 方法將錯誤資訊返回，並行送 /error 請求，交由底層處理

sendError —— 表示此次請求立刻結束，發出 /error 請求，SpringBoot 找誰能處理，都不能處理返回預設的錯誤頁

    protected ModelAndView applyStatusAndReason(int statusCode, @Nullable String reason, HttpServletResponse response) throws IOException {
        if (!StringUtils.hasLength(reason)) {
            response.sendError(statusCode);
        } else {
            String resolvedReason = this.messageSource != null ? this.messageSource.getMessage(reason, (Object[])null, reason, LocaleContextHolder.getLocale()) : reason;
            response.sendError(statusCode, resolvedReason);
        }
        return new ModelAndView();
    }

4. 框架底層異常

使用 DefaultHandlerExceptionResolver 例外處理器能處理 SpringMVC 底層異常，其能處理我異常種類如下

    protected ModelAndView doResolveException(HttpServletRequest request, HttpServletResponse response, @Nullable Object handler, Exception ex) {
        try {
            if (ex instanceof HttpRequestMethodNotSupportedException) {
                return this.handleHttpRequestMethodNotSupported((HttpRequestMethodNotSupportedException)ex, request, response, handler);
            }
			// 此處省略.............
            if (ex instanceof HttpMessageNotWritableException) {
                return this.handleHttpMessageNotWritable((HttpMessageNotWritableException)ex, request, response, handler);
            }
            if (ex instanceof MethodArgumentNotValidException) {
                return this.handleMethodArgumentNotValidException((MethodArgumentNotValidException)ex, request, response, handler);
            }
        } catch (Exception var6) {
            if (this.logger.isWarnEnabled()) {
                this.logger.warn("Failure while trying to resolve exception [" + ex.getClass().getName() + "]", var6);
            }
        }
        return null;
    }

5. 自定義異常解析器

自定義異常解析器需要滿足以下：

實現 HandlerExceptionResolver 介面並註冊到容器中（@Component）
在自定義解析器中實現 resolveException 方法，方法內可通過 sendError 方法返回錯誤資訊並返回一空檢視，交給底層將錯誤資訊解析拼接為最終頁面
可以通過 @Order 註釋調整自定義異常解析器的優先順序，value越小優先順序越高

自定義異常解析器範例程式碼：

import javax.servlet.http.HttpServletResponse;
import java.io.IOException;
@Order(value = Ordered.HIGHEST_PRECEDENCE) // 優先順序數位越小，優先順序越高
@Component // 註冊到容器中
public class CustomerHandlerResolver implements HandlerExceptionResolver {
    @Override
    public ModelAndView resolveException(HttpServletRequest httpServletRequest, HttpServletResponse httpServletResponse, Object o, Exception e) {
        try {
            httpServletResponse.sendError(511, "我不喜歡的錯誤");
        } catch (IOException e1){
            e1.printStackTrace();
        }
        return new ModelAndView();
    }
}

自定義例外處理器被加入（未調整優先順序時，預設加到最後）：