展开菜单
首页 精品内容 本月促销 装机必备 Windows macOS软件 IOS软件 Android AI PDF教程 专题
全部分类

当前位置:

首页 > 编程开发 > SpringBoot中自动配置与条件装配原理详解

SpringBoot中自动配置与条件装配原理详解

SpringBoot自动配置通过@EnableAutoConfiguration的@Import(AutoConfigurationImportSelector.class)实现。执行流程包括读取META-INF/spring/*.imports文件,经过去重、排序、排除和@Conditional条件过滤后注册Bean。SpringBoot2.7将自动配置列

适合用过 Spring Boot、写过 @Configuration、但在碰到"为什么这个自动配置没生效"时一脸茫然的开发者。不适合刚学 Spring 第一天的新手。

SpringBoot中自动配置与条件装配原理详解

"Spring Boot 的核心就是自动配置"——这句话在开发者圈子里流传很广。但直到有一天排查一个诡异的 bug:引入了一个数据源的 starter,启动时配置类没被执行,数据源根本没创建。当时除了断点调试也别无他法,但断点打哪里呢?自动配置类什么时候被加载的?条件判断为什么没通过?

坦白说,用了四五年 Spring Boot,很多人对它的理解停留在"配置中心 + starter"的层面。直到翻了一遍 AutoConfigurationImportSelector 的源码,才真正明白自动配置是怎么"自动"的。

从 @SpringBootApplication 说起

// org.springframework.boot.autoconfigure.SpringBootApplication.ja va
@Target(ElementType.TYPE)
@Retention(RetentionPolicy.RUNTIME)
@Documented
@Inherited
@SpringBootConfiguration
@EnableAutoConfiguration          // ← 关键
@ComponentScan(excludeFilters = ...)
public @interface SpringBootApplication {
    // ...
}

@SpringBootApplication 是三个注解的合成体,但起自动配置作用的是 @EnableAutoConfiguration

// org.springframework.boot.autoconfigure.EnableAutoConfiguration.ja va
@Target(ElementType.TYPE)
@Retention(RetentionPolicy.RUNTIME)
@Documented
@Inherited
@AutoConfigurationPackage
@Import(AutoConfigurationImportSelector.class)  // ← 核心
public @interface EnableAutoConfiguration {
    String ENABLED_OVERRIDE_PROPERTY = "spring.boot.enableautoconfiguration";
    Class[] exclude() default {};
    String[] excludeName() default {};
}

核心就一行:@Import(AutoConfigurationImportSelector.class)

@Import 这玩意儿在 Spring 3.x 就有,但 Spring Boot 把它用到了极致——通过 ImportSelector 接口,可以在运行时动态决定要导入哪个配置类。这在 Spring 4.x 之前只能靠 XML 或者 context:component-scan 做到。

// org.springframework.context.annotation.ImportSelector.ja va
// ——运行时决定导入哪个配置类
public interface ImportSelector {
    String[] selectImports(AnnotationMetadata importingClassMetadata);
}

@Import 在处理时会调用 ImportSelector.selectImports(),返回的类名数组会被注册成 BeanDefinition。这就是自动配置的入口。

AutoConfigurationImportSelector 的执行流程

// org.springframework.boot.autoconfigure.AutoConfigurationImportSelector.ja va
// ——自动配置的核心选择器(极度精简)
public class AutoConfigurationImportSelector 
    implements DeferredImportSelector, BeanClassLoaderAware, ... {
    
    @Override
    public String[] selectImports(AnnotationMetadata annotationMetadata) {
        if (!isEnabled(annotationMetadata)) {
            return NO_IMPORTS;
        }
        // 1. 获取所有自动配置项
        AutoConfigurationEntry autoConfigurationEntry = getAutoConfigurationEntry(
                annotationMetadata);
        // 2. 返回配置类的全限定名
        return StringUtils.toStringArray(autoConfigurationEntry.getConfigurations());
    }
    
    protected AutoConfigurationEntry getAutoConfigurationEntry(
            AnnotationMetadata annotationMetadata) {
        // 1. 从 META-INF/spring/org.springframework.boot.autoconfigure.
        //    AutoConfiguration.imports 读取
        List configurations = getCandidateConfigurations(annotationMetadata, 
                getSpringFactoriesLoaderFactoryClass());
        
        // 2. 去重
        configurations = removeDuplicates(configurations);
        
        // 3. 按 @AutoConfigureOrder、@AutoConfigureAfter、@AutoConfigureBefore 排序
        configurations = sort(configurations);
        
        // 4. 根据 exclude 过滤
        Set exclusions = getExclusions(annotationMetadata, exclusions);
        configurations.removeAll(exclusions);
        
        // 5. 条件过滤!——根据 @Conditional 系列注解判断
        configurations = filter(configurations, autoConfigurationMetadata);
        
        return new AutoConfigurationEntry(configurations, exclusions);
    }
}

整个流程清晰:

读取配置文件 → 去重 → 排序 → 排除 → 条件过滤 → 注册为 BeanDefinition

配置文件的进化

在 Spring Boot 2.7 之前,自动配置项写在 META-INF/spring.factories

# spring.factories(旧方案)
org.springframework.boot.autoconfigure.EnableAutoConfiguration=
org.springframework.boot.autoconfigure.web.servlet.WebMvcAutoConfiguration,
org.springframework.boot.autoconfigure.jdbc.DataSourceAutoConfiguration

Spring Boot 2.7 开始换成独立的文件:

# META-INF/spring/org.springframework.boot.autoconfigure.AutoConfiguration.imports
org.springframework.boot.autoconfigure.web.servlet.WebMvcAutoConfiguration
org.springframework.boot.autoconfigure.jdbc.DataSourceAutoConfiguration
org.springframework.boot.autoconfigure.jdbc.DataSourceTransactionManagerAutoConfiguration

说实话,这个改动挺实在的——spring.factories 是个大杂烩,什么都能往里塞。换成 .imports 文件之后,自动配置的列表单独管理,也方便 Spring Boot 做编译时优化。

查看 JDK 的实现会发现,Spring Boot 通过 SpringFactoriesLoader 加载这些文件:

// org.springframework.core.io.support.SpringFactoriesLoader.ja va
// ——加载 META-INF/spring/*.imports 文件
public static List loadFactoryNames(Class factoryType, @Nullable ClassLoader classLoader) {
    String factoryTypeName = factoryType.getName();
    return loadSpringFactories(classLoader).getOrDefault(factoryTypeName, Collections.emptyList());
}

@Conditional 条件装配:自动配置的灵魂

如果自动配置只是读配置、注册 Bean,那跟 Spring 3.x 的 @Import 没区别。真正的"自动"在于条件判断。

// org.springframework.context.annotation.Conditional.ja va
@Target({ElementType.TYPE, ElementType.METHOD})
@Retention(RetentionPolicy.RUNTIME)
@Documented
public @interface Conditional {
    Class[] value();
}

Spring Boot 内置了十几个条件注解:

注解判断条件
@ConditionalOnClassclasspath 中有指定类
@ConditionalOnMissingClassclasspath 中无指定类
@ConditionalOnBean容器已有指定 Bean
@ConditionalOnMissingBean容器无指定 Bean
@ConditionalOnProperty指定属性存在且有特定值
@ConditionalOnResource指定资源文件存在
@ConditionalOnWebApplication当前是 Web 应用
@ConditionalOnNotWebApplication当前不是 Web 应用
@ConditionalOnExpressionSpEL 表达式为 true
@ConditionalOnJa vaJa va 版本满足条件
@ConditionalOnJndiJNDI 资源存在

DataSourceAutoConfiguration 的实际例子

// org.springframework.boot.autoconfigure.jdbc.DataSourceAutoConfiguration.ja va
@AutoConfiguration
@ConditionalOnClass({ DataSource.class, EmbeddedDatabaseType.class })
@ConditionalOnMissingBean(type = "io.r2dbc.spi.ConnectionFactory")
@EnableConfigurationProperties(DataSourceProperties.class)
@Import({ DataSourcePoolMetadataProvidersConfiguration.class,
         DataSourceInitializationConfiguration.InitializationSpecificCredentialsDataSourceInitializationConfiguration.class })
public class DataSourceAutoConfiguration {
    
    @Configuration
    @ConditionalOnMissingBean(DataSource.class)
    @ConditionalOnProperty(name = "spring.datasource.type")
    static class Generic {
        @Bean
        DataSource dataSource(DataSourceProperties properties) {
            return properties.initializeDataSourceBuilder().build();
        }
    }
    
    @Configuration
    @ConditionalOnClass(HikariDataSource.class)
    @ConditionalOnMissingBean(DataSource.class)
    @ConditionalOnProperty(name = "spring.datasource.type", 
            ha vingValue = "com.zaxxer.hikari.HikariDataSource", 
            matchIfMissing = true)
    static class Hikari {
        @Bean
        @ConditionalOnMissingBean(DataSource.class)
        HikariDataSource dataSource(DataSourceProperties properties) {
            HikariDataSource ds = properties.initializeDataSourceBuilder()
                    .type(HikariDataSource.class).build();
            // ...
            return ds;
        }
    }
}

这个类的条件逻辑链非常典型:

DataSourceAutoConfiguration 生效需要:

1. classpath 有 ja vax.sql.DataSource(必须有 JDBC 驱动)

2. classpath 有 EmbeddedDatabaseType(不能是纯 R2DBC)

3. 容器里没有 io.r2dbc.spi.ConnectionFactory(避免冲突)

然后进入内部配置类:

  • Generic 配置:只在 spring.datasource.type 有值时生效
  • Hikari 配置:classpath 有 HikariCP 时优先使用(matchIfMissing = true)

如果 classpath 同时有 HikariCP 和 TomcatCP?

  • Hikari 配置因为 matchIfMissing=true,在没有 spring.datasource.type 时默认生效
  • Spring Boot 官方推荐 HikariCP,默认优先

调试这段代码时发现了一个有趣的细节:@ConditionalOnClass 的类找不到时不会报错,只是默默地跳过这个配置。这意味着你即使往 classpath 里多塞了几个数据源的 jar,最终只会有一个 DataSource 被创建——其余的自动配置都被条件绊住了。

这是自动配置最精巧的地方:条件失败不是异常,而是静默跳过。 这就允许所有的 starter 无脑导入所有依赖,框架自己判断哪个生效。

条件评估的"短路"策略

// org.springframework.boot.autoconfigure.condition.OnClassCondition.ja va
// 
@Order(Ordered.HIGHEST_PRECEDENCE)
class OnClassCondition extends SpringBootCondition {
    @Override
    public ConditionOutcome getMatchOutcome(ConditionContext context, 
            AnnotatedTypeMetadata metadata) {
        // 检查 @ConditionalOnClass 和 @ConditionalOnMissingClass
        // 通过 ClassLoader.loadClass() 或 sun.misc.Unsafe.defineClass 判断
    }
}

Spring Boot 的 ConditionEvaluator 在评估条件时有个优化:多个 @ConditionalOnClass 条件,只要第一个不满足就直接返回 false,不继续判断后面的。 这种短路策略在大量自动配置类时能省不少时间。

自定义 Starter:一个完整的例子

理解了原理后,写个 starter 其实就那么几步。

my-starter/

├── src/main/ja va/...

│ └── MyAutoConfiguration.ja va // 自动配置类

├── src/main/resources/

│ └── META-INF/spring/

│ └── org.springframework.boot.autoconfigure.AutoConfiguration.imports

└── pom.xml

// MyAutoConfiguration.ja va
@AutoConfiguration
@ConditionalOnClass(MyService.class)
@ConditionalOnProperty(prefix = "my.starter", name = "enabled", ha vingValue = "true", 
        matchIfMissing = true)
@EnableConfigurationProperties(MyProperties.class)
public class MyAutoConfiguration {
    
    @Bean
    @ConditionalOnMissingBean
    public MyService myService(MyProperties properties) {
        return new MyService(properties.getHost(), properties.getPort());
    }
}
# META-INF/spring/org.springframework.boot.autoconfigure.AutoConfiguration.imports
com.example.starter.MyAutoConfiguration

就这么简单。启动 Spring Boot,只要 classpath 有这个 jar + 环境变量允许,MyService 自动创建好。

Spring Boot 的 starter 机制最成功的地方不在于降低了使用门槛——它降低了框架创造者的门槛。以前写个框架要配 XML、写一堆集成文档、让用户手动导入。现在一包依赖 + 一行配置,自动搞定。

自动配置常见问题排查

1. 自动配置没生效

最常见的疑惑。"我引了 starter,为什么 Bean 没创建?"

打开 debug 日志:

# application.yml
debug: true

或者

logging:
  level:
    org.springframework.boot.autoconfigure: DEBUG

然后看控制台,会输出类似这样的条件评估报告:

=========================

AUTO-CONFIGURATION REPORT

=========================

Positive matches:

-----------------

DataSourceAutoConfiguration matched:

- @ConditionalOnClass found required classes 'ja vax.sql.DataSource',

'org.springframework.jdbc.datasource.embedded.EmbeddedDatabaseType'

(OnClassCondition)

- @ConditionalOnMissingBean (types: io.r2dbc.spi.ConnectionFactory)

did not find any beans (OnBeanCondition)

Negative matches:

-----------------

ActiveMQAutoConfiguration:

Did not match:

- @ConditionalOnClass did not find required class

'ja vax.jms.ConnectionFactory' (OnClassCondition)

Positive matches 是匹配成功的,Negative matches 是匹配失败——会写明为什么失败。这个日志是排查自动配置问题的第一手段。

2. 自动配置的优先级问题

有时候两个 starter 都试图创建同一个类型的 Bean,谁胜出?

Spring Boot 按这个顺序决定:

  1. @AutoConfigureOrder 注解的 order 值(越小越优先)
  2. @AutoConfigureBefore / @AutoConfigureAfter 指定的顺序
  3. 默认顺序——取决于配置文件中间出现的顺序
@AutoConfiguration
@AutoConfigureBefore(DataSourceAutoConfiguration.class)  // 在 DataSource 之前
@AutoConfigureAfter(JdbcTemplateAutoConfiguration.class)   // 在 JdbcTemplate 之后
public class MyDataSourceConfiguration {
    // ...
}

3. 条件判断的时序问题

@ConditionalOnBean 是个容易踩坑的点:

@Configuration
public class AConfig {
    @Bean
    public A a() { return new A(); }
}

@Configuration
@ConditionalOnBean(A.class)
public class BConfig {
    @Bean
    public B b() { return new B(); }
}

因为 Spring Boot 的自动配置类是在 @Bean 解析之前就已经注册到容器的,@ConditionalOnBean 的判断是基于已经注册的 BeanDefinition 而不是运行时容器。如果 A 没有在另一个配置类中提前注册 BeanDefinition,BConfig 的条件就可能失败。

解决方案:用 @ConditionalOnClass(基于 ClassLoader)代替,或者把 A 的优先级提高。

从源码看设计原则

Spring Boot 自动配置这部分的代码质量非常高,最值得学习的是它的可扩展性和防御性设计

  1. 基于 SPI 的扩展点.imports 文件等价于 Ja va 的 ServiceLoader 机制,但它支持排序、过滤和条件判断
  2. 条件失败不是异常:这是最优雅的设计决策——不合适的配置静默跳过
  3. ConfigurationClassPostProcessor:所有配置类解析都在这个 BeanFactoryPostProcessor 中完成,保证在 Bean 实例化之前就完成了所有配置决策

总结

Spring Boot 自动配置的核心就三环:

  1. 入口@EnableAutoConfiguration@Import(AutoConfigurationImportSelector.class)
  2. 加载:读 .imports 文件,获知所有自动配置类的全限定名
  3. 过滤:通过 @Conditional 条件族,只注册满足条件的配置类

反过来,如果你是一个框架作者,想写 starter 也就三步:

  1. 写配置类和 Bean
  2. 加条件注解
  3. .imports 文件中声明

文中引用的 Spring Boot 源码路径:

  • org.springframework.boot.autoconfigure.EnableAutoConfiguration.ja va
  • org.springframework.boot.autoconfigure.AutoConfigurationImportSelector.ja va
  • org.springframework.context.annotation.Conditional.ja va
  • org.springframework.boot.autoconfigure.jdbc.DataSourceAutoConfiguration.ja va
  • org.springframework.core.io.support.SpringFactoriesLoader.ja va
本文内容来源于互联网,如有侵权请联系删除。
作者最新文章
编程开发
相关文章 更多
精品专题 更多
本月促销

正软商城本月促销专区,汇集办公、设计、安全、影音、系统工具及AI软件等正版软件优惠活动,提供限时折扣、特价授权和优惠购买信息,活动库存及价格以页面实时展示为准。

装机必备

正软商城装机必备专区,精选办公、浏览器、安全防护、影音播放、压缩解压、设计创作和系统工具等电脑常用正版软件,帮助用户快速完成新电脑软件配置。

Windows

正软商城Windows软件专区,汇集适用于Windows电脑的办公、设计、安全防护、影音播放、开发工具和系统优化软件,提供软件介绍、系统要求、正版授权及购买下载服务。

macOS软件

正软商城macOS软件专区,精选适用于Mac电脑的办公、设计、影音、效率、开发和系统工具,提供软件功能介绍、macOS兼容版本、正版授权及购买下载服务。

IOS软件

正软商城iOS软件专区,精选适用于iPhone和iPad的办公、学习、影音、设计、效率及AI应用,提供功能介绍、适用设备、系统要求和正版获取方式等信息。

AI

正软商城AI软件专区,汇集AI写作、AI绘画、AI视频、AI办公、AI编程、AI翻译、智能客服和数据分析等人工智能工具,提供功能介绍、适用平台、收费方式及正版购买信息。

PDF教程

正软商城PDF教程频道提供PDF编辑、转换、合并、拆分、压缩及格式处理方法,同时介绍常用PDF软件和工具的使用技巧。

Mac软件 更多
灵活计算器
灵活计算器

灵活计算器是一款笔记式算数应用,支持实时计算、动态关联和云端同步功能。记录、整理和输出之间的过渡会更自然,适合长期写作、做笔记或持续沉淀个人内容。

赤友清理大师
赤友清理大师

赤友清理大师是一款为 Mac 设计的智能清理优化工具,可精准扫描垃圾、大文件、重复文件等,释放磁盘空间。做扫描整理、文字提取和表格转换时,它能把识别后的处理步骤接得更顺,资料录入这类场景会省下不少时间。

极度公式
极度公式

极度公式是一款跨平台专业LaTeX公式识别编辑软件,支持OCR公式识别和多平台编辑。和使用说明,避免使用,享受完整功能与稳定支持。做扫描整理、文字提取和表格转换时,它能把识别后的处理步骤接得更顺,资料录入这类场景会省下不少时间。

图几
图几

图几是一款适用于 macOS 的截图、标注与美化工具,支持离线操作保障隐私。界面整理和高频系统操作被放到一起考虑,桌面或窗口内容一多时,管理起来会更省心。

密码键盘
密码键盘

密码键盘是一款兼具安全性与便捷性的高效密码管理器。日常使用里的持续防护和信息管理会更突出,适合把安全控制放进长期使用流程中的场景。

思源笔记
思源笔记

思源笔记是一款本地笔记软件,提供所见即所得的编辑方式,为长文写作带来顺滑的体验。记录、整理和输出之间的过渡会更自然,适合长期写作、做笔记或持续沉淀个人内容。

Office 365 简体中文
Office 365 简体中文

一款文字处理软件,一种订阅式的跨平台办公软件,基于云平台提供多种服务,通过将 Excel 和 Outlook 等应用与 OneDrive 和 Microsoft Teams 等强大的云服务相结合,Office 365 可让任何人使用任何设备随时随地创建和共享内容。

WALTR PRO
WALTR PRO

WALTR是一款电脑至iOS文件传输转换工具,操作简单,快速实现文件识别与传送。做扫描整理、文字提取和表格转换时,它能把识别后的处理步骤接得更顺,资料录入这类场景会省下不少时间。

CodeExpander
CodeExpander

CodeExpander 是一款快捷短语输入增强工具,通过键入缩写自动展开为自定义文段,提升工作效率。任务管理和过程控制会更完整,持续下载、批量同步或需要稳定传输流程的场景会更适合它。

Mountain Duck
Mountain Duck

Mountain Duck 是一款能将多个网盘挂载到本地的工具,像本地磁盘一样使用网盘。清理链路的完整性会更好一些,做应用卸载、残留处理和空间整理时,通常能少走很多手动排查步骤。

Menuist
Menuist

Menuist 是一款面向 macOS 的 Finder 右键菜单增强工具,主要用来补充新建文件、快捷导航等常用操作,让日常文件管理和访问路径时更高效、更顺手。

Mole
Mole

Mole 是一款专为 Mac 设计的深度清理优化工具,涵盖缓存清理、应用管理及实时状态监控等功能。清理链路的完整性会更好一些,做应用卸载、残留处理和空间整理时,通常能少走很多手动排查步骤。

WINDOWS 更多
Windows 10
Windows 10

Windows 10 是一款微软推出的经典操作系统,拥有硬件兼容性与多任务处理能力。它更偏向把系统状态查看和常用调节动作放在一起,适合需要持续观察和微调设备状态的场景。

极度公式
极度公式

极度公式是一款跨平台专业LaTeX公式识别编辑软件,支持OCR公式识别和多平台编辑。和使用说明,避免使用,享受完整功能与稳定支持。做扫描整理、文字提取和表格转换时,它能把识别后的处理步骤接得更顺,资料录入这类场景会省下不少时间。

密码键盘
密码键盘

密码键盘是一款兼具安全性与便捷性的高效密码管理器。日常使用里的持续防护和信息管理会更突出,适合把安全控制放进长期使用流程中的场景。

思源笔记
思源笔记

思源笔记是一款本地笔记软件,提供所见即所得的编辑方式,为长文写作带来顺滑的体验。记录、整理和输出之间的过渡会更自然,适合长期写作、做笔记或持续沉淀个人内容。

傲梅轻松备份
傲梅轻松备份

傲梅轻松备份是一款专业易用的数据备份软件,为重要数据提供安全保障。日常使用里的持续防护和信息管理会更突出,适合把安全控制放进长期使用流程中的场景。

Office 365 简体中文
Office 365 简体中文

一款文字处理软件,一种订阅式的跨平台办公软件,基于云平台提供多种服务,通过将 Excel 和 Outlook 等应用与 OneDrive 和 Microsoft Teams 等强大的云服务相结合,Office 365 可让任何人使用任何设备随时随地创建和共享内容。

Wise Folder Hider Pro
Wise Folder Hider Pro

Wise Folder Hider Pro 是一款专业级文件和文件夹隐藏加密软件,为私密数据添加多重保护。高频操作更强调就近处理,浏览、整理和跨目录移动文件时,来回切换和重复点击都会少很多。

WALTR PRO
WALTR PRO

WALTR是一款电脑至iOS文件传输转换工具,操作简单,快速实现文件识别与传送。做扫描整理、文字提取和表格转换时,它能把识别后的处理步骤接得更顺,资料录入这类场景会省下不少时间。

CodeExpander
CodeExpander

CodeExpander 是一款快捷短语输入增强工具,通过键入缩写自动展开为自定义文段,提升工作效率。任务管理和过程控制会更完整,持续下载、批量同步或需要稳定传输流程的场景会更适合它。

PinStack
PinStack

PinStack是一款轻量级的Windows平台剪贴板管理工具,优化您的剪贴板使用体验。它更偏向把系统状态查看和常用调节动作放在一起,适合需要持续观察和微调设备状态的场景。

Mountain Duck
Mountain Duck

Mountain Duck 是一款能将多个网盘挂载到本地的工具,像本地磁盘一样使用网盘。清理链路的完整性会更好一些,做应用卸载、残留处理和空间整理时,通常能少走很多手动排查步骤。

Seer
Seer

Seer是一款在Win平台下的空格键功能增强效率工具,只需轻敲空格键,就能预览几乎任何格式的文件。它更适合把零散的小功能集中起来使用,处理高频琐碎任务时会更省事。