好久没写博客了,这两天跟教授聊天,提到开始用spring boot,教授问我一系列问题,很多都没有回答上来,此篇博文总结下这两天关于Spring boot工作原理的学习

—Eddie Lee

Spring

Spring 可以说构成了Java之所以这么流行的核心原因,那Spring的核心,两个最为核心的就是IOC(控制反转)与AOP(动态代理)。

IOC

那么什么是IOC,原本我们在一个类(A)依赖另一个类(B)的时候,需要在使用类(A类)的类new出来(B类),那么这个操作,耦合度非常高,如果哪天我们不用那个类(B),改用类(C),那么所有原本依赖(B)的类都要改。

那IOC是怎么实现的控制反转呢。
一种是DI(dependency injection,依赖注入),另一种是DL(dependency lookup,依赖查找)

第一种是主动注入,另一种是当需要的时候去查找依赖。
通常context.getBean(...)这种方式就是DL,去找依赖,而@Autowired是依赖注入(DI)

AOP

AOP面向切面编程其实说白了,就是封装了多个类的公共行为到一个可重用模块
AOP是通过Java的动态代理机制来实现的,通过配置和注解的方式,让Spring找到需要被代理的类,然后动态代理这个类,实现在方法,类等执行之前,和之后做的增强操作,一般用于权限,缓存,调试,记录跟踪,错误处理等。

Spring Annotation

@Configuration
任何一个标注了@Configuration的Java类定义都是一个JavaConfig配置类。包括SpringBoot的@SpringBootApplicaton,里面也是包含了一个@Configuration,所以Spring Boot的启动类,也是一个JavaConfig。

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

@ComponentScan
用于配合一些元信息Java annotation,比如@Component@Repository等,将标注了这些元信息annotation的bean定义类批量采集到spring的IOC容器中。可以通过basePackages等属性来细粒度地定制@ComponentScan自动扫描的范围,如果不指定,则默认spring框架实现会从声明@ComponentScan所在类的package进行扫描。

@PropertySource@PropertySources

@PropertySource用于从某些地方加载*.properties文件内容,并将其中的属性加载到IOC容器中,便于填充一些bean定义属性的占位符。

@Import@ImportResource

@Import负责引入JavaConfig形式定义的IOC容器配置,如果有一些遗留的配置或者遗留系统需要以xml的形式来配置(比如dubbo框架),我们依然可以通过@ImportResource将它们一起合并到当前JavaConfig配置的容器中。

Spring IOC启动

Spring IOC容器的依赖注入工作可以分为两个阶段:

  1. 收集和注册
    • 第一个阶段可以认为是构建和收集bean定义的阶段,在这个阶段,我们可以通过xml或者Java代码的方式定义一些bean,然后通过手动组装或者让容器基于某些机制自动扫描的方式,将这些bean定义收集到ioc容器中。
    • IOC 底层其实是一个Map,把所有的Bean加载到这个Map当中,根据相关机制获取,如果找不到,就会抛出异常,如果配置或bean加载出错,也会在容器启动时报错
  2. 分析和组装
    • 当第一个阶段完成后,底层Map容器中有一个个Bean,暂时它们之间是没有什么关系的,第二阶段要做的,就是分析Bean里面的关系,把它们组合起来,达到可用的状态

默认情况下(无单独配置),Spring加载的Bean对象都是单例模式,每次被注入或者被查找,都是同一个对象(hashCode相同)

Spring Boot

SpringBoot并不是对Spring Web框架进行颠覆,而是不同的bean互相作用,如果我们把Spring想象成人体,把Bean当做细胞的话,那么正是不同种类bean的相互协作才使得spring这个大工厂正常运行,有些bean做管理工作,有些bean为其它bean服务,有些bean生产其它bean,通过协作完成功能,而SpringBoot则是有默认约定,帮助完成了大部分Bean的配置,大量简化了需要开发人员编写的配置项。Spring Boot并不是对原有Spring框架的颠覆,而是基于原有功能的一次进化。

一个典型的Spring Boot项目,就是有一个由@SpringBootApplication注释的main函数
进入到@SpringBootApplication,会发现里面有

1
2
3
4
5
6
7
8
9
10
@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 {
...
}

@EnableAutoConfiguration作为一个复合annotation,其中最关键的要属@Import(AutoConfigurationImportSelector.class),借助AutoConfigurationImportSelector,@EnableAutoConfiguration可以帮助springboot应用将所有符合条件的@Configuration配置都加载到当前Spring Boot创建并使用的IOC容器,就跟一只八爪鱼一样。
AutoConfigurationImportSelector借助spring框架原有的一个工具类SpringFactoriesLoader的支持,@EnableAutoConfiguration可以智能地完成自动配置。

配合@EnableAutoConfiguration使用的话,它更多是提供一种配置查找的功能支持,即根据@EnableAutoConfiguration的完整类名org.springframework.boot.autoconfigure.EnableAutoConfiguration作为查找的Key,获取对应的一组@Configuration类。
所以,@EnableAutoConfiguration自动配置就变成了: 从classpath中搜寻所有的META-INF/spring.factories配置文件,并将其中org.springframework.boot.autoconfigure.EnableutoConfiguration对应的配置项通过反射(Java Refletion)实例化为对应的标注了@Configuration的JavaConfig形式的IoC容器配置类,然后汇总为一个并加载到IoC容器。

SpringFactoriesLoader主要功能是从指定的配置文件META-INF/spring.factories加载配置,spring.factories是一个典型的Java properties文件,配置的格式为key=value形式,只不过key和value都是Java类型的完整类型。

那么,既然Spring Boot的启动项也被@SpringBootConfiguration注释了,那么说明这也是一个配置类。

Spring Boot最强的地方,在于约定大于配置,所谓开箱即用,那么,约定是怎么做的呢?

Spring Boot AutoConfig类里面,默认编写了很多配置类,实现约定的核心就是,Boot导入这些配置,变成Bean对象
那么Spring Boot的启动顺序就应该是:

  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应用要开始执行咯!”。
    • 创建并配置当前Spring Boot应用将要使用的Environment(包括配置要使用的PropertySource以及Profile)。
    • 遍历调用所有SpringApplicationRunListener的environmentPrepared()的方法,告诉他们:“当前SpringBoot应用使用的Environment准备好了咯!”。
    • 如果SpringApplication的showBanner属性被设置为true,则打印banner。
    • 根据用户是否明确设置了applicationContextClass类型以及初始化阶段的推断结果,决定该为当前SpringBoot应用创建什么类型的ApplicationContext并创建完成,然后根据条件决定是否添加ShutdownHook,决定是否使用自定义的BeanNameGenerator,决定是否使用自定义的ResourceLoader,当然,最重要的,将之前准备好的Environment设置给创建好的ApplicationContext使用。
    • ApplicationContext创建好之后,SpringApplication会再次借助Spring-FactoriesLoader,查找并加载classpath中所有可用的ApplicationContext-Initializer,然后遍历调用这些ApplicationContextInitializer的initialize(applicationContext)方法来对已经创建好的ApplicationContext进行进一步的处理。
    • 遍历调用所有SpringApplicationRunListener的contextPrepared()方法。
    • 最核心的一步,将之前通过@EnableAutoConfiguration获取的所有配置以及其他形式的IoC容器配置加载到已经准备完毕的ApplicationContext
    • 遍历调用所有SpringApplicationRunListener的contextLoaded()方法。
    • 调用ApplicationContext的refresh()方法,完成IoC容器可用的最后一道工序。
    • 遍历调用所有SpringApplicationRunListener的contextLoaded()方法。
    • 查找当前ApplicationContext中是否注册有CommandLineRunner,如果有,则遍历执行它们。
    • 正常情况下,遍历执行SpringApplicationRunListener的finished()方法、(如果整个过程出现异常,则依然调用所有SpringApplicationRunListener的finished()方法,只不过这种情况下会将异常信息一并传入处理)

Spring Boot总结

启动:
每个SpringBoot程序都有一个主入口,也就是main方法,main里面调用SpringApplication.run()启动整个spring-boot程序,该方法所在类需要使用@SpringBootApplication注解,以及@ImportResource注解(if need),@SpringBootApplication包括三个注解,功能如下:

  • @EnableAutoConfiguration SpringBoot根据应用所声明的依赖来对Spring框架进行自动配置。
  • @SpringBootConfiguration(内部为@Configuration) 被标注的类等于在spring的XML配置文件中(applicationContext.xml),装配所有bean事务,提供了一个spring的上下文环境。
  • @ComponentScan:组件扫描,可自动发现和装配Bean,默认扫描SpringApplication的run方法里的Booter.class所在的包路径下文件,所以最好将该启动类放到根包路径下。

run方法中去创建了一个SpringApplication实例,在该构造方法内,我们可以发现其调用了一个初始化的initialize方法
主要是为SpringApplication对象赋一些初值。构造函数执行完毕后,我们回到run方法

  1. 创建了应用的监听器SpringApplicationRunListeners并开始监听
  2. 加载Spring Boot配置环境ConfigurableEnvironment,如果是通过web容器发布,会加载StandardEnvironment,其最终也是继承了ConfigurableEnvironment*Environment最终都实现了PropertyResolver接口,我们平时通过environment对象获取配置文件中指定Key对应的value方法时,就是调用了propertyResolver接口的getProperty方法

  3. 配置环境Environment加入到监听器对象中SpringApplicationRunListeners

  4. 创建run方法的返回对象:ConfigurableApplicationContext(应用配置上下文),我们可以看一下创建方法

    • 方法会先获取显式设置的应用上下文applicationContextClass,如果不存在,再加载默认的环境配置(通过是否是web environment判断),默认选择AnnotationConfigApplicationContext注解上下文(通过扫描所有注解类来加载bean),最后通过BeanUtils实例化上下文对象,并返回。

ConfigurableApplicationContext 的继承树中实现了LifeCycle和ApplicationContext:
LifeCycle:生命周期类,定义了start启动、stop结束、isRunning是否运行中等生命周期空值方法
ApplicationContext:应用上下文类,其主要继承了beanFactory(bean的工厂类)

  1. 回到run方法内,prepareContext方法将listenersenvironmentapplicationArgumentsbanner等重要组件与上下文对象关联

  2. 接下来的refreshContextcontext方法(初始化方法如下)将是实现spring-boot-starter-(mybatis、redis...)自动化配置的关键,包括spring.factories的加载,bean的实例化等核心工作。

配置结束后,Spring Boot做了一些基本的收尾工作,返回了应用环境上下文。回顾整体流程,Spring Boot的启动,主要创建了配置环境(environment)、事件监听(listeners)、应用上下文(applicationContext),并基于以上条件,在容器中开始实例化我们需要的Bean,至此,通过Spring Boot启动的程序已经构造完成,接下来我们来探讨自动化配置是如何实现。

自动配置

之前的启动结构中,我们注意到无论是应用初始化还是具体的执行过程,都调用了Spring Boot自动配置模块。

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

mybatis-spring-boot-starterspring-boot-starter-web等组件的META-INF文件下均含有spring.factories文件,自动配置模块中,SpringFactoriesLoader收集到文件中的类全名并返回一个类全名的数组,返回的类全名通过反射被实例化,就形成了具体的工厂实例,工厂实例来生成组件具体需要的bean。

之前我们提到了EnableAutoConfiguration注解,关注他的类图
可以发现其最终实现了ImportSelector(选择器)和BeanClassLoaderAware(bean类加载器中间件),重点关注一下AutoConfigurationImportSelectorselectImports方法。

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
@Override
public String[] selectImports(AnnotationMetadata annotationMetadata) {
if (!isEnabled(annotationMetadata)) {
return NO_IMPORTS;
}
AutoConfigurationMetadata autoConfigurationMetadata = AutoConfigurationMetadataLoader
.loadMetadata(this.beanClassLoader);
AnnotationAttributes attributes = getAttributes(annotationMetadata);
List<String> configurations = getCandidateConfigurations(annotationMetadata,
attributes);
configurations = removeDuplicates(configurations);
Set<String> exclusions = getExclusions(annotationMetadata, attributes);
checkExcludedClasses(configurations, exclusions);
configurations.removeAll(exclusions);
configurations = filter(configurations, autoConfigurationMetadata);
fireAutoConfigurationImportEvents(configurations, exclusions);
return StringUtils.toStringArray(configurations);
}

该方法在Spring Boot启动流程——bean实例化前被执行,返回要实例化的类信息列表。我们知道,如果获取到类信息,spring自然可以通过类加载器将类加载到jvm中,现在我们已经通过spring-boot的starter依赖方式依赖了我们需要的组件,那么这些组建的类信息在select方法中也是可以被获取到的,不要急我们继续向下分析。

该方法中的getCandidateConfigurations方法,通过方法注释了解到,其返回一个自动配置类的类名列表,方法调用了loadFactoryNames方法,查看该方法

1
2
3
4
5
6
7
8
9
protected List<String> getCandidateConfigurations(AnnotationMetadata metadata,
AnnotationAttributes attributes) {
List<String> configurations = SpringFactoriesLoader.loadFactoryNames(
getSpringFactoriesLoaderFactoryClass(), getBeanClassLoader());
Assert.notEmpty(configurations,
"No auto configuration classes found in META-INF/spring.factories. If you "
+ "are using a custom packaging, make sure that file is correct.");
return configurations;
}

在上面的代码可以看到自动配置器会根据传入的factoryClass.getName()到项目系统路径下所有的spring.factories文件中找到相应的key,从而加载里面的类。我们就选取这个mybatis-spring-boot-autoconfigure下的spring.factories文件

1
2
3
# Auto Configure
org.springframework.boot.autoconfigure.EnableAutoConfiguration=\
org.mybatis.spring.boot.autoconfigure.MybatisAutoConfiguration

进入org.mybatis.spring.boot.autoconfigure.MybatisAutoConfiguration中,主要看一下类头:

1
2
3
4
5
6
@org.springframework.context.annotation.Configuration
@ConditionalOnClass({ SqlSessionFactory.class, SqlSessionFactoryBean.class })
@ConditionalOnBean(DataSource.class)
@EnableConfigurationProperties(MybatisProperties.class)
@AutoConfigureAfter(DataSourceAutoConfiguration.class)
public class MybatisAutoConfiguration

发现Spring的@Configuration,俨然是一个通过注解标注的springBean,继续向下看,

@ConditionalOnClass({ SqlSessionFactory.class, SqlSessionFactoryBean.class})这个注解的意思是:当存在SqlSessionFactory.class, SqlSessionFactoryBean.class这两个类时才解析MybatisAutoConfiguration配置类,否则不解析这一个配置类,make sence,我们需要mybatis为我们返回会话对象,就必须有会话工厂相关类。

@CondtionalOnBean(DataSource.class):只有处理已经被声明为bean的dataSource。

@ConditionalOnMissingBean(MapperFactoryBean.class)这个注解的意思是如果容器中不存在name指定的bean则创建bean注入,否则不执行(该类源码较长,篇幅限制不全粘贴)

以上配置可以保证sqlSessionFactorysqlSessionTemplatedataSource等mybatis所需的组件均可被自动配置,@Configuration注解已经提供了Spring的上下文环境,所以以上组件的配置方式与Spring启动时通过mybatis.xml文件进行配置起到一个效果。通过分析我们可以发现,只要一个基于SpringBoot项目的类路径下存在SqlSessionFactory.class, SqlSessionFactoryBean.class,并且容器中已经注册了dataSourceBean,就可以触发自动化配置,意思说我们只要在maven的项目中加入了mybatis所需要的若干依赖,就可以触发自动配置,但引入mybatis原生依赖的话,每集成一个功能都要去修改其自动化配置类,那就得不到开箱即用的效果了。所以Spring-boot为我们提供了统一的starter可以直接配置好相关的类,触发自动配置所需的依赖(mybatis)如下:

这里是截取的mybatis-spring-boot-starter的源码中pom.xml文件中所有依赖:

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
<dependencies>
<dependency>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter</artifactId>
</dependency>
<dependency>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter-jdbc</artifactId>
</dependency>
<dependency>
<groupId>org.mybatis.spring.boot</groupId>
<artifactId>mybatis-spring-boot-autoconfigure</artifactId>
</dependency>
<dependency>
<groupId>org.mybatis</groupId>
<artifactId>mybatis</artifactId>
</dependency>
<dependency>
<groupId>org.mybatis</groupId>
<artifactId>mybatis-spring</artifactId>
</dependency>
</dependencies>

可以看到其中mybatis-spring-boot-autoconfigure就是配置文件,实现开箱即用

1
2
3
# Auto Configure
org.springframework.boot.autoconfigure.EnableAutoConfiguration=\
org.mybatis.spring.boot.autoconfigure.MybatisAutoConfiguration