自动配置,意为自动将第三方框架集成到spring-boot项目中。
在spring-boot项目中,类路径下若是存在starter依赖,则会自动尝试配置该框架。该依赖工作的原理是:
- @EnableAutoConfiguration 启动自动配置(包含过滤自动配置等功能)
- Spring-boot启动时会对类路径进行扫描,寻找META-INF/spring.factories文件
- spring.factories文件记录着自动配置类(AutoConfigurationClass)
- 自动配置类有一个相应的自动配置属性类MybatisProperties(导入外化配置)
接下来分析每个步骤是怎么完成的:
1. spring-boot的核心注解:@SpringBootApplication
它是spring-boot项目配置类*application.class上的注解,在该注解中,我们可以看到三个关键的注解:
@org.springframework.boot.SpringBootConfiguration
@org.springframework.boot.autoconfigure.EnableAutoConfiguration
@org.springframework.context.annotation.ComponentScan()
分别进入三个注解,查看功能:
@SpringBootApplication 该注解标记的类是一个配置类
@org.springframework.context.annotation.Configuration
@EnableAutoConfiguration 启动自动配置
@org.springframework.boot.autoconfigure.AutoConfigurationPackage
@org.springframework.context.annotation.Import()
@ComponentScan 扫包,以当前类(Application类启动类)所在的包为基包递归扫描
2. 接下来的步骤以mybatis的自动配置为例:
在External Libraries中找到以下路径
pom.xml中传递了autoconfigure依赖
在该依赖中可以找到spring.properties文件
进入该文件我们找到了指向的类MybatisAutoConfiguration
3. 在MybatisAutoAutoConfiguration中:
@Configuration
@ConditionalOnClass({SqlSessionFactory.class, SqlSessionFactoryBean.class})
@ConditionalOnSingleCandidate(DataSource.class)
@EnableConfigurationProperties({MybatisProperties.class})
@AutoConfigureAfter({DataSourceAutoConfiguration.class, MybatisLanguageDriverAutoConfiguration.class})
该类中的注解的功能:
@Configuration 标记该类是一个配置类
@ConditionalOnClass 条件开关,类路径上存在SqlSessionFactory、SqlSessionFactoryBean这两个类的时候启动配置
@ConditionalOnSingleCandidate 要求有一个DataSource的Bean
@EnableConfigurationProperties 启动配置属性,关联了一个配置属性类
@AutoConfigureAfter 指定在某些自动配置类之后执行自动配置
DataSourceAutoConfiguration.class 提供数据源
该类有一个属性:通过构造器给属性赋值
private final MybatisProperties properties;
本类中有一个方法,该方法创建了一个SqlSessionFactory,并且注册成spring的Bean。此时spring和mybatis的集成就完成了。
@Bean
@ConditionalOnMissingBean
public SqlSessionFactory sqlSessionFactory(DataSource dataSource)
该方法通过properties属性获取外化配置文件的参数完成项目配置
4. 在AutoConfiguration中关联的配置属性类MybatisProperties.class中,有一个注解,参数对应外化配置文件的key的prefix(前缀)
@ConfigurationProperties(
prefix = "mybatis"
)
public class MybatisProperties
外化配置文件的配置的key和AutoConfiguration类的属性进行映射。
此时,自动配置框架获取到了需要的属性和参数,就能完成spring-boot的自动配置了。具体的路径是:
META-INF/spring.factories --》 MybatisAutoConfigraution --》 MybatisPropeties (prefix) --》 application.yml里的mybatis开头的所有配置
其中:MybatisAutoConfigraution:负责自动配置;MybatisPropeties:存储外化配置数据。