Spring源码讲解之 registerBeanDefinitions 方法

registerBeanDefinitions 方法是在接口 org.springframework.beans.factory.xml.BeanDefinitionDocumentReader 中定义的，主要作用是：从指定的 DOM 文档中读取 bean 定义并将其注册到 bean 定义表中，该方法第一个参数是 org.w3c.dom.Document 类型（包含 bean 定义信息的 document），第二个参数是 org.springframework.beans.factory.xml.XmlReaderContext 类型（xml 读取器上下文，包含目标 bean 工厂和 bean 定义资源），返回值类型为 void，当解析 bean 定义出错时会抛出 org.springframework.beans.factory.BeanDefinitionStoreException 异常。

源码

void registerBeanDefinitions(Document doc, XmlReaderContext readerContext)
			throws BeanDefinitionStoreException;

registerBeanDefinitions 方法在 org.springframework.beans.factory.xml.DefaultBeanDefinitionDocumentReader 类中的实现

public void registerBeanDefinitions(Document doc, XmlReaderContext readerContext) {
	this.readerContext = readerContext;
	// 解析 document 中的 bean 定义信息并注册到 bean 工厂中
	doRegisterBeanDefinitions(doc.getDocumentElement());
}

doRegisterBeanDefinitions 的实现

@SuppressWarnings("deprecation")  // for Environment.acceptsProfiles(String...)
protected void doRegisterBeanDefinitions(Element root) {
	// Any nested <beans> elements will cause recursion in this method. In
	// order to propagate and preserve <beans> default-* attributes correctly,
	// keep track of the current (parent) delegate, which may be null. Create
	// the new (child) delegate with a reference to the parent for fallback purposes,
	// then ultimately reset this.delegate back to its original (parent) reference.
	// this behavior emulates a stack of delegates without actually necessitating one.
	BeanDefinitionParserDelegate parent = this.delegate;
	// 创建 bean 定义解析器
	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);
			// We cannot use Profiles.of(...) since profile expressions are not supported
			// in XML config. See SPR-12458 for details.
			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;
			}
		}
	}

	// 解析 bean 定义之前处理 xml 对象，例如解析自定义 xml 元素，默认实现是空
	preProcessXml(root);
	// 解析指定 document 中的 import、alias 和 bean 等根元素
	parseBeanDefinitions(root, this.delegate);
	// 解析 bean 定义之后处理 xml 对象，例如解析自定义 xml 元素，默认实现是空
	postProcessXml(root);

	this.delegate = parent;
}

createDelegate 方法的实现

protected BeanDefinitionParserDelegate createDelegate(
		XmlReaderContext readerContext, Element root, @Nullable BeanDefinitionParserDelegate parentDelegate) {

	BeanDefinitionParserDelegate delegate = new BeanDefinitionParserDelegate(readerContext);
	delegate.initDefaults(root, parentDelegate);
	return delegate;
}

preProcessXml 方法的实现

protected void preProcessXml(Element root) {
}

parseBeanDefinitions 方法的实现

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)) {
					// 解析默认的根元素（import、alias 和 bean）
					parseDefaultElement(ele, delegate);
				}
				else {
					delegate.parseCustomElement(ele);
				}
			}
		}
	}
	else {
		delegate.parseCustomElement(root);
	}
}

parseDefaultElement 方法的实现

private void parseDefaultElement(Element ele, BeanDefinitionParserDelegate delegate) {
	if (delegate.nodeNameEquals(ele, IMPORT_ELEMENT)) {
		// 解析 import 元素并将其指定资源中包含的 bean 定义信息添加到 bean 定义信息表中，
		// 方便 bean 工厂创建对应的 bean 实例
		importBeanDefinitionResource(ele);
	}
	else if (delegate.nodeNameEquals(ele, ALIAS_ELEMENT)) {
		// 解析 alias 元素，并将其结果添加到 bean 定义信息表中
		processAliasRegistration(ele);
	}
	else if (delegate.nodeNameEquals(ele, BEAN_ELEMENT)) {
		// 解析 bean 元素，并将其添加到 bean 定义信息表中
		processBeanDefinition(ele, delegate);
	}
	else if (delegate.nodeNameEquals(ele, NESTED_BEANS_ELEMENT)) {
		// recurse
		// 解析 beans 元素，并将其中的包含的 bean 定义添加到 bean 定义信息表中
		doRegisterBeanDefinitions(ele);
	}
}

importBeanDefinitionResource 方法的实现

protected void importBeanDefinitionResource(Element ele) {
	String location = ele.getAttribute(RESOURCE_ATTRIBUTE);
	if (!StringUtils.hasText(location)) {
		getReaderContext().error("Resource location must not be empty", ele);
		return;
	}

	// Resolve system properties: e.g. "${user.dir}"
	location = getReaderContext().getEnvironment().resolveRequiredPlaceholders(location);

	Set<Resource> actualResources = new LinkedHashSet<>(4);

	// Discover whether the location is an absolute or relative URI
	boolean absoluteLocation = false;
	try {
		absoluteLocation = ResourcePatternUtils.isUrl(location) || ResourceUtils.toURI(location).isAbsolute();
	}
	catch (URISyntaxException ex) {
		// cannot convert to an URI, considering the location relative
		// unless it is the well-known Spring prefix "classpath*:"
	}

	// Absolute or relative?
	if (absoluteLocation) {
		try {
			int importCount = getReaderContext().getReader().loadBeanDefinitions(location, actualResources);
			if (logger.isTraceEnabled()) {
				logger.trace("Imported " + importCount + " bean definitions from URL location [" + location + "]");
			}
		}
		catch (BeanDefinitionStoreException ex) {
			getReaderContext().error(
					"Failed to import bean definitions from URL location [" + location + "]", ele, ex);
		}
	}
	else {
		// No URL -> considering resource location as relative to the current file.
		try {
			int importCount;
			Resource relativeResource = getReaderContext().getResource().createRelative(location);
			if (relativeResource.exists()) {
				importCount = getReaderContext().getReader().loadBeanDefinitions(relativeResource);
				actualResources.add(relativeResource);
			}
			else {
				String baseLocation = getReaderContext().getResource().getURL().toString();
				importCount = getReaderContext().getReader().loadBeanDefinitions(
						StringUtils.applyRelativePath(baseLocation, location), actualResources);
			}
			if (logger.isTraceEnabled()) {
				logger.trace("Imported " + importCount + " bean definitions from relative location [" + location + "]");
			}
		}
		catch (IOException ex) {
			getReaderContext().error("Failed to resolve current resource location", ele, ex);
		}
		catch (BeanDefinitionStoreException ex) {
			getReaderContext().error(
					"Failed to import bean definitions from relative location [" + location + "]", ele, ex);
		}
	}
	Resource[] actResArray = actualResources.toArray(new Resource[0]);
	getReaderContext().fireImportProcessed(location, actResArray, extractSource(ele));
}

processAliasRegistration 方法的实现

protected void processAliasRegistration(Element ele) {
	String name = ele.getAttribute(NAME_ATTRIBUTE);
	String alias = ele.getAttribute(ALIAS_ATTRIBUTE);
	boolean valid = true;
	if (!StringUtils.hasText(name)) {
		getReaderContext().error("Name must not be empty", ele);
		valid = false;
	}
	if (!StringUtils.hasText(alias)) {
		getReaderContext().error("Alias must not be empty", ele);
		valid = false;
	}
	if (valid) {
		try {
			getReaderContext().getRegistry().registerAlias(name, alias);
		}
		catch (Exception ex) {
			getReaderContext().error("Failed to register alias '" + alias +
					"' for bean with name '" + name + "'", ele, ex);
		}
		getReaderContext().fireAliasRegistered(name, alias, extractSource(ele));
	}
}

processBeanDefinition 方法的实现

protected void processBeanDefinition(Element ele, BeanDefinitionParserDelegate delegate) {
	// 解析 bean 元素并将结果转存储到 BeanDefinitionHolder 中 
	BeanDefinitionHolder bdHolder = delegate.parseBeanDefinitionElement(ele);
	if (bdHolder != null) {
		// 处理带命名空间的元素属性
		bdHolder = delegate.decorateBeanDefinitionIfRequired(ele, bdHolder);
		try {
			// 将 bean 定义信息注册到 bean 工厂中.
			BeanDefinitionReaderUtils.registerBeanDefinition(bdHolder, getReaderContext().getRegistry());
		}
		catch (BeanDefinitionStoreException ex) {
			getReaderContext().error("Failed to register bean definition with name '" +
					bdHolder.getBeanName() + "'", ele, ex);
		}
		// 触发 registration 事件.
		getReaderContext().fireComponentRegistered(new BeanComponentDefinition(bdHolder));
	}
}

postProcessXml 方法的实现

protected void postProcessXml(Element root) {
}

本文详细讲解了 registerBeanDefinitions 方法的处理过程，importBeanDefinitionResource 和 processAliasRegistration 两个方法没有讲解，只是将其实现代码进行了描述，因为这两个方法在现实开发中用的比较少。如果开发中用到这两个方法的可以自己研究一下源码，如果有不懂得地方，大家可以一起讨论。