SpringBoot2学习笔记（六）——SpringApplication

1.Spring Application生命周期

在Spring Boot的入口类中，我们通常是通过调用SpringApplication的run方法来启动Spring Boot项目。这节我们来深入学习下SpringApplication的一些细节。

SpringApplication生命周期分为两个部分：准备阶段和运行阶段。

一、 准备阶段

public SpringApplication(ResourceLoader resourceLoader, Class... primarySources) {
        this.sources = new LinkedHashSet();
        this.bannerMode = Mode.CONSOLE;
        this.logStartupInfo = true;
        this.addCommandLineProperties = true;
        this.addConversionService = true;
        this.headless = true;
        this.registerShutdownHook = true;
        this.additionalProfiles = new HashSet();
        this.isCustomEnvironment = false;
        this.resourceLoader = resourceLoader;
        Assert.notNull(primarySources, "PrimarySources must not be null");
        this.primarySources = new LinkedHashSet(Arrays.asList(primarySources));
        this.webApplicationType = WebApplicationType.deduceFromClasspath();
        this.setInitializers(this.getSpringFactoriesInstances(ApplicationContextInitializer.class));
        this.setListeners(this.getSpringFactoriesInstances(ApplicationListener.class));
        this.mainApplicationClass = this.deduceMainApplicationClass();
    }

1.1 配置源
构造器中this.primarySources = new LinkedHashSet<>(Arrays.asList(primarySources));这行代码用于加载我们配置的Spring Boot Bean源。通常我们使用SpringApplication或者SpringApplicationBuilder的构造器来直接指定源。所谓的Spring Boot Bean源指的是某个被@SpringBootApplication注解标注的类，比如入口类。

1.2 推断应用类型

构造器中这行this.webApplicationType = WebApplicationType.deduceFromClasspath();代码用于推断当前Spring Boot应用类型。

Spring Boot 2.0后，应用可以分为下面三种类型：

1. WebApplicationType.NONE：非WEB类型；
2. WebApplicationType.REACTIVE：Web Reactive类型；
3. WebApplicationType.SERVLET：Web Servlet类型。

1.3 加载应用上下文初始器

this.setInitializers(this.getSpringFactoriesInstances(ApplicationContextInitializer.class))用于加载应用上下文初始器

	private <T> Collection<T> getSpringFactoriesInstances(Class<T> type) {
        return this.getSpringFactoriesInstances(type, new Class[0]);
    }

    private <T> Collection<T> getSpringFactoriesInstances(Class<T> type, Class<?>[] parameterTypes, Object... args) {
        ClassLoader classLoader = this.getClassLoader();
        Set<String> names = new LinkedHashSet(SpringFactoriesLoader.loadFactoryNames(type, classLoader));
        List<T> instances = this.createSpringFactoriesInstances(type, parameterTypes, classLoader, args, names);
        AnnotationAwareOrderComparator.sort(instances);
        return instances;
    }

上面代码利用Spring工厂加载机制，实例化ApplicationContextInitializer实现类，并进行排序。所以我们可以通过实现ApplicationContextInitializer接口用于在Spring Boot应用初始化之前执行一些自定义操作。

自定义初始化

1. 创建一个ApplicationContextInitializer的实现类HelloApplicationContextInitializer，在initialize方法中实现自定义初始化方法。

//启动顺序
@Order(Ordered.HIGHEST_PRECEDENCE)
public class HelloApplicationContextInitializer implements ApplicationContextInitializer {
    @Override
    public void initialize(ConfigurableApplicationContext configurableApplicationContext) {
        System.out.println("ConfigurableApplicationContext.id - " + configurableApplicationContext.getId());
    }
}

public class AfterApplicationContextInitializer implements ApplicationContextInitializer, Ordered {

    @Override
    public void initialize(ConfigurableApplicationContext configurableApplicationContext) {
        System.out.println("AfterHelloApplicationContextInitializer: " + configurableApplicationContext.getId());
    }

    @Override
    public int getOrder() {
        return Ordered.LOWEST_PRECEDENCE;
    }
}

2. 在resource目录下，新建一个META-INF文件夹，新建spring.factories文件（此文件用于Spring工厂加载机制），配置需要初始化的类名：

# Initializers
org.springframework.context.ApplicationContextInitializer=\
com.example.applicationdemo.initializer.AfterApplicationContextInitializer,\
com.example.applicationdemo.initializer.HelloApplicationContextInitializer

3. 演示效果
   

1.4 加载应用事件监听器

在加载完应用上下文初始器后，下一行的setListeners((Collection) getSpringFactoriesInstances(ApplicationListener.class));代码加载了应用事件监听器。与加载事件上下文初始器类似，Spring Boot也是通过Spring的工厂方法来实例化ApplicationListener的实现类，并进行排序。

自定义事件监听器

1. 创建事件监听器，以上下文关闭为例，创建ApplicationListener的实现类ContextClosedEventListener。

@Order(Ordered.HIGHEST_PRECEDENCE)
public class ContextClosedEventListener implements ApplicationListener<ContextClosedEvent> {

    @Override
    public void onApplicationEvent(ContextClosedEvent contextClosedEvent) {
        System.out.println("ContextClosedEvent: " + contextClosedEvent.getApplicationContext().getId());
    }
}

2. 在spring.factories中添加

# listener
org.springframework.context.ApplicationListener=\
com.example.applicationdemo.listener.ContextClosedEventListener

3. 演示效果
   

1.5 推断入口类
接着构造器里的代码下一行this.mainApplicationClass = deduceMainApplicationClass();用于推断运行Spring Boot应用的入口类。查看deduceMainApplicationClass方法源码：

代码主要逻辑是根据Main线程执行堆栈判断实际的入口类。
准备阶段介绍完毕后，接下来开始介绍运行阶段。

二、 SpringApplication运行阶段

SpringApplication的运行阶段对应SpringApplication的run方法，我们查看其源码：

public ConfigurableApplicationContext run(String... args) {
	//开启时间监听
    StopWatch stopWatch = new StopWatch();
    stopWatch.start();
    ConfigurableApplicationContext context = null;
    Collection<SpringBootExceptionReporter> exceptionReporters = new ArrayList<>();
    configureHeadlessProperty();
    SpringApplicationRunListeners listeners = getRunListeners(args);
    listeners.starting();
    try {
        ApplicationArguments applicationArguments = new DefaultApplicationArguments(
                args);
        ConfigurableEnvironment environment = prepareEnvironment(listeners,
                applicationArguments);
        configureIgnoreBeanInfo(environment);
        //是否打印Banner
        Banner printedBanner = printBanner(environment);
        context = createApplicationContext();
        exceptionReporters = getSpringFactoriesInstances(
                SpringBootExceptionReporter.class,
                new Class[]{ConfigurableApplicationContext.class}, context);
        prepareContext(context, environment, listeners, applicationArguments,
                printedBanner);
        refreshContext(context);
        afterRefresh(context, applicationArguments);
        //计算启动花费时长
        stopWatch.stop();
        if (this.logStartupInfo) {
            new StartupInfoLogger(this.mainApplicationClass)
                    .logStarted(getApplicationLog(), stopWatch);
        }
        //广播所有监听已完成启动
        listeners.started(context);
        
        //遍历所有ApplicationRunner和CommandLineRunner的实现类，并执行其run方法
        callRunners(context, applicationArguments);
    } catch (Throwable ex) {
        handleRunFailure(context, ex, exceptionReporters, listeners);
        throw new IllegalStateException(ex);
    }

    try {
        listeners.running(context);
    } catch (Throwable ex) {
        handleRunFailure(context, ex, exceptionReporters, null);
        throw new IllegalStateException(ex);
    }
    return context;
}

2.1 开启时间监听

2.2 开启运行监听器

获取SpringApplicationRunListeners 内含SpringApplicationRunListener实例列表

SpringApplicationRunListeners listeners = getRunListeners(args);
listeners.started();

getRunListeners方法源码：

private SpringApplicationRunListeners getRunListeners(String[] args) {
    Class<?>[] types = new Class<?>[] { SpringApplication.class, String[].class };
    return new SpringApplicationRunListeners(logger, getSpringFactoriesInstances(
        SpringApplicationRunListener.class, types, this, args));
}

通过Spring工厂加载机制，从getSpringFactoriesInstances中获取到所有的SpringApplicationRunListener类型的事件监听实例，存储在SpringApplicationRunListeners 实例中，通过listeners.starting()来遍历调用所有监听实例对象的starting方法开启监听。

在Spring Boot中SpringApplicationRunListener接口用于监听整个Spring Boot应用生命周期，其代码如下所示：

public interface SpringApplicationRunListener {
	//Spring 应用刚启动
    void starting();
	//ConfigurableEnvironment 准备完毕，允许将其调整
    void environmentPrepared(ConfigurableEnvironment environment);
	//ConfigurableApplicationContext 准备完毕，允许将其调整
    void contextPrepared(ConfigurableApplicationContext context);
	//ConfigurableApplicationContext 已装载，但仍未启动
    void contextLoaded(ConfigurableApplicationContext context);
	//ConfigurableApplicationContext 已启动，此时 Spring Bean 已初始化完成
    void started(ConfigurableApplicationContext context);
	//Spring 应用正在运行
    void running(ConfigurableApplicationContext context);
	//Spring 应用运行失败
    void failed(ConfigurableApplicationContext context, Throwable exception);
}

2.3 创建 Environment

ConfigurableEnvironment environment = prepareEnvironment(listeners, applicationArguments);

在准备过程中，我们判断了应用类型，这个函数就是依据判断出的应用类型创建相应的环境对象。
类型和环境对应关系如下：

Web Reactive： StandardReactiveWebEnvironment
Web Servlet： StandardServletEnvironment
非 Web： StandardEnvironment

在prepareEnvironment方法中会执行listeners.environmentPrepared(environment);，用于遍历调用所有SpringApplicationRunListener实现类的environmentPrepared()方法，广播Environment准备完毕。

2.4 创建Context上下文对象

context = createApplicationContext();

不同的环境对应不同的ApplicationContext：

Web Reactive： AnnotationConfigReactiveWebServerApplicationContext
Web Servlet： AnnotationConfigServletWebServerApplicationContext
非 Web： AnnotationConfigApplicationContext

2.5 装配Context

prepareContext(context, environment, listeners, applicationArguments, printedBanner);


//方法源码
private void prepareContext(ConfigurableApplicationContext context,
                            ConfigurableEnvironment environment, SpringApplicationRunListeners listeners,
                            ApplicationArguments applicationArguments, Banner printedBanner) {
    context.setEnvironment(environment);
    postProcessApplicationContext(context);
    applyInitializers(context);
    listeners.contextPrepared(context);
    if (this.logStartupInfo) {
        logStartupInfo(context.getParent() == null);
        logStartupProfileInfo(context);
    }
    // Add boot specific singleton beans
    ConfigurableListableBeanFactory beanFactory = context.getBeanFactory();
    beanFactory.registerSingleton("springApplicationArguments", applicationArguments);
    if (printedBanner != null) {
        beanFactory.registerSingleton("springBootBanner", printedBanner);
    }
    if (beanFactory instanceof DefaultListableBeanFactory) {
        ((DefaultListableBeanFactory) beanFactory)
                .setAllowBeanDefinitionOverriding(this.allowBeanDefinitionOverriding);
    }
    // Load the sources
    Set<Object> sources = getAllSources();
    Assert.notEmpty(sources, "Sources must not be empty");
    load(context, sources.toArray(new Object[0]));
    listeners.contextLoaded(context);
}

首先装配应用环境，之后通过applyInitializers方法逐个执行ApplicationContextInitializer的initialize方法来进一步封装ApplicationContext，并调用所有的SpringApplicationRunListener实现类的contextPrepared方法，广播ApplicationContext已经准备完毕了。
之后初始化IOC容器，并调用SpringApplicationRunListener实现类的contextLoaded方法，广播ApplicationContext加载完成，这里就包括通过@EnableAutoConfiguration导入的各种自动配置类。

2.6 执行Runner
run方法中的这行代码callRunners(context, applicationArguments);遍历所有ApplicationRunner和CommandLineRunner的实现类，并执行其run方法。我们可以实现自己的ApplicationRunner或者CommandLineRunner，来对Spring Boot的启动过程进行扩展。