SpringApplication执行流程
SpringApplication的run方法的实现是我们本次旅程的主要线路,该方法的主要流程大体可以归纳如下:
如果我们使用的SpringApplication的静态run方法,那么,这个方法里面首先需要创建一个SpringApplication对象实例,然后调用这个创建好的SpringApplication的实例的run方法。在SpringApplication实例初始化的时候,它会提前做几件事情:
根据classpath里面是否存在某个特征类(org.springframework.web.context.ConfigurableWebApplicationContext)判断WebApplicationType,来决定是否应该创建一下为Web应用使用的ApplicationContext类型,还是创建一下标准的Standalone应用使用的ApplicationContext类型。
使用SpringFactoriesLoader在应用的classpath中查找并加载所有可用的ApplicationContextInitializer。
使用SpringFactoriesLoader在应用的classpath中查找并加载所有可用的ApplicationListener。
推断并设置main方法的定义类。
如图所示:
SpringApplication实例初始化完成并且完成设置后,就开始执行run方法的逻辑了,方法执行伊始,首先遍历执行所有通过SpringFactoriesLoader可以查找到并加载的SpringApplicationRunListener,调用它们的started()方法,告诉这些SpringApplicationRunListener,“嘿,SpringBoot应用要开始执行咯!”。
创建并配置当前SpringBoot应用将要使用的Environment。遍历调用所有的SpringApplicationRunListener的environmentPrepared()方法,告诉他们:“当前SpringBoot应用使用的Environment准备好咯!”
根据WebApplicationType来决定创建何种类型的ApplicationContext。
再次通过SpringFactoriesLoader查找并加载的异常分析器。
最核心的一步,将之前通过@EnableAutoConfiguration获取的所有配置以及其它形式的IoC容器配置加载到已经准备完毕的ApplicationContext;执行ApplicationContextInitializer.initialize方法;遍历调用所有SpringApplicationRunListener的contextLoaded()方法,告知SpringApplicationRunListener,ApplicationContext“装填完毕”
调用ApplicationContext的refresh()方法,完成IoC容器可用的最后一道工序。
对ApplicationRunner和CommandLineRunner类型做回调处理。
如图所示:
整个过程看起来冗长无比,但其实很多都是一些事件通知的扩展点,如果将这些逻辑暂时忽略,那么,其实整个SpringBoot应用启动的逻辑就可以压缩到及其精简的几步
除了初始化并准备好ApplicationContext,剩下的大部分工作都是通过这些扩展点完成的,所以,我们有必要对各类扩展点进行逐一剖析。
SpringApplicationRunListener
SpringApplicationRunListener 接口的作用主要就是在Spring Boot 启动初始化的过程中可以通过SpringApplicationRunListener接口回调来让用户在启动的各个流程中可以加入自己的逻辑。
package org.springframework.boot;
public interface SpringApplicationRunListener {
// 在run()方法开始执行时,该方法就立即被调用,可用于在初始化最早期时做一些工作
void starting();
// 当environment构建完成,ApplicationContext创建之前,该方法被调用
void environmentPrepared(ConfigurableEnvironment environment);
// 当ApplicationContext构建完成时,该方法被调用
void contextPrepared(ConfigurableApplicationContext context);
// 在ApplicationContext完成加载,但没有被刷新前,该方法被调用
void contextLoaded(ConfigurableApplicationContext context);
// 在ApplicationContext刷新并启动后,CommandLineRunners和ApplicationRunner未被调用前,该方法被调用
void started(ConfigurableApplicationContext context);
// 在run()方法执行完成前该方法被调用
void running(ConfigurableApplicationContext context);
// 当应用运行出错时该方法被调用
void failed(ConfigurableApplicationContext context, Throwable exception);
}
对于我们来说,基本没什么常见的场景需要自己实现一个SpringApplicationRunListener,即使SpringBoot默认也只是实现一个org.springframework.boot.context.event.EventPublishingRunListener,用于在SpringBoot启动的不同时点发布不同的应用事件类型,假设我们需要自己定义一个SpringApplicationRunListener,出了需要实现接口的方法之外,还需要一个构造方法:
package com.sixj.demoapplication.listener;
import org.springframework.boot.SpringApplication;
import org.springframework.boot.SpringApplicationRunListener;
import org.springframework.context.ConfigurableApplicationContext;
import org.springframework.core.env.ConfigurableEnvironment;
/**
* @author sixiaojie
* @date 2019-08-09 8:53
*/
public class HelloApplicationRunListener implements SpringApplicationRunListener {
public HelloApplicationRunListener(SpringApplication application, String[] args) {
System.out.println("构造器...");
}
@Override
public void starting() {
System.out.println("starting...");
}
@Override
public void environmentPrepared(ConfigurableEnvironment environment) {
System.out.println("environmentPrepared...");
}
@Override
public void contextPrepared(ConfigurableApplicationContext context) {
System.out.println("contextPrepared...");
}
@Override
public void contextLoaded(ConfigurableApplicationContext context) {
System.out.println("contextLoaded...");
}
@Override
public void started(ConfigurableApplicationContext context) {
System.out.println("started...");
}
@Override
public void running(ConfigurableApplicationContext context) {
System.out.println("running...");
}
@Override
public void failed(ConfigurableApplicationContext context, Throwable exception) {
System.out.println("failed...");
}
}
然后需要在当前SpringBoot应用classpath下的META-INF/spring.factories文件中进行配置:
org.springframework.boot.SpringApplicationRunListener=\
com.sixj.demoapplication.listener.HelloApplicationRunListener
至于为什么这样配置,可以看另一篇文章中对SpringFactoriesLoader的介绍:SpringBoot工作机制之@SpringBootApplication
然后SpringApplication就会在运行的时候调用了。
参考资料:《SpringBoot揭秘 快速构建微服务体系》