Spring Boot 2.x 自动配置原理解析

最新推荐文章于 2025-03-22 01:47:58 发布

Delete丶94

最新推荐文章于 2025-03-22 01:47:58 发布

阅读量810

点赞数 1

分类专栏： SpringBoot 文章标签： SpringBoot SpringBoot自动配置

本文链接：https://blog.youkuaiyun.com/qq_42459181/article/details/90899512

版权

SpringBoot 专栏收录该内容

1 篇文章

订阅专栏

一、导语

自从Spring Boot问世以来，就饱受开发人员的喜爱，它的出现是一次革命，让Java开发者们从Spring繁琐的配置中解放了出来，约定优于配置的理念深入人心！

二、@SpringBootApplication 注解

首先，一切的源头在 @SpringBootApplication这个注解，进入此注解：
在这里插入图片描述
注解说明：
1.@Target：定义了此注解修饰的对象(注解)范围。范围取值源于ElementType此枚举类。此处的含义是：被@Target修饰的@SpringBootApplication注解，只能修饰类、接口或枚举类。
2.@Retention：定义了被此注解修饰的注解的生命周期。取值源于RetentionPolicy此枚举类。当取值为RetentionPolicy.SOURCE时，被该注解修饰的注解(此处为@SpringBootApplication)保留在源文件中，编译时会被丢弃；当取值为RetentionPolicy.CLASS时，被该注解修饰的注解保留在编译后的class文件，但JVM加载class文件时会丢弃；当取值为RetentionPolicy.RUNTIME时，被该注解修饰的注解不仅保留在class文件中，也保留在JVM加载后的环境中(内存中的字节码)。
3.@Documented：被此注解修饰的注解，其信息可以被保留在Javadoc里面。
4.@Inherited：允许子类继承父类的注解。举例说明，@Inherited修饰@SpringBootApplication，@SpringBootApplication修饰类Foo，Child类继承Foo类，那么Child类就相当于被@SpringBootApplication注解所修饰了。
5.@SpringBootConfiguration：此注解继承自@Configuration，用法基本一样，被此注解修饰的类是一个配置类，可以在类里用@Bean方式注入一些第三方的类。
6.@EnableAutoConfiguration：此注解是本次分析SpringBoot自动配置的重点，下面会详细说明，故在此不再赘述。
7.@ComponentScan：扫描符合规则的类并将其注入到Spring容器里(IOC)。其扫描路径可配置，默认是扫描被此注解修饰的类的包及其子包，所以SpringBoot的启动类一般都放在最高级包路径下。此处还配置了excludeFilters，即排除过滤条件，继承TypeExcludeFilter和AutoConfigurationExcludeFilter的类，不被扫描。详解请自行学习，此处不赘述。

三、@EnableAutoConfiguration 注解

在这里插入图片描述
此处重点在于：@Import(AutoConfigurationImportSelector.class)
1.@Import：笼统点说就是把符合条件的类注入到Spring容器里(IOC)。三种方式：1.直接注入；2.实现 ImportBeanDefinitionRegistrar 接口注入；3.实现 ImportSelector 注入，此处的AutoConfigurationImportSelector就是实现了ImportSelector的实现类。

接下来，我们进入到AutoConfigurationImportSelector这个类里面，重点关注selectImports这个方法：

@Override
	public String[] selectImports(AnnotationMetadata annotationMetadata) {
		if (!isEnabled(annotationMetadata)) {
			return NO_IMPORTS;
		}
		// 步骤一：读取 META-INF/spring-autoconfigure-metadata.properties文件,
		// 先筛选一下要加载哪些配置类,再把符合条件配置类的信息封装到AutoConfigurationMetadata
		AutoConfigurationMetadata autoConfigurationMetadata = AutoConfigurationMetadataLoader
				.loadMetadata(this.beanClassLoader);
		// 步骤二：读取 META-INF/spring.factories文件，把其信息封装到
		// AutoConfigurationEntry里,再将步骤一获取的配置类与此处获取的配置类
		// 执行过滤、去重、排序等操作，保存满足条件的配置类
		AutoConfigurationEntry autoConfigurationEntry = getAutoConfigurationEntry(
				autoConfigurationMetadata, annotationMetadata);
		// 返回满足自动配置条件的类的字符串数组，后交给@Import注解，将其注入到Spring容器中，
		// 至此，完成SpringBoot的自动配置！
		return StringUtils.toStringArray(autoConfigurationEntry.getConfigurations());
	}

步骤一、步骤二详解见本文四、五

四、spring-autoconfigure-metadata.properties文件

其位置：spring-boot-autoconfigure-2.1.3.RELEASE.jar/META-INF/spring-autoconfigure-metadata.properties

其内容：

#Fri Feb 15 10:11:26 GMT 2019
org.springframework.boot.autoconfigure.security.servlet.SecurityFilterAutoConfiguration.AutoConfigureAfter=org.springframework.boot.autoconfigure.security.servlet.SecurityAutoConfiguration
org.springframework.boot.autoconfigure.data.cassandra.CassandraDataAutoConfiguration.Configuration=
org.springframework.boot.autoconfigure.data.neo4j.Neo4jBookmarkManagementConfiguration.Configuration=
org.springframework.boot.autoconfigure.kafka.KafkaAutoConfiguration=
org.springframework.boot.autoconfigure.kafka.KafkaAnnotationDrivenConfiguration.Configuration=
org.springframework.boot.autoconfigure.session.SessionAutoConfiguration.ConditionalOnClass=org.springframework.session.Session
......略

其作用：此properties文件其实封装了许多配置类生效的条件。
举例说明：

   org.springframework.boot.autoconfigure.kafka.KafkaAutoConfiguration=

扫描到这行代码时，SpringBoot要自动配置KafkaAutoConfiguration，但是是有条件的，我们进入到KafkaAutoConfiguration中：
在这里插入图片描述
可以看到这个注解：

@ConditionalOnClass(KafkaTemplate.class)

也就是说在KafkaTemplate这个类的class文件出现在classpath时(在JVM运行环境下被加载)才会加载KafkaAutoConfiguration!

当然有些条件会显式地写在META-INF/spring-autoconfigure-metadata.properties中，如：

... SessionAutoConfiguration.ConditionalOnClass=org.springframework.session.Session

五、spring.factories文件

其位置：spring-boot-autoconfigure-2.1.3.RELEASE.jar/META-INF/spring.factories
其内容：

# Auto Configure
org.springframework.boot.autoconfigure.EnableAutoConfiguration=\
org.springframework.boot.autoconfigure.admin.SpringApplicationAdminJmxAutoConfiguration,\
org.springframework.boot.autoconfigure.aop.AopAutoConfiguration,\
org.springframework.boot.autoconfigure.amqp.RabbitAutoConfiguration,\
org.springframework.boot.autoconfigure.batch.BatchAutoConfiguration,\
org.springframework.boot.autoconfigure.cache.CacheAutoConfiguration,\
org.springframework.boot.autoconfigure.cassandra.CassandraAutoConfiguration,\
org.springframework.boot.autoconfigure.cloud.CloudServiceConnectorsAutoConfiguration,\
org.springframework.boot.autoconfigure.context.ConfigurationPropertiesAutoConfiguration...省略

其作用：此文件中有那么多xxxAutoConfiguration，那么Spring怎么知道我们需要加载哪些呢？
举个例子，看其中一条配置：

   org.springframework.boot.autoconfigure.aop.AopAutoConfiguration

进入到AopAutoConfiguration类中：
在这里插入图片描述
于是，我们又看到了熟悉的@ConditionalOnXXX注解，这个AopAutoConfiguration类加载不加载完全由@ConditionalOnXXX注解们来控制！下面详细分析下加载条件：

  @ConditionalOnProperty(prefix = "spring.aop", name = "auto", havingValue = "true", matchIfMissing = true)

解析：在我们自己工程的application.properties里，有spring.aop.auto=true时加载AopAutoConfiguration。但是缺少spring.aop.auto=true时，也可继续验证(matchIfMissing = true)，并不直接放弃加载。

  @ConditionalOnClass({ EnableAspectJAutoProxy.class, Aspect.class, Advice.class,AnnotatedElement.class })

解析：在JVM运行时加载了EnableAspectJAutoProxy、Aspect、Advice、AnnotatedElement这些类后，才加载AopAutoConfiguration。

六、总结

SpringBoot的自动配置，不仅仅是依赖SpringBoot本身，它还依赖了Spring的相关功能(诸如@ConditionalOnXXX都是Spring里的注解)，由于本文写的还比较仓促，有时间再来完善补充。