SpringBoot（3） - SpringApplication（3） - 自定义FailureAnalyzer

水深无声 2022-04-17 02:12 190阅读 0赞

参考：[https://docs.spring.io/spring-boot/docs/1.5.17.RELEASE/reference/htmlsingle/\#howto-failure-analyzer][https_docs.spring.io_spring-boot_docs_1.5.17.RELEASE_reference_htmlsingle_howto-failure-analyzer]

FailureAnalyzer是一种很好的方式在启动时拦截异常并将其转换为易读的消息，并将其包含在FailureAnalysis中。 Spring Boot为应用程序上下文相关异常、JSR-303验证等提供了此类分析器。 实际上也是非常容易创建自己的FailureAnalyzer。

AbstractFailureAnalyzer是FailureAnalyzer的一个抽象实现，它检查要处理的异常中是否存在指定的异常类型。 我们可以从中进行扩展，以便存在指定的异常时有机会去处理。 如果由于某种原因无法处理异常，则返回null以使另一个实现有机会处理异常。

FailureAnalyzer实现将在META-INF/spring.factories中注册：注册ProjectConstraintViolationFailureAnalyzer：

org.springframework.boot.diagnostics.FailureAnalyzer=\
    com.example.ProjectConstraintViolationFailureAnalyzer

示例：

检查java.lang.ArithmeticException异常

1. 继承AbstractFailureAnalyzer，重写analyze方法，返回FailureAnalysis。泛型的类型是Throwable的子类。

import org.springframework.boot.diagnostics.AbstractFailureAnalyzer;
    import org.springframework.boot.diagnostics.FailureAnalysis;
    
    public class ArithmeticFailureAnalyzer extends AbstractFailureAnalyzer<ArithmeticException> {
        @Override
        protected FailureAnalysis analyze(Throwable rootFailure, ArithmeticException cause) {
            return new FailureAnalysis(cause.getMessage(), "Check your logic.", cause);
        }
    }

2. spring.factories注册

src/main/resources/META-INF中添加spring.factories，并注册自定义的FailureAnalyzer：

org.springframework.boot.diagnostics.FailureAnalyzer=\
    com.momo.springbootfailureanalyzer.ArithmeticFailureAnalyzer

3. 测试

定义一个算术异常，如1/0。SpringBoot在启动时会创建这个bean，在执行方法时由于1/0的原因会抛出java.lang.ArithmeticException运行时异常，此时通过自定义的FailureAnalyzer进行捕获并处理该异常。

@Service
    public class ArithmeticService {
        public ArithmeticService() {
            int i = 1 / 0;
        }
    }

启动时控制台打印的信息：

![watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L215dHRfMTA1NjY_size_16_color_FFFFFF_t_70][]

demo代码：[https://github.com/mytt-10566/springboot-failureanalyzer][https_github.com_mytt-10566_springboot-failureanalyzer]

[https_docs.spring.io_spring-boot_docs_1.5.17.RELEASE_reference_htmlsingle_howto-failure-analyzer]: https://docs.spring.io/spring-boot/docs/1.5.17.RELEASE/reference/htmlsingle/#howto-failure-analyzer
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L215dHRfMTA1NjY_size_16_color_FFFFFF_t_70]: /images/20220417/1d53f7d34b194b1882bb99840c8bceb7.png
[https_github.com_mytt-10566_springboot-failureanalyzer]: https://github.com/mytt-10566/springboot-failureanalyzer