1.浅谈SpringBoot启动原理
0.前言
任何一个Spring Boot项目,都会有类似如下的启动类
1 import org.springframework.boot.SpringApplication; 2 import org.springframework.boot.autoconfigure.EnableAutoConfiguration; 3 import org.springframework.boot.autoconfigure.SpringBootApplication; 4 import org.springframework.context.annotation.ComponentScan; 5 import org.springframework.context.annotation.Configuration; 6 7 /* 8 @Configuration 9 @EnableAutoConfiguration 10 @ComponentScan 11 PS: 使用这三个注解和单独使用@SpringBootApplication效果是一样的 12 */ 13 @SpringBootApplication 14 public class ConsumerSpringBootApplication { 15 public static void main(String[] args) { 16 SpringApplication.run(ConsumerSpringBootApplication.class); 17 } 18 }
从上面的代码来看,注解定义(@SpringBootApplication)和类定义(SpringApplication.run)最为引人注目,所以要揭开SpringBoot的神秘面纱,我们要从这两位着手。
1.下面让我们先来看看@SpringBootApplication背后的秘密
1 @Target({ElementType.TYPE}) 2 @Retention(RetentionPolicy.RUNTIME) 3 @Documented 4 @Inherited 5 @SpringBootConfiguration 6 @EnableAutoConfiguration 7 @ComponentScan(excludeFilters = { 8 @Filter(type = FilterType.CUSTOM,classes = {TypeExcludeFilter.class}), 9 @Filter(type = FilterType.CUSTOM,classes = {AutoConfigurationExcludeFilter.class}) 10 }) 11 public @interface SpringBootApplication { 12 @AliasFor( 13 annotation = EnableAutoConfiguration.class 14 ) 15 Class<?>[] exclude() default {}; 16 17 @AliasFor( 18 annotation = EnableAutoConfiguration.class 19 ) 20 String[] excludeName() default {}; 21 22 @AliasFor( 23 annotation = ComponentScan.class, 24 attribute = "basePackages" 25 ) 26 String[] scanBasePackages() default {}; 27 28 @AliasFor( 29 annotation = ComponentScan.class, 30 attribute = "basePackageClasses" 31 ) 32 Class<?>[] scanBasePackageClasses() default {}; 33 }
从上面的代码看,SpringBootApplication这个接口使用了很多注解进行原信息标注,但是其中只有三个注解是最为重要的。
1).@Configuration(其实扒拉一下@SpringBootConfiguration,还是使用的@Configuration)
2).@EnableAutoConfiguration
3).@ComponentScan
所以,在最开始的启动类中,如果我们将@SpringBootApplication这个注解用@Configuration、@EnableAutoConfiguration和@ComponentScan这三个注解代替,效果是一样滴。
想要探寻@SpringBootApplication的最终秘密,我们还是要继续往下面挖,接着我们来扒一扒@Configuration、@EnableAutoConfiguration和@ComponentScan这三个注解。
1.1@Configuration
这里的@Configuration对我们来说并不陌生,因为它就是JavaConfig形式的SpringIOC容器的配置类使用的那个@Configuration。SpringBoot社区推荐使用基于JavaConfig的配置形式,所以,这里的启动类标注了@Configuration之后,本身其实也是一个IOC容器的配置类。
举几个简单例子回顾下,XML和Config配置方式的区别。
a).表达形式层面
基于XML配置的方式是这样:
1 <?xml version="1.0" encoding="UTF-8"?> 2 <beans xmlns="http://www.springframework.org/schema/beans" 3 xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" 4 xmlns:context="http://www.springframework.org/schema/context" 5 xmlns:rabbit="http://www.springframework.org/schema/rabbit" 6 xsi:schemaLocation="http://www.springframework.org/schema/beans 7 http://www.springframework.org/schema/beans/spring-beans.xsd 8 http://www.springframework.org/schema/context 9 https://www.springframework.org/schema/context/spring-context.xsd 10 http://www.springframework.org/schema/rabbit 11 http://www.springframework.org/schema/rabbit/spring-rabbit.xsd"> 12 <!--定义bean--> 13 </beans>
基于JavaConfig的配置方式是这样:
1 @Configuration 2 public class MockConfiguration{ 3 //定义bean 4 }
任何一个标注了@Configuration的Java类定义都是一个JavaConfig配置类。
b).注册bean定义层面
基于XML的配置形式是这样:
1 <bean id="mockService" class="..MockServiceImpl"> 2 ... 3 </bean>
基于JavaConfig的配置形式是这样的:
1 @Configuration 2 public class MockConfiguration{ 3 @Bean 4 public MockService mockService(){ 5 return new MockServiceImpl(); 6 } 7 }
任何一个标注了@Bean的方法,其返回值将作为一个bean定义注册到SpringIOC容器,方法名将默认成该bean定义的id。
c).表达依赖注入关系层面
为了表达bean与bean之间依赖关系,在XML形式的配置中一般是这样的:
1 <bean id="mockService" class="..MockServiceImpl"> 2 <propery name="dependencyService" ref="dependencyService"/> 3 </bean> 4 5 <bean id="dependencyService" class="DependencyServiceImpl"></bean>
基于JavaConfig的配置形式是这样的:
1 @Configuration 2 public class MockConfiguration{ 3 @Bean 4 public MockService mockService(){ 5 return new MockServiceImpl(dependencyService()); 6 } 7 8 @Bean 9 public DependencyService dependencyService(){ 10 retrun new DependencyServiceImpl(); 11 } 12 }
如果一个bean的定义依赖其他bean,则直接调用对应的JavaConfig类中依赖bean的创建方法就可以了。
1.2@ComponentScan
@ComponentScan这个注解在Spring中很重要,它对应XML配置中的元素。@ComponentScan的功能其实就是自动扫描并加载符合条件的组件(比如@Component和@Repository等)或者bean的定义,最终将这些bean定义加载到IOC容器中。
我们可以通过basePackages等属性来细粒度的定制@ComponentScan自动扫描的范围,如果不指定,则默认Spring框架实现会从声明@ComponentScan所在类的package进行扫描。
PS: 所以SpringBoot的启动类最好是放在root package下
1.3EnableAutoConfiguration
个人感觉@EnableAutoConfiguration这个注解最为重要,所以放在最后来解读,大家是否还记得Spring框架提供的各种名字为@Enable开头的注解定义?比如@EnableScheduling、@EnableCaching、@EnableMBeanExport等。@EnableAutoConfiguration的理念和做事方式其实一脉相承,简单概括一下就是,借助@Import的支持,收集和注册特定场景相关的bean定义。
- @EnableScheduling是通过@Import将Spring调度框架相关的bean定义都加载到IOC容器。
- @EnableMBeanExport是通过@Import将JMX相关的bean定义加载到IOC容器。
而@EnableAutoConfiguration也是借助@Import的帮助,将所有符合自动配置条件的bean定义加载到IOC容器,仅此而已!
@EnableAutoConfiguration作为一个复合注解,其自身定义关键信息如下:
1 @Target({ElementType.TYPE}) 2 @Retention(RetentionPolicy.RUNTIME) 3 @Documented 4 @Inherited 5 @AutoConfigurationPackage 6 @Import({AutoConfigurationImportSelector.class}) 7 public @interface EnableAutoConfiguration { 8 String ENABLED_OVERRIDE_PROPERTY = "spring.boot.enableautoconfiguration"; 9 10 Class<?>[] exclude() default {}; 11 12 String[] excludeName() default {}; 13 }
其中,最为关键的要属@Import({AutoConfigurationImportSelector.class}),借助AutoConfigurationImportSelector,@EnableAutoConfiguration可以帮助SpringBoot应用将所有符合条件的@Configuration配置都加载到当前SpringBoot创建并使用的IOC容器。就像一只"八爪鱼"一样。
借助于Spring框架原有的一个工具类: SpringFactoriesLoader的支持,@EnableAutoConfiguration可以智能的自动配置功效才得以大工告成!
自动配置幕后英雄: SpringFactoriesLoader详解
SpringFactoriesLoader属于Spring框架私有的一种扩展方案,其主要功能就是从指定的配置文件META-INF/spring.factories加载配置。
1 public final class SpringFactoriesLoader { 2 //... 3 public static <T> List<T> loadFactories(Class<T> factoryClass, @Nullable ClassLoader classLoader) { 4 ... 5 } 6 7 public static List<String> loadFactoryNames(Class<?> factoryClass, @Nullable ClassLoader classLoader) { 8 ... 9 }
配合@EnableAutoConfiguration使用的话,它更多是提供一种配置查找的功能支持,即根据@EnableAutoConfiguration的完整类名org.springframework.boot.autoconfigure.EnableAutoConfiguration作为查找Key,获取对应的一组@Configuration类
上图就是从SpringBoot的autoconfigure依赖包中的META-INF/spring.factories配置文件中摘录的一段内容,可以很好的说明问题。
所以,@EnableAutoConfiguration自动配置的魔法骑士就变成了: 从classpath中搜寻所有的META-INF/spring.factories配置文件,并将其中org.springframeword.boot.autoconfigure.EnableAutoConfiguration对应的配置项通过反射(Java Refletion)实例化为对应的标注了@Configuration的JavaConfig形式的IOC容器配置类,然后汇总为一个并加载到IOC容器。
2.深入探索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).创建并配置当前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会再次借助SpringFactoriesLoader,查找并加载classpath中所有可用的ApplicationContext-Initializer,然后遍历调用这些ApplicationContextInitialize(applicationContext)方法来对已经创建好的ApplicationContext进行进一步的处理。
8).遍历调用所有SpringApplicationRunListener的contextPrepared()方法。
9).最核心的一步,将之前通过@EnableAutoConfiguration获取的所有配置以及其他形式的IOC容器配置加载到已经准备完毕的ApplicationContext。
10).遍历调用所有的SpringApplicationRunListener的contextLoaded()方法。
11).调用ApplicationContext的refresh()方法,完成IOC容器可用的最后一道工序。
12).查找当前ApplicationContext中是否注册有CommandLineRunner,如果有,则遍历执行它们。
13).正常情况下,遍历执行SpringApplicationRunListener的finished()方法、(如果整个过程出现异常,则依然调用所有SpringApplicationRunListener的finished()方法,只不过这种情况下会将异常信息一并传入处理)
去除事件通知点后,整个流程如下:
浙公网安备 33010602011771号