SpringBoot中自動(dòng)配置與條件裝配原理詳解
適合用過(guò) Spring Boot、寫(xiě)過(guò) @Configuration、但在碰到"為什么這個(gè)自動(dòng)配置沒(méi)生效"時(shí)一臉茫然的開(kāi)發(fā)者。不適合剛學(xué) Spring 第一天的新手。
"Spring Boot 的核心就是自動(dòng)配置"——這句話我聽(tīng)過(guò)不下二十遍。但直到有一天排查一個(gè)詭異的 bug:引入了一個(gè)數(shù)據(jù)源的 starter,啟動(dòng)時(shí)配置類沒(méi)被執(zhí)行,數(shù)據(jù)源根本沒(méi)創(chuàng)建。當(dāng)時(shí)除了斷點(diǎn)調(diào)試也別無(wú)他法,但斷點(diǎn)打哪里呢?自動(dòng)配置類什么時(shí)候被加載的?條件判斷為什么沒(méi)通過(guò)?
說(shuō)實(shí)話,用了四五年 Spring Boot,我自認(rèn)對(duì)它的理解停留在"配置中心 + starter"的層面。直到翻了一遍 AutoConfigurationImportSelector 的源碼,才真正明白自動(dòng)配置是怎么"自動(dòng)"的。
從 @SpringBootApplication 說(shuō)起
// org.springframework.boot.autoconfigure.SpringBootApplication.java
@Target(ElementType.TYPE)
@Retention(RetentionPolicy.RUNTIME)
@Documented
@Inherited
@SpringBootConfiguration
@EnableAutoConfiguration // ← 關(guān)鍵
@ComponentScan(excludeFilters = ...)
public @interface SpringBootApplication {
// ...
}
@SpringBootApplication 是三個(gè)注解的合成體,但起自動(dòng)配置作用的是 @EnableAutoConfiguration。
// org.springframework.boot.autoconfigure.EnableAutoConfiguration.java
@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 把它用到了極致——通過(guò) ImportSelector 接口,可以在運(yùn)行時(shí)動(dòng)態(tài)決定要導(dǎo)入哪個(gè)配置類。這在 Spring 4.x 之前只能靠 XML 或者 context:component-scan 做到。
// org.springframework.context.annotation.ImportSelector.java
// ——運(yùn)行時(shí)決定導(dǎo)入哪個(gè)配置類
public interface ImportSelector {
String[] selectImports(AnnotationMetadata importingClassMetadata);
}
@Import 在處理時(shí)會(huì)調(diào)用 ImportSelector.selectImports(),返回的類名數(shù)組會(huì)被注冊(cè)成 BeanDefinition。這就是自動(dòng)配置的入口。
AutoConfigurationImportSelector 的執(zhí)行流程
// org.springframework.boot.autoconfigure.AutoConfigurationImportSelector.java
// ——自動(dòng)配置的核心選擇器(極度精簡(jiǎn))
public class AutoConfigurationImportSelector
implements DeferredImportSelector, BeanClassLoaderAware, ... {
@Override
public String[] selectImports(AnnotationMetadata annotationMetadata) {
if (!isEnabled(annotationMetadata)) {
return NO_IMPORTS;
}
// 1. 獲取所有自動(dòng)配置項(xiàng)
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<String> configurations = getCandidateConfigurations(annotationMetadata,
getSpringFactoriesLoaderFactoryClass());
// 2. 去重
configurations = removeDuplicates(configurations);
// 3. 按 @AutoConfigureOrder、@AutoConfigureAfter、@AutoConfigureBefore 排序
configurations = sort(configurations);
// 4. 根據(jù) exclude 過(guò)濾
Set<String> exclusions = getExclusions(annotationMetadata, exclusions);
configurations.removeAll(exclusions);
// 5. 條件過(guò)濾!——根據(jù) @Conditional 系列注解判斷
configurations = filter(configurations, autoConfigurationMetadata);
return new AutoConfigurationEntry(configurations, exclusions);
}
}
整個(gè)流程清晰:
讀取配置文件 → 去重 → 排序 → 排除 → 條件過(guò)濾 → 注冊(cè)為 BeanDefinition
配置文件的進(jìn)化
在 Spring Boot 2.7 之前,自動(dòng)配置項(xiàng)寫(xiě)在 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 開(kāi)始換成獨(dú)立的文件:
# 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
說(shuō)實(shí)話,這個(gè)改動(dòng)挺實(shí)在的——spring.factories 是個(gè)大雜燴,什么都能往里塞。換成 .imports 文件之后,自動(dòng)配置的列表單獨(dú)管理,也方便 Spring Boot 做編譯時(shí)優(yōu)化。
我看了下 JDK 的實(shí)現(xiàn),Spring Boot 通過(guò) SpringFactoriesLoader 加載這些文件:
// org.springframework.core.io.support.SpringFactoriesLoader.java
// ——加載 META-INF/spring/*.imports 文件
public static List<String> loadFactoryNames(Class<?> factoryType, @Nullable ClassLoader classLoader) {
String factoryTypeName = factoryType.getName();
return loadSpringFactories(classLoader).getOrDefault(factoryTypeName, Collections.emptyList());
}
@Conditional 條件裝配:自動(dòng)配置的靈魂
如果自動(dòng)配置只是讀配置、注冊(cè) Bean,那跟 Spring 3.x 的 @Import 沒(méi)區(qū)別。真正的"自動(dòng)"在于條件判斷。
// org.springframework.context.annotation.Conditional.java
@Target({ElementType.TYPE, ElementType.METHOD})
@Retention(RetentionPolicy.RUNTIME)
@Documented
public @interface Conditional {
Class<? extends Condition>[] value();
}
Spring Boot 內(nèi)置了十幾個(gè)條件注解:
| 注解 | 判斷條件 |
|---|---|
@ConditionalOnClass | classpath 中有指定類 |
@ConditionalOnMissingClass | classpath 中無(wú)指定類 |
@ConditionalOnBean | 容器已有指定 Bean |
@ConditionalOnMissingBean | 容器無(wú)指定 Bean |
@ConditionalOnProperty | 指定屬性存在且有特定值 |
@ConditionalOnResource | 指定資源文件存在 |
@ConditionalOnWebApplication | 當(dāng)前是 Web 應(yīng)用 |
@ConditionalOnNotWebApplication | 當(dāng)前不是 Web 應(yīng)用 |
@ConditionalOnExpression | SpEL 表達(dá)式為 true |
@ConditionalOnJava | Java 版本滿足條件 |
@ConditionalOnJndi | JNDI 資源存在 |
DataSourceAutoConfiguration 的實(shí)際例子
// org.springframework.boot.autoconfigure.jdbc.DataSourceAutoConfiguration.java
@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",
havingValue = "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;
}
}
}
這個(gè)類的條件邏輯鏈非常典型:
DataSourceAutoConfiguration 生效需要:
1. classpath 有 javax.sql.DataSource(必須有 JDBC 驅(qū)動(dòng))
2. classpath 有 EmbeddedDatabaseType(不能是純 R2DBC)
3. 容器里沒(méi)有 io.r2dbc.spi.ConnectionFactory(避免沖突)
然后進(jìn)入內(nèi)部配置類:
- Generic 配置:只在 spring.datasource.type 有值時(shí)生效
- Hikari 配置:classpath 有 HikariCP 時(shí)優(yōu)先使用(matchIfMissing = true)
如果 classpath 同時(shí)有 HikariCP 和 TomcatCP?
- Hikari 配置因?yàn)?matchIfMissing=true,在沒(méi)有 spring.datasource.type 時(shí)默認(rèn)生效
- Spring Boot 官方推薦 HikariCP,默認(rèn)優(yōu)先
我調(diào)試這段代碼時(shí)發(fā)現(xiàn)了一個(gè)有趣的事:@ConditionalOnClass 的類找不到時(shí)不會(huì)報(bào)錯(cuò),只是默默地跳過(guò)這個(gè)配置。這意味著你即使往 classpath 里多塞了幾個(gè)數(shù)據(jù)源的 jar,最終只會(huì)有一個(gè) DataSource 被創(chuàng)建——其余的自動(dòng)配置都被條件絆住了。
這是我認(rèn)為 Spring Boot 自動(dòng)配置最精巧的地方:條件失敗不是異常,而是靜默跳過(guò)。 這就允許所有的 starter 無(wú)腦導(dǎo)入所有依賴,框架自己判斷哪個(gè)生效。
條件評(píng)估的"短路"策略
// org.springframework.boot.autoconfigure.condition.OnClassCondition.java
//
@Order(Ordered.HIGHEST_PRECEDENCE)
class OnClassCondition extends SpringBootCondition {
@Override
public ConditionOutcome getMatchOutcome(ConditionContext context,
AnnotatedTypeMetadata metadata) {
// 檢查 @ConditionalOnClass 和 @ConditionalOnMissingClass
// 通過(guò) ClassLoader.loadClass() 或 sun.misc.Unsafe.defineClass 判斷
}
}
Spring Boot 的 ConditionEvaluator 在評(píng)估條件時(shí)有個(gè)優(yōu)化:多個(gè) @ConditionalOnClass 條件,只要第一個(gè)不滿足就直接返回 false,不繼續(xù)判斷后面的。 這種短路策略在大量自動(dòng)配置類時(shí)能省不少時(shí)間。
自定義 Starter:一個(gè)完整的例子
理解了原理后,寫(xiě)個(gè) starter 其實(shí)就那么幾步。
my-starter/
├── src/main/java/...
│ └── MyAutoConfiguration.java // 自動(dòng)配置類
├── src/main/resources/
│ └── META-INF/spring/
│ └── org.springframework.boot.autoconfigure.AutoConfiguration.imports
└── pom.xml
// MyAutoConfiguration.java
@AutoConfiguration
@ConditionalOnClass(MyService.class)
@ConditionalOnProperty(prefix = "my.starter", name = "enabled", havingValue = "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
就這么簡(jiǎn)單。啟動(dòng) Spring Boot,只要 classpath 有這個(gè) jar + 環(huán)境變量允許,MyService 自動(dòng)創(chuàng)建好。
我覺(jué)得 Spring Boot 的 starter 機(jī)制最成功的地方不在于降低了使用門檻——它降低了框架創(chuàng)造者的門檻。以前寫(xiě)個(gè)框架要配 XML、寫(xiě)一堆集成文檔、讓用戶手動(dòng)導(dǎo)入?,F(xiàn)在一包依賴 + 一行配置,自動(dòng)搞定。
自動(dòng)配置常見(jiàn)問(wèn)題排查
1. 自動(dòng)配置沒(méi)生效
最常見(jiàn)的疑惑。"我引了 starter,為什么 Bean 沒(méi)創(chuàng)建?"
打開(kāi) debug 日志:
# application.yml debug: true
或者
logging:
level:
org.springframework.boot.autoconfigure: DEBUG然后看控制臺(tái),會(huì)輸出類似這樣的條件評(píng)估報(bào)告:
=========================
AUTO-CONFIGURATION REPORT
=========================
Positive matches:
-----------------
DataSourceAutoConfiguration matched:
- @ConditionalOnClass found required classes 'javax.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
'javax.jms.ConnectionFactory' (OnClassCondition)
Positive matches 是匹配成功的,Negative matches 是匹配失敗——會(huì)寫(xiě)明為什么失敗。這個(gè)日志是我排查自動(dòng)配置問(wèn)題的第一手段。
2. 自動(dòng)配置的優(yōu)先級(jí)問(wèn)題
有時(shí)候兩個(gè) starter 都試圖創(chuàng)建同一個(gè)類型的 Bean,誰(shuí)勝出?
Spring Boot 按這個(gè)順序決定:
@AutoConfigureOrder注解的 order 值(越小越優(yōu)先)@AutoConfigureBefore/@AutoConfigureAfter指定的順序- 默認(rèn)順序——取決于配置文件中出現(xiàn)的順序
@AutoConfiguration
@AutoConfigureBefore(DataSourceAutoConfiguration.class) // 在 DataSource 之前
@AutoConfigureAfter(JdbcTemplateAutoConfiguration.class) // 在 JdbcTemplate 之后
public class MyDataSourceConfiguration {
// ...
}
3. 條件判斷的時(shí)序問(wèn)題
@ConditionalOnBean 是個(gè)容易踩坑的點(diǎn):
@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(); }
}
因?yàn)?Spring Boot 的自動(dòng)配置類是在 @Bean 解析之前就已經(jīng)注冊(cè)到容器的,@ConditionalOnBean 的判斷是基于已經(jīng)注冊(cè)的 BeanDefinition 而不是運(yùn)行時(shí)容器。如果 A 沒(méi)有在另一個(gè)配置類中提前注冊(cè) BeanDefinition,BConfig 的條件就可能失敗。
解決方案:用 @ConditionalOnClass(基于 ClassLoader)代替,或者把 A 的優(yōu)先級(jí)提高。
從源碼看設(shè)計(jì)原則
我覺(jué)得 Spring Boot 自動(dòng)配置這部分的代碼質(zhì)量非常高,最值得學(xué)習(xí)的是它的可擴(kuò)展性和防御性設(shè)計(jì):
- 基于 SPI 的擴(kuò)展點(diǎn):
.imports文件等價(jià)于 Java 的 ServiceLoader 機(jī)制,但它支持排序、過(guò)濾和條件判斷 - 條件失敗不是異常:這是最優(yōu)雅的設(shè)計(jì)決策——不合適的配置靜默跳過(guò)
- ConfigurationClassPostProcessor:所有配置類解析都在這個(gè) BeanFactoryPostProcessor 中完成,保證在 Bean 實(shí)例化之前就完成了所有配置決策
總結(jié)
Spring Boot 自動(dòng)配置的核心就三環(huán):
- 入口:
@EnableAutoConfiguration→@Import(AutoConfigurationImportSelector.class) - 加載:讀
.imports文件,獲知所有自動(dòng)配置類的全限定名 - 過(guò)濾:通過(guò)
@Conditional條件族,只注冊(cè)滿足條件的配置類
反過(guò)來(lái),如果你是一個(gè)框架作者,想寫(xiě) starter 也就三步:
- 寫(xiě)配置類和 Bean
- 加條件注解
- 在
.imports文件中聲明
文中引用的 Spring Boot 源碼路徑:
- org.springframework.boot.autoconfigure.EnableAutoConfiguration.java
- org.springframework.boot.autoconfigure.AutoConfigurationImportSelector.java
- org.springframework.context.annotation.Conditional.java
- org.springframework.boot.autoconfigure.jdbc.DataSourceAutoConfiguration.java
- org.springframework.core.io.support.SpringFactoriesLoader.java
以上就是SpringBoot中自動(dòng)配置與條件裝配原理詳解的詳細(xì)內(nèi)容,更多關(guān)于SpringBoot自動(dòng)配置的資料請(qǐng)關(guān)注腳本之家其它相關(guān)文章!
- SpringBoot自動(dòng)配置機(jī)制從原理到實(shí)踐的深度解析
- 淺談SpringBoot自動(dòng)配置的坑
- SpringBoot自動(dòng)配置:集成ApacheKafka導(dǎo)致自動(dòng)配置未觸發(fā)
- SpringBoot自動(dòng)配置排除的五種方式
- SpringBoot自動(dòng)配置類加載順序與優(yōu)先級(jí)
- SpringBoot中自動(dòng)配置的完整啟動(dòng)流程詳解
- SpringBoot多模塊項(xiàng)目中優(yōu)雅實(shí)現(xiàn)自動(dòng)配置的完整指南
- SpringBoot Web開(kāi)發(fā)中的異常處理自動(dòng)配置原理解析
相關(guān)文章
SpringCloud實(shí)現(xiàn)基于RabbitMQ消息隊(duì)列的詳細(xì)步驟
在Spring Cloud框架中,我們可以利用RabbitMQ實(shí)現(xiàn)強(qiáng)大而可靠的消息隊(duì)列系統(tǒng),本篇將詳細(xì)介紹如何在Spring Cloud項(xiàng)目中集成RabbitMQ,并創(chuàng)建一個(gè)簡(jiǎn)單的消息隊(duì)列,感興趣的朋友一起看看吧2024-03-03
Java中@ExcelIgnoreUnannotated注解小結(jié)
本文主要介紹了Java中@ExcelIgnoreUnannotated注解小結(jié),文中通過(guò)示例代碼介紹的非常詳細(xì),對(duì)大家的學(xué)習(xí)或者工作具有一定的參考學(xué)習(xí)價(jià)值,需要的朋友們下面隨著小編來(lái)一起學(xué)習(xí)學(xué)習(xí)吧2025-08-08
Mybatis-Plus分頁(yè)的使用與注意事項(xiàng)
分頁(yè)查詢每個(gè)人程序猿幾乎都使用過(guò),下面這篇文章主要給大家介紹了關(guān)于Mybatis-Plus分頁(yè)的使用與注意事項(xiàng)的相關(guān)資料,文中通過(guò)實(shí)例代碼介紹的非常詳細(xì),需要的朋友可以參考下2022-04-04
使用springboot不自動(dòng)初始化數(shù)據(jù)庫(kù)連接池
這篇文章主要介紹了使用springboot不自動(dòng)初始化數(shù)據(jù)庫(kù)連接池,具有很好的參考價(jià)值,希望對(duì)大家有所幫助。如有錯(cuò)誤或未考慮完全的地方,望不吝賜教2021-09-09
spring集成httpclient配置的詳細(xì)過(guò)程
spring框架是一個(gè)非常強(qiáng)大的框架這里就不多說(shuō)了,那么主要是介紹spring與httpclient的整合集成過(guò)程,感興趣的朋友跟隨小編一起看看吧2021-07-07

