作为一名Java工程师,对于Spring Boot的自动装配原理进行深入的源码分析是非常有意义的。Spring Boot的自动装配机制是其独特之处,让开发者能够更加便捷地构建和部署应用程序。在这篇博文中,我们将深入探讨Spring Boot自动装配的原理,并通过阅读源代码来揭示它背后的工作机制。
1. Spring Boot自动装配简介
Spring Boot的自动装配是通过@EnableAutoConfiguration
注解实现的。当我们在Spring Boot应用中添加了该注解时,Spring Boot会根据约定大于配置的原则,自动配置一些常用的Bean和组件,从而简化开发流程。这使得开发者无需手动配置大量的Bean,而是可以直接专注于业务逻辑的实现。
2. @EnableAutoConfiguration注解解析
我们首先来看一下@EnableAutoConfiguration
注解的源码
@Target(ElementType.TYPE)
@Retention(RetentionPolicy.RUNTIME)
@Documented
@Inherited
@AutoConfigurationPackage
@Import(AutoConfigurationImportSelector.class)
public @interface EnableAutoConfiguration {
// ...
}
从源码中可以看到,@EnableAutoConfiguration
注解上使用了@Import
注解,并传入了AutoConfigurationImportSelector.class
作为参数。这意味着在使用@EnableAutoConfiguration
注解的时候,会自动导入AutoConfigurationImportSelector
类。
3. AutoConfigurationImportSelector解析
接下来我们来看一下AutoConfigurationImportSelector
类的源码:
public class AutoConfigurationImportSelector implements DeferredImportSelector, BeanClassLoaderAware,
ResourceLoaderAware, BeanFactoryAware, EnvironmentAware, Ordered {
// ...
@Override
public String[] selectImports(AnnotationMetadata annotationMetadata) {
if (!isEnabled(annotationMetadata)) {
return NO_IMPORTS;
}
AutoConfigurationMetadata autoConfigurationMetadata = AutoConfigurationMetadataLoader
.loadMetadata(this.beanClassLoader);
AutoConfigurationEntry autoConfigurationEntry = getAutoConfigurationEntry(autoConfigurationMetadata,
annotationMetadata);
return StringUtils.toStringArray(autoConfigurationEntry.getConfigurations());
}
// ...
}
在AutoConfigurationImportSelector
类中,我们可以看到selectImports
方法被重写了。在这个方法中,它首先判断是否启用了自动装配,然后加载自动配置的元数据,并获取自动配置的入口。最后,返回自动配置的类名数组。
4. 获取自动配置的入口
在AutoConfigurationImportSelector
类的selectImports
方法中,我们看到调用了getAutoConfigurationEntry
方法来获取自动配置的入口。让我们来看一下这个方法的源码:
protected AutoConfigurationEntry getAutoConfigurationEntry(AutoConfigurationMetadata autoConfigurationMetadata,
AnnotationMetadata annotationMetadata) {
if (!this.isEnabled(annotationMetadata)) {
return EMPTY_ENTRY;
}
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);
configurations = getConfigurationClassFilter().filter(configurations);
fireAutoConfigurationImportEvents(configurations, exclusions);
return new AutoConfigurationEntry(configurations, exclusions);
}
在这个方法中,首先判断是否启用了自动配置,然后通过getCandidateConfigurations
方法获取候选的自动配置类。接着,移除重复的自动配置类和已经排除的自动配置类。最后,根据一些条件对自动配置类进行过滤,并返回一个包含候选自动配置类和已排除自动配置类的AutoConfigurationEntry
对象
5. 自动装配类的加载和注册
在AutoConfigurationImportSelector
类的selectImports
方法中,最后一步返回了自动配置类的类名数组。接下来,Spring Boot会将这些自动配置类进行加载,并将其中的Bean注册到容器中。
这里触发selectImports方法是在Spring启动容器的时候触发,熟悉Spring源码的应该是很清楚,这里就不做过多的分析了,这里用一个方法的执行链路展示一下
refresh => invokeBeanFactoryPostProcessors => processConfigBeanDefinitions => parse => process
这个process方法会调用到
ConfigurationClassParser这个类的process方法
public void process() { List<DeferredImportSelectorHolder> deferredImports = this.deferredImportSelectors; this.deferredImportSelectors = null; try { if (deferredImports != null) { DeferredImportSelectorGroupingHandler handler = new DeferredImportSelectorGroupingHandler(); deferredImports.sort(DEFERRED_IMPORT_COMPARATOR); deferredImports.forEach(handler::register); handler.processGroupImports(); } } finally { this.deferredImportSelectors = new ArrayList<>(); } }
这里最终会 调用 AutoConfigurationImportSelector 的 selectImports
方法
总结来说,Spring Boot的自动装配原理是通过@EnableAutoConfiguration
注解、AutoConfigurationImportSelector
类和spring.factories
文件相互配合实现的。通过这种方式,Spring Boot能够根据约定大于配置的原则,自动加载和配置常用的Bean和组件,使开发者能够更加便捷地构建和部署应用程序。