springboot--自动配置原理

最新推荐文章于 2025-04-16 12:21:48 发布

jarvis314159

最新推荐文章于 2025-04-16 12:21:48 发布

阅读量133

点赞数

CC 4.0 BY-SA版权

分类专栏： springboot 文章标签： spring spring boot

本文链接：https://blog.youkuaiyun.com/weixin_43283513/article/details/109827854

springboot 专栏收录该内容

21 篇文章

订阅专栏

本文解析SpringBoot项目中pom.xml配置及自动配置原理。介绍如何通过@EnableAutoConfiguration启用自动配置，以及自动配置类如何根据条件生效。

摘要生成于 C知道，由 DeepSeek-R1 满血版支持，前往体验 >

pom.xml

一个springboot项目的pom.xml中，有如下配置：

<parent>
        <groupId>org.springframework.boot</groupId>
        <artifactId>spring-boot-starter-parent</artifactId>
        <version>2.4.0</version>
        <relativePath/> 
</parent>
说明继承了父项目：spring-boot-starter-parent

<parent>
    <groupId>org.springframework.boot</groupId>
    <artifactId>spring-boot-dependencies</artifactId>
    <version>2.4.0</version>
</parent>
再次继承了spring-boot-dependencies，这个父工程中定义了核心依赖的版本:
<properties>
    <activemq.version>5.16.0</activemq.version>
    <antlr2.version>2.7.7</antlr2.version>
    <appengine-sdk.version>1.9.83</appengine-sdk.version>
    <artemis.version>2.15.0</artemis.version>
    <aspectj.version>1.9.6</aspectj.version>
    <assertj.version>3.18.1</assertj.version>
    ...
</properties>

主程序

/**
 * @SpringBootApplication : 标注这是个主程序类，声明这是个springboot引用
 */
@SpringBootApplication
public class HelloWorldMainApplication {
    public static void main(String[] args) {
        //用于Spring应用启动
        SpringApplication.run(HelloWorldMainApplication.class,args);
    }
}

@SpringBootApplication注解定义，包含了：

@SpringBootConfiguration：表示这是个springboot的配置类，该注解内部有@Configuration注解，说明主配置类也是个spring的组件
@EnableAutoConfiguration：开启自动配置功能。

@SpringBootConfiguration
@EnableAutoConfiguration
@ComponentScan(excludeFilters = { @Filter(type = FilterType.CUSTOM, classes = TypeExcludeFilter.class),
		@Filter(type = FilterType.CUSTOM, classes = AutoConfigurationExcludeFilter.class) })
public @interface SpringBootApplication {

@EnableAutoConfiguration ！！！

@AutoConfigurationPackage  
@Import(AutoConfigurationImportSelector.class) 
public @interface EnableAutoConfiguration {

@AutoConfigurationPackage： 自动扫描主应用类所在的包，并注册包下面的组件
@Import(AutoConfigurationImportSelector.class) ： 导入自动配置的选择器

1. @AutoConfigurationPackage

@Import(AutoConfigurationPackages.Registrar.class) //表示AutoConfigurationPackages.Registrar注册bean到容器
public @interface AutoConfigurationPackage {

@Import配合ImportBeanDefinitionRegistrar的方式，可以将主配置类的所在包及其下面所有子包中的所有组件扫描到spring容器中

static class Registrar implements ImportBeanDefinitionRegistrar, DeterminableImports {
		@Override
		public void registerBeanDefinitions(AnnotationMetadata metadata, BeanDefinitionRegistry registry) {
			register(registry, new PackageImports(metadata).getPackageNames().toArray(new String[0]));
		}
	}

在这里插入图片描述

2. Import(AutoConfigurationImportSelector.class)

public class AutoConfigurationImportSelector implements ... {
		@Override
	public String[] selectImports(AnnotationMetadata annotationMetadata) {
		if (!isEnabled(annotationMetadata)) {
			return NO_IMPORTS;
		}
		//这里返回自动配置
		AutoConfigurationEntry autoConfigurationEntry = getAutoConfigurationEntry(annotationMetadata);
		return StringUtils.toStringArray(autoConfigurationEntry.getConfigurations());
	}
}

AutoConfigurationImportSelector的selectImports()方法通过SpringFactoriesLoader.loadFactoryNames()扫描所有具有META-INF/spring.factories的jar包。
自动配置类都在spring-boot-autoconfigure的spring.properties文件中
在这里插入图片描述

自动配置生效
以AopAutoConfiguration为例：

@Configuration(proxyBeanMethods = false)
@ConditionalOnProperty(prefix = "spring.aop", name = "auto", havingValue = "true", matchIfMissing = true)
public class AopAutoConfiguration {

每一个XxxxAutoConfiguration自动配置类都是在某些条件之下才会生效的，这些条件的限制在Spring Boot中以注解的形式体现，常见的条件注解有如下几项：

@ConditionalOnBean：当容器里有指定的bean的条件下。
@ConditionalOnMissingBean：当容器里不存在指定bean的条件下。
@ConditionalOnClass：当类路径下有指定类的条件下。
@ConditionalOnMissingClass：当类路径下不存在指定类的条件下。
@ConditionalOnProperty：指定的属性是否有指定的值，比如@ConditionalOnProperties(prefix=”xxx.xxx”, value=”enable”, matchIfMissing=true)，代表当xxx.xxx为enable时条件的布尔值为true，如果没有设置的情况下也为true。

结论

Spring Boot启动的时候会通过@EnableAutoConfiguration注解找到META-INF/spring.factories配置文件中的所有自动配置类，并对其进行加载。
这些自动配置类都是以AutoConfiguration结尾来命名的，它实际上就是一个JavaConfig形式的Spring容器配置类
这些AutoConfiguration自动配置类，能通过以Properties结尾命名的类中取得在全局配置文件中配置的属性如：server.port，而XxxxProperties类是通@ConfigurationProperties注解与全局配置文件中对应的属性进行绑定的

参考：https://blog.youkuaiyun.com/u014745069/article/details/83820511