【SpringBoot系列-02】自动配置机制源码剖析
【SpringBoot系列-02】自动配置机制源码剖析
咱们天天用Spring Boot,一个@SpringBootApplication注解扔进去,啥配置都不用写,项目就跑起来了。你有没有过这种疑惑:那些DispatcherServlet、DataSource是从哪冒出来的?今天咱们就扒开自动配置的底裤,看看Spring Boot到底在背后干了些啥。
1. @EnableAutoConfiguration工作原理:自动配置的"总开关"
咱们先看启动类上的@SpringBootApplication,点进去瞅瞅(用Ctrl+鼠标点,IDE都支持这操作):
@Target(ElementType.TYPE)
@Retention(RetentionPolicy.RUNTIME)
@Documented
@Inherited
@SpringBootConfiguration
@EnableAutoConfiguration // 重点在这
@ComponentScan(excludeFilters = { @ComponentScan.Filter(type = FilterType.CUSTOM, classes = TypeExcludeFilter.class),@ComponentScan.Filter(type = FilterType.CUSTOM, classes = AutoConfigurationExcludeFilter.class)
})
public @interface SpringBootApplication { // 排除特定的自动配置类@AliasFor(annotation = EnableAutoConfiguration.class)Class<?>[] exclude() default {};@AliasFor(annotation = EnableAutoConfiguration.class)String[] excludeName() default {};
}
这注解就是个"组合拳",真正负责自动配置的是@EnableAutoConfiguration。再点进去看:
@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,这哥们就是自动配置的"搬运工"。简单说,它的作用就是:从一堆配置类里挑出符合条件的,塞给Spring容器。
自动配置整体流程图
调试小技巧:
- 启动时在AutoConfigurationImportSelector的selectImports()方法打个断点,观察返回的String[]数组
- 添加VM参数
-Ddebug
或在配置文件设置debug=true
,查看控制台的自动配置报告 - 使用Spring Boot Actuator的
/actuator/conditions
端点查看条件评估报告
2. AutoConfigurationImportSelector源码解析:配置类的"筛选器"
这哥们的核心方法是selectImports(),咱们看关键代码:
@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) {if (!isEnabled(annotationMetadata)) {return EMPTY_ENTRY;}// 获取@EnableAutoConfiguration注解的属性AnnotationAttributes attributes = getAttributes(annotationMetadata);// 获取候选配置类(重点!)List<String> configurations = getCandidateConfigurations(annotationMetadata, attributes);// 去重configurations = removeDuplicates(configurations);// 获取需要排除的配置类Set<String> exclusions = getExclusions(annotationMetadata, attributes);checkExcludedClasses(configurations, exclusions);configurations.removeAll(exclusions);// 应用过滤器(Spring Boot 2.x后新增的机制)configurations = getConfigurationClassFilter().filter(configurations);// 触发自动配置导入事件fireAutoConfigurationImportEvents(configurations, exclusions);return new AutoConfigurationEntry(configurations, exclusions);
}
配置类筛选流程图
重点看getCandidateConfigurations()方法
protected List<String> getCandidateConfigurations(AnnotationMetadata metadata, AnnotationAttributes attributes) {List<String> configurations = new ArrayList<>();// 1. 从新位置加载(META-INF/spring/org.springframework.boot.autoconfigure.AutoConfiguration.imports)configurations.addAll(ImportCandidates.load(AutoConfiguration.class, getBeanClassLoader()).getCandidates());// 2. 为了兼容,仍然从spring.factories加载configurations.addAll(SpringFactoriesLoader.loadFactoryNames(getSpringFactoriesLoaderFactoryClass(), getBeanClassLoader()));return configurations;
}
3. 条件注解处理器实现原理:配置类的"门禁卡"
光把配置类捞出来还不够,得看它们能不能生效。这就轮到@Conditional家族出场了。
条件注解家族关系图
咱们以@ConditionalOnClass为例,看看它的源码:
@Target({ElementType.TYPE, ElementType.METHOD})
@Retention(RetentionPolicy.RUNTIME)
@Documented
@Conditional(OnClassCondition.class) // 关键:指定了条件处理器
public @interface ConditionalOnClass {Class<?>[] value() default {};String[] name() default {}; // 支持字符串类名,避免强依赖
}
真正干活的是OnClassCondition类:
@Order(Ordered.HIGHEST_PRECEDENCE) // 优先级最高,最先执行
class OnClassCondition extends FilteringSpringBootCondition {@Overrideprotected final ConditionOutcome[] getOutcomes(String[] autoConfigurationClasses,AutoConfigurationMetadata autoConfigurationMetadata) {// 批量处理,提高性能ConditionOutcome[] outcomes = new ConditionOutcome[autoConfigurationClasses.length];for (int i = 0; i < outcomes.length; i++) {String autoConfigurationClass = autoConfigurationClasses[i];if (autoConfigurationClass != null) {// 从元数据中获取条件值Set<String> candidates = autoConfigurationMetadata.getSet(autoConfigurationClass,"ConditionalOnClass");if (candidates != null) {outcomes[i] = getOutcome(candidates);}}}return outcomes;}private ConditionOutcome getOutcome(Set<String> candidates) {try {List<String> missing = new ArrayList<>();for (String candidate : candidates) {if (!isPresent(candidate, this.beanClassLoader)) {missing.add(candidate);}}if (!missing.isEmpty()) {return ConditionOutcome.noMatch(ConditionMessage.forCondition(ConditionalOnClass.class).didNotFind("required class", "required classes").items(Style.QUOTE, missing));}} catch (Exception ex) {// ...}return ConditionOutcome.match();}
}
条件评估时机和流程
咱们自己写个条件注解试试:
// 1. 定义条件注解
@Target({ElementType.TYPE, ElementType.METHOD})
@Retention(RetentionPolicy.RUNTIME)
@Documented
@Conditional(OnSystemPropertyCondition.class)
public @interface ConditionalOnSystemProperty {String name();String value();
}// 2. 实现条件处理器
public class OnSystemPropertyCondition implements Condition {@Overridepublic boolean matches(ConditionContext context, AnnotatedTypeMetadata metadata) {Map<String, Object> attributes = metadata.getAnnotationAttributes(ConditionalOnSystemProperty.class.getName());String propertyName = (String) attributes.get("name");String expectedValue = (String) attributes.get("value");String actualValue = System.getProperty(propertyName);return expectedValue.equals(actualValue);}
}// 3. 使用条件注解
@Configuration
@ConditionalOnSystemProperty(name = "app.env", value = "production")
public class ProductionConfiguration {@Beanpublic DataSource productionDataSource() {// 生产环境数据源配置HikariDataSource dataSource = new HikariDataSource();dataSource.setMaximumPoolSize(50);return dataSource;}
}
性能优化提示:Spring Boot使用了spring-autoconfigure-metadata.properties文件来存储条件注解的元数据,这样可以在不加载类的情况下就进行条件判断,大大提升了启动速度。
4. Spring Factories加载机制:配置类的"花名册"
Spring Factories文件位置变化
让我们看看不同版本的配置文件格式:
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.context.ConfigurationPropertiesAutoConfiguration,\
org.springframework.boot.autoconfigure.context.LifecycleAutoConfiguration,\
org.springframework.boot.autoconfigure.context.MessageSourceAutoConfiguration,\
org.springframework.boot.autoconfigure.context.PropertyPlaceholderAutoConfiguration,\
org.springframework.boot.autoconfigure.couchbase.CouchbaseAutoConfiguration,\
org.springframework.boot.autoconfigure.dao.PersistenceExceptionTranslationAutoConfiguration,\
org.springframework.boot.autoconfigure.data.cassandra.CassandraDataAutoConfiguration,\
org.springframework.boot.autoconfigure.data.redis.RedisAutoConfiguration,\
org.springframework.boot.autoconfigure.data.web.SpringDataWebAutoConfiguration,\
org.springframework.boot.autoconfigure.jdbc.DataSourceAutoConfiguration,\
org.springframework.boot.autoconfigure.web.servlet.DispatcherServletAutoConfiguration,\
org.springframework.boot.autoconfigure.web.servlet.ServletWebServerFactoryAutoConfiguration,\
org.springframework.boot.autoconfigure.web.servlet.WebMvcAutoConfiguration
META-INF/spring/org.springframework.boot.autoconfigure.AutoConfiguration.imports格式:
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.jdbc.DataSourceAutoConfiguration
org.springframework.boot.autoconfigure.web.servlet.DispatcherServletAutoConfiguration
org.springframework.boot.autoconfigure.web.servlet.WebMvcAutoConfiguration
SpringFactoriesLoader加载机制的核心代码:
public final class SpringFactoriesLoader {private static final String FACTORIES_RESOURCE_LOCATION = "META-INF/spring.factories";// 缓存,避免重复加载private static final Map<ClassLoader, Map<String, List<String>>> cache = new ConcurrentReferenceHashMap<>();public static List<String> loadFactoryNames(Class<?> factoryType, @Nullable ClassLoader classLoader) {ClassLoader classLoaderToUse = classLoader;if (classLoaderToUse == null) {classLoaderToUse = SpringFactoriesLoader.class.getClassLoader();}String factoryTypeName = factoryType.getName();return loadSpringFactories(classLoaderToUse).getOrDefault(factoryTypeName, Collections.emptyList());}private static Map<String, List<String>> loadSpringFactories(ClassLoader classLoader) {Map<String, List<String>> result = cache.get(classLoader);if (result != null) {return result;}result = new HashMap<>();try {// 加载所有jar包中的spring.factories文件Enumeration<URL> urls = classLoader.getResources(FACTORIES_RESOURCE_LOCATION);while (urls.hasMoreElements()) {URL url = urls.nextElement();UrlResource resource = new UrlResource(url);Properties properties = PropertiesLoaderUtils.loadProperties(resource);for (Map.Entry<?, ?> entry : properties.entrySet()) {String factoryTypeName = ((String) entry.getKey()).trim();String[] factoryImplementationNames = StringUtils.commaDelimitedListToStringArray((String) entry.getValue());for (String factoryImplementationName : factoryImplementationNames) {result.computeIfAbsent(factoryTypeName, key -> new ArrayList<>()).add(factoryImplementationName.trim());}}}// 去重并保持原有顺序result.replaceAll((factoryType, implementations) -> implementations.stream().distinct().collect(Collectors.collectingAndThen(Collectors.toList(), Collections::unmodifiableList)));cache.put(classLoader, result);} catch (IOException ex) {throw new IllegalArgumentException("Unable to load factories from location [" +FACTORIES_RESOURCE_LOCATION + "]", ex);}return result;}
}
Spring Factories加载流程图
实战技巧:想知道哪些自动配置类生效了,可以通过以下方式:
- 启动时添加debug参数:
java -jar myapp.jar --debug
# 或者
java -Ddebug -jar myapp.jar
- 配置文件开启debug:
debug: true
# 或者只看自动配置报告
logging:level:org.springframework.boot.autoconfigure: DEBUG
- 使用Actuator端点(推荐):
<dependency><groupId>org.springframework.boot</groupId><artifactId>spring-boot-starter-actuator</artifactId>
</dependency>
访问 http://localhost:8080/actuator/conditions
查看详细的条件评估报告。
5. 自动配置顺序控制:谁先谁后有讲究
有时候配置类之间有依赖关系,需要控制加载顺序。Spring Boot提供了多种方式:
顺序控制注解关系图
举个实际的例子:
// 基础配置
@Configuration
@AutoConfigureOrder(Ordered.HIGHEST_PRECEDENCE)
public class InfrastructureAutoConfiguration {@Beanpublic ConnectionPool connectionPool() {return new HikariConnectionPool();}
}// 数据源配置(依赖基础配置)
@Configuration
@AutoConfigureAfter(InfrastructureAutoConfiguration.class)
@ConditionalOnBean(ConnectionPool.class)
public class DataSourceAutoConfiguration {@Beanpublic DataSource dataSource(ConnectionPool connectionPool) {return new PooledDataSource(connectionPool);}
}// JPA配置(依赖数据源配置)
@Configuration
@AutoConfigureAfter(DataSourceAutoConfiguration.class)
@ConditionalOnBean(DataSource.class)
public class JpaAutoConfiguration {@Beanpublic EntityManagerFactory entityManagerFactory(DataSource dataSource) {LocalContainerEntityManagerFactoryBean factory = new LocalContainerEntityManagerFactoryBean();factory.setDataSource(dataSource);return factory.getObject();}
}// MyBatis配置(也依赖数据源,但要在JPA之前)
@Configuration
@AutoConfigureAfter(DataSourceAutoConfiguration.class)
@AutoConfigureBefore(JpaAutoConfiguration.class)
@ConditionalOnBean(DataSource.class)
public class MyBatisAutoConfiguration {@Beanpublic SqlSessionFactory sqlSessionFactory(DataSource dataSource) throws Exception {SqlSessionFactoryBean factory = new SqlSessionFactoryBean();factory.setDataSource(dataSource);return factory.getObject();}
}
源码层面,这些注解是怎么起作用的?看AutoConfigurationSorter类:
class AutoConfigurationSorter {private final MetadataReaderFactory metadataReaderFactory;private final AutoConfigurationMetadata autoConfigurationMetadata;List<String> getInPriorityOrder(Collection<String> classNames) {// 1. 构建配置类的元数据final AutoConfigurationClasses classes = new AutoConfigurationClasses(this.metadataReaderFactory, this.autoConfigurationMetadata, classNames);// 2. 按字母顺序初始排序List<String> orderedClassNames = new ArrayList<>(classNames);Collections.sort(orderedClassNames);// 3. 按@AutoConfigureOrder排序orderedClassNames.sort((o1, o2) -> {int i1 = classes.get(o1).getOrder();int i2 = classes.get(o2).getOrder();return Integer.compare(i1, i2);});// 4. 按@AutoConfigureBefore和@AutoConfigureAfter排序orderedClassNames = sortByAnnotation(classes, orderedClassNames);return orderedClassNames;}private List<String> sortByAnnotation(AutoConfigurationClasses classes, List<String> classNames) {// 使用拓扑排序处理before/after依赖关系List<String> toSort = new ArrayList<>(classNames);toSort.addAll(classes.getAllNames());Set<String> sorted = new LinkedHashSet<>();Set<String> processing = new LinkedHashSet<>();while (!toSort.isEmpty()) {doSortByAfterAnnotation(classes, toSort, sorted, processing, null);}return new ArrayList<>(sorted);}
}
配置类加载顺序决策流程
重要提醒: 这三个顺序控制注解(@AutoConfigureBefore、@AutoConfigureAfter、@AutoConfigureOrder)只对自动配置类生效,即那些通过spring.factories或.imports文件加载的类。对于通过@ComponentScan扫描到的普通@Configuration类无效!
如果需要控制普通配置类的加载顺序,可以使用:
- @DependsOn:控制Bean的创建顺序
- @Order + @Configuration:在某些场景下可以控制配置类的处理顺序
- BeanFactoryPostProcessor:自定义Bean定义的处理顺序
6. 自动配置失效分析:为啥它又不干活了?
自动配置失效是开发中的常见问题,我们来系统地分析排查方法:
自动配置失效排查流程图
常见失效场景及解决方案
场景1:条件不满足
问题表现:
RedisAutoConfiguration:Did not match:- @ConditionalOnClass did not find required class 'org.springframework.data.redis.core.RedisOperations'
解决方案:
<!-- 添加必要的依赖 -->
<dependency><groupId>org.springframework.boot</groupId><artifactId>spring-boot-starter-data-redis</artifactId>
</dependency>
场景2:Bean被覆盖
问题代码:
@Configuration
public class MyDataSourceConfig {@Beanpublic DataSource dataSource() {// 自定义的DataSource会覆盖自动配置的return new HikariDataSource();}
}
解决方案:
@Configuration
public class MyDataSourceConfig {@Bean@ConditionalOnMissingBean(DataSource.class) // 添加条件,避免覆盖public DataSource customDataSource() {return new HikariDataSource();}// 或者使用@Primary指定主要的Bean@Bean@Primarypublic DataSource primaryDataSource() {return new HikariDataSource();}
}
场景3:扫描路径问题
问题代码:
@SpringBootApplication(scanBasePackages = "com.example.service") // 限制了扫描范围
public class Application {public static void main(String[] args) {SpringApplication.run(Application.class, args);}
}
解决方案:
@SpringBootApplication // 使用默认扫描(当前包及子包)
@ComponentScan(basePackages = {"com.example.service", "com.example.config"}) // 或明确指定多个包
public class Application {public static void main(String[] args) {SpringApplication.run(Application.class, args);}
}
场景4:依赖冲突
问题表现:
同时引入spring-boot-starter-web和spring-boot-starter-webflux导致WebMvcAutoConfiguration失效。
排查命令:
# Maven查看依赖树
mvn dependency:tree# Gradle查看依赖
gradle dependencies
解决方案:
<dependency><groupId>org.springframework.boot</groupId><artifactId>spring-boot-starter-webflux</artifactId><exclusions><exclusion><groupId>org.springframework.boot</groupId><artifactId>spring-boot-starter-reactor-netty</artifactId></exclusion></exclusions>
</dependency>
实用的排查工具和技巧
- 使用Spring Boot Actuator:
@RestController
@RequestMapping("/debug")
public class AutoConfigDebugController {@Autowiredprivate ConfigurableApplicationContext context;@GetMapping("/beans")public List<String> getBeans() {return Arrays.stream(context.getBeanDefinitionNames()).sorted().collect(Collectors.toList());}@GetMapping("/autoconfig/{className}")public Map<String, Object> checkAutoConfig(@PathVariable String className) {Map<String, Object> result = new HashMap<>();try {Class<?> clazz = Class.forName(className);result.put("isLoaded", context.containsBean(clazz.getSimpleName()));result.put("beanNames", context.getBeanNamesForType(clazz));} catch (ClassNotFoundException e) {result.put("error", "Class not found");}return result;}
}
- 自定义条件评估监听器:
@Component
public class ConditionEvaluationListener implements ApplicationListener<ContextRefreshedEvent> {@Overridepublic void onApplicationEvent(ContextRefreshedEvent event) {ConditionEvaluationReport report = ConditionEvaluationReport.get(event.getApplicationContext().getBeanFactory());System.out.println("=== Positive Matches ===");report.getConditionAndOutcomesBySource().entrySet().stream().filter(entry -> entry.getValue().isFullMatch()).forEach(entry -> System.out.println(entry.getKey()));System.out.println("\n=== Negative Matches ===");report.getConditionAndOutcomesBySource().entrySet().stream().filter(entry -> !entry.getValue().isFullMatch()).forEach(entry -> {System.out.println(entry.getKey() + ":");entry.getValue().forEach(condition -> System.out.println(" - " + condition.getMessage()));});}
}
- 配置文件控制:
# 排除特定的自动配置
spring:autoconfigure:exclude:- org.springframework.boot.autoconfigure.jdbc.DataSourceAutoConfiguration- org.springframework.boot.autoconfigure.orm.jpa.HibernateJpaAutoConfiguration# 或者使用环境变量
# SPRING_AUTOCONFIGURE_EXCLUDE=org.springframework.boot.autoconfigure.jdbc.DataSourceAutoConfiguration# 条件属性控制
spring:datasource:# 通过设置属性影响@ConditionalOnPropertyinitialize: falsejpa:hibernate:ddl-auto: none
7. 总结:自动配置的本质就是"约定大于配置"
通过源码分析,我们可以总结出Spring Boot自动配置的核心机制:
自动配置核心要素总结
Spring Boot自动配置的本质就是:
- 约定配置类的位置:从spring.factories或.imports文件找配置类
- 约定生效的条件:通过@Conditional系列注解控制配置类是否生效
- 约定加载的顺序:通过@AutoConfigure系列注解控制加载顺序
- 约定优于配置:提供合理的默认值,同时允许自定义覆盖
实战建议
-
开发自定义Starter时:
- 务必提供spring.factories或.imports文件
- 合理使用条件注解,避免强制依赖
- 提供配置属性类(@ConfigurationProperties)
- 编写自动配置测试类
-
遇到自动配置问题时:
- 第一时间开启debug模式查看报告
- 使用Actuator的conditions端点
- 检查依赖版本兼容性
- 查看官方文档的配置属性说明
-
性能优化时:
- 排除不需要的自动配置类
- 使用懒加载(@Lazy)
- 合理设置组件扫描范围
- 考虑使用配置类的条件化加载
动手练习
现在,让我们来完成一个自定义starter的练习:
// 1. 创建配置属性类
@ConfigurationProperties(prefix = "custom.cache")
public class CustomCacheProperties {private boolean enabled = true;private int maxSize = 1000;private long ttl = 3600;// getters and setters
}// 2. 创建自动配置类
@Configuration
@ConditionalOnClass(name = "com.github.benmanes.caffeine.cache.Caffeine")
@ConditionalOnProperty(prefix = "custom.cache", name = "enabled", havingValue = "true", matchIfMissing = true)
@EnableConfigurationProperties(CustomCacheProperties.class)
@AutoConfigureAfter(CacheAutoConfiguration.class)
public class CustomCacheAutoConfiguration {@Bean@ConditionalOnMissingBeanpublic CacheManager customCacheManager(CustomCacheProperties properties) {CaffeineCacheManager cacheManager = new CaffeineCacheManager();cacheManager.setCaffeine(Caffeine.newBuilder().maximumSize(properties.getMaxSize()).expireAfterWrite(properties.getTtl(), TimeUnit.SECONDS));return cacheManager;}
}// 3. 创建spring.factories文件
// resources/META-INF/spring.factories
org.springframework.boot.autoconfigure.EnableAutoConfiguration=\
com.example.autoconfigure.CustomCacheAutoConfiguration// 4. 创建配置元数据(可选但推荐)
// resources/META-INF/spring-configuration-metadata.json
{"properties": [{"name": "custom.cache.enabled","type": "java.lang.Boolean","defaultValue": true,"description": "Enable custom cache configuration."},{"name": "custom.cache.max-size","type": "java.lang.Integer","defaultValue": 1000,"description": "Maximum cache size."},{"name": "custom.cache.ttl","type": "java.lang.Long","defaultValue": 3600,"description": "Cache TTL in seconds."}]
}
通过这个练习,你就能真正掌握Spring Boot自动配置的精髓了!
理解了这些原理,以后再遇到自动配置相关的问题,我们就能像老中医一样,望(看日志)闻(debug断点)问(查依赖)切(改配置),轻松搞定!记住,Spring Boot的魔法并不神秘,它只是帮我们把繁琐的配置工作自动化了。掌握了原理,你也能写出优雅的自动配置代码。
有问题欢迎在评论区讨论,让我们一起深入Spring Boot的源码世界!