1. 什么时候使用到
当使用到 context:annotation-config/ 或者context:component-scan/配置的时候,及声明做为其它BeanFactoryPostProcessor的时候。
本例使用:
<context:component-scan base-package="com.songbl.config" ></context:component-scan>
2.1 源码分析
容器启动,在解析配置文件的时候:
DefaultBeanDefinitionDocumentReader.java
->
protected void parseBeanDefinitions(Element root, BeanDefinitionParserDelegate delegate) {
if (delegate.isDefaultNamespace(root)) {
NodeList nl = root.getChildNodes();
for (int i = 0; i < nl.getLength(); i++) {
Node node = nl.item(i);
if (node instanceof Element) {
Element ele = (Element) node;
if (delegate.isDefaultNamespace(ele)) {
parseDefaultElement(ele, delegate);
}
else {
//调用其它自定义解析器。
//根据命名空间获取处理器,在处理器中根据属性标签,获取解析器,解析
delegate.parseCustomElement(ele);
}
}
}
}
else {
delegate.parseCustomElement(root);
}
}
//=================
//=>
public BeanDefinition parseCustomElement(Element ele, @Nullable BeanDefinition containingBd) {
// 获取对应的命名空间
String namespaceUri = getNamespaceURI(ele);
if (namespaceUri == null) {
return null;
}
// 根据命名空间找到对应的NamespaceHandler 接口->对象,
// 根据命名空间uri,找到value ,再实例化处理器。处理器包含解析器,根据ele找到解析器
//内部有实例化的调用,实例化NamespaceHander
NamespaceHandler handler = this.readerContext.getNamespaceHandlerResolver().resolve(namespaceUri);
if (handler == null) {
error("Unable to locate Spring NamespaceHandler for XML schema namespace [" + namespaceUri + "]", ele);
return null;
}//举例使用ContextNamespaceHandler ,map里面有很多解析器
// 调用自定义的NamespaceHandler进行解析。通过findParserForElement,找到对应的解析器
//parse 是根据属性标签找到的
return handler.parse(ele, new ParserContext(this.readerContext, this, containingBd));
}
//===============================
// hander 实例化时候会注册一些解析器
//注册各种解析器,其中有ComponentScanBeanDefinitionParser
ContextNamespaceHandler.java
@Override
public void init() {
registerBeanDefinitionParser("property-placeholder", new PropertyPlaceholderBeanDefinitionParser());
registerBeanDefinitionParser("property-override", new PropertyOverrideBeanDefinitionParser());
registerBeanDefinitionParser("annotation-config", new AnnotationConfigBeanDefinitionParser());
//=====用到扫描parse,就回加上InterXXconfigXXX=====
registerBeanDefinitionParser("component-scan", new ComponentScanBeanDefinitionParser());
registerBeanDefinitionParser("load-time-weaver", new LoadTimeWeaverBeanDefinitionParser());
registerBeanDefinitionParser("spring-configured", new SpringConfiguredBeanDefinitionParser());
....
}
spring.handlers:
http\://www.springframework.org/schema/context=org.springframework.context.config.ContextNamespaceHandler
根据指定的xml,实例化对应的Hander,在实例化Hander的同时,也注册了解析器。假如application.xml文件是:
<context:component-scan base-package=“com.mashibing.config” ></context:component-scan>,那么上面的parse方法即开始调用对应类的parse(…),本例使用ComponentScanBeanDefinitionParser。
开始调用: parse() 解析方法。
接上面的parse方法
ComponentScanBeanDefinitionParser.java
public BeanDefinition parse(Element element, ParserContext parserContext) {
// 获取<context:component-scan>节点的base-package属性值
String basePackage = element.getAttribute(BASE_PACKAGE_ATTRIBUTE);
// 解析占位符
basePackage = parserContext.getReaderContext().getEnvironment().resolvePlaceholders(basePackage);
// 解析base-package
String[] basePackages = StringUtils.tokenizeToStringArray(basePackage,
ConfigurableApplicationContext.CONFIG_LOCATION_DELIMITERS);
// 构建和配置ClassPathBeanDefinitionScanner
ClassPathBeanDefinitionScanner scanner = configureScanner(parserContext, element);
// 使用scanner在执行的basePackages包中执行扫描,返回已注册的bean定义
Set<BeanDefinitionHolder> beanDefinitions = scanner.doScan(basePackages);
// 组件注册(包括注册一些内部的注解后置处理器,触发注册事件)。
//扫描,下面有internalXXConfigurationXX
registerComponents(parserContext.getReaderContext(), beanDefinitions, element);
return null;
}
2.1.1.1 doScan()-扫描
使用scanner扫描指定包下的类,拿到bean信息后进行注册。返回已注册的bean信息用于注册组件。
protected Set<BeanDefinitionHolder> doScan(String... basePackages) {
Assert.notEmpty(basePackages, "At least one base package must be specified");
Set<BeanDefinitionHolder> beanDefinitions = new LinkedHashSet<>();
// 遍历basePackages
for (String basePackage : basePackages) {
// 扫描basePackage,将符合要求的bean定义全部找出来
Set<BeanDefinition> candidates = findCandidateComponents(basePackage);
// 遍历所有候选的bean定义
for (BeanDefinition candidate : candidates) {
// 解析@Scope注解,包括scopeName和proxyMode
ScopeMetadata scopeMetadata = this.scopeMetadataResolver.resolveScopeMetadata(candidate);
candidate.setScope(scopeMetadata.getScopeName());
// 使用beanName生成器来生成beanName
String beanName = this.beanNameGenerator.generateBeanName(candidate, this.registry);
if (candidate instanceof AbstractBeanDefinition) {
// 处理beanDefinition对象,例如,此bean是否可以自动装配到其他bean中
postProcessBeanDefinition((AbstractBeanDefinition) candidate, beanName);
}
if (candidate instanceof AnnotatedBeanDefinition) {
// 处理定义在目标类上的通用注解,包括@Lazy,@Primary,@DependsOn,@Role,@Description
AnnotationConfigUtils.processCommonDefinitionAnnotations((AnnotatedBeanDefinition) candidate);
}
// 检查beanName是否已经注册过,如果注册过,检查是否兼容
if (checkCandidate(beanName, candidate)) {
// 将当前遍历bean的bean定义和beanName封装成BeanDefinitionHolder
BeanDefinitionHolder definitionHolder = new BeanDefinitionHolder(candidate, beanName);
// 根据proxyMode的值,选择是否创建作用域代理
definitionHolder =
AnnotationConfigUtils.applyScopedProxyMode(scopeMetadata, definitionHolder, this.registry);
beanDefinitions.add(definitionHolder);
// =======注册beanDefinition========
registerBeanDefinition(definitionHolder, this.registry);
}
}
}
return beanDefinitions;
}
2.1.1.2 注册组件
其中有一个重要的configurationclasspostprocessor的beanName
protected void registerComponents(
XmlReaderContext readerContext, Set<BeanDefinitionHolder> beanDefinitions, Element element) {
Object source = readerContext.extractSource(element);
// 使用注解的tagName和source构建CompositeComponentDefinition
CompositeComponentDefinition compositeDef = new CompositeComponentDefinition(element.getTagName(), source);
// 将扫描到的所有beanDefinition添加到compositeDef的nestedComponents属性中
for (BeanDefinitionHolder beanDefHolder : beanDefinitions) {
compositeDef.addNestedComponent(new BeanComponentDefinition(beanDefHolder));
}
// Register annotation config processors, if necessary.
boolean annotationConfig = true;
if (element.hasAttribute(ANNOTATION_CONFIG_ATTRIBUTE)) {
// 获取component-scan标签的annotation-config属性值,默认为true
annotationConfig = Boolean.parseBoolean(element.getAttribute(ANNOTATION_CONFIG_ATTRIBUTE));
}
if (annotationConfig) {
// 如果annotation-config属性值为true,在给定的注册表中注册所有用于注解的bean后置处理器
Set<BeanDefinitionHolder> processorDefinitions =
AnnotationConfigUtils.registerAnnotationConfigProcessors(readerContext.getRegistry(), source);
for (BeanDefinitionHolder processorDefinition : processorDefinitions) {
// *******其中有一个重要的configurationclasspostprocessor******
// 将注册的注解后置处理器的BeanDefinition添加到compositeDef的nestedComponents属性中
compositeDef.addNestedComponent(new BeanComponentDefinition(processorDefinition));
}
}
// 触发组件注册事件,默认实现为EmptyReaderEventListener
readerContext.fireComponentRegistered(compositeDef);
}
//====================
registerAnnotationConfigProcessors(.....){
.......
// 注册内部管理的用于处理@configuration注解的后置处理器的bean
if (!registry.containsBeanDefinition(CONFIGURATION_ANNOTATION_PROCESSOR_BEAN_NAME)) {
RootBeanDefinition def = new RootBeanDefinition(ConfigurationClassPostProcessor.class);
def.setSource(source);
// 注册BeanDefinition到注册表中,registerBeanPostProcessors(beanFactory)的时候实例化并调用。ConfigurationClassPostProcessor到注册表中(internalConfigurationAnnotationProcessor)
beanDefs.add(registerPostProcessor(registry, def, CONFIGURATION_ANNOTATION_PROCESSOR_BEAN_NAME));
}
}
3. 思考
在读取配置文件的时候,解析,遇见 context:component-scan,实例化Hander,同时注册各种解析器,调用parse(),开始使用对应的解析器开始解析,componentScanBeanDefinitionParse-parse(),各种解析,最后回注册ConfigurationClassPostProcessor,待到
refresh()->
registerBeanPostProcessors(beanFactory);实例化、调用