[SpringBoot]源码分析SpringBoot的异常处理机制

发布时间:2020-06-28 21:04:09 作者:GitShare
来源:网络 阅读:5211

微信号:GitShare
微信公众号:爱折腾的稻草
如有问题或建议,请在公众号留言[1]

前续

为帮助广大SpringBoot用户达到“知其然,更需知其所以然”的境界,作者将通过SpringBoot系列文章全方位对SpringBoot2.0.0.RELEASE版本深入分解剖析,让您深刻的理解其内部工作原理。

正文

在SpringBoot启动时,会查找并加载所有可用的SpringBootExceptionReporter,其源码如下:

//7 使用SpringFactoriesLoader在应用的classpath中查找并加载所有可用的SpringBootExceptionReporter
exceptionReporters = getSpringFactoriesInstances(
        SpringBootExceptionReporter.class,
        new Class[] { ConfigurableApplicationContext.class }, context);

继续查看getSpringFactoriesInstances方法源码:

private <T> Collection<T> getSpringFactoriesInstances(Class<T> type,
        Class<?>[] parameterTypes, Object... args)
 
{
    ClassLoader classLoader = Thread.currentThread().getContextClassLoader();
    //查找并加载classpath路径下META-INF/spring.factories中配置的SpringBootExceptionReporter的所有名称
    Set<String> names = new LinkedHashSet<>(SpringFactoriesLoader.loadFactoryNames(type, classLoader));
    //实例化所有的SpringBootExceptionReporter
    List<T> instances = createSpringFactoriesInstances(type, parameterTypes, classLoader, args, names);
    //排序
    AnnotationAwareOrderComparator.sort(instances);
    //返回结果
    return instances;
}

代码来看不难,也是通过Spring的Factories机制来加载,之前的文章中已经详细讲解过其过程。

SpringBootExceptionReporter
@FunctionalInterface
public interface SpringBootExceptionReporter {

    /**
     * 向用户报告启动失败。
     */

    boolean reportException(Throwable failure);

}
FailureAnalyzers
1、实例化FailureAnalyzers
FailureAnalyzers(ConfigurableApplicationContext context) {
    this(context, null);
}

FailureAnalyzers(ConfigurableApplicationContext context, ClassLoader classLoader) {
    Assert.notNull(context, "Context must not be null");
    this.classLoader = (classLoader == null ? context.getClassLoader() : classLoader);
    this.analyzers = loadFailureAnalyzers(this.classLoader);
    prepareFailureAnalyzers(this.analyzers, context);
}
# Failure Analyzers
org.springframework.boot.diagnostics.FailureAnalyzer=\
org.springframework.boot.diagnostics.analyzer.BeanCurrentlyInCreationFailureAnalyzer,\
org.springframework.boot.diagnostics.analyzer.BeanNotOfRequiredTypeFailureAnalyzer,\
org.springframework.boot.diagnostics.analyzer.BindFailureAnalyzer,\
org.springframework.boot.diagnostics.analyzer.BindValidationFailureAnalyzer,\
org.springframework.boot.diagnostics.analyzer.UnboundConfigurationPropertyFailureAnalyzer,\
org.springframework.boot.diagnostics.analyzer.ConnectorStartFailureAnalyzer,\
org.springframework.boot.diagnostics.analyzer.NoUniqueBeanDefinitionFailureAnalyzer,\
org.springframework.boot.diagnostics.analyzer.PortInUseFailureAnalyzer,\
org.springframework.boot.diagnostics.analyzer.ValidationExceptionFailureAnalyzer,\
org.springframework.boot.diagnostics.analyzer.InvalidConfigurationPropertyNameFailureAnalyzer,\
org.springframework.boot.diagnostics.analyzer.InvalidConfigurationPropertyValueFailureAnalyzer
private void prepareAnalyzer(ConfigurableApplicationContext context,
        FailureAnalyzer analyzer)
 
{
    if (analyzer instanceof BeanFactoryAware) {
        ((BeanFactoryAware) analyzer).setBeanFactory(context.getBeanFactory());
    }
    if (analyzer instanceof EnvironmentAware) {
        ((EnvironmentAware) analyzer).setEnvironment(context.getEnvironment());
    }
}

准备阶段:根据FailureAnalyzer的类型,设置其BeanFactory或者Environment属性值。

2、FailureAnalyzer
@FunctionalInterface
public interface FailureAnalyzer {

    /**
     * 返回给定故障的分析,如果不无法分析,则返回null。
     */

    FailureAnalysis analyze(Throwable failure);

}

用于分析故障并提供可以显示给用户的诊断信息。

3、AbstractFailureAnalyzer

FailureAnalyzer的抽象基类,是个泛型类,泛型参数为Throwable的子类.其实现了analyze方法,源码如下:

@Override
public FailureAnalysis analyze(Throwable failure) {
    // 1. 获得failure中的异常堆栈中是type类型的异常
    T cause = findCause(failure, getCauseType());
    if (cause != null) {
        // 2. 如果不等于null,则进行分析
        return analyze(failure, cause);
    }
    // 3. 无法分析,则返回null
    return null;
}
protected final <E extends Throwable> findCause(Throwable failure, Class<E> type) {
    while (failure != null) {
        if (type.isInstance(failure)) {
            return (E) failure;
        }
        failure = failure.getCause();
    }
    return null;
}
3.1、AbstractInjectionFailureAnalyzer:用来对注入异常进行分析的抽象基类。    
3.2、BeanCurrentlyInCreationFailureAnalyzer:针对BeanCurrentlyInCreationException.对BeanCurrentlyInCreationException(循环依赖)进行分析。    
3.3、BeanNotOfRequiredTypeFailureAnalyzer:针对BeanNotOfRequiredTypeException异常进行分析。  
3.4、BindFailureAnalyzer:针对BindException异常进行分析。  
3.5、BindValidationFailureAnalyzer :针对BindValidationException或者BindException异常进行分析。
3.6、ConnectorStartFailureAnalyzer:针对ConnectorStartFailedException(tomcat端口占用时抛出)异常进行分析。  
3.7、DataSourceBeanCreationFailureAnalyzer:针对DataSourceBeanCreationException异常进行分析。  
3.8、HikariDriverConfigurationFailureAnalyzer:它对使用不支持的“dataSourceClassName”属性导致的Hikari配置失败进行分析。  
3.9、InvalidConfigurationPropertyNameFailureAnalyzer:针对InvalidConfigurationPropertyNameException异常进行分析。  
3.10、InvalidConfigurationPropertyValueFailureAnalyzer:针对InvalidConfigurationPropertyValueException异常进行分析。  
3.11、NoUniqueBeanDefinitionFailureAnalyzer:针对NoUniqueBeanDefinitionException异常进行分析,且实现了BeanFactoryAware接口。  
3.12、PortInUseFailureAnalyzer:针对PortInUseException(jetty,undertow 容器启动时端口占用时抛出)异常进行分析。
3.13、UnboundConfigurationPropertyFailureAnalyzer:针对BindException异常进行分析。  
3.14、ValidationExceptionFailureAnalyzer:泛型参数为ValidationException(当使用validation相关的注解,但是没有加入相关实现时触发,一般不容易触发,因为一旦加入spring-boot-starter-web依赖,就会加入hibernate-validator)。
4、失败报告(FailureAnalysisReporter)
@FunctionalInterface
public interface FailureAnalysisReporter {

    /**
     * 将失败结果(failureAnalysis)报告给用户
     */

    void report(FailureAnalysis analysis);

}
public final class LoggingFailureAnalysisReporter implements FailureAnalysisReporter {

    private static final Log logger = LogFactory
            .getLog(LoggingFailureAnalysisReporter.class);

    @Override
    public void report(FailureAnalysis failureAnalysis) {
        if (logger.isDebugEnabled()) {
            logger.debug("Application failed to start due to an exception",
                    failureAnalysis.getCause());
        }
        if (logger.isErrorEnabled()) {
            logger.error(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();
    }

}

通过日志的方式进行打印失败错误信息。

小结

Spring的代码使用了很多设计模式,所以阅读起来总是绕来绕去,个人感觉其可读性比较差。今天原本是想画出异常处理机制的相关类图,但是发现这里的接口和类的关系都比较简单,所以就偷懒。如果您通过本文讲解,还不是很清晰的话,您可以将其类图画出来,那样会帮助您理解。

后记

为帮助广大SpringBoot用户达到“知其然,更需知其所以然”的境界,作者将通过SpringBoot系列文章全方位对SpringBoot2.0.0.RELEASE版本深入分解剖析,让您深刻的理解其内部工作原理。

本系列历史文章列表



[SpringBoot]源码分析SpringBoot的异常处理机制


推荐阅读:
  1. 关于springBoot+mybatis+thymeleaf前后端交互的案例分析
  2. SpringBoot项目中什么情况下需要添加@ResponseBody注解

免责声明:本站发布的内容(图片、视频和文字)以原创、转载和分享为主,文章观点不代表本网站立场,如果涉及侵权请联系站长邮箱:is@yisu.com进行举报,并提供相关证据,一经查实,将立刻删除涉嫌侵权内容。

springboot spring boot 源码分析

上一篇:python简单的基于做市商的股票高频交易策略

下一篇:Eclipse+ADT+SDK环境配置详细过程,带包地址

相关阅读

您好,登录后才能下订单哦!

密码登录
登录注册
其他方式登录
点击 登录注册 即表示同意《亿速云用户服务条款》