【Spring Boot 15】启动类原理解析

一时失言乱红尘 2021-08-26 13:05 351阅读 0赞

# ![format_png][] #

# 一、启动类简介 #

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

从上面代码可以看出，Annotation定义（@SpringBootApplication）和类定义（SpringApplication.run）最为耀眼，所以要揭开SpringBoot的神秘面纱，我们要从这两位开始就可以了。

# **二、SpringBootApplication背后的秘密** #

@Target(ElementType.TYPE)
    @Retention(RetentionPolicy.RUNTIME)
    @Documented
    @Inherited
    @SpringBootConfiguration
    @EnableAutoConfiguration
    @ComponentScan(excludeFilters = {
            @Filter(type = FilterType.CUSTOM, classes = TypeExcludeFilter.class),
            @Filter(type = FilterType.CUSTOM, classes = AutoConfigurationExcludeFilter.class) })
    public @interface SpringBootApplication {
        ...
    }

虽然定义使用了多个Annotation进行了原信息标注，但实际上重要的只有三个Annotation：

*  @Configuration（@SpringBootApplication点开查看发现里面还是应用了@Configuration）
 *  @EnableAutoConfiguration
 *  @ComponentScan

所以，如果我们使用如下的SpringBoot启动类，整个SpringBoot应用依然可以与之前的启动类功能对等：

@Configuration
    @EnableAutoConfiguration
    @ComponentScan
    public class Application {
        public static void main(String[] args) {
            SpringApplication.run(Application.class, args);
        }
    }

写三个比较累，所以写一个@SpringBootApplication比较方便。

# 三、@Configuration #

这里的@Configuration对我们来说并不陌生，它就是JavaConfig形式的Spring IOC容器的配置类使用的那个@Configuration，SpringBoot社区推荐使用基于JavaConfig的配置形式，所以，这里的启动类标注了@Configuration之后，本身其实也是一个IOC容器的配置类。

举几个简单的例子例子回顾下，XML和config配置方式的区别：

## 1、表达形式层面 ##

基于xml配置的形式：

<?xml version="1.0" encoding="UTF-8"?>
    <beans xmlns="http://www.springframework.org/schema/beans"
           xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
           xsi:schemaLocation="http://www.springframework.org/schema/beans http://www.springframework.org/schema/beans/spring-beans-3.0.xsd"
           default-lazy-init="true">
        
    </beans>

而基于JavaConfig的配置方式是这样：

@Configuration
    public class MockConfiguration{
        //bean定义
    }

任何一个标注了@Configuration的Java类定义都是一个JavaConfig配置类。

## 2、注册bean定义层面 ##

基于XML的配置形式是这样：

而基于JavaConfig的配置形式是这样的：

@Configuration
    public class MockConfiguration{
        @Bean
        public MockService mockService(){
            return new MockServiceImpl();
        }
    }

任何一个标注了@Bean的方法，其返回值将作为一个bean定义注册到Spring的IOC容器，方法名将默认成该bean定义的id。

## 3、表达依赖注入关系层面 ##

为了表达bean与bean之间的依赖关系，在XML形式中一般是这样：

而基于JavaConfig的配置形式：

@Configuration
    public class MockConfiguration{
        @Bean
        public MockService mockService(){
            return new MockServiceImpl(dependencyService());
        }
        
        @Bean
        public DependencyService dependencyService(){
            return new DependencyServiceImpl();
        }
    }

如果一个bean的定义依赖其他bean，则直接调用对应的JavaConfig类中依赖bean的创建方法就可以了。

# **四、@ComponentScan** #

@ComponentScan这个注解在Spring中很重要，它对应XML配置中的元素，@ComponentScan的功能其实就是自动扫描并加载符合条件的组件（比如@Component和@Repository等）或者bean定义，最终将这些bean定义加载到IOC容器中。

我们可以通过basePackages等属性来细粒度的定制@ComponentScan自动扫描的范围，如果不指定，则默认Spring框架实现会从声明@ComponentScan所在类的package进行扫描。

注：所以SpringBoot的启动类最好是放在root package下，因为默认不指定basePackages。

# **五、@EnableAutoConfiguration** #

个人感觉@EnableAutoConfiguration这个Annotation最为重要，所以放在最后解读，大家是否还记得Spring框架提供的各种名字为@Enable开头的Annotation定义？比如@EnableScheduling、@EnableCaching、@EnableMBeanExport等，@EnableAutoConfiguration的理念和做事方式其实一脉相承，简单概括一下就是，借助@Import的支持、收集和注册特定场景相关的bean定义。

*  @ EnableScheduling 是通过@Import将Spring调度框架相关的bean定义都加载到IOC容器。
 *  @EnableMBeanExport是通过@Import将JMX相关的bean定义加载到IOC容器。

而 @EnableAutoConfiguration也是借助@Import的帮助， 将所有符合自动配置条件的bean定义加载到IOC容器，仅此而已！

@EnableAutoConfiguration 作为一个符合Annotation，其自身定义关键信息如下：

@SuppressWarnings("deprecation")
    @Target(ElementType.TYPE)
    @Retention(RetentionPolicy.RUNTIME)
    @Documented
    @Inherited
    @AutoConfigurationPackage
    @Import(EnableAutoConfigurationImportSelector.class)
    public @interface EnableAutoConfiguration {
        ...
    }

其中，最关键的要属@Import(EnableAutoConfigurationImportSelector.class)， 借助 EnableAutoConfigurationImportSelector，将@EnableAutoConfiguration可以帮助SpringBoot应用将所有符合条件的@Configuration配置都加载到当前SpringBoot创建并使用的IOC容器。  就像一只“八爪鱼”一样，借助于Spring框架原有的一个工具类：SpringFacoriesLoader的支持， @EnableAutoConfiguration可以智能的自动配置功效才得以大功告成！

![format_png 1][]

# **六、自动配置幕后英雄：SpringFactoriesLoader详解** #

SpringFactoriesLoader属于Spring框架私有的一种扩展方案，其主要功能就是从指定的配置文件

META-INF/spring.factories加载配置。

public abstract class SpringFactoriesLoader {
        //...
        public static <T> List<T> loadFactories(Class<T> factoryClass, ClassLoader classLoader) {
            ...
        }
    
    
        public static List<String> loadFactoryNames(Class<?> factoryClass, ClassLoader classLoader) {
            ....
        }
    }

配合@EnableAutoConfiguration使用的话，它更多是提供一种配置查找的功能支持，即根据@EnableAutoConfiguration的完整类名org.springframework.boot.autoconfigure.EnableAutoConfiguration作为查找的Key,获取对应的一组@Configuration类

![format_png 2][]

上图就是从SpringBoot的autoconfigure依赖包中的 META-INF/spring.factories 配置文件中摘取的一段内容，可以很好地说明问题。

所以， @EnableAutoConfiguration自动配置的魔法骑士就变成了：**从classpath中搜寻所有的META-INF/spring.factories配置文件，并将其中** **org.springframework.boot.autoconfigure.EnableutoConfiguration** 对应的配置项通过反射实例化对应的标注了@Configuration的JavaConfig形式的IOC容器配置类，然后汇总为一个并加载到IOC容器。

# 七、深入探索SpringApplication执行流程 #

SpringApplication的run方法的实现是我们本次旅程的主要线路，该方法的主要流程大体可以归纳如下：

1、如果我们使用的是 SpringApplication 的静态run方法，那么，这个方法里面首先要创建一个 SpringApplication 对象实例，然后调用这个创建好的 SpringApplication 的实例方法。在 SpringApplication 实例初始化的时候，它会提前做几件事情：

*  根据classpath里面是否存在某个特征类（org.springframework.web.context.ConfigurableWebApplicationContext）来决定是否应该创建一个为Web应用使用的ApplicationContext类型。
 *  使用SpringFactoriesLoader在应用的classpath中查找并加载所有可用的 ApplicationContextInitialize。
 *  使用SpringFactoriesLoader在应用的classpath中查找并加载所有可用的ApplicationListener。
 *  推断并设置main方法的定义类。

2、SpringApplication实例初始化完成并且完成设置后，就开始执行run方法的逻辑了，方法执行伊始，首先遍历执行所有通过SpringFactoriesLoader可以查找并加载的 SpringApplicationRunListene。调用它们的started()方法，告诉这些 SpringApplicationRunListener，“嘿，SpringBoot应用要开始执行咯！”。

3、创建并配置当前SpringBoot应用将要使用的environment（包括配置要使用的propertySource以及Profile）。

4、遍历调用所有 SpringApplicationRunListener 的environmentPrepared()方法，告诉他们： “当前SpringBoot应用使用的Environment准备好了咯！”。

5、如果SpringApplication的showBanner属性被设置为true，则打印banner。

6、根据用户是否明确设置了 applicationContextClass类型以及初始化阶段的推断结果，决定该位当前SpringBoot应用创建什么类型的ApplicationContext并创建完成，然后根据条件决定是否添加 ShutdownHook ，决定是否使用自定义的BeanNameGenerator，决定是否使用自定义的ResourceLoader，当然，最重要的，将之前准备好的Environment设置给创建好的ApplicationContext使用。

7、ApplicationContext创建好之后，SpringApplication会再次借助Spring-FactoriesLoader，查找并加载classpath中所有可用的ApplicationContext-Initializer，然后遍历调用这些ApplicationContextInitializer的initialize（applicationContext）方法来对已经创建好的ApplicationContext进行进一步的处理。

8、遍历调用所有SpringApplicationRunListener的contextPrepared()方法。

9、最核心的一步，将之前通过@EnableAutoConfiguration获取的所有配置以及其他形式的IoC容器配置加载到已经准备完毕的ApplicationContext。

10、遍历调用所有 SpringApplicationRunListener的contextLoaded()方法。

11、调用ApplicationContext的refresh()方法，完成IOC容器可用的最后一道工序。

12、查找当前ApplicationContext中是否注册有CommandLineRunner，如果有，则遍历执行它们。

13、正常情况下，遍历执行SpringApplicationRunListener的finished()方法、（如果整个过程出现异常，则依然调用所有SpringApplicationRunListener的finished()方法，只不过这种情况下会将异常信息一并传入处理）  
去除事件通知点后，整个流程如下：

![format_png 3][]

# **八、总结** #

到此，SpringBoot的核心组件完成了基本的解析，综合来看，大部分都是Spring框架背后的一些概念和实践方式，SpringBoot只是在这些概念和实践上对特定的场景事先进行了固化和升华，而也恰恰是这些固化让我们开发基于Sping框架的应用更加方便高效。

[format_png]: /images/20210813/f20e699b0fff4998b3569f9586034305.png
[format_png 1]: /images/20210813/1d02606de359456b835cd1eec32eb2e2.png
[format_png 2]: /images/20210813/0b73df5a9d4b46f68a1945703974ccd2.png
[format_png 3]: /images/20210813/3f5d359f2b4443dba050a659bd2c9c48.png