我们开发任何一个Spring Boot项目,都会用到如下的启动类
@SpringBootApplication
public class Application {
public static void main(String[] args) {
SpringApplication.run(Application.class, args);
}
}
从上面代码可以看出,Annotation定义(@SpringBootApplication
)和类定义(SpringApplication.run
)最为耀眼,所以要揭开SpringBoot的神秘面纱,我们要从这两位开始就可以了。
SpringBootApplication背后的秘密
@SpringBootApplication注解是Spring Boot的核心注解,它其实是一个组合注解:
@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
+ @ComponentScan
所以,如果我们使用如下的SpringBoot启动类,整个SpringBoot应用依然可以与之前的启动类功能对等:
@Configuration
@EnableAutoConfiguration
@ComponentScan
public class Application {
public static void main(String[] args) {
SpringApplication.run(Application.class, args);
}
}
每次写这3个比较累,所以写一个@SpringBootApplication
方便点。接下来分别介绍这3个Annotation。
@Configuration
这里的@Configuration
对我们来说不陌生,它就是JavaConfig形式的Spring Ioc容器的配置类使用的那个@Configuration
,SpringBoot社区推荐使用基于JavaConfig的配置形式,所以,这里的启动类标注了@Configuration
之后,本身其实也是一个IoC容器的配置类。
举几个简单例子回顾下,XML跟config配置方式的区别:
一、表达形式层面
基于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配置类。
二、注册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。
三、表达依赖注入关系层面
为了表达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
方法返回类名集合,方法调用方得到这些集合后,再通过反射获取这些类的类对象、构造方法,最终生成实例。