SpringBoot中FailureAnalyzer的使用详解

 更新时间:2023年12月15日 10:49:12   作者:johnny233  
这篇文章主要介绍了SpringBoot中FailureAnalyzer的使用详解,FailureAnalyzer拦截启动时异常,将异常转换成更加易读的信息并包装成org.springframework.boot.diagnostics.FailureAnalysis对象,监控应用启动过程,需要的朋友可以参考下

FailureAnalyzer的使用

<dependency>
    <groupId>org.springframework.boot</groupId>
    <artifactId>spring-boot</artifactId>
</dependency>

功能定位:拦截启动时异常,将异常转换成更加易读的信息并包装成org.springframework.boot.diagnostics.FailureAnalysis对象,监控应用启动过程。

FailureAnalysis是一个POJO:

@Getter
@AllArgsConstructor
public class FailureAnalysis {
    private final String description;
    private final String action;
    private final Throwable cause;
}

FailureAnalyzer接口:

public interface FailureAnalyzer {
    FailureAnalysis analyze(Throwable var1);
}

AbstractFailureAnalyzer 抽象类实现 FailureAnalyzer 接口,SpringBoot 已经提供一系列 AbstractFailureAnalyzer 继承类,在 org.springframework.boot.diagnostics.analyzer和org.springframework.boot.autoconfigure.diagnostics.analyzer包下面

  • BeanCurrentlyInCreationFailureAnalyzer
  • PortInUseFailureAnalyzer
  • NoSuchMethodFailureAnalyzer
  • BindFailureAnalyzer
  • AbstractInjectionFailureAnalyzer
  • NoSuchBeanDefinitionFailureAnalyzer
  • DataSourceBeanCreationFailureAnalyzer
  • HikariDriverConfigurationFailureAnalyzer
  • NoUniqueBeanDefinitionFailureAnalyzer
  • ValidationExceptionFailureAnalyzer
  • ConnectorStartFailureAnalyzer
  • CompatibilityNotMetFailureAnalyzer
  • BeanNotOfRequiredTypeFailureAnalyzer

随着Spring Boot版本的提升,实现类有所新增。

注册启动异常分析

上面只是编写指定异常启动分析,接下来需要让它生效,这个生效方式比较特殊,类似于自定义SpringBoot Starter AutoConfiguration的形式,然后每个FailureAnalyzer都需要配置在META-INF/spring.factories文件中,如:

# Failure analyzers
org.springframework.boot.diagnostics.FailureAnalyzer=\
org.springframework.boot.autoconfigure.diagnostics.analyzer.NoSuchBeanDefinitionFailureAnalyzer,\
org.springframework.boot.autoconfigure.jdbc.DataSourceBeanCreationFailureAnalyzer,\
org.springframework.boot.autoconfigure.jdbc.HikariDriverConfigurationFailureAnalyzer

那我们为什么需要使用这种方式定义呢? 项目启动遇到的异常顺序不能确定,很可能在Spring IOC并未执行初始化之前就出现了异常,我们不能通过@Component注解的形式使其生效,所以SpringBoot提供了通过spring.factories配置文件的方式定义。

通过FailureAnalyzer接口拦截获取到启动时异常,然后呢,有啥用?不难发现,在同一个包路径下面存在FailureAnalysisReporter接口:

public interface FailureAnalysisReporter {
    void report(FailureAnalysis var1);
}

接口实现类,有所删减:

@NoArgsConstructor
public final class LoggingFailureAnalysisReporter implements FailureAnalysisReporter {
    public void report(FailureAnalysis failureAnalysis) {
		logger.debug("Application failed to start due to an exception", failureAnalysis.getCause());
        logger.error(this.buildMessage(failureAnalysis));
    }
    private String buildMessage(FailureAnalysis failureAnalysis) {
        StringBuilder builder = new StringBuilder();
        builder.append(String.format("%n%n"));
        builder.append(String.format("***************************%n"));
        builder.append(String.format("APPLICATION FAILED TO START%n"));
        builder.append(String.format("***************************%n%n"));
        builder.append(String.format("Description:%n%n"));
        builder.append(String.format("%s%n", failureAnalysis.getDescription()));
        if (StringUtils.hasText(failureAnalysis.getAction())) {
            builder.append(String.format("%nAction:%n%n"));
            builder.append(String.format("%s%n", failureAnalysis.getAction()));
        }
        return builder.toString();
    }
}

到次,发现熟悉的控制台输出:APPLICATION FAILED TO START

使用

自定义类 CustomFailedAnalyzer 实现接口 FailureAnalyzer,重写方法 FailureAnalysis analyze(Throwable failure);

配置文件spring.factories放置在resources/META-INF org.springframework.boot.diagnostics.FailureAnalyzer=com.awesome.CustomFailedAnalyzer

到此这篇关于SpringBoot中FailureAnalyzer的使用详解的文章就介绍到这了,更多相关FailureAnalyzer的使用内容请搜索脚本之家以前的文章或继续浏览下面的相关文章希望大家以后多多支持脚本之家!

相关文章

  • SpringBoot的java -jar命令启动原理解读

    SpringBoot的java -jar命令启动原理解读

    这篇文章主要介绍了SpringBoot的java -jar命令启动原理,具有很好的参考价值,希望对大家有所帮助,如有错误或未考虑完全的地方,望不吝赐教
    2024-02-02
  • SpringBoot使用Nacos进行application.yml配置管理详解

    SpringBoot使用Nacos进行application.yml配置管理详解

    Nacos是阿里巴巴开源的一个微服务配置管理和服务发现的解决方案,下面我们来看看在SpringBoot中如何使用Nacos进行application.yml配置管理吧
    2025-03-03
  • Java+mysql实现学籍管理系统

    Java+mysql实现学籍管理系统

    这篇文章主要为大家详细介绍了Java+mysql实现学籍管理系统,文中示例代码介绍的非常详细,具有一定的参考价值,感兴趣的小伙伴们可以参考一下
    2022-07-07
  • Java经典设计模式之适配器模式原理与用法详解

    Java经典设计模式之适配器模式原理与用法详解

    这篇文章主要介绍了Java经典设计模式之适配器模式,简单说明了适配器模式的概念、原理,并结合实例形式分析了java适配器模式的用法与相关注意事项,需要的朋友可以参考下
    2017-08-08
  • 使用dom4j实现xml转map与xml转json字符串

    使用dom4j实现xml转map与xml转json字符串

    这篇文章主要为大家详细介绍了如何使用dom4j实现xml转map与xml转json字符串功能,文中的示例代码讲解详细,感兴趣的小伙伴可以了解下
    2024-11-11
  • Java正则验证字串符RegexValidator类使用

    Java正则验证字串符RegexValidator类使用

    正则验证字串符是一种强大的工具,可以帮助程序员在处理字符串时轻松进行复杂匹配,本文将介绍正则表达式的概念、语法和在编程中的应用,并通过实例演示如何使用正则表达式进行字符串匹配、替换和提取等操作
    2023-11-11
  • Java的函数方法详解(含汉诺塔问题)

    Java的函数方法详解(含汉诺塔问题)

    汉诺塔问题是一个经典的递归问题,下面这篇文章主要给大家介绍了关于Java函数方法(含汉诺塔问题)的相关资料,文中通过图文以及代码示例介绍的非常详细,需要的朋友可以参考下
    2023-11-11
  • 解决JDK21中用不了TimeUtild问题

    解决JDK21中用不了TimeUtild问题

    在使用TimeUtil时,可能因为IDE版本不兼容导致问题,升级IDEA到2023.2以上版本可解决此问题,详细步骤可以通过评论区索取安装包或直接从官网下载,分享个人经验,希望对大家有帮助
    2024-10-10
  • Java之单链表问题解决案例讲解

    Java之单链表问题解决案例讲解

    这篇文章主要介绍了Java之单链表问题解决案例讲解,本篇文章通过简要的案例,讲解了该项技术的了解与使用,以下就是详细内容,需要的朋友可以参考下
    2021-08-08
  • Java 获取Web项目相对webapp地址的实例

    Java 获取Web项目相对webapp地址的实例

    下面小编就为大家带来一篇Java 获取Web项目相对webapp地址的实例。小编觉得挺不错的,现在就分享给大家,也给大家做个参考。一起跟随小编过来看看吧
    2017-11-11

最新评论