我们知道 Spring Boot 大大简化了项目初始搭建以及开发过程,而这些都是通过 Spring Boot 提供的 starter 来完成的。
2.1 starter 介绍
spring boot 在配置上相比 spring 要简单许多, 其核心在于 spring-boot-starter, 在使用 spring boot 来搭建一个项目时, 只需要引入官方提供的 starter, 就可以直接使用, 免去了各种配置。starter 简单来讲就是引入了一些相关依赖和一些初始化的配置。
Spring 官方提供了很多 starter,第三方也可以定义 starter。为了加以区分,starter 从名称上进行了如下规范:
- Spring 官方提供的 starter 名称为:spring-boot-starter-xxx 例如 Spring 官方提供的 spring-boot-starter-web
- 第三方提供的 starter 名称为:xxx-spring-boot-starter 例如由 mybatis 提供的 mybatis-spring-boot-starter
2.2 starter 原理
Spring Boot 之所以能够帮我们简化项目的搭建和开发过程,主要是基于它提供的起步依赖和自动配置。
2.2.1 起步依赖
起步依赖,其实就是将具备某种功能的坐标打包到一起,可以简化依赖导入的过程。例如,我们导入 spring-boot-starter-web 这个 starter,则和 web 开发相关的 jar 包都一起导入到项目中了。如下图所示:
2.2.2 自动配置
自动配置,就是无须手动配置 xml,自动配置并管理 bean,可以简化开发过程。那么 Spring Boot 是如何完成自动配置的呢?
自动配置涉及到如下几个关键步骤:
- 基于 Java 代码的 Bean 配置
- 自动配置条件依赖
- Bean 参数获取
- Bean 的发现
- Bean 的加载
我们可以通过一个实际的例子 mybatis-spring-boot-starter 来说明自动配置的实现过程。
2.2.2.1 基于 Java 代码的 Bean 配置
当我们在项目中导入了 mybatis-spring-boot-starter 这个 jar 后,可以看到它包括了很多相关的 jar 包,如下图:
其中在 mybatis-spring-boot-autoconfigure 这个 jar 包中有如下一个 MybatisAutoConfiguration 自动配置类:
打开这个类,截取的关键代码如下:
@Configuration 和 @Bean 这两个注解一起使用就可以创建一个基于 java 代码的配置类,可以用来替代传统的 xml 配置文件。
@Configuration 注解的类可以看作是能生产让 Spring IoC 容器管理的 Bean 实例的工厂。
@Bean 注解的方法返回的对象可以被注册到 spring 容器中。
所以上面的 MybatisAutoConfiguration 这个类,自动帮我们生成了 SqlSessionFactory 和 SqlSessionTemplate 这些 Mybatis 的重要实例并交给 spring 容器管理,从而完成 bean 的自动注册。
2.2.2.2 自动配置条件依赖
从 MybatisAutoConfiguration 这个类中使用的注解可以看出,要完成自动配置是有依赖条件的。
所以要完成 Mybatis 的自动配置,需要在类路径中存在 SqlSessionFactory.class、SqlSessionFactoryBean.class 这两个类,同时需要存在 DataSource 这个 bean 且这个 bean 完成自动注册。
这些注解是 spring boot 特有的,常见的条件依赖注解有:
注解 | 功能说明 |
---|---|
@ConditionalOnBean | 仅在当前上下文中存在某个 bean 时,才会实例化这个 Bean |
@ConditionalOnClass | 某个 class 位于类路径上,才会实例化这个 Bean |
@ConditionalOnExpression | 当表达式为 true 的时候,才会实例化这个 Bean |
@ConditionalOnMissingBean | 仅在当前上下文中不存在某个 bean 时,才会实例化这个 Bean |
@ConditionalOnMissingClass | 某个 class 在类路径上不存在的时候,才会实例化这个 Bean |
@ConditionalOnNotWebApplication | 不是 web 应用时才会实例化这个 Bean |
@AutoConfigureAfter | 在某个 bean 完成自动配置后实例化这个 bean |
@AutoConfigureBefore | 在某个 bean 完成自动配置前实例化这个 bean |
2.2.2.3 Bean 参数获取
要完成 mybatis 的自动配置,需要我们在配置文件中提供数据源相关的配置参数,例如数据库驱动、连接 url、数据库用户名、密码等。那么 spring boot 是如何读取 yml 或者 properites 配置文件的的属性来创建数据源对象的?
在我们导入 mybatis-spring-boot-starter 这个 jar 包后会传递过来一个 spring-boot-autoconfigure 包,在这个包中有一个自动配置类 DataSourceAutoConfiguration,如下所示:
我们可以看到这个类上加入了 EnableConfigurationProperties 这个注解,继续跟踪源码到 DataSourceProperties 这个类,如下:
可以看到这个类上加入了 ConfigurationProperties 注解,这个注解的作用就是把 yml 或者 properties 配置文件中的配置参数信息封装到 ConfigurationProperties 注解标注的 bean(即 DataSourceProperties) 的相应属性上。
@EnableConfigurationProperties 注解的作用是使 @ConfigurationProperties 注解生效。
2.2.2.4 Bean 的发现
spring boot 默认扫描启动类所在的包下的主类与子类的所有组件,但并没有包括依赖包中的类,那么依赖包中的 bean 是如何被发现和加载的?
我们需要从 Spring Boot 项目的启动类开始跟踪,在启动类上我们一般会加入 SpringBootApplication 注解,此注解的源码如下:
重点介绍如下三个注解:
SpringBootConfiguration:作用就相当于 Configuration 注解,被注解的类将成为一个 bean 配置类
ComponentScan:作用就是自动扫描并加载符合条件的组件,最终将这些 bean 加载到 spring 容器中
EnableAutoConfiguration :这个注解很重要,借助 @Import 的支持,收集和注册依赖包中相关的 bean 定义
继续跟踪 EnableAutoConfiguration 注解源码:
@EnableAutoConfiguration 注解引入了 @Import 这个注解。
Import:导入需要自动配置的组件,此处为 EnableAutoConfigurationImportSelector 这个类
EnableAutoConfigurationImportSelector 类源码如下:
EnableAutoConfigurationImportSelector 继承了 AutoConfigurationImportSelector 类,继续跟踪 AutoConfigurationImportSelector 类源码:
AutoConfigurationImportSelector 类的 getCandidateConfigurations 方法中的调用了 SpringFactoriesLoader 类的 loadFactoryNames 方法,继续跟踪源码:
SpringFactoriesLoader 的 loadFactoryNames 静态方法可以从所有的 jar 包中读取 META-INF/spring.factories 文件,而自动配置的类就在这个文件中进行配置:
spring.factories 文件内容如下:
这样 Spring Boot 就可以加载到 MybatisAutoConfiguration 这个配置类了。
2.2.2.5 Bean 的加载
在 Spring Boot 应用中要让一个普通类交给 Spring 容器管理,通常有以下方法:
1、使用 @Configuration 与 @Bean 注解
2、使用 @Controller @Service @Repository @Component 注解标注该类并且启用 @ComponentScan 自动扫描
3、使用 @Import 方法
其中 Spring Boot 实现自动配置使用的是 @Import 注解这种方式,AutoConfigurationImportSelector 类的 selectImports 方法返回一组从 META-INF/spring.factories 文件中读取的 bean 的全类名,这样 Spring Boot 就可以加载到这些 Bean 并完成实例的创建工作。
2.2.3 自动配置总结
我们可以将自动配置的关键几步以及相应的注解总结如下:
1、@Configuration 与 @Bean:基于 Java 代码的 bean 配置
2、@Conditional:设置自动配置条件依赖
3、@EnableConfigurationProperties 与 @ConfigurationProperties:读取配置文件转换为 bean
4、@EnableAutoConfiguration 与 @Import:实现 bean 发现与加载