接着上一篇 invokeBeanFactoryPostProcessors 來分析，主要分析 ConfigurationClassPostProcessor 作用。
前言
ConfigurationClassPostProcessor 對已經註冊的 BeanDefinition 進行分析，如果有配置 @ComponentScan 等，則進一步掃描
添加
在初始化 AnnotationConfigApplicationContext 時候，會網beanDefs中加入一些默認配置bean：
org.springframework.context.annotation.internalConfigurationAnnotationProcessor：對應ConfigurationClassPostProcessororg.springframework.context.annotation.internalAutowiredAnnotationProcessor對應AutowiredAnnotationBeanPostProcessororg.springframework.context.annotation.internalCommonAnnotationProcessor"對應CommonAnnotationBeanPostProcessororg.springframework.context.annotation.internalPersistenceAnnotationProcessor對應org.springframework.orm.jpa.support.PersistenceAnnotationBeanPostProcessororg.springframework.context.event.internalEventListenerProcessor對應EventListenerMethodProcessororg.springframework.context.event.internalEventListenerFactory對應DefaultEventListenerFactory
上面有 和 @Autowired 、 @Configuration 以及其他一些通用註解相關的。
後面文章會一一分析。
ConfigurationClassPostProcessor 結構
先看看 ConfigurationClassPostProcessor 類結構：
public class ConfigurationClassPostProcessor implements BeanDefinitionRegistryPostProcessor,
PriorityOrdered, ResourceLoaderAware, BeanClassLoaderAware, EnvironmentAware {
...
}
從上面類定義，可以有以下幾點：
- 實現了
PriorityOrdered優先級接口 - 實現了
ResourceLoaderAware，當初始化ConfigurationClassPostProcessor，會設置其內部的resourceLoaderAware - 實現
BeanClassLoaderAware， 會設置ClassLoader。 - 實現
EnvironmentAware，會設置Environment - 實現
BeanDefinitionRegistryPostProcessor接口，用於更改BeanDefinition。
調用
從上篇文章可知，在 invokeBeanFactoryPostProcessors 中被調用。具體調用路徑：
applicationContext.refresh() -> invokeBeanFactoryPostProcessors(beanFactory) -> PostProcessorRegistrationDelegate.invokeBeanFactoryPostProcessors(beanFactory, getBeanFactoryPostProcessors()) -> invokeBeanDefinitionRegistryPostProcessors(currentRegistryProcessors, registry) -> postProcessor.postProcessBeanDefinitionRegistry(registry)
下面從 postProcessor.postProcessBeanDefinitionRegistry(registry) 中開始分析：
postProcessBeanDefinitionRegistry
先看代碼：
@Override
public void postProcessBeanDefinitionRegistry(BeanDefinitionRegistry registry) {
// 設置registryId
int registryId = System.identityHashCode(registry);
if (this.registriesPostProcessed.contains(registryId)) {
throw new IllegalStateException(
"postProcessBeanDefinitionRegistry already called on this post-processor against " + registry);
}
if (this.factoriesPostProcessed.contains(registryId)) {
throw new IllegalStateException(
"postProcessBeanFactory already called on this post-processor against " + registry);
}
this.registriesPostProcessed.add(registryId);
// 開始處理
processConfigBeanDefinitions(registry);
}
上面代碼主要是設置 registryId，而主要處理在 processConfigBeanDefinitions，主要爲解析 配置類 (configuration classes)
processConfigBeanDefinitions
該方法主要爲驗證即構建所有的 @Configuration 類：
List<BeanDefinitionHolder> configCandidates = new ArrayList<>();
String[] candidateNames = registry.getBeanDefinitionNames();
// 從所有的 BeanDefinition中獲取配置類。
for (String beanName : candidateNames) {
BeanDefinition beanDef = registry.getBeanDefinition(beanName);
// 判斷一個類是否爲 @Configuration類並且已經處理過。
if (ConfigurationClassUtils.isFullConfigurationClass(beanDef) ||
ConfigurationClassUtils.isLiteConfigurationClass(beanDef)) {
if (logger.isDebugEnabled()) {
logger.debug("Bean definition has already been processed as a configuration class: " + beanDef);
}
}
else if (ConfigurationClassUtils.checkConfigurationClassCandidate(beanDef, this.metadataReaderFactory)) {
// 如果是配置類，則加入
configCandidates.add(new BeanDefinitionHolder(beanDef, beanName));
}
}
// 如果啥也沒找到，直接退出
if (configCandidates.isEmpty()) {
return;
}
// 根據 @Order 排序
configCandidates.sort((bd1, bd2) -> {
int i1 = ConfigurationClassUtils.getOrder(bd1.getBeanDefinition());
int i2 = ConfigurationClassUtils.getOrder(bd2.getBeanDefinition());
return Integer.compare(i1, i2);
});
// 判斷是否需要配置 BeanNameGenerator
SingletonBeanRegistry sbr = null;
if (registry instanceof SingletonBeanRegistry) {
sbr = (SingletonBeanRegistry) registry;
if (!this.localBeanNameGeneratorSet) {
BeanNameGenerator generator = (BeanNameGenerator) sbr.getSingleton(CONFIGURATION_BEAN_NAME_GENERATOR);
if (generator != null) {
this.componentScanBeanNameGenerator = generator;
this.importBeanNameGenerator = generator;
}
}
}
// 設置 environment
if (this.environment == null) {
this.environment = new StandardEnvironment();
}
// 解析每一個 @Configuration註解類
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);
// Read the model and create bean definitions based on its content
if (this.reader == null) {
this.reader = new ConfigurationClassBeanDefinitionReader(
registry, this.sourceExtractor, this.resourceLoader, this.environment,
this.importBeanNameGenerator, parser.getImportRegistry());
}
this.reader.loadBeanDefinitions(configClasses);
alreadyParsed.addAll(configClasses);
candidates.clear();
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());
// Register the ImportRegistry as a bean in order to support ImportAware @Configuration classes
if (sbr != null && !sbr.containsSingleton(IMPORT_REGISTRY_BEAN_NAME)) {
sbr.registerSingleton(IMPORT_REGISTRY_BEAN_NAME, parser.getImportRegistry());
}
if (this.metadataReaderFactory instanceof CachingMetadataReaderFactory) {
// Clear cache in externally provided MetadataReaderFactory; this is a no-op
// for a shared cache since it'll be cleared by the ApplicationContext.
((CachingMetadataReaderFactory) this.metadataReaderFactory).clearCache();
}
}
- FullConfiguration 候選指的是直接使用
@Configuration修飾 - LiteConfigurationCandidate 候選是指是否有``@Component
、@Bean、@Import`註解， processConfigBeanDefinitions這個方法是一個可遞歸的方法，即如果在 找到配置類中，有新的 類（例如@ComponentScan），則需要再一步解析下面的類。
parser.parse(candidates)
在此之前 所有已經註冊的BeanDefinition 將在這裏進一步解析，判斷不同類型後，將每個BeanDefinitionHolder 放入 ConfigurationClassParser 的 parse 方法解析，而後進入 processConfigurationClass 方法：
protected void processConfigurationClass(ConfigurationClass configClass) throws IOException {
// 判斷是否跳過該 bean的解析，通過 @Conditional 註解判斷。
if (this.conditionEvaluator.shouldSkip(configClass.getMetadata(), ConfigurationPhase.PARSE_CONFIGURATION)) {
return;
}
// 看是否已經解析過
ConfigurationClass existingClass = this.configurationClasses.get(configClass);
if (existingClass != null) {
if (configClass.isImported()) {
if (existingClass.isImported()) {
existingClass.mergeImportedBy(configClass);
}
// Otherwise ignore new imported config class; existing non-imported class overrides it.
return;
}
else {
// Explicit bean definition found, probably replacing an import.
// Let's remove the old one and go with the new one.
this.configurationClasses.remove(configClass);
this.knownSuperclasses.values().removeIf(configClass::equals);
}
}
// 獲取一個 SourceClass
SourceClass sourceClass = asSourceClass(configClass);
do {
// 遞歸的去解析配置類 以及 它的 父類.
sourceClass = doProcessConfigurationClass(configClass, sourceClass);
}
while (sourceClass != null);
this.configurationClasses.put(configClass, configClass);
}
以上代碼有以下幾段邏輯：
- 判斷是否要跳過該bean的加載解析，通過
@Conditional判定。 - 構造
SourceClass循環調用doProcessConfigurationClass進行解析。 - 在 doProcessConfigurationClass 則主要是解析具體過程。
doProcessConfigurationClass
protected final SourceClass doProcessConfigurationClass(ConfigurationClass configClass, SourceClass sourceClass)
throws IOException {
if (configClass.getMetadata().isAnnotated(Component.class.getName())) {
// 如果該類，使用@Component註解，則遞歸搜尋內部類
processMemberClasses(configClass, sourceClass);
}
// 解析 @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 註解
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());
// Check the set of scanned definitions for any further config classes and parse recursively if needed
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());
}
}
}
}
// getImports 解析 @Import註解 ，進去會遞歸的掃描，即 @Import上的@Import 引入
processImports(configClass, sourceClass, getImports(sourceClass), true);
// 解析 @ImportResource
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註解
Set<MethodMetadata> beanMethods = retrieveBeanMethodMetadata(sourceClass);
for (MethodMetadata methodMetadata : beanMethods) {
configClass.addBeanMethod(new BeanMethod(methodMetadata, configClass));
}
// 解析 接口默認方法。Process default methods on interfaces
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();
}
}
// 沒有父類處理，所以只解析本類，那麼返回null退出。
return null;
}
- 上面方法依次會解析
@Component、@PropertySource、@ComponentScans、@ImportResource、@Bean和 默認接口方法（這類也會以@Bean 註解方法處理。）。註解 - 如果該類，使用@Component註解，則遞歸向上 搜尋內部類
- 在 解析 @Import 註解時，會首先通過
getImports(sourceClass)向上獲取所有的 @Import 中的value，而後，去到processImports方法中，將對應Import標籤加入進來。 - 循環對所有的 FullConfigurationCandidate 和 LiteConfigurationCandidate的候選
BeanDefinition進行處理。
整個 ConfigurationClassPostProcessor 就分析完成，它是在 bean初始化之前，去解析配置類，將他們都加入到 Spring 的BeanDefinition 容器中，但此時尚未初始化。
覺得博主寫的有用，不妨關注博主公衆號: 六點A君。
哈哈哈，一起研究Spring：
