快捷導(dǎo)航

SpringBoot自定義錯(cuò)誤處理邏輯詳解

更新時(shí)間：2022年10月20日 17:08:45 作者：劉婉晴

這篇文章主要介紹了SpringBoot自定義錯(cuò)誤處理邏輯，文中通過(guò)示例代碼介紹的非常詳細(xì)，對(duì)大家的學(xué)習(xí)或者工作具有一定的參考學(xué)習(xí)價(jià)值，需要的朋友們下面隨著小編來(lái)一起學(xué)習(xí)吧

1. 自定義錯(cuò)誤頁(yè)面

將自定義錯(cuò)誤頁(yè)面放在 templates 的 error 文件夾下，SpringBoot 精確匹配錯(cuò)誤信息，使用 4xx.html 或者 5xx.html 頁(yè)面可以打印錯(cuò)誤信息

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

自定義全局異常處理類(lèi)，處理 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
    }) // 使用此注釋?zhuān)罄ㄌ?hào)內(nèi)為可以處理的異常信息
    public String handleArithException(Exception e){
        log.info("異常是：" + e);
        return "login"; // 返回一個(gè)視圖地址（ModelAndView）
    }
}

原理：

使用 ExceptionHandlerExceptionResolver 異常處理器處理用 @ExceptionHandler 注釋的異常

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

自定義異常類(lèi)示例代碼：

import org.springframework.http.HttpStatus;
import org.springframework.web.bind.annotation.ResponseStatus;
@ResponseStatus(value = HttpStatus.FORBIDDEN, reason = "用戶(hù)數(shù)量太多~~") // 異?？梢苑祷貭顟B(tài)碼信息
public class userToMany extends  RuntimeException{
    // 有參構(gòu)造器
    public userToMany(String message){
        super(message);
    }
    public userToMany(){
    }
}

原理：

ResponseStatusExceptionResolver 處理器可以處理 @ResponseStatus 注解的異常，得到 @ResponseStatus 注解的信息，調(diào)用 response.sendError(statusCode) 方法將錯(cuò)誤信息返回，并發(fā)送 /error 請(qǐng)求，交由底層處理

sendError —— 表示此次請(qǐng)求立刻結(jié)束，發(fā)出 /error 請(qǐng)求，SpringBoot 找誰(shuí)能處理，都不能處理返回默認(rèn)的錯(cuò)誤頁(yè)

    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 底層異常，其能處理我異常種類(lèi)如下

    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. 自定義異常解析器

自定義異常解析器需要滿(mǎn)足以下：

實(shí)現(xiàn) HandlerExceptionResolver 接口并注冊(cè)到容器中（@Component）
在自定義解析器中實(shí)現(xiàn) resolveException 方法，方法內(nèi)可通過(guò) sendError 方法返回錯(cuò)誤信息并返回一空視圖，交給底層將錯(cuò)誤信息解析拼接為最終頁(yè)面
可以通過(guò) @Order 注釋調(diào)整自定義異常解析器的優(yōu)先級(jí)，value越小優(yōu)先級(jí)越高

自定義異常解析器示例代碼：

import javax.servlet.http.HttpServletResponse;
import java.io.IOException;
@Order(value = Ordered.HIGHEST_PRECEDENCE) // 優(yōu)先級(jí)數(shù)字越小，優(yōu)先級(jí)越高
@Component // 注冊(cè)到容器中
public class CustomerHandlerResolver implements HandlerExceptionResolver {
    @Override
    public ModelAndView resolveException(HttpServletRequest httpServletRequest, HttpServletResponse httpServletResponse, Object o, Exception e) {
        try {
            httpServletResponse.sendError(511, "我不喜歡的錯(cuò)誤");
        } catch (IOException e1){
            e1.printStackTrace();
        }
        return new ModelAndView();
    }
}

自定義異常處理器被加入（未調(diào)整優(yōu)先級(jí)時(shí)，默認(rèn)加到最后）：