- Spring IoC原理(三) IoC容器的初始化过程——BeanDefinition的载入与解析
- 前言
- 一、BeanDefinition的载入
- 二、BeanDefinition的解析
- 三、总结
在上一节Spring IoC原理(二) IoC容器的初始化过程——BeanDefinition的Resource定位中对BeanDefinition的Resource定位进行了介绍，本节将在上一节的基础上继续进行IoC容器初始化的分析。本节主要介绍的内容为BeanDefinition的载入与解析。
一、BeanDefinition的载入图1-1 BeanDefinition的载入过程
loadBeanDefinitions
通过调用getResources()方法得到XML资源并将得到结果resources，将得到的resources作为参数进行后续的BeanDefinition载入。
public int loadBeanDefinitions(String location, @Nullable SetactualResources) throws BeanDefinitionStoreException { ResourceLoader resourceLoader = getResourceLoader(); if (resourceLoader == null) { throw new BeanDefinitionStoreException( "Cannot load bean definitions from location [" + location + "]: no ResourceLoader available"); } if (resourceLoader instanceof ResourcePatternResolver) { // Resource pattern matching available. try { Resource[] resources = ((ResourcePatternResolver) resourceLoader).getResources(location); int count = loadBeanDefinitions(resources); } } }
registerBeanDefinitions
在经过一系列loadBeanDefinitions相关方法后将调用DefaultBeanDefinitionDocumentReader类中的registerBean Definitions()方法。首先创建一个BeanDefinitionDocumentReader类型的读取器documentReader ，并将resource转换为XmlReaderContext类型以便进行读取。调用documentReader的registerBeanDefinitions方法，将读取的DOM文件以及转换后的resource作为参数。
public int registerBeanDefinitions(Document doc, Resource resource) throws BeanDefinitionStoreException {
BeanDefinitionDocumentReader documentReader = createBeanDefinitionDocumentReader();
int countBefore = getRegistry().getBeanDefinitionCount();
documentReader.registerBeanDefinitions(doc, createReaderContext(resource));
return getRegistry().getBeanDefinitionCount() - countBefore;
}
public void registerBeanDefinitions(Document doc, XmlReaderContext readerContext) {
this.readerContext = readerContext;
doRegisterBeanDefinitions(doc.getDocumentElement());
}
doRegisterBeanDefinitions
documentReader 的registerBeanDefinitions并未直接进行BeanDefinition的载入，而是获取DOM文档的根节点，如图1-2所示，将得到的根节点作为参数调用DefaultBeanDefinitionDocument Reader类中的doRegisterBeanDefinitions()方法。
图1-2 getDocumentElement结果
doRegisterBeanDefinitions()方法中首先创建BeanDefinitionParserDelegate类型的parent，从名字就可以看出为BeanDefinition解析的委托类。将parent以及DOM根节点root作为参数调用parseBeanDefinitions()方法，进行后续的载入过程。
protected void doRegisterBeanDefinitions(Element root) {
BeanDefinitionParserDelegate parent = this.delegate;
this.delegate = createDelegate(getReaderContext(), root, parent);
if (this.delegate.isDefaultNamespace(root)) {
String profileSpec = root.getAttribute(PROFILE_ATTRIBUTE);
if (StringUtils.hasText(profileSpec)) {
String[] specifiedProfiles = StringUtils.tokenizeToStringArray(
profileSpec, BeanDefinitionParserDelegate.MULTI_VALUE_ATTRIBUTE_DELIMITERS);
if (!getReaderContext().getEnvironment().acceptsProfiles(specifiedProfiles)) {
if (logger.isDebugEnabled()) {
logger.debug("Skipped XML bean definition file due to specified profiles [" + profileSpec +
"] not matching: " + getReaderContext().getResource());
}
return;
}
}
}
preProcessXml(root);
parseBeanDefinitions(root, this.delegate);
postProcessXml(root);
this.delegate = parent;
}
parseBeanDefinitions
parseBeanDefinitions()方法对获取传入DOM根节点下的所有子节点，并调用parseDefaultElement()方法对每个子节点进行处理。
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;
// 判断ele是否为默认命名空间
if (delegate.isDefaultNamespace(ele)) {
parseDefaultElement(ele, delegate);
}
// 非默认命名空间进行特殊处理
else {
delegate.parseCustomElement(ele);
}
}
}
}
else {
delegate.parseCustomElement(root);
}
}
parseDefaultElement
parseDefaultElement()方法将根据子节点的不同类型进行相应的处理，由于载入的节点标签为，因此将调用processBeanDefinition()方法对子节点进行处理。
private void parseDefaultElement(Element ele, BeanDefinitionParserDelegate delegate) {
if (delegate.nodeNameEquals(ele, IMPORT_ELEMENT)) {
importBeanDefinitionResource(ele);
}
else if (delegate.nodeNameEquals(ele, ALIAS_ELEMENT)) {
processAliasRegistration(ele);
}
else if (delegate.nodeNameEquals(ele, BEAN_ELEMENT)) {
processBeanDefinition(ele, delegate);
}
else if (delegate.nodeNameEquals(ele, NESTED_BEANS_ELEMENT)) {
// recurse
doRegisterBeanDefinitions(ele);
}
}
processBeanDefinition
processBeanDefinition()方法中将调用parseBeanDefinitionElement()方法对子节点进行解析，并得到BeanDefinitionHolder类型的bdHolder用来储存解析出来的BeanDefinition。
protected void processBeanDefinition(Element ele, BeanDefinitionParserDelegate delegate) {
BeanDefinitionHolder bdHolder = delegate.parseBeanDefinitionElement(ele);
if (bdHolder != null) {
bdHolder = delegate.decorateBeanDefinitionIfRequired(ele, bdHolder);
try {
// Register the final decorated instance.
BeanDefinitionReaderUtils.registerBeanDefinition(bdHolder, getReaderContext().getRegistry());
}
catch (BeanDefinitionStoreException ex) {
getReaderContext().error("Failed to register bean definition with name '" +
bdHolder.getBeanName() + "'", ele, ex);
}
// Send registration event.
getReaderContext().fireComponentRegistered(new BeanComponentDefinition(bdHolder));
}
}
二、BeanDefinition的解析
parseBeanDefinitionElement
BeanDefinitionParserDelegate类中有多个重载的parseBeanDefinitionElement()方法，BeanDefinition的解析首先调用的parseBeanDefinitionElement()方法对节点进行解析并将解析出的BeanDefinition存入BeanDefinitionHolder。方法内首先对bean属性进行简单的解析得到id、name属性，并进行合法性检查。在完成相关处理后将调用parseBeanDefinitionElement()方法进行进一步解析。在得到beanDefinition后将对其包装为BeanDefinitionHolder类型并返回。
public BeanDefinitionHolder parseBeanDefinitionElement(Element ele, @Nullable BeanDefinition containingBean) {
String id = ele.getAttribute(ID_ATTRIBUTE);
String nameAttr = ele.getAttribute(NAME_ATTRIBUTE);
List aliases = new ArrayList<>();
if (StringUtils.hasLength(nameAttr)) {
String[] nameArr = StringUtils.tokenizeToStringArray(nameAttr, MULTI_VALUE_ATTRIBUTE_DELIMITERS);
aliases.addAll(Arrays.asList(nameArr));
}
String beanName = id;
if (!StringUtils.hasText(beanName) && !aliases.isEmpty()) {
beanName = aliases.remove(0);
if (logger.isTraceEnabled()) {
logger.trace("No XML 'id' specified - using '" + beanName +
"' as bean name and " + aliases + " as aliases");
}
}
if (containingBean == null) {
checkNameUniqueness(beanName, aliases, ele);
}
AbstractBeanDefinition beanDefinition = parseBeanDefinitionElement(ele, beanName, containingBean);
if (beanDefinition != null) {
if (!StringUtils.hasText(beanName)) {
try {
if (containingBean != null) {
beanName = BeanDefinitionReaderUtils.generateBeanName(
beanDefinition, this.readerContext.getRegistry(), true);
}
else {
beanName = this.readerContext.generateBeanName(beanDefinition);
// Register an alias for the plain bean class name, if still possible,
// if the generator returned the class name plus a suffix.
// This is expected for Spring 1.2/2.0 backwards compatibility.
String beanClassName = beanDefinition.getBeanClassName();
if (beanClassName != null &&
beanName.startsWith(beanClassName) && beanName.length() > beanClassName.length() &&
!this.readerContext.getRegistry().isBeanNameInUse(beanClassName)) {
aliases.add(beanClassName);
}
}
if (logger.isTraceEnabled()) {
logger.trace("Neither XML 'id' nor 'name' specified - " +
"using generated bean name [" + beanName + "]");
}
}
catch (Exception ex) {
error(ex.getMessage(), ele);
return null;
}
}
String[] aliasesArray = StringUtils.toStringArray(aliases);
return new BeanDefinitionHolder(beanDefinition, beanName, aliasesArray);
}
return null;
}
parseBeanDefinitionElement
此处的parseBeanDefinitionElement()方法将继续对bean属性进行解析得到class和parent属性，并根据class和parent创建一个AbstractBeanDefinition。接下来将对bean进行全面解析，parseBeanDefinitionAttributes()将对当前bean进行属性解析，parseProperty Element()解析当前bean的property设置，parseConstructorArgElements()对设置的构造函数进行解析等等。
public AbstractBeanDefinition parseBeanDefinitionElement(
Element ele, String beanName, @Nullable BeanDefinition containingBean) {
this.parseState.push(new BeanEntry(beanName));
String className = null;
if (ele.hasAttribute(CLASS_ATTRIBUTE)) {
className = ele.getAttribute(CLASS_ATTRIBUTE).trim();
}
String parent = null;
if (ele.hasAttribute(PARENT_ATTRIBUTE)) {
parent = ele.getAttribute(PARENT_ATTRIBUTE);
}
try {
AbstractBeanDefinition bd = createBeanDefinition(className, parent);
parseBeanDefinitionAttributes(ele, beanName, containingBean, bd);
bd.setDescription(DomUtils.getChildElementValueByTagName(ele, DESCRIPTION_ELEMENT));
parseMetaElements(ele, bd);
parseLookupOverrideSubElements(ele, bd.getMethodOverrides());
parseReplacedMethodSubElements(ele, bd.getMethodOverrides());
parseConstructorArgElements(ele, bd);
parsePropertyElements(ele, bd);
parseQualifierElements(ele, bd);
bd.setResource(this.readerContext.getResource());
bd.setSource(extractSource(ele));
return bd;
}
return null;
}
三、总结
经过了BeanDefinition的载入与解析，在XML文件中设置的bean相关信息已经全部转化为数据结构，接下来将在解析后的BeanDefinition的基础上进行bean的注册。
