前言
SpringBoot比较与Spring的一大特点就是自动配置。由此我们不需要像Spring一样,需要写一大串xml配置,只需要引入依赖就可以各种零配置开箱即用。
概念
SpringBoo遵循"约定大于配置"原则,依靠注解对配置进行常规默认配置,来减少或不需要xml配置。当我们想要引入某种组件的时候,只要引入对应的starter即可。比如想要使用redis,引入redis的starter即可使用,不需要在xml上写redis配置。
<dependency>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter-data-redis</artifactId>
</dependency>
原理
@SpringBootApplication
自动配置的核心注解是@SpringBootApplication
@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 {
// ...
}
在@SpringBootAplication
中最重要的注解是@EnableAutoConfiguration
,它的作用就如同他的名字一样,开启SpringBoot自动配置。
@EnableAutoConfiguration
@Target(ElementType.TYPE)
@Retention(RetentionPolicy.RUNTIME)
@Documented
@Inherited
@AutoConfigurationPackage
@Import(AutoConfigurationImportSelector.class)
public @interface EnableAutoConfiguration {
// ...
}
而在@EnableAutoConfiguration
注解中重要的注解有两个。一个是@AutoConfigurationPackage
,它默认情况下扫描主配置类(也就是标记@SpringBootAplication
注解的类)所在的包及其自包下的组件并注册。不过这个与我们的自动配置无关,与我们有关的是:
@Import(AutoConfigurationImportSelector.class)
@Import
注解导入了AutoConfigurationImportSelector
类并使其声明为bean。
AutoConfigurationImportSelector()
AutoConfigurationImportSelector
里面有个内部类AutoConfigurationGroup
,其中有一个重要方法process()
,在这个方法中调用了getAutoConfigurationEntry()
。
getAutoConfigurationEntry()
是负责自动配置类的方法。
getAutoConfigurationEntry()
调用了getCandidateConfigurations()
在getCandidateConfigurations()
中调用了SpringFactoriesLoader.loadFactoryNames()
,注意第一个参数,getSpringFactoriesLoaderFactoryClass()返回的注解@EnableAutoConfiguration,这个是后面以及自定义starter的时候很重要的一点。
SpringFactoriesLoader.loadFactoryNames()
SpringFactoriesLoader.loadFactoryNames()
中调用了loadSpringFactories()
。loadSpringFactories()
方法以Map的形式返回缓存或者META/INF下spring.factories中所有的类名。
spring.factories和loadSpringFactories
返回内容如下:
但是并不是loadSpringFactories()
返回的类名都会自动配置,从loadFactoryNames()
中可以看到只是获取了以@EnableAutoConfiguration路径名为key的类。
// factoryType是前面要注意的传入第一个参数@EnableAutoConfiguration
String factoryTypeName = factoryType.getName();
return loadSpringFactories(classLoaderToUse).getOrDefault(factoryTypeName, Collections.emptyList());
也就是说实际可能要自动配置的类就是下面的262个(后面这262个类还会经过一次筛选,这边先不提)。
因此我们自定义一个starter的时候也需要把要自动配置的类路径下载EnableAutoConfiguration路径下。
总的来说,整的一个调用链如下:
按需配置
前面来说了,并不是所有的类名都会被自动配置。有些类的加载需要依靠其他类存在才会被加载。比如:
@Configuration
// 检查相关的类:RabbitTemplate 和 Channel是否存在
// 存在才会加载
@ConditionalOnClass({ RabbitTemplate.class, Channel.class })
@EnableConfigurationProperties(RabbitProperties.class)
@Import(RabbitAnnotationDrivenConfiguration.class)
public class RabbitAutoConfiguration {
}
@ConditionalOnXXX
是Spring提供的条件注解,只有这个注解内的条件都符合,标记的类才会被加载。
而筛选的代码就在getAutoConfigurationEntry()
中的filter()
,从下图中的debug中可以看到数量与上面的数量相比明显减少。
总结
SpringBoot通过@SpringBootApplication
中的注解@EnableAutoConfiguration
开启自动配置,通过SpringFactoriesLoader
加载META-INF/spring.factories中的自动配置类。
其他
我在一些文章中看到是依靠AutoConfigurationImportSelector
中的selectImports()
方法来实现自动加载,这个方法里也有调用getAutoConfigurationEntry()
方法。但是我自己debug的时候发现并没有进selectImports()
方法,而是AutoConfigurationGroup.process()
,所以我以自己debug所看到的为正确思路。如果有什么问题请指出,谢谢。