springboot 启动原理

时间 2019-11-06

原文原文链接

咱们开发任何一个Spring Boot项目，都会用到以下的启动类web

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

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

SpringBootApplication背后的秘密

@SpringBootApplication注解是Spring Boot的核心注解，它实际上是一个组合注解：app

@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（@SpringBootConfiguration点开查看发现里面仍是应用了@Configuration）
@EnableAutoConfiguration
@ComponentScan

即 @SpringBootApplication = (默认属性)@Configuration + @EnableAutoConfiguration + @ComponentScanspring-boot

因此，若是咱们使用以下的SpringBoot启动类，整个SpringBoot应用依然能够与以前的启动类功能对等：工具

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

每次写这3个比较累，因此写一个@SpringBootApplication方便点。接下来分别介绍这3个Annotation。spa

@Configuration

这里的@Configuration对咱们来讲不陌生，它就是JavaConfig形式的Spring Ioc容器的配置类使用的那个@Configuration，SpringBoot社区推荐使用基于JavaConfig的配置形式，因此，这里的启动类标注了@Configuration以后，自己其实也是一个IoC容器的配置类。code

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

1、表达形式层面

基于XML配置的方式是这样：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">
    <!--bean定义-->
</beans>

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

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

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

2、注册bean定义层面

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

<bean id="mockService" class="..MockServiceImpl">
    ...
</bean>

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

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

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

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

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

<bean id="mockService" class="..MockServiceImpl">
   <propery name ="dependencyService" ref="dependencyService" />
</bean>
<bean id="dependencyService" class="DependencyServiceImpl"></bean>

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

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

    @Bean
    public DependencyService dependencyService(){
        return new DependencyServiceImpl();
    }
}

若是一个bean的定义依赖其余bean，则直接调用对应的JavaConfig类中依赖bean的建立方法就能够了。

@Configuration：提到@Configuration就要提到他的搭档@Bean。使用这两个注解就能够建立一个简单的spring配置类，能够用来替代相应的xml配置文件。

<beans> 
    <bean id = "car" class="com.test.Car"> 
        <property name="wheel" ref = "wheel"></property> 
    </bean> 
    <bean id = "wheel" class="com.test.Wheel"></bean> 
</beans>

至关于：

@Configuration 
public class Conf { 
    @Bean 
    public Car car() { 
        Car car = new Car(); 
        car.setWheel(wheel()); 
        return car; 
    }

    @Bean 
    public Wheel wheel() { 
        return new Wheel(); 
    } 
}

@Configuration的注解类标识这个类可使用Spring IoC容器做为bean定义的来源。

@Bean注解告诉Spring，一个带有@Bean的注解方法将返回一个对象，该对象应该被注册为在Spring应用程序上下文中的bean。

@ComponentScan

@ComponentScan这个注解在Spring中很重要，它对应XML配置中的<context:component-scan base-package="" />元素，@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的帮助，将全部符合自动配置。

@EnableAutoConfiguration会根据类路径中的jar依赖为项目进行自动配置，如：添加了spring-boot-starter-web依赖，会自动添加Tomcat和Spring MVC的依赖，Spring Boot会对Tomcat和Spring MVC进行自动配置。

@EnableAutoConfiguration做为一个复合Annotation，其自身定义关键信息以下：

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

其中，最关键的要属 @Import(AutoConfigurationImportSelector.class)，借助AutoConfigurationImportSelector@EnableAutoConfiguration能够帮助SpringBoot应用将全部符合条件的@Configuration配置都加载到当前SpringBoot建立并使用的IoC容器。就像一只“八爪鱼”同样，借助于Spring框架原有的一个工具类：

SpringFactoriesLoader的支持，@EnableAutoConfiguration能够智能的自动配置功效才得以大功告成！

自动配置幕后英雄：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类。

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

因此，@EnableAutoConfiguration自动配置的魔法其实就变成了：从classpath中搜寻全部的META-INF/spring.factories配置文件，并将其中org.springframework.boot.autoconfigure.EnableutoConfiguration对应的配置项经过反射（Java Refletion）实例化为对应的标注了@Configuration的JavaConfig形式的IoC容器配置类，而后汇总为一个并加载到IoC容器。

深刻探索SpringApplication执行流程

SpringApplication的run方法的实现是咱们本次旅程的主要线路，该方法的主要流程大致能够概括以下：

1）若是咱们使用的是SpringApplication的静态run方法，那么，这个方法里面首先要建立一个SpringApplication对象实例，而后调用这个建立好的SpringApplication的实例方法。在SpringApplication实例初始化的时候，它会提早作几件事情：

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

2）SpringApplication实例初始化完成而且完成设置后，就开始执行run方法的逻辑了，方法执行伊始，首先遍历执行全部经过SpringFactoriesLoader能够查找到并加载的SpringApplicationRunListener。调用它们的started()方法，告诉这些SpringApplicationRunListener，“嘿，SpringBoot应用要开始执行咯！”。

3）建立并配置当前Spring Boot应用将要使用的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()方法，只不过这种状况下会将异常信息一并传入处理）

去除事件通知点后，整个流程以下：

自动化配置

以前的启动结构图中，咱们注意到不管是应用初始化仍是具体的执行过程，都调用了SpringBoot自动配置模块。

SpringBoot自动配置模块

该配置模块的主要使用到了SpringFactoriesLoader，即Spring工厂加载器，该对象提供了loadFactoryNames方法，入参为factoryClass和classLoader，即须要传入上图中的工厂类名称和对应的类加载器，方法会根据指定的classLoader，加载该类加器搜索路径下的指定文件，即spring.factories文件，传入的工厂类为接口，而文件中对应的类则是接口的实现类，或最终做为实现类，因此文件中通常为以下图这种一对多的类名集合，获取到这些实现类的类名后，loadFactoryNames方法返回类名集合，方法调用方获得这些集合后，再经过反射获取这些类的类对象、构造方法，最终生成实例。