SpringBoot源码分析之SpringBoot的启动过程

先看示例

SpringBoot的启动很简单，在许多情况下，你可以委托给静态SpringApplication.run方法，代码如下：

    @SpringBootApplication
    public class MyApplication {
        public static void main(String[] args) {
            SpringApplication.run(MyApplication.class, args);
        }
    }

从代码上可以看出，调用了SpringApplication的静态方法run。这个run方法会构造一个SpringApplication的实例，然后再调用这里实例的run方法就表示启动SpringBoot。

当你的应用程序启动时，你应该看到类似于以下输出的内容:

  .   ____          _            __ _ _
 /\\ / ___'_ __ _ _(_)_ __  __ _ \ \ \ \
( ( )\___ | '_ | '_| | '_ \/ _` | \ \ \ \
 \\/  ___)| |_)| | | | | || (_| |  ) ) ) )
  '  |____| .__|_| |_|_| |_\__, | / / / /
 =========|_|==============|___/=/_/_/_/
 :: Spring Boot ::       (v1.5.10.RELEASE)

因此，想要分析SpringBoot的启动过程，我们需要熟悉SpringApplication的构造过程以及SpringApplication的run方法执行过程即可。

我们以上述这段代码为例，分析SpringBoot的启动过程。

一、SpringApplication的构造过程

SpringApplication构造的时候内部会调用一个private方法initialize：

    public SpringApplication(Object... sources) {
      initialize(sources); // sources目前是一个MyApplication的class对象
    }

    private void initialize(Object[] sources) {
      if (sources != null && sources.length > 0) {
        this.sources.addAll(Arrays.asList(sources)); // 把sources设置到SpringApplication的sources属性中，目前只是一个MyApplication类对象
      }
      this.webEnvironment = deduceWebEnvironment(); // 判断是否是web程序，如果(javax.servlet.Servlet和org.springframework.web.context.ConfigurableWebApplicationContext）都在当前的类加载器中，则为true否则为false，判断结果设置到webEnvironment属性中
      

      // 从spring.factories文件中找出key为ApplicationContextInitializer的类并实例化后设置到SpringApplication的initializers属性中。这个过程也就是找出所有的应用程序初始化器
      setInitializers((Collection) getSpringFactoriesInstances(
          ApplicationContextInitializer.class));

      // 从spring.factories文件中找出key为ApplicationListener的类并实例化后设置到SpringApplication的listeners属性中。这个过程就是找出所有的应用程序事件监听器
      setListeners((Collection) getSpringFactoriesInstances(ApplicationListener.class));
      // 找出main类，这里是MyApplication类
      this.mainApplicationClass = deduceMainApplicationClass();
    }

下面分别介绍下载SpringApplication的构造中，涉及到的几个类：

1.1、ApplicationContextInitializer，应用程序初始化器，做一些初始化的工作：

    public interface ApplicationContextInitializerextends ConfigurableApplicationContext> {
        void initialize(C applicationContext);
    }

Springboot中目前有如下这些ContextInitializer，看截图：

       

1.2、ApplicationListener，应用程序事件(ApplicationEvent)监听器：

    public interface ApplicationListenerextends ApplicationEvent> extends EventListener {
        void onApplicationEvent(E event);
    }

这里的应用程序事件(ApplicationEvent)有：应用程序启动事件(ApplicationStartedEvent)、失败事件(ApplicationFailedEvent)、准备事件(ApplicationPreparedEvent)等。

应用程序事件监听器跟监听事件是绑定的。比如：

• ConfigServerBootstrapApplicationListener只跟ApplicationEnvironmentPreparedEvent事件绑定，
• LiquibaseServiceLocatorApplicationListener只跟ApplicationStartedEvent事件绑定，
• LoggingApplicationListener跟所有事件绑定等。

默认情况下，initialize方法从spring.factories文件中找出的key为ApplicationContextInitializer的类有：

org.springframework.boot.context.config.DelegatingApplicationContextInitializer
org.springframework.boot.context.ContextIdApplicationContextInitializer
org.springframework.boot.context.ConfigurationWarningsApplicationContextInitializer
org.springframework.boot.context.web.ServerPortInfoApplicationContextInitializer
org.springframework.boot.autoconfigure.logging.AutoConfigurationReportLoggingInitializer

key为ApplicationListener的有：

org.springframework.boot.context.config.ConfigFileApplicationListener
org.springframework.boot.context.config.AnsiOutputApplicationListener
org.springframework.boot.logging.LoggingApplicationListener
org.springframework.boot.logging.ClasspathLoggingApplicationListener
org.springframework.boot.autoconfigure.BackgroundPreinitializer
org.springframework.boot.context.config.DelegatingApplicationListener
org.springframework.boot.builder.ParentContextCloserApplicationListener
org.springframework.boot.context.FileEncodingApplicationListener
org.springframework.boot.liquibase.LiquibaseServiceLocatorApplicationListener

二、SpringApplication的执行

SpringApplication的run方法代码如下：

public ConfigurableApplicationContext run(String... args) {
        //①开启任务执行时间监听器
        StopWatch stopWatch = new StopWatch();
        // 开始执行，记录开始时间
        stopWatch.start();
        
        ConfigurableApplicationContext context = null;
        FailureAnalyzers analyzers = null;
        
        //设置系统属性『java.awt.headless』，为true则启用headless模式支持
        configureHeadlessProperty();
        
        //②通过*SpringFactoriesLoader*检索*META-INF/spring.factories*，
        //找到声明的所有SpringApplicationRunListener的实现类并将其实例化，
        //之后逐个调用其started()方法，广播SpringBoot要开始执行了。
        SpringApplicationRunListeners listeners = getRunListeners(args);
        //相当于批量的发布事件，及批量的监听器处理事件进行相应的操作
        listeners.starting();
        
        try {
            //构造一个应用程序参数持有类
            ApplicationArguments applicationArguments = new DefaultApplicationArguments(
                    args);
            
            //③创建并配置当前SpringBoot应用将要使用的Environment（包括配置要使用的PropertySource以及Profile）,
            //并遍历调用所有的SpringApplicationRunListener的environmentPrepared()方法，广播Environment准备完毕。
            ConfigurableEnvironment environment = prepareEnvironment(listeners,
                    applicationArguments);
            
            //④决定是否打印Banner
            Banner printedBanner = printBanner(environment);
            
            //⑤根据webEnvironment的值来决定创建何种类型的ApplicationContext对象
            //如果是web环境，则创建org.springframework.boot.context.embedded.AnnotationConfigEmbeddedWebApplicationContext
            //否则创建org.springframework.context.annotation.AnnotationConfigApplicationContext
            context = createApplicationContext();
            
            //⑥-1注册异常分析器
            analyzers = new FailureAnalyzers(context);
            
            //⑥-2为ApplicationContext加载environment，之后逐个执行ApplicationContextInitializer的initialize()方法来进一步封装ApplicationContext，
            //并调用所有的SpringApplicationRunListener的contextPrepared()方法，【EventPublishingRunListener只提供了一个空的contextPrepared()方法】，
            //之后初始化IoC容器，并调用SpringApplicationRunListener的contextLoaded()方法，广播ApplicationContext的IoC加载完成，
            //这里就包括通过**@EnableAutoConfiguration**导入的各种自动配置类。
            prepareContext(context, environment, listeners, applicationArguments,
                    printedBanner);
                    
            //⑦初始化所有自动配置类，调用ApplicationContext的refresh()方法        
            refreshContext(context);
            
            //⑧遍历所有注册的ApplicationRunner和CommandLineRunner，并执行其run()方法。
            //该过程可以理解为是SpringBoot完成ApplicationContext初始化前的最后一步工作，
            //我们可以实现自己的ApplicationRunner或者CommandLineRunner，来对SpringBoot的启动过程进行扩展。
            afterRefresh(context, applicationArguments);
            
            //⑨调用所有的SpringApplicationRunListener的finished()方法，广播SpringBoot已经完成了ApplicationContext初始化的全部过程。
            listeners.finished(context, null);
            
            //⑩关闭任务执行时间监听器
            stopWatch.stop();
            
            //⑪如果开启日志，则打印执行是时间

            if (this.logStartupInfo) {
                new StartupInfoLogger(this.mainApplicationClass)
                        .logStarted(getApplicationLog(), stopWatch);
            }
            return context;
        }
        catch (Throwable ex) {
            //⑫调用异常分析器打印报告，调用所有的SpringApplicationRunListener的finished()方法将异常信息发布出去

            handleRunFailure(context, listeners, analyzers, ex);
            throw new IllegalStateException(ex);
        }
    }

相关的分析：

①StopWatch，StopWatch相关见《Spring计时器StopWatch使用》

分析run方法之前，先看一下SpringApplication中的一些事件和监听器概念。

②、首先是SpringApplicationRunListeners类和SpringApplicationRunListener类的介绍

• SpringApplicationRunListeners类：

  SpringApplicationRunListeners内部持有SpringApplicationRunListener集合和1个Log日志类。用于SpringApplicationRunListener监听器的批量执行。

class SpringApplicationRunListeners {

    private final Log log;

    private final List listeners;

• SpringApplicationRunListener类：

　　　　SpringApplicationRunListener看名字也知道用于监听SpringApplication的run方法的执行。

              

　　　　它定义了5个步骤：

1. 1. 　　started(run方法执行的时候立马执行；对应事件的类型是ApplicationStartedEvent)：通知监听器，SpringBoot开始执行
   2. 　　environmentPrepared(ApplicationContext创建之前并且环境信息准备好的时候调用；对应事件的类型是ApplicationEnvironmentPreparedEvent)：通知监听器，Environment准备完成
   3. 　　contextPrepared(ApplicationContext创建好并且在source加载之前调用一次；没有具体的对应事件)：通知监听器，ApplicationContext已经创建并初始化完成
   4. 　　contextLoaded(ApplicationContext创建并加载之后并在refresh之前调用；对应事件的类型是ApplicationPreparedEvent)：通知监听器，ApplicationContext已经完成IoC配置价值
   5. 　　finished(run方法结束之前调用；对应事件的类型是ApplicationReadyEvent或ApplicationFailedEvent)：通知监听器，SpringBoot启动完成

　　　　　　　　SpringApplicationRunListener目前只有一个实现类EventPublishingRunListener，它把监听的过程封装成了SpringApplicationEvent事件并让内部属性(属性名为multicaster)ApplicationEventMulticaster接口的实现类SimpleApplicationEventMulticaster广播出去，广播出去的事件对象会被SpringApplication中的listeners属性进行处理。

所以说SpringApplicationRunListener和ApplicationListener之间的关系是通过ApplicationEventMulticaster广播出去的SpringApplicationEvent所联系起来的。更多的spring事件知识见《ApplicationEvent事件机制源码分析》

 

③、SpringBoot的Environment的准备

    private ConfigurableEnvironment prepareEnvironment(
            SpringApplicationRunListeners listeners,
            ApplicationArguments applicationArguments) {
        // 创建SpringBoot的Environment，可能是StandardServletEnvironment或者StandardEnvironment
        ConfigurableEnvironment environment = getOrCreateEnvironment();
        //包括配置要使用的PropertySource以及Profile
        configureEnvironment(environment, applicationArguments.getSourceArgs());
        //遍历调用所有的Environment的environmentPrepared方法，目前只有一个实现类EventPublishRunListener，即调用其multicastEvent，广播事件
        listeners.environmentPrepared(environment);
        if (!this.webEnvironment) {
            //将给定环境转换为标准环境。如果环境已经是一个标准环境，而不是ConfigurableWebEnvironment，则不执行转换，并且不改变返回值。
            environment = new EnvironmentConverter(getClassLoader())
                    .convertToStandardEnvironmentIfNecessary(environment);
        }
        return environment;
    }

④决定是否打印Banner

    private Banner printBanner(ConfigurableEnvironment environment) {
        //判断是否开启打印,如果没有开启，直接返回不执行下面的打印逻辑
        if (this.bannerMode == Banner.Mode.OFF) {
            return null;
        }
        //读取banner文件
        ResourceLoader resourceLoader = this.resourceLoader != null ? this.resourceLoader
                : new DefaultResourceLoader(getClassLoader());
        SpringApplicationBannerPrinter bannerPrinter = new SpringApplicationBannerPrinter(
                resourceLoader, this.banner);
        if (this.bannerMode == Mode.LOG) {
            return bannerPrinter.print(environment, this.mainApplicationClass, logger);
        }
        return bannerPrinter.print(environment, this.mainApplicationClass, System.out);
    }

⑤创建ApplicationContext

    protected ConfigurableApplicationContext createApplicationContext() {
        Class contextClass = this.applicationContextClass;
        if (contextClass == null) {
            try {
                //通过反射获得ApplicationContext的类信息

　　　　　　　　// 如果是web程序，那么构造org.springframework.boot.context.embedded.AnnotationConfigEmbeddedWebApplicationContext容器
          　　// 否则构造org.springframework.context.annotation.AnnotationConfigApplicationContext容器

                contextClass = Class.forName(this.webEnvironment
                        ? DEFAULT_WEB_CONTEXT_CLASS : DEFAULT_CONTEXT_CLASS);
            }
            catch (ClassNotFoundException ex) {
                throw new IllegalStateException(
                        "Unable create a default ApplicationContext, "
                                + "please specify an ApplicationContextClass",
                        ex);
            }
        }
        //通过类的newInstance创建实例
        return (ConfigurableApplicationContext) BeanUtils.instantiate(contextClass);
    }

    public static  T instantiate(Class clazz) throws BeanInstantiationException {
        Assert.notNull(clazz, "Class must not be null");
        if (clazz.isInterface()) {
            throw new BeanInstantiationException(clazz, "Specified class is an interface");
        }
        try {
            return clazz.newInstance();
        }
        catch (InstantiationException ex) {
            throw new BeanInstantiationException(clazz, "Is it an abstract class?", ex);
        }
        catch (IllegalAccessException ex) {
            throw new BeanInstantiationException(clazz, "Is the constructor accessible?", ex);
        }
    }

⑥-1、注册异常分析器

    public 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);
        //通过反射，批量创建FailureAnalyzer,顺序的放到list集合里
        this.analyzers = loadFailureAnalyzers(this.classLoader);
        prepareFailureAnalyzers(this.analyzers, context);
    }

    //遍历为每个FailureAnalyzer调用prepareAnalyzer
    private void prepareFailureAnalyzers(List analyzers,
            ConfigurableApplicationContext context) {
        for (FailureAnalyzer analyzer : analyzers) {
            prepareAnalyzer(context, analyzer);
        }
    }
    //将Analyzer拥有的工厂赋值给上面新创建的Analyzer，提供给Analyzer实例的回调。
    //在填充普通bean属性之后调用，但在初始化回调(如InitializingBean.afterPropertiesSet()或自定义init-method)之前调用。
    private void prepareAnalyzer(ConfigurableApplicationContext context,
            FailureAnalyzer analyzer) {
        if (analyzer instanceof BeanFactoryAware) {
            ((BeanFactoryAware) analyzer).setBeanFactory(context.getBeanFactory());
        }
    }

⑥-2、ApplicationContext的初始化（environment、initializer）

    private void prepareContext(ConfigurableApplicationContext context,
            ConfigurableEnvironment environment, SpringApplicationRunListeners listeners,
            ApplicationArguments applicationArguments, Banner printedBanner) {
        //为context设置上面的Environment
        context.setEnvironment(environment);
        
        //在ApplicationContext中应用任何相关的后处理。子类可以根据需要应用额外的处理。
        postProcessApplicationContext(context);
        
        //在刷新上下文之前，将所有的applicationcontextinitialalizer应用于上下文。这里是遍历执行所有的initialize()来进一步封装ApplicationContext
        applyInitializers(context);
        
        //
        listeners.contextPrepared(context);
        if (this.logStartupInfo) {
            logStartupInfo(context.getParent() == null);
            logStartupProfileInfo(context);
        }

        // Add boot specific singleton beans
        context.getBeanFactory().registerSingleton("springApplicationArguments",
                applicationArguments);
        if (printedBanner != null) {
            context.getBeanFactory().registerSingleton("springBootBanner", printedBanner);
        }

        // Load the sources
        Set