SpringBoot 異常處理二三事

前言

2020 以前打算將 Spring 和 SpringBoot 的官方文檔看一遍，順便看點感興趣的源碼。

昨天莫名想研究在 SpringBoot 中 Exception 怎麼處理的。
複製代碼

代碼 GitHub

涉及內容。

SpringBoot 啓動生成的異常怎麼處理的。

實現這個接口 ApplicationListener<ApplicationFailedEvent> ，

將 Bean 加入 ioc ,當程序啓動發生異常你會感知到。好比啓動失敗發送郵件通知。

實現這個接口 ApplicationListener<ApplicationReadyEvent> ，
將 Bean 加入 ioc 容器中，當程序啓動成功你會感知到。


基於實現 SpringBootExceptionReporter，對啓動異常分析，
在咱們自定義 starter 頗有用
複製代碼

SpringBoot 運行期間發生的異常。

@ExceptionHandler 和 @RestControllerAdvice 結合。處理標記的異常。

Tomcat 會根據 Response 判斷是否有異常須要處理。
而後轉發 DispatcherServlet url /error,這個可路徑在 SpringBoot 可修改。

BasicErrorController 既是處理 /error 。

會講一些源碼，記錄一下處理流程。
複製代碼

判斷對象、對象父類，Class 的泛型類型

看源碼的時候學到的，很強大的功能。ResolvableType
複製代碼

SpringBoot 啓動的異常處理

SpringApplication.run(String... args) 中啓動系統上下文，當發生異常的時候，
SpringApplication.handleRunFailure 處理啓動異常邏輯。
一、會發送失敗事件，可經過監聽事件，處理邏輯。
二、SpringApplication.reportFailure 分析平常信息。
實現這個接口 SpringBootExceptionReporter 就能夠註冊異常了。
不過 SpringBoot FailureAnalyzers 給了默認實現。
咱們能夠基於 FailureAnalyzers 的邏輯進行擴展。
複製代碼

經過事件機制進行異常信息控制

經過 ApplicationEvent 事件，及發佈事件，能夠很好的解耦。

咱們也能夠經過自定義業務事件進行結構業務。

監聽啓動失敗的事件

@Component
public class StartFailedApplicationListener implements ApplicationListener<ApplicationFailedEvent> {

    @Autowired
    private EmailService emailService;

    @Override
    public void onApplicationEvent(ApplicationFailedEvent applicationFailedEvent) {
        // 發送郵件告訴啓動失敗了
        Throwable exception = applicationFailedEvent.getException();

// 31 紅色 32 綠色 33 黃色
        StringJoiner stringJoiner = new StringJoiner("", "\031[32;4m", "\031[0m");
        String join = String.join("", "服務器 ip: 192.168.11.11 啓動失敗, 異常緣由爲：", exception.getMessage());
        String s = stringJoiner.add(join).toString();
        emailService.sendEmail(s);
    }
}
複製代碼

實現接口監聽啓動成功的事件

@Component
public class StartSuccessApplicationListener implements ApplicationListener<ApplicationReadyEvent> {

    @Autowired
    private EmailService emailService;

    @Override
    public void onApplicationEvent(ApplicationReadyEvent applicationReadyEvent) {
        // 發送郵件告訴啓動成功了
        // 31 紅色 32 綠色 33 黃色
        StringJoiner stringJoiner = new StringJoiner("", "\033[32;4m", "\033[0m");
        String join = String.join("", "服務器 ip: 192.168.11.11 啓動成功!");
        String s = stringJoiner.add(join).toString();
        emailService.sendEmail(s);
    }
}
複製代碼

使用註解監聽事件

@Component
public class AnnotationListener {

    @EventListener(value={ApplicationReadyEvent.class})
    public void annotationListener(){
        System.out.println(AnnotationListener.class.getName()+"啓動成功了");
    }

}
複製代碼

FailureAnalyzers 異常分析

第一步繼承 AbstractFailureAnalyzer，確認處理那個異常。

public class StartExceptionFailureAnalyzer extends AbstractFailureAnalyzer<RuntimeException> {
    @Override
    protected FailureAnalysis analyze(Throwable rootFailure, RuntimeException cause) {
        Throwable rootCause = cause.getCause();
        if (rootCause instanceof StartException) {
            return new FailureAnalysis("測試啓動異常","",rootCause);
        }
        return null;
    }
}
複製代碼

第二步實現 FailureAnalysisReporter，確認處理某個異常的邏輯。

public class MyFailureAnalysisReporter implements FailureAnalysisReporter {
    private EmailService emailService;
    public MyFailureAnalysisReporter(){
        emailService=new EmailService();
    }
    @Override
    public void report(FailureAnalysis analysis) {
        final Throwable cause = analysis.getCause();
        final String message = cause.getMessage();
        emailService.sendEmail(String.join("","異常緣由：",message));
    }

}
複製代碼

第三部將上述兩個類加入到 spring.factories

SpringFactoriesLoader 能夠加載 spring.factories 的類

org.springframework.boot.diagnostics.FailureAnalyzer=\
com.fly.exception.start.analyzer.StartExceptionFailureAnalyzer
org.springframework.boot.diagnostics.FailureAnalysisReporter=\
com.fly.exception.start.analyzer.MyFailureAnalysisReporter
複製代碼

服務運行時，異常處理

建議返回值能夠設置成 ResponseEntity，比較容易設置請求頭和狀態碼，restful 接口實現的時候挺有用。

@Component
@RestControllerAdvice
public class HandleActionException extends ResponseEntityExceptionHandler {
    public HandleActionException(){

    }

    @Override
    protected ResponseEntity handleExceptionInternal(Exception ex, Object body, HttpHeaders headers, HttpStatus status, WebRequest request) {
        if (HttpStatus.INTERNAL_SERVER_ERROR.equals(status)) {
            request.setAttribute(WebUtils.ERROR_EXCEPTION_ATTRIBUTE, ex, WebRequest.SCOPE_REQUEST);
        }
        final ResponseEntity<RetUtil> retUtilResponseEntity = new ResponseEntity<>(RetUtil.build().code(5000), headers, status);
        return retUtilResponseEntity;
    }

    @ExceptionHandler(value = {RuntimeException.class})
    public ResponseEntity<RetUtil> handleRunTimeException(){
        return ResponseEntity.status(HttpStatus.INTERNAL_SERVER_ERROR).body(RetUtil.build().code(5000));
    }
}
複製代碼

代碼大體處理邏輯以下

繼承 BasicErrorController 處理 /error 接口

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

    private ApplicationContext applicationContext;


    public MyErrorController(ErrorAttributes errorAttributes, ServerProperties serverProperties, List<ErrorViewResolver> errorViewResolvers) {
        super( errorAttributes,  serverProperties.getError(), errorViewResolvers);
    }

    @Override
    @RequestMapping
    public ResponseEntity error(HttpServletRequest request) {
        HttpStatus status = getStatus(request);
        if (status == HttpStatus.NO_CONTENT) {
            return ResponseEntity.status(status).body(RetUtil.build().code(status.value()));
        }
        Map<String, Object> body = getErrorAttributes(request, isIncludeStackTrace(request, MediaType.ALL));
        return new ResponseEntity<>(RetUtil.build().code(status.value()).data(body), status);
    }
}
複製代碼

Response.sendError 會將設置 org.apache.coyote.Response 對應的狀態碼 和 errorState，errorState 爲 1 說明有問題。Tomcat 會轉發 /error

判斷 errorState 是否爲 1，爲 1 進行業務處理，轉發 /error

轉發請求，轉發 /error 不會 執行過濾器了。

上述圖片執行過濾器鏈邏輯

上述圖片，責任鏈模式執行過濾器鏈(不會執行過濾器的操做)，而後執行 DispatcherServlet.doDispatch

判斷對象、對象父類，Class 的泛型類型

泛型使用限定符才能準確獲取到

當使用通配符，沒有使用限定符，是不能獲取的。

ResolvableType 描述一個 Class 的信息

相等於對 Class 的 api 封裝了一些東西，很方便使用。

ResolvableType.resolveGenerics 獲取當前泛型。
ResolvableType.getInterfaces 獲取父接口 Class 信息
ResolvableType.getSuperType 獲取父類的 Class 信息
複製代碼

@Test
    public void run77() {
        final MyList55<String, Demo2> stringDemo2MyList55 = new MyList55<>();
        final ResolvableType resolvableType = ResolvableType.forInstance(stringDemo2MyList55);
        // null
        // null
        for (ResolvableType generic : resolvableType.getGenerics()) {
            System.out.println(generic.resolve());
        }
    }
複製代碼

代碼演示使用的類父接口泛型

public interface MyGenericInterface<T extends CharSequence, M extends Demo> {
   default void onApplicationEvent1(T event,M event3){
      System.out.println(event.charAt(1));
      System.out.println(event3.getName());
   }
}

public class MyList2 implements MyGenericInterface<String,Demo>{
}

public class MyList33 implements MyGenericInterface<String,Demo2> {
}

@Data
public class Demo {
    private String name;
}

public class Demo2 extends Demo {
}
複製代碼

獲取接口的泛型類型

@Test
    public void run22() {
        ResolvableType resolvableType = ResolvableType.forClass(MyList2.class);
        final ResolvableType[] interfaces = resolvableType.getInterfaces();
        final ResolvableType[] generics = interfaces[0].getGenerics();
        /** * class java.lang.String * class com.fly.exception.Demo */

        for (ResolvableType generic : generics) {
            System.out.println(generic.resolve());
        }
    }
    
    @Test
    public void run33() {
        ResolvableType resolvableType = ResolvableType.forClass(MyList33.class);
        final ResolvableType[] interfaces = resolvableType.getInterfaces();
        final ResolvableType[] generics = interfaces[0].getGenerics();
        /** * class java.lang.String * class com.fly.exception.Demo2 */
        for (ResolvableType generic : generics) {
            System.out.println(generic.resolve());
        }
    }
複製代碼

獲取對象的父接口泛型

@Test
    public void run44() {
        final MyList33 myList33 = new MyList33();
        final ResolvableType resolvableType = ResolvableType.forInstance(myList33);
        /** * class com.fly.exception.MyList33 */
        System.out.println(resolvableType.resolve());
        final ResolvableType[] interfaces = resolvableType.getInterfaces();
        for (ResolvableType anInterface : interfaces) {
            final ResolvableType[] generics = anInterface.getGenerics();
            /** * class java.lang.String * class com.fly.exception.Demo2 */
            for (ResolvableType generic : generics) {
                System.out.println(generic.resolve());
            }
        }
    }
複製代碼

對象本身的泛型

@Test
public void run55() {
    MyList44<String, Demo> objectObjectMyList44 = new MyList44<>();
    final ResolvableType resolvableType = ResolvableType.forInstance(objectObjectMyList44);
    // class java.lang.String
    // class com.fly.exception.Demo
    for (ResolvableType generic : resolvableType.getGenerics()) {
        System.out.println(generic.resolve());
    }
}
複製代碼

獲取類自身的泛型

@Test
public void run66() {
    final ResolvableType resolvableType = ResolvableType.forClass(MyList44.class);
    // class java.lang.String
    // class com.fly.exception.Demo
    for (ResolvableType generic : resolvableType.getGenerics()) {
        System.out.println(generic.resolve());
    }
}
複製代碼