spring-IOC容器源碼分析（二）BeanDefinition註冊流程
本篇文章主要介紹如下幾個部分：java
- BeanFactory接口體系
- BeanDefinition的接口實現類體系
- 梳理註冊註解配置類流程
- 從解析@Scope的流程入手，分析一個通用的spring解析註解屬性的流程
- java code config基於註解配置的原理
BeanFactory接口體系
以DefaultListableBeanFactory爲例梳理一下BeanFactory接口體系的細節 spring
主要接口、抽象類的做用以下：
- BeanFactory（根據註冊的bean定義來生產bean的功能）
- BeanRegistry（bean定義的註冊功能）
- BeanDefinition（bean的定義信息）
BeanFactory
- BeanFactory：用於訪問Spring bean容器的根接口，提供多個重載的getBean方法來獲取註冊到容器中的bean的實例
- HierarchicalBeanFactory：爲Spring bean 容器提供父子容器的上下層級關係的能力
- ListableBeanFactory：提供遍歷Spring bean容器中bean的能力但其方法只檢查容器內部bean的定義，而不會真正的實例化bean;而且不會包含其父容器中的bean定義
- ConfigurableBeanFactory：提供遍歷Spring bean容器的能力，好比向container中增長BeanPostProcessor
- AutowireCapableBeanFactory：提供自動注入bean屬性的能力，以及其餘框架的集成代碼能夠利用這個接口來鏈接和填充Spring沒法控制的現有bean實例生命週期
BeanRegistry
- AliasRegistry：用於管理bean別名的接口
- BeanDefinitionRegistry：提供註冊BeanDefinition的能力
BeanDefinition
- AnnotatedBeanDefinition：註解的元數據
- RootBeanDefinition：在Spring bean容器運行期間，經過合併註冊到容器中的bean定義生成的bean元數據
總結
在spring的容器接口體系中，咱們可使用原材料、工廠、生產線操做工人、最終產品的關係來類比BeanDefinition、BeanFactory、BeanRegistry、bean實例。 BeanRegistry提供能力將BeanDefinition註冊到BeanFactory中，BeanFactory經過其內部的生產線來生成bean實例app
BeanDefinition的接口實現類體系
以AnnotatedGenericBeanDefinition爲例梳理一下BeanDefinition接口實現類體系框架
Metadata元數據部分
Metadata元數據部分在其內部包裝了須要註冊到BeanFactory的類的信息ide
類圖
類關係說明
- ClassMetadata,抽象出類的元數據的接口。提供獲取類名、判斷是否爲接口類、是否爲註解類、是否爲抽象類等功能；
- AnnotatedTypeMetadata，定義了接口，用於訪問AnnotationMetadata、MethodMetadata這兩個類的註解。提供判斷是否被指定註解標記、獲取指定註解的屬性等功能；
- AnnotationMetadata，定義了接口，用於訪問指定類的註解；如getMetaAnnotationTypes(String annotationName)用於獲取指定註解annotationName的元註解集合
- StandardClassMetadata,用標準的反射功能實現了ClassMetadata類
- StandardAnnotationMetadata，擴展StandardClassMetadata類並實現AnnotationMetadata接口
BeanDefinition部分
BeanDefinition做爲註冊到BeanFactory中的載體，在具體的實現類中，持有metadata實例。工具
類圖
類關係說明
- AttributeAccessor，定義設置和獲取屬性元數據的接口；
- AttributeAccessorSupport，在內部經過LinkedHashMap實現了AttributeAccessor接口；
- BeanMetadataElement，持有一個source，具體用途待考究；
- BeanMetadataAttribute，實現BeanMetadataElement接口，在其內部以key-value的形式持有bean definition的屬性；
- BeanMetadataAttributeAccessor，實現BeanMetadataElement接口，並重寫部分AttributeAccessorSupport的接口，用於設置和獲取BeanMetadataElement；
- BeanDefinition，一個BeanDefinition對象用於描述一個bean instance，其中擁有屬性值、構造器屬性值以及更多由其子類提供的信息；
- AbstractBeanDefinition：實現了BeanDefinition接口，提供了設置和獲取bean definition中的各個屬性（即類的各類屬性數據）
- AnnotatedBeanDefinition，提供接口用於獲取被包裝的類的元數據
- GenericBeanDefinition，提供parent bean的設置功能
- AnnotatedGenericBeanDefinition，擴展自GenericBeanDefinition，實現AnnotatedBeanDefinition提供暴露註解元數據的支持功能
註冊註解配置類流程
主流程
源碼分析
public class AnnotatedBeanDefinitionReader {
// 省略部分代碼
public void registerBean(Class<?> annotatedClass, String name, Class<? extends Annotation>... qualifiers) {
AnnotatedGenericBeanDefinition abd = new AnnotatedGenericBeanDefinition(annotatedClass);
if (this.conditionEvaluator.shouldSkip(abd.getMetadata())) {
return;
}
// 解析@Scope註解，獲取bean的做用域配置信息
ScopeMetadata scopeMetadata = this.scopeMetadataResolver.resolveScopeMetadata(abd);
abd.setScope(scopeMetadata.getScopeName());
String beanName = (name != null ? name : this.beanNameGenerator.generateBeanName(abd, this.registry));
// 解析通用註解，如@Lazy等
AnnotationConfigUtils.processCommonDefinitionAnnotations(abd);
// 定義qualifier信息，主要涉及到後續指定bean注入的註解@Qualifier
if (qualifiers != null) {
for (Class<? extends Annotation> qualifier : qualifiers) {
if (Primary.class == qualifier) {
abd.setPrimary(true);
}
else if (Lazy.class == qualifier) {
abd.setLazyInit(true);
}
else {
abd.addQualifier(new AutowireCandidateQualifier(qualifier));
}
}
}
BeanDefinitionHolder definitionHolder = new BeanDefinitionHolder(abd, beanName);
// 根據ScopeMetadata生成對應的Scope代理
definitionHolder = AnnotationConfigUtils.applyScopedProxyMode(scopeMetadata, definitionHolder, this.registry);
// 實際bean的注入，在registry內部用一個ConcurrentHashMap持有了beandefinition信息
BeanDefinitionReaderUtils.registerBeanDefinition(definitionHolder, this.registry);
}
}
複製代碼
解析@Scope的流程，分析spring解析註解類屬性值的流程
主流程
源碼分析
// @Scope註解的解析器
public class AnnotationScopeMetadataResolver implements ScopeMetadataResolver {
// 解析@Scope註解，構造ScopeMetadata實例，持有bean做用域的配置信息
@Override
public ScopeMetadata resolveScopeMetadata(BeanDefinition definition) {
ScopeMetadata metadata = new ScopeMetadata();
if (definition instanceof AnnotatedBeanDefinition) {
AnnotatedBeanDefinition annDef = (AnnotatedBeanDefinition) definition;
// 獲取指定註解的屬性值對,此處爲@Scope註解
AnnotationAttributes attributes = AnnotationConfigUtils.attributesFor(
annDef.getMetadata(), this.scopeAnnotationType);
// 若是屬性不爲null，則根據屬性值對修改ScopeMetadata的值
if (attributes != null) {
metadata.setScopeName(attributes.getString("value"));
ScopedProxyMode proxyMode = attributes.getEnum("proxyMode");
if (proxyMode == null || proxyMode == ScopedProxyMode.DEFAULT) {
proxyMode = this.defaultProxyMode;
}
metadata.setScopedProxyMode(proxyMode);
}
}
return metadata;
}
}
// 註解配置信息的輔助工具類
public class AnnotationConfigUtils {
// 獲取metadata中，annotationClass註解類型的屬性值，用AnnotationAttributes（繼承自LinkedHashMap，額外保存了註解類型等信息）持有
static AnnotationAttributes attributesFor(AnnotatedTypeMetadata metadata, Class<?> annotationClass) {
return attributesFor(metadata, annotationClass.getName());
}
// 獲取metadata中，annotationClass註解類型的屬性值，用AnnotationAttributes（繼承自LinkedHashMap，額外保存了註解類型等信息）持有
static AnnotationAttributes attributesFor(AnnotatedTypeMetadata metadata, String annotationClassName) {
return AnnotationAttributes.fromMap(metadata.getAnnotationAttributes(annotationClassName, false));
}
}
// 持有類的元數據
public class StandardAnnotationMetadata extends StandardClassMetadata implements AnnotationMetadata {
// 獲取指定註解名annotationName中的屬性值對
@Override
public Map<String, Object> getAnnotationAttributes(String annotationName, boolean classValuesAsString) {
return (this.annotations.length > 0 ? AnnotatedElementUtils.getMergedAnnotationAttributes(
getIntrospectedClass(), annotationName, classValuesAsString, this.nestedAnnotationsAsMap) : null);
}
}
// 用於在AnnotatedElement上查找註解、元註解、可重複註解的工具類
public class AnnotatedElementUtils {
public static AnnotationAttributes getMergedAnnotationAttributes(AnnotatedElement element, String annotationName, boolean classValuesAsString, boolean nestedAnnotationsAsMap) {
Assert.hasLength(annotationName, "'annotationName' must not be null or empty");
// 根據註解名查找註解的屬性值對
AnnotationAttributes attributes = searchWithGetSemantics(element, null, annotationName,
new MergedAnnotationAttributesProcessor(classValuesAsString, nestedAnnotationsAsMap));
// 處理註解別名
AnnotationUtils.postProcessAnnotationAttributes(element, attributes, classValuesAsString, nestedAnnotationsAsMap);
return attributes;
}
private static <T> T searchWithGetSemantics(AnnotatedElement element, Class<? extends Annotation> annotationType, String annotationName, Processor<T> processor) {
// 將查找工做，轉發給processor處理（Processor -> MergedAnnotationAttributesProcessor）
return searchWithGetSemantics(element, annotationType, annotationName, null, processor);
}
private static <T> T searchWithGetSemantics(AnnotatedElement element, Class<? extends Annotation> annotationType, String annotationName, Class<? extends Annotation> containerType, Processor<T> processor) {
try {
// 進行第一層查找（metaDepth=0）
return searchWithGetSemantics(element, annotationType, annotationName,
containerType, processor, new HashSet<AnnotatedElement>(), 0);
}
catch (Throwable ex) {
AnnotationUtils.rethrowAnnotationConfigurationException(ex);
throw new IllegalStateException("Failed to introspect annotations on " + element, ex);
}
}
private static <T> T searchWithGetSemantics(AnnotatedElement element, Class<? extends Annotation> annotationType, String annotationName, Class<? extends Annotation> containerType, Processor<T> processor, Set<AnnotatedElement> visited, int metaDepth) {
Assert.notNull(element, "AnnotatedElement must not be null");
if (visited.add(element)) {
try {
// Start searching within locally declared annotations
List<Annotation> declaredAnnotations = Arrays.asList(element.getDeclaredAnnotations());
// 轉發給重載方法，進行實際的查找操做
T result = searchWithGetSemanticsInAnnotations(element, declaredAnnotations,
annotationType, annotationName, containerType, processor, visited, metaDepth);
if (result != null) {
return result;
}
if (element instanceof Class) { // otherwise getAnnotations does not return anything new
List<Annotation> inheritedAnnotations = new ArrayList<Annotation>();
for (Annotation annotation : element.getAnnotations()) {
if (!declaredAnnotations.contains(annotation)) {
inheritedAnnotations.add(annotation);
}
}
// Continue searching within inherited annotations
result = searchWithGetSemanticsInAnnotations(element, inheritedAnnotations,
annotationType, annotationName, containerType, processor, visited, metaDepth);
if (result != null) {
return result;
}
}
}
catch (Throwable ex) {
AnnotationUtils.handleIntrospectionFailure(element, ex);
}
}
return null;
}
// 執行實際的註解屬性查找功能
private static <T> T searchWithGetSemanticsInAnnotations(AnnotatedElement element, List<Annotation> annotations, Class<? extends Annotation> annotationType, String annotationName, Class<? extends Annotation> containerType, Processor<T> processor, Set<AnnotatedElement> visited, int metaDepth) {
// Search in annotations
// 遍歷註解列表
for (Annotation annotation : annotations) {
Class<? extends Annotation> currentAnnotationType = annotation.annotationType();
// 只處理非JDK內置的註解
if (!AnnotationUtils.isInJavaLangAnnotationPackage(currentAnnotationType)) {
// 知足如下任意條件，須要調用processor.process(element, annotation, metaDepth)方法進行屬性值的查找工做
// 1. 若是當前循環的註解，爲咱們指定的註解類型
// 2. 若是當前循環的註解，爲咱們指定的註解名稱
// 3. 始終調用processor，即processor.alwaysProcesses()返回true
if (currentAnnotationType == annotationType ||
currentAnnotationType.getName().equals(annotationName) ||
processor.alwaysProcesses()) {
// 查找註解屬性值
T result = processor.process(element, annotation, metaDepth);
if (result != null) {
if (processor.aggregates() && metaDepth == 0) {
// 聚合查找結果
processor.getAggregatedResults().add(result);
}
else {
return result;
}
}
}
// Repeatable annotations in container?
else if (currentAnnotationType == containerType) {
for (Annotation contained : getRawAnnotationsFromContainer(element, annotation)) {
T result = processor.process(element, contained, metaDepth);
if (result != null) {
// No need to post-process since repeatable annotations within a
// container cannot be composed annotations.
processor.getAggregatedResults().add(result);
}
}
}
}
}
// Recursively search in meta-annotations
for (Annotation annotation : annotations) {
Class<? extends Annotation> currentAnnotationType = annotation.annotationType();
if (!AnnotationUtils.isInJavaLangAnnotationPackage(currentAnnotationType)) {
T result = searchWithGetSemantics(currentAnnotationType, annotationType,
annotationName, containerType, processor, visited, metaDepth + 1);
if (result != null) {
processor.postProcess(element, annotation, result);
if (processor.aggregates() && metaDepth == 0) {
processor.getAggregatedResults().add(result);
}
else {
return result;
}
}
}
}
return null;
}
}
private static class MergedAnnotationAttributesProcessor implements Processor<AnnotationAttributes> {
@Override
public AnnotationAttributes process(AnnotatedElement annotatedElement, Annotation annotation, int metaDepth) {
return AnnotationUtils.retrieveAnnotationAttributes(annotatedElement, annotation,
this.classValuesAsString, this.nestedAnnotationsAsMap);
}
}
public abstract class AnnotationUtils {
// 將註解屬性值包裝爲AnnotationAttributes，返回給上層調用
static AnnotationAttributes retrieveAnnotationAttributes(Object annotatedElement, Annotation annotation, boolean classValuesAsString, boolean nestedAnnotationsAsMap) {
Class<? extends Annotation> annotationType = annotation.annotationType();
AnnotationAttributes attributes = new AnnotationAttributes(annotationType);
for (Method method : getAttributeMethods(annotationType)) {
try {
Object attributeValue = method.invoke(annotation);
Object defaultValue = method.getDefaultValue();
if (defaultValue != null && ObjectUtils.nullSafeEquals(attributeValue, defaultValue)) {
attributeValue = new DefaultValueHolder(defaultValue);
}
attributes.put(method.getName(),
adaptValue(annotatedElement, attributeValue, classValuesAsString, nestedAnnotationsAsMap));
}
catch (Throwable ex) {
if (ex instanceof InvocationTargetException) {
Throwable targetException = ((InvocationTargetException) ex).getTargetException();
rethrowAnnotationConfigurationException(targetException);
}
throw new IllegalStateException("Could not obtain annotation attribute value for " + method, ex);
}
}
return attributes;
}
}
複製代碼
基於註解配置，註冊bean的原理
在spring的高版本中，官方建議開發者使用java code的配置方式。其原理主要是利用ConfigurationClassPostProcessor類來進行解析。執行的時機發生在容器啓動後，調用invokeBeanFactoryPostProcessors()方法這一步。源碼分析
主流程
源碼分析
public class ConfigurationClassPostProcessor implements BeanDefinitionRegistryPostProcessor, PriorityOrdered, ResourceLoaderAware, BeanClassLoaderAware, EnvironmentAware {
public void processConfigBeanDefinitions(BeanDefinitionRegistry registry) {
List<BeanDefinitionHolder> configCandidates = new ArrayList<BeanDefinitionHolder>();
String[] candidateNames = registry.getBeanDefinitionNames();
// 遍歷beanfactory中全部已註冊的bean
for (String beanName : candidateNames) {
BeanDefinition beanDef = registry.getBeanDefinition(beanName);
// 判斷是否爲處理過的full配置類
if (ConfigurationClassUtils.isFullConfigurationClass(beanDef) ||
// 判斷是否爲處理過的lite配置類
ConfigurationClassUtils.isLiteConfigurationClass(beanDef)) {
if (logger.isDebugEnabled()) {
logger.debug("Bean definition has already been processed as a configuration class: " + beanDef);
}
}
// 判斷是否爲配置類（標註了@Configuration、@Component、@ComponentScan、@Import、@ImportResource）
// 爲full配置類時，爲beanDef增長鍵爲org.springframework.context.annotation.ConfigurationClassPostProcessor.configurationClass，值爲full的attribute
// 爲lite配置類時，爲beanDef增長鍵爲org.springframework.context.annotation.ConfigurationClassPostProcessor.configurationClass，值爲lite的attribute
else if (ConfigurationClassUtils.checkConfigurationClassCandidate(beanDef, this.metadataReaderFactory)) {
configCandidates.add(new BeanDefinitionHolder(beanDef, beanName));
}
}
// Return immediately if no @Configuration classes were found
if (configCandidates.isEmpty()) {
return;
}
// Sort by previously determined @Order value, if applicable
// 配置類能夠按照順序加載
Collections.sort(configCandidates, new Comparator<BeanDefinitionHolder>() {
@Override
public int compare(BeanDefinitionHolder bd1, BeanDefinitionHolder bd2) {
int i1 = ConfigurationClassUtils.getOrder(bd1.getBeanDefinition());
int i2 = ConfigurationClassUtils.getOrder(bd2.getBeanDefinition());
return (i1 < i2) ? -1 : (i1 > i2) ? 1 : 0;
}
});
// Detect any custom bean name generation strategy supplied through the enclosing application context
SingletonBeanRegistry sbr = null;
if (registry instanceof SingletonBeanRegistry) {
sbr = (SingletonBeanRegistry) registry;
if (!this.localBeanNameGeneratorSet && sbr.containsSingleton(CONFIGURATION_BEAN_NAME_GENERATOR)) {
BeanNameGenerator generator = (BeanNameGenerator) sbr.getSingleton(CONFIGURATION_BEAN_NAME_GENERATOR);
this.componentScanBeanNameGenerator = generator;
this.importBeanNameGenerator = generator;
}
}
// Parse each @Configuration class
ConfigurationClassParser parser = new ConfigurationClassParser(
this.metadataReaderFactory, this.problemReporter, this.environment,
this.resourceLoader, this.componentScanBeanNameGenerator, registry);
Set<BeanDefinitionHolder> candidates = new LinkedHashSet<BeanDefinitionHolder>(configCandidates);
Set<ConfigurationClass> alreadyParsed = new HashSet<ConfigurationClass>(configCandidates.size());
do {
// 解析配置類，完成這一步流程後，在其內部對各類配置信息，包裝爲一個ConfigurationClass的集合
// 在加載bean的過程當中，實際上也是對這個集合進行各類操做，如：從@Bean方法加載bean、@Import導入配置等等
parser.parse(candidates);
parser.validate();
Set<ConfigurationClass> configClasses = new LinkedHashSet<ConfigurationClass>(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());
}
// 對ConfigurationClassParser持有的配置信息集合進行bean的加載。
// 至此，須要註冊到IOC容器的全部bean都已註冊完畢
this.reader.loadBeanDefinitions(configClasses);
alreadyParsed.addAll(configClasses);
candidates.clear();
if (registry.getBeanDefinitionCount() > candidateNames.length) {
String[] newCandidateNames = registry.getBeanDefinitionNames();
Set<String> oldCandidateNames = new HashSet<String>(Arrays.asList(candidateNames));
Set<String> alreadyParsedClasses = new HashSet<String>();
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) {
if (!sbr.containsSingleton(IMPORT_REGISTRY_BEAN_NAME)) {
sbr.registerSingleton(IMPORT_REGISTRY_BEAN_NAME, parser.getImportRegistry());
}
}
if (this.metadataReaderFactory instanceof CachingMetadataReaderFactory) {
((CachingMetadataReaderFactory) this.metadataReaderFactory).clearCache();
}
}
}
複製代碼
相關文章
- 1. Spring 源碼（二）註冊內置的BeanPostProcessor的BeanDefinition到容器
- 2. spring源碼解析 - spring容器加載源碼(beandefinition封裝和註冊過程)
- 3. SpringIOC源碼分析(一) ___IOC容器
- 4. Spring 源碼（三）註冊配置類 BeanDefinition 到容器
- 5. Spring IOC 源碼解析（二），容器中的 BeanDefinition（Annotation 解析篇）
- 6. SpringBoot2 | BeanDefinition 註冊核心類 ImportBeanDefinitionRegistrar 源碼分析 （十）
- 7. spring源碼閱讀（八）之BeanDefinition註冊
- 8. Spring源碼(二)SpringIOC初始化過程源碼分析-基於註解方式
- 9. BeanDefinition 解析和註冊
- 10. EventBus3.x源碼分析之註冊(二)
- 更多相關文章...
- • Lua 流程控制 - Lua 教程
- • Git 工作流程 - Git 教程
- • Java Agent入門實戰（二）-Instrumentation源碼概述
- • Docker容器實戰(七) - 容器眼光下的文件系統
相關標籤/搜索
每日一句
-
每一个你不满意的现在，都有一个你没有努力的曾经。
歡迎關注本站公眾號,獲取更多信息
相關文章
- 1. Spring 源碼（二）註冊內置的BeanPostProcessor的BeanDefinition到容器
- 2. spring源碼解析 - spring容器加載源碼(beandefinition封裝和註冊過程)
- 3. SpringIOC源碼分析(一) ___IOC容器
- 4. Spring 源碼（三）註冊配置類 BeanDefinition 到容器
- 5. Spring IOC 源碼解析（二），容器中的 BeanDefinition（Annotation 解析篇）
- 6. SpringBoot2 | BeanDefinition 註冊核心類 ImportBeanDefinitionRegistrar 源碼分析 （十）
- 7. spring源碼閱讀（八）之BeanDefinition註冊
- 8. Spring源碼(二)SpringIOC初始化過程源碼分析-基於註解方式
- 9. BeanDefinition 解析和註冊
- 10. EventBus3.x源碼分析之註冊(二)