SpringBoot详细打印启动时异常堆栈信息

SpringBoot在项目启动时若是遇到异常并不能友好的打印出具体的堆栈错误信息，咱们只能查看到简单的错误消息，以至于并不能及时解决发生的问题，针对这个问题SpringBoot提供了故障分析仪的概念（failure-analyzer），内部根据不一样类型的异常提供了一些实现，咱们若是想自定义该怎么去作？

FailureAnalyzer

SpringBoot提供了启动异常分析接口FailureAnalyzer，该接口位于org.springframework.boot.diagnosticspackage内。
内部仅提供一个分析的方法，源码以下所示：

@FunctionalInterface
public interface FailureAnalyzer {

    /**
     * Returns an analysis of the given {@code failure}, or {@code null} if no analysis
     * was possible.
     * @param failure the failure
     * @return the analysis or {@code null}
     */
    FailureAnalysis analyze(Throwable failure);

}

该接口会把遇到的异常对象实例Throwable failure交付给实现类，实现类进行自定义处理。

AbstractFailureAnalyzer

AbstractFailureAnalyzer是FailureAnalyzer的基础实现抽象类，实现了FailureAnalyzer定义的analyze(Throwable failure)方法，并提供了一个指定异常类型的抽象方法analyze(Throwable rootFailure, T cause)，源码以下所示：

public abstract class AbstractFailureAnalyzer<T extends Throwable> implements FailureAnalyzer {

    @Override
    public FailureAnalysis analyze(Throwable failure) {
        T cause = findCause(failure, getCauseType());
        if (cause != null) {
            return analyze(failure, cause);
        }
        return null;
    }

    /**
     * Returns an analysis of the given {@code rootFailure}, or {@code null} if no
     * analysis was possible.
     * @param rootFailure the root failure passed to the analyzer
     * @param cause the actual found cause
     * @return the analysis or {@code null}
     */
    protected abstract FailureAnalysis analyze(Throwable rootFailure, T cause);

    /**
     * Return the cause type being handled by the analyzer. By default the class generic
     * is used.
     * @return the cause type
     */
    @SuppressWarnings("unchecked")
    protected Class<? extends T> getCauseType() {
        return (Class<? extends T>) ResolvableType.forClass(AbstractFailureAnalyzer.class, getClass()).resolveGeneric();
    }

    @SuppressWarnings("unchecked")
    protected final <E extends Throwable> E findCause(Throwable failure, Class<E> type) {
        while (failure != null) {
            if (type.isInstance(failure)) {
                return (E) failure;
            }
            failure = failure.getCause();
        }
        return null;
    }

}

经过AbstractFailureAnalyzer源码咱们能够看到，它在实现于FailureAnalyzer的接口方法内进行了特殊处理，根据getCauseType()方法获取当前类定义的第一个泛型类型，也就是咱们须要分析的指定异常类型。

获取泛型异常类型后根据方法findCause判断Throwable是否与泛型异常类型匹配，若是匹配直接返回给SpringBoot进行注册处理。

SpringBoot提供的分析实现

SpringBoot内部经过实现AbstractFailureAnalyzer抽象类定义了一系列的针对性异常类型的启动分析，以下图所示：

指定异常分析

SpringBoot内部提供的启动异常分析都是指定具体的异常类型实现的，最多见的一个错误就是端口号被占用（PortInUseException），虽然SpringBoot内部提供一个这个异常的启动分析，咱们也是能够进行替换这一异常分析的，咱们只须要建立PortInUseException异常的AbstractFailureAnalyzer，而且实现类注册给SpringBoot便可，实现自定义以下所示：

/**
 * 端口号被占用{@link PortInUseException}异常启动分析
 *
 * @author 恒宇少年
 */
public class PortInUseFailureAnalyzer extends AbstractFailureAnalyzer<PortInUseException> {
    /**
     * logger instance
     */
    static Logger logger = LoggerFactory.getLogger(PortInUseFailureAnalyzer.class);

    @Override
    protected FailureAnalysis analyze(Throwable rootFailure, PortInUseException cause) {
        logger.error("端口被占用。", cause);
        return new FailureAnalysis("端口号：" + cause.getPort() + "被占用", "PortInUseException", rootFailure);
    }
}

注册启动异常分析

在上面咱们只是编写了指定异常启动分析，咱们接下来须要让它生效，这个生效方式比较特殊，相似于自定义SpringBoot Starter AutoConfiguration的形式，咱们须要在META-INF/spring.factories文件内进行定义，以下所示：

org.springframework.boot.diagnostics.FailureAnalyzer=\
  org.minbox.chapter.springboot.failure.analyzer.PortInUseFailureAnalyzer

那咱们为何须要使用这种方式定义呢？

项目启动遇到的异常顺序不能肯定，极可能在Spring IOC并未执行初始化以前就出现了异常，咱们不能经过@Component注解的形式使其生效，因此SpringBoot提供了经过spring.factories配置文件的方式定义。

启动异常分析继承关系

自定义的运行异常通常都是继承自RuntimeException，若是咱们定义一个RuntimeException的异常启动分析实例会是什么效果呢？

/**
 * 项目启动运行时异常{@link RuntimeException}统一启动分析
 *
 * @author 恒宇少年
 */
public class ProjectBootUnifiedFailureAnalyzer extends AbstractFailureAnalyzer<RuntimeException> {
    /**
     * logger instance
     */
    static Logger logger = LoggerFactory.getLogger(ProjectBootUnifiedFailureAnalyzer.class);

    @Override
    protected FailureAnalysis analyze(Throwable rootFailure, RuntimeException cause) {
        logger.error("遇到运行时异常", cause);
        return new FailureAnalysis(cause.getMessage(), "error", rootFailure);
    }
}

将该类也一并注册到spring.factories文件内，以下所示：

org.springframework.boot.diagnostics.FailureAnalyzer=\
  org.minbox.chapter.springboot.failure.analyzer.PortInUseFailureAnalyzer,\
  org.minbox.chapter.springboot.failure.analyzer.ProjectBootUnifiedFailureAnalyzer

运行项目并测试端口号被占用异常咱们会发现，并无执行ProjectBootUnifiedFailureAnalyzer内的analyze方法，而是继续执行了PortInUseFailureAnalyzer类内的方法。

那咱们将PortInUseFailureAnalyzer这个启动分析从spring.factories文件内暂时删除掉，再来运行项目咱们会发现这时倒是会执行ProjectBootUnifiedFailureAnalyzer类内分析方法。

总结

根据本章咱们了解了SpringBoot提供的启动异常分析接口以及基本抽象实现类的运做原理，并且启动异常分析存在分析泛型异常类的上下级继承关系，异常子类的启动分析会覆盖掉异常父类的启动分析，若是你想包含所有异常的启动分析能够尝试使用Exception做为AbstractFailureAnalyzer的泛型参数。