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的使用内容请搜索脚本之家以前的文章或继续浏览下面的相关文章希望大家以后多多支持脚本之家!

相关文章

  • 浅谈为什么重写equals()就要重写hashCode()

    浅谈为什么重写equals()就要重写hashCode()

    困扰我很久的问题,一直不明白为什么重写equals()方法的时候要重写hashCode()方法,这次总算弄明白了,作此分享,感兴趣的可以了解一下
    2021-10-10
  • Java学生信息类继承与接口的原理及使用方式

    Java学生信息类继承与接口的原理及使用方式

    这篇文章主要介绍了Java学生信息类继承与接口的原理及使用方式,具有很好的参考价值,希望对大家有所帮助,如有错误或未考虑完全的地方,望不吝赐教
    2024-02-02
  • Spring Boot如何通过CORS处理跨域问题

    Spring Boot如何通过CORS处理跨域问题

    这篇文章主要介绍了Spring Boot如何通过CORS处理跨域问题,文中通过示例代码介绍的非常详细,对大家的学习或者工作具有一定的参考学习价值,需要的朋友可以参考下
    2020-04-04
  • Java并发编程之ConcurrentLinkedQueue解读

    Java并发编程之ConcurrentLinkedQueue解读

    这篇文章主要介绍了Java并发编程之ConcurrentLinkedQueue解读,非阻塞的实现方式则可以使用循环CAS的方式来实现,而ConcurrentLinkedQueue就是juc包中自带的经典非堵塞方式实现的工具类,需要的朋友可以参考下
    2023-12-12
  • Java 数据结构之堆的概念与应用

    Java 数据结构之堆的概念与应用

    堆是一颗完全二叉树,在这棵树中,所有父节点都满足大于等于其子节点的堆叫大根堆,所有父节点都满足小于等于其子节点的堆叫小根堆,堆虽然是一颗树,但是通常存放在一个数组中,父节点和孩子节点的父子关系通过数组下标来确定
    2021-10-10
  • 理解java多线程中ExecutorService使用

    理解java多线程中ExecutorService使用

    这篇文章主要帮助大家理解java多线程中ExcetorServiced的使用方法,具有一定的参考价值,感兴趣的小伙伴们可以参考一下
    2016-12-12
  • SpringBoot项目中分页插件PageHelper无效的问题及解决方法

    SpringBoot项目中分页插件PageHelper无效的问题及解决方法

    这篇文章主要介绍了解决SpringBoot项目中分页插件PageHelper无效的问题,本文通过实例代码给大家介绍的非常详细,对大家的学习或工作具有一定的参考借鉴价值,需要的朋友可以参考下
    2020-06-06
  • SpringBoot2.0新特性之配置绑定全解析

    SpringBoot2.0新特性之配置绑定全解析

    在Spring Boot 2.0中推出了Relaxed Binding 2.0,对原有的属性绑定功能做了非常多的改进以帮助我们更容易的在Spring应用中加载和读取配置信息,感兴趣的小伙伴们可以参考一下
    2019-03-03
  • Java中Spring的创建和使用详解

    Java中Spring的创建和使用详解

    这篇文章主要介绍了Java中Spring的创建和使用详解,Spring 是⼀个包含了众多⼯具⽅法的 IoC 容器,既然是容器那么 它就具备两个最基本的功能,将对象存储到容器中,从容器中将对象取出来,需要的朋友可以参考下
    2023-08-08
  • 集合嵌套之ArrayList嵌套ArrayList实例

    集合嵌套之ArrayList嵌套ArrayList实例

    下面小编就为大家带来一篇集合嵌套之ArrayList嵌套ArrayList实例。小编觉得挺不错的,现在就分享给大家,也给大家做个参考。一起跟随小编过来看看吧
    2017-08-08

最新评论