Spring處理@Configuration的分析
聲明：本文若有任何紕漏、錯誤，還請不吝指出！
序言
@Configuration注解在SpringBoot中作用很大，且不說SpringBoot中的外部化配置，一些第三方組件也是通過這個注解完成整合的，常用的比如說mybatis，就是利用了@Configuration這個注解來實現的。
在注解類中，還可以使用@Bean的方式向Spring容器中，注入一些我們自定義的組件。
在SpringBoot中各種Enable又是如何實現的？和@Configuration又有什么聯系呢？
這就要了解Spring是怎么對待被@Configuration所注解的類。
環境
SpringBoot 2.2.6RELEASE
Spring 5.2.5.RELEASE
正文
注解依附於具體的Java類，所以如果想獲取注解的信息，必須先將類加載進來，才能從Class對象獲取到其注解元信息。
好在Spring容器啟動之前，已經把所有需要加載的Bean，封裝成一個BeanDefinition對象，最終注冊到BeanDefinitionRegistry中。
BeanDefinition包含了一個Bean所有的信息，自然也包含了它的元注解信息。
有了這個就能輕而易舉的獲取到標注有@Configuration注解的BeanDefinition，從而去處理這個配置類擁有的各種配置信息。
有了BeanDefinition之后，下面一步就是要進行Bean的實例化了。如果一個Bean被實例化后，就沒有可操作的機會了，因此Spring在Bean的實例化前預留了一些自定義的處理時機。
BeanFactoryPostProcessor就是這樣的一個功能，用於在Bean實例化之前，做一些其他的處理操作。
對配置類的處理，也正是利用了這一預留點。
BeanDefinitionRegistryPostProcessor
處理配置類，第一步就要從茫茫的BeanDefinition中，找出哪些是配置類。
容器開始啟動之前的一些准備動作，這里不說明，主要是掃描classpath，然后將生成BeanDefinition。
直接從容器的啟動開始簡單下調用棧
Spring容器真正開始啟動的是從這里開始的org.springframework.context.support.AbstractApplicationContext#refresh，在這個方法中，會去執行所有的BeanFactoryPostProcessor。
通過一個委托類org.springframework.context.support.PostProcessorRegistrationDelegate，執行所有的BeanFactoryPostProcessor后置處理邏輯。
BeanFactoryPostProcessor有一個子接口是BeanDefinitionRegistryPostProcessor，這個接口的主要作用就是在其他后置處理執行之前，額外注冊一些BeanDefinition進來。
想想在配置類中使用的@Import和@Bean，就可以猜到，這些注解的處理就是由這個處理器進行處理的。
BeanDefinitionRegistryPostProcessor和BeanFactoryPostProcessor是放到一起處理的，只不過BeanDefinitionRegistryPostProcessor的執行時機，早於BeanFactoryPostProcessor的執行時機。
// org.springframework.context.support.PostProcessorRegistrationDelegate
public static void invokeBeanFactoryPostProcessors(
ConfigurableListableBeanFactory beanFactory, List<BeanFactoryPostProcessor> beanFactoryPostProcessors) {
Set<String> processedBeans = new HashSet<>();
// 如果BeanFactory同時又是一個BeanDefinitionRegistry的話
// 例如 DefaultListaleBeanFactory
if (beanFactory instanceof BeanDefinitionRegistry) {
BeanDefinitionRegistry registry = (BeanDefinitionRegistry) beanFactory;
List<BeanFactoryPostProcessor> regularPostProcessors = new ArrayList<>();
List<BeanDefinitionRegistryPostProcessor> registryProcessors = new ArrayList<>();
// 如果有直接注冊到Context的后置處理器，
// 先執行直接添加到ApplicationContext的BeanDefinitionRegistryPostProcessor處理器
for (BeanFactoryPostProcessor postProcessor : beanFactoryPostProcessors) {
if (postProcessor instanceof BeanDefinitionRegistryPostProcessor) {
BeanDefinitionRegistryPostProcessor registryProcessor =
(BeanDefinitionRegistryPostProcessor) postProcessor;
// 執行BeanDefinitionRegistryPostProcessor處理器
registryProcessor.postProcessBeanDefinitionRegistry(registry);
// BeanDefinitionRegistryPostProcessor同時又是一個BeanFactoryPostProcessor
// 待所有的BeanDefinitionRegistryPostProcessor執行完后，再來執行它
registryProcessors.add(registryProcessor);
}
else {
// 加入到BeanFactoryPostProcessor處理器集合中，待所有的BeanDefinitionRegistryPostProcessor執行完后，來執行它
regularPostProcessors.add(postProcessor);
}
}
List<BeanDefinitionRegistryPostProcessor> currentRegistryProcessors = new ArrayList<>();
// 對從BeanDefinitionRegistry中的BeanDefinition做后置處理
// 先執行被@PriorityOrdered注解的BeanDefinitionRegistryPostProcessor
// 並且按排序大小進行優先級排序
// 根據類型，從BeanDefinitionRegistry中查找出所有的BeanDefinitionRegistryPostProcessor的是實現類，及子類
String[] postProcessorNames =
beanFactory.getBeanNamesForType(BeanDefinitionRegistryPostProcessor.class, true, false);
for (String ppName : postProcessorNames) {
// 使用@PriorityOrdered注解的先查找出來
if (beanFactory.isTypeMatch(ppName, PriorityOrdered.class)) {
currentRegistryProcessors.add(beanFactory.getBean(ppName, BeanDefinitionRegistryPostProcessor.class));
processedBeans.add(ppName);
}
}
// 按編號大小排序，升序排列
sortPostProcessors(currentRegistryProcessors, beanFactory);
registryProcessors.addAll(currentRegistryProcessors);
// 執行BeanDefinitionRegistryPostProcessor
invokeBeanDefinitionRegistryPostProcessors(currentRegistryProcessors, registry);
currentRegistryProcessors.clear();
// 處理被注解@Ordered標注的BeanDefinitionRegistryPostProcessor，
// 並且按排序后排序后執行
// 根據類型，從BeanDefinitionRegistry中查找出所有的BeanDefinitionRegistryPostProcessor的是實現類，及子類
postProcessorNames = beanFactory.getBeanNamesForType(BeanDefinitionRegistryPostProcessor.class, true, false);
for (String ppName : postProcessorNames) {
// 沒被處理過且被注解@Ordered
if (!processedBeans.contains(ppName) && beanFactory.isTypeMatch(ppName, Ordered.class)) {
currentRegistryProcessors.add(beanFactory.getBean(ppName, BeanDefinitionRegistryPostProcessor.class));
processedBeans.add(ppName);
}
}
sortPostProcessors(currentRegistryProcessors, beanFactory);
registryProcessors.addAll(currentRegistryProcessors);
// 執行BeanDefinitionRegistryPostProcessor
invokeBeanDefinitionRegistryPostProcessors(currentRegistryProcessors, registry);
currentRegistryProcessors.clear();
// 再去執行其他的剩下的所有BeanDefinitionRegistryPostProcessor
boolean reiterate = true;
while (reiterate) {
reiterate = false;
postProcessorNames= beanFactory.getBeanNamesForType(BeanDefinitionRegistryPostProcessor.class, true, false);
for (String ppName : postProcessorNames) {
if (!processedBeans.contains(ppName)) {
currentRegistryProcessors.add(beanFactory.getBean(ppName, BeanDefinitionRegistryPostProcessor.class));
processedBeans.add(ppName);
reiterate = true;
}
}
sortPostProcessors(currentRegistryProcessors, beanFactory);
registryProcessors.addAll(currentRegistryProcessors);
invokeBeanDefinitionRegistryPostProcessors(currentRegistryProcessors, registry);
currentRegistryProcessors.clear();
}
// BeanDefinitionRegistryPostProcessor也是一個BeanFactoryPostProcessor
// 下面這部分就是執行postProcessBeanFactory方法，
// 會在@Configuration的proxyBeanMethods為true時對配置類做一個CGLIB增強，
// 表示對配置類中的BeanMethod創建時，使用代理創建
// 將增強后的類，替換到其BeanDefinition#setBeanClass
invokeBeanFactoryPostProcessors(registryProcessors, beanFactory);
// 最后再執行直接注冊到到ApplicationContext中的BeanFactoryPostProcessor
invokeBeanFactoryPostProcessors(regularPostProcessors, beanFactory);
}
else {
// 處理直接通過ApplicationContext實例注冊的BeanFactoryPostProcessor
invokeBeanFactoryPostProcessors(beanFactoryPostProcessors, beanFactory);
}
// 上面就執行過了定義的所有的BeanDefinitionRegistryPostProcessor，以及實現的
// BeanFactoryPostProcessor#postProcessBeanFactory方法
// 接下來回去執行所有的BeanFactoryPostProcessor處理器
// 查找出所有注冊的類型為BeanFactoryPostProcessor的BeanDefinition的name數組
String[] postProcessorNames =
beanFactory.getBeanNamesForType(BeanFactoryPostProcessor.class, true, false);
// 分別歸類出使用@PriorityOrdered 和 @Ordered注解和沒有使用的
List<BeanFactoryPostProcessor> priorityOrderedPostProcessors = new ArrayList<>();
List<String> orderedPostProcessorNames = new ArrayList<>();
List<String> nonOrderedPostProcessorNames = new ArrayList<>();
for (String ppName : postProcessorNames) {
if (processedBeans.contains(ppName)) {
// 處理過的，不用重復處理
}
else if (beanFactory.isTypeMatch(ppName, PriorityOrdered.class)) {
priorityOrderedPostProcessors.add(beanFactory.getBean(ppName, BeanFactoryPostProcessor.class));
}
else if (beanFactory.isTypeMatch(ppName, Ordered.class)) {
orderedPostProcessorNames.add(ppName);
}
else {
nonOrderedPostProcessorNames.add(ppName);
}
}
// 優先處理 PriorityOrdered.
sortPostProcessors(priorityOrderedPostProcessors, beanFactory);
invokeBeanFactoryPostProcessors(priorityOrderedPostProcessors, beanFactory);
// 其次 Ordered.
List<BeanFactoryPostProcessor> orderedPostProcessors = new ArrayList<>(orderedPostProcessorNames.size());
for (String postProcessorName : orderedPostProcessorNames) {
orderedPostProcessors.add(beanFactory.getBean(postProcessorName, BeanFactoryPostProcessor.class));
}
sortPostProcessors(orderedPostProcessors, beanFactory);
invokeBeanFactoryPostProcessors(orderedPostProcessors, beanFactory);
//最后普通的 BeanFactoryPostProcessor
List<BeanFactoryPostProcessor> nonOrderedPostProcessors = new ArrayList<>(nonOrderedPostProcessorNames.size());
for (String postProcessorName : nonOrderedPostProcessorNames) {
nonOrderedPostProcessors.add(beanFactory.getBean(postProcessorName, BeanFactoryPostProcessor.class));
}
invokeBeanFactoryPostProcessors(nonOrderedPostProcessors, beanFactory);
beanFactory.clearMetadataCache();
}
上面這個方法執行完后，已經完成了所有BeanFactoryPostProcessor的執行，也自然已經處理過所有的配置類了。
ConfigurationClassPostProcessor
在眾多的后置處理器中，有一個獨屬於@Configuration的后置處理器，就是ConfigurationClassPostProcessor，一個好的命名的效果，就體現出來了。
下面這個方法，負責兩件事
- 從
BeanDefinitionRegistry中篩選出配置類 - 對配置類的
BeanDefinition進行解析
// org.springframework.context.annotation.ConfigurationClassPostProcessor
public void processConfigBeanDefinitions(BeanDefinitionRegistry registry) {
// 候選配置類集合
List<BeanDefinitionHolder> configCandidates = new ArrayList<>();
// 獲取所有的BeanDefinition的name數組
String[] candidateNames = registry.getBeanDefinitionNames();
for (String beanName : candidateNames) {
BeanDefinition beanDef = registry.getBeanDefinition(beanName);
// 如果BeanDefinition中有這個屬性存在，說明作為一個配置類已經被處理過了
if (beanDef.getAttribute(ConfigurationClassUtils.CONFIGURATION_CLASS_ATTRIBUTE) != null) {
if (logger.isDebugEnabled()) {
logger.debug("Bean definition has already been processed as a configuration class: " + beanDef);
}
}
// 檢查是否為一個配置類
// 查看是否具有@Configuration注解
// 這里不會僅僅看BeanDefinition所代表的類直接標注的注解，而是會遞歸查找其注解的注解是否有為
// @Configuration，只要找到了那么當前的類就是一個配置類
else if (ConfigurationClassUtils.checkConfigurationClassCandidate(beanDef, this.metadataReaderFactory)) {
configCandidates.add(new BeanDefinitionHolder(beanDef, beanName));
}
}
// 找不到就結束
if (configCandidates.isEmpty()) {
return;
}
// 對使用了@Order的進行排序 自然排序也就是升序
// 注意不是@Ordered
configCandidates.sort((bd1, bd2) -> {
int i1 = ConfigurationClassUtils.getOrder(bd1.getBeanDefinition());
int i2 = ConfigurationClassUtils.getOrder(bd2.getBeanDefinition());
return Integer.compare(i1, i2);
});
// 如果有自定義Bean Name生成器，就使用自定義的
SingletonBeanRegistry sbr = null;
if (registry instanceof SingletonBeanRegistry) {
sbr = (SingletonBeanRegistry) registry;
if (!this.localBeanNameGeneratorSet) {
BeanNameGenerator generator = (BeanNameGenerator) sbr.getSingleton(
AnnotationConfigUtils.CONFIGURATION_BEAN_NAME_GENERATOR);
if (generator != null) {
this.componentScanBeanNameGenerator = generator;
this.importBeanNameGenerator = generator;
}
}
}
// 如果還沒有初始化Environment對象，初始化一個
if (this.environment == null) {
this.environment = new StandardEnvironment();
}
// 解析每一個被@Configuratin標注的注解類
ConfigurationClassParser parser = new ConfigurationClassParser(
this.metadataReaderFactory, this.problemReporter, this.environment,
this.resourceLoader, this.componentScanBeanNameGenerator, registry);
Set<BeanDefinitionHolder> candidates = new LinkedHashSet<>(configCandidates);
Set<ConfigurationClass> alreadyParsed = new HashSet<>(configCandidates.size());
do {
parser.parse(candidates);
parser.validate();
Set<ConfigurationClass> configClasses = new LinkedHashSet<>(parser.getConfigurationClasses());
configClasses.removeAll(alreadyParsed);
// 構造一個BeanDefinitionReader
if (this.reader == null) {
this.reader = new ConfigurationClassBeanDefinitionReader(
registry, this.sourceExtractor, this.resourceLoader, this.environment,
this.importBeanNameGenerator, parser.getImportRegistry());
}
// 加載配置類中的@Bean，生成BeanDefinition
this.reader.loadBeanDefinitions(configClasses);
alreadyParsed.addAll(configClasses);
candidates.clear();
// 下面這段主要是考慮到@Import進來的或者@ImportSource或者@Bean等方式注入進來的會有配置類
if (registry.getBeanDefinitionCount() > candidateNames.length) {
String[] newCandidateNames = registry.getBeanDefinitionNames();
Set<String> oldCandidateNames = new HashSet<>(Arrays.asList(candidateNames));
Set<String> alreadyParsedClasses = new HashSet<>();
for (ConfigurationClass configurationClass : alreadyParsed) {
alreadyParsedClasses.add(configurationClass.getMetadata().getClassName());
}
for (String candidateName : newCandidateNames) {
if (!oldCandidateNames.contains(candidateName)) {
BeanDefinition bd = registry.getBeanDefinition(candidateName);
if (ConfigurationClassUtils.checkConfigurationClassCandidate(bd, this.metadataReaderFactory) &&
!alreadyParsedClasses.contains(bd.getBeanClassName())) {
candidates.add(new BeanDefinitionHolder(bd, candidateName));
}
}
}
candidateNames = newCandidateNames;
}
}
while (!candidates.isEmpty());
//把 ImportRegistry注冊成一個Bean，以便支持 繼承ImportAware 有注解類@Configuration的配置類
if (sbr != null && !sbr.containsSingleton(IMPORT_REGISTRY_BEAN_NAME)) {
sbr.registerSingleton(IMPORT_REGISTRY_BEAN_NAME, parser.getImportRegistry());
}
}
這個方法執行完后，所有的配置類都會被進行處理，並且在此過程中，BeanDefinition的總量有可能會增加，有新的BeanDefinition在解析過程新增進來。
這些BeanDefinition的來源就是存在於配置類上的其他注解
ConfigurationClassParser
SpringBoot是如何使用一個@SpringBootApplication注解，完成了那么多的事情？
答案就在下面揭曉
// `org.springframework.context.annotation.ConfigurationClassParser
protected final SourceClass doProcessConfigurationClass(
ConfigurationClass configClass, SourceClass sourceClass, Predicate<String> filter)
throws IOException {
// 如果有Component注解
if (configClass.getMetadata().isAnnotated(Component.class.getName())) {
// 首先遞歸處理內部類
processMemberClasses(configClass, sourceClass, filter);
}
// 處理所有的@PropertySource注解
for (AnnotationAttributes propertySource : AnnotationConfigUtils.attributesForRepeatable(
sourceClass.getMetadata(), PropertySources.class,
org.springframework.context.annotation.PropertySource.class)) {
if (this.environment instanceof ConfigurableEnvironment) {
processPropertySource(propertySource);
}
else {
logger.info("Ignoring @PropertySource annotation on [" + sourceClass.getMetadata().getClassName() +
"]. Reason: Environment must implement ConfigurableEnvironment");
}
}
// 處理所有的 @ComponentScan 和@ComponentScans
Set<AnnotationAttributes> componentScans = AnnotationConfigUtils.attributesForRepeatable(
sourceClass.getMetadata(), ComponentScans.class, ComponentScan.class);
if (!componentScans.isEmpty() &&
!this.conditionEvaluator.shouldSkip(sourceClass.getMetadata(), ConfigurationPhase.REGISTER_BEAN)) {
for (AnnotationAttributes componentScan : componentScans) {
// The config class is annotated with @ComponentScan -> perform the scan immediately
Set<BeanDefinitionHolder> scannedBeanDefinitions =
this.componentScanParser.parse(componentScan, sourceClass.getMetadata().getClassName());
// 繼續檢查掃描的BeanDefinition有沒有是配置類的
for (BeanDefinitionHolder holder : scannedBeanDefinitions) {
BeanDefinition bdCand = holder.getBeanDefinition().getOriginatingBeanDefinition();
if (bdCand == null) {
bdCand = holder.getBeanDefinition();
}
if (ConfigurationClassUtils.checkConfigurationClassCandidate(bdCand, this.metadataReaderFactory)) {
// 如果是的話，解析
parse(bdCand.getBeanClassName(), holder.getBeanName());
}
}
}
}
// 處理所有的@Import注解，將導入的Bean注冊到BeanDefinitionRegistry
// 會遞歸查找出所有的@Import
// getImports會查找所有配置類上的@Import注解，@Import可以導入一個普通的配置類
// 也可以是ImportSelector或者ImportBeanDefinitionRegistrar的實現類
// 之所以需要ImportSelector和ImportBeanDefinitionRegistrar，是為了可以更加方便的一次注冊多個類
// 這倆接口的實現類，也一要由Import導入進來，或者直接使用@Component，不過這樣就就沒必要去實現接口了
// 這三個的主要用途不是為了注冊自己程序中的類成為一個Bean，而是為了那些不方便使用@Component注解的類
// @Component的更像一個為了業務代碼使用的注解
processImports(configClass, sourceClass, getImports(sourceClass), filter, true);
// 處理所有的@ImportResource 注解，將導入的Bean注冊到BeanDefinitionRegistry
AnnotationAttributes importResource =
AnnotationConfigUtils.attributesFor(sourceClass.getMetadata(), ImportResource.class);
if (importResource != null) {
String[] resources = importResource.getStringArray("locations");
Class<? extends BeanDefinitionReader> readerClass = importResource.getClass("reader");
for (String resource : resources) {
String resolvedResource = this.environment.resolveRequiredPlaceholders(resource);
configClass.addImportedResource(resolvedResource, readerClass);
}
}
// 處理獨立的 @Bean方法，生成BeanMethod
// 使用@Bean，方法要是可重寫，也就是不能為default/private，因為要使用CGLIB代理
// 詳細可進去下面方法細看
Set<MethodMetadata> beanMethods = retrieveBeanMethodMetadata(sourceClass);
for (MethodMetadata methodMetadata : beanMethods) {
configClass.addBeanMethod(new BeanMethod(methodMetadata, configClass));
}
// 處理接口的默認方法
processInterfaces(configClass, sourceClass);
// 如果有父類，處理
if (sourceClass.getMetadata().hasSuperClass()) {
String superclass = sourceClass.getMetadata().getSuperClassName();
if (superclass != null && !superclass.startsWith("java") &&
!this.knownSuperclasses.containsKey(superclass)) {
this.knownSuperclasses.put(superclass, configClass);
// Superclass found, return its annotation metadata and recurse
return sourceClass.getSuperClass();
}
}
//沒有父類，處理完成
return null;
}
看下@SpringBootApplication的定義
@Target(ElementType.TYPE)
@Retention(RetentionPolicy.RUNTIME)
@Documented
@Configuration
public @interface SpringBootConfiguration {
}
@Target(ElementType.TYPE)
@Retention(RetentionPolicy.RUNTIME)
@Documented
@Inherited
@SpringBootConfiguration
@EnableAutoConfiguration
@ComponentScan(excludeFilters = { @Filter(type = FilterType.CUSTOM, classes = TypeExcludeFilter.class),
@Filter(type = FilterType.CUSTOM, classes = AutoConfigurationExcludeFilter.class) })
public @interface SpringBootApplication {
}
可以看到@SpringBootApplication在功能上也是一個@Configuration。
這樣就解釋了，一般在SpringBoot的啟動類上寫了那么多注解，為啥可以被執行。
如果有看過各類@Enable注解，就一定會看到，每一個@Enable幾乎都會被@Import所注解，而一般使用@Enable時，都會和@SpringBootApplication寫一起，這個寫法的一方面是比較清晰，集中寫到一起，還有個原因就是部分@Enable在定義時，沒有使用@Configuration來進行注解，需要借助於一個能被Spring容器啟動時處理的配置類上。
上面的這段代碼分析，正好解釋了@Enable背后的實現原理。
總結
其實總的看下來，@Configuration就是一個標志注解，更大的作用就是為別的注解服務的。這么說有點矛盾，主要是覺得本身不具備什么功能性。
至於其能實現的對字段進行配置值綁定來說，可以使用@ConfigurationProperties或者@Value這兩個注解來實現，由此可見，@Configuration並不是用於將配置文件的配置值，綁定到配置類的，這個工作和他沒有任何關系，對於一些配置文件的配置來說，可以使用@Component注解來對普通的配置類注解，達到一樣的效果，而並非一定要使用@Configuration(@Configuration注解派生自@Component)。
通過我們上面的分析，被@Configuration注解的類，僅有存在以上那幾個注解時，才有意義，才能被ConfigurationClassPostProcessor所處理，而這個處理過程中，和配置值綁定一毛錢的關系都沒有。
實際上配置值的綁定，都是在Bean實例化后，Bean屬性填充期間進行的。
@ConfigurationProperties注解會在ConfigurationPropertiesBindingPostProcessor執行時進行處理，這個處理器是一個BeanPostProcessor。
@Value注解的處理是在AutowiredAnnotationBeanPostProcessor這個BeanPostProcessor中來處理的，這個處理器同時也是處理@Inject、 @Autowired、 @Resource的BeanPostProcesoor。
Spring或者SpringBoot中，大量的使用各種后置處理器，除了對主體框架(Bean的生命周期)的理解外，剩下的主要就是熟悉這些支持各種功能的PostProcessor。
還有個值得注意的是，@Configuration有個方法proxyBeanMethods，這個方法返回true時，默認也是true，會對我們的配置類，生成一個代理類，注意，這里是直接生成一個代理類，並且最后實例化時，也是使用這個代理類進行實例化Bean，這個就給我們一個啟發，如果想對一些無法直接修改又被Spring容器所管理的的Bean，是否可以通過自定義BeanDefinitionRegistryPostProcessor的方式，來對原Class做一個增強，從而實現我們的目的。
PS：是否具備切實可行性，並不保證，只是覺得如果遇到，可以嘗試下。