BeanDefinition信息加载原理

BeanDefinition加载原理

  • 几个重要的类
    • BeanDefinitionRegistry(DefaultListableBeanFactory)
    • XmlBeanDefinitionReader
    • XmlReaderContext
    • DefaultBeanDefinitionDocumentReader
    • BeanDefinitionParserDelegate
  • 重要代码实现
    • 创建XmlBeanDefinitionReader对象
    • 跳过一系列重载方法,到注册BeanDefinition信息
    • 注册BeanDefinition信息到注册表中
    • 解析xml配置信息

几个重要的类

BeanDefinition信息加载原理_第1张图片

BeanDefinitionRegistry(DefaultListableBeanFactory)

BeanDefinition注册表,用来注册Bean定义信息。因为DefaultListableBeanFactory实现了BeanDefinitionRegistry接口,所以在加载BeanDefinition时,直接将BeanDefinition注册到了DefaultListableBeanFactory中。

XmlBeanDefinitionReader

BeanDefinition读取器,用来读取xml中配置的Bean定义信息。这个类重载了n多loadBeanDefinitions方法,但最终doLoadBeanDefinitions方法中,具体的读取工作还是委托给BeanDefinitionDocumentReader的实现类完成的。

XmlReaderContext

为BeanDefinitionDocumentReader的实现类提供在读取器中配置的NamespaceHandlerResolver的访问。

DefaultBeanDefinitionDocumentReader

实现了BeanDefinitionDocumentReader接口,读取xml文档中的配置信息,并将配置信息的解析工作委托给BeanDefinitionParserDelegate。

BeanDefinitionParserDelegate

解析xml节点信息,并注册到BeanDefinition注册表中。

重要代码实现

创建XmlBeanDefinitionReader对象

将Bean工厂DefaultListableBeanFactory作为BeanDefinitionRegistry传给XmlBeanDefinitionReader对象。

public abstract class AbstractXmlApplicationContext extends AbstractRefreshableConfigApplicationContext {
	@Override
	protected void loadBeanDefinitions(DefaultListableBeanFactory beanFactory) throws BeansException, IOException {
		// 创建XmlBeanDefinitionReader对象,构造方法入参是BeanDefinitionRegistry
		XmlBeanDefinitionReader beanDefinitionReader = new XmlBeanDefinitionReader(beanFactory);

		beanDefinitionReader.setEnvironment(this.getEnvironment());
		beanDefinitionReader.setResourceLoader(this);
		beanDefinitionReader.setEntityResolver(new ResourceEntityResolver(this));

		initBeanDefinitionReader(beanDefinitionReader);
		// 开始加载BeanDefinition信息
		loadBeanDefinitions(beanDefinitionReader);
	}
}

跳过一系列重载方法,到注册BeanDefinition信息

  1. 创建BeanDefinitionDocumentReader对象。
  2. 创建XmlReaderContext对象,并将当前XmlBeanDefinitionReader对象传给XmlReaderContext。
  3. 委托BeanDefinitionDocumentReader对象读取BeanDefinition信息,调用registerBeanDefinitions方法,并将XmlReaderContext对象作为参数传到方法中。
public class XmlBeanDefinitionReader extends AbstractBeanDefinitionReader {
	public int registerBeanDefinitions(Document doc, Resource resource) throws BeanDefinitionStoreException {
		// 创建BeanDefinitionDocumentReader对象
		BeanDefinitionDocumentReader documentReader = createBeanDefinitionDocumentReader();
		int countBefore = getRegistry().getBeanDefinitionCount();
		// 创建XmlReaderContext对象
		// 委托BeanDefinitionDocumentReader对象读取BeanDefinition信息
		documentReader.registerBeanDefinitions(doc, createReaderContext(resource));
		return getRegistry().getBeanDefinitionCount() - countBefore;
	}

	public XmlReaderContext createReaderContext(Resource resource) {
		return new XmlReaderContext(resource, this.problemReporter, this.eventListener,
				this.sourceExtractor, this, getNamespaceHandlerResolver());
	}

	protected BeanDefinitionDocumentReader createBeanDefinitionDocumentReader() {
		return BeanUtils.instantiateClass(this.documentReaderClass);
	}
}

注册BeanDefinition信息到注册表中

  1. 获取XmlReadContext对象,并创建BeanDefinitionParserDelegate对象
  2. 使用BeanDefinitionParserDelegate对象来解析xml配置信息。
public class DefaultBeanDefinitionDocumentReader implements BeanDefinitionDocumentReader {
	@Override
	public void registerBeanDefinitions(Document doc, XmlReaderContext readerContext) {
		this.readerContext = readerContext;
		doRegisterBeanDefinitions(doc.getDocumentElement());
	}

	protected void doRegisterBeanDefinitions(Element root) {
		BeanDefinitionParserDelegate parent = this.delegate;
		// 获取XmlReadContext对象,并创建BeanDefinitionParserDelegate对象
		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);
		// 解析xml配置信息
		parseBeanDefinitions(root, this.delegate);
		postProcessXml(root);

		this.delegate = parent;
	}
}

解析xml配置信息

解析xml配置信息,从XmlReadContext中拿到BeanDefinitionRegistry,将解析后的信息注册到注册表中。

  1. 解析默认元素,包括import、alias、bean、beans标签
  2. 解析自定义元素,包括context等需要自定义命名空间的标签
	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);
		}
	}

	private void parseDefaultElement(Element ele, BeanDefinitionParserDelegate delegate) {
		if (delegate.nodeNameEquals(ele, IMPORT_ELEMENT)) {
			// import标签
			importBeanDefinitionResource(ele);
		}
		else if (delegate.nodeNameEquals(ele, ALIAS_ELEMENT)) {
			// alias标签
			processAliasRegistration(ele);
		}
		else if (delegate.nodeNameEquals(ele, BEAN_ELEMENT)) {
			// bean标签
			processBeanDefinition(ele, delegate);
		}
		else if (delegate.nodeNameEquals(ele, NESTED_BEANS_ELEMENT)) {
			// beans标签,递归执行
			doRegisterBeanDefinitions(ele);
		}
	}

	@Nullable
	public BeanDefinition parseCustomElement(Element ele, @Nullable BeanDefinition containingBd) {
		String namespaceUri = getNamespaceURI(ele);
		if (namespaceUri == null) {
			return null;
		}
		// 从XmlReaderContext中获取NamespaceHandlerResolver
		NamespaceHandler handler = this.readerContext.getNamespaceHandlerResolver().resolve(namespaceUri);
		if (handler == null) {
			error("Unable to locate Spring NamespaceHandler for XML schema namespace [" + namespaceUri + "]", ele);
			return null;
		}
		return handler.parse(ele, new ParserContext(this.readerContext, this, containingBd));
	}

BeanDefinitionRegistry -> XmlBeanDefinitionReader -> XmlReadContext -> BeanDefinitionParserDelegate
总结:对象一层一层往下传递,所以在BeanDefinitionParserDelegate对象实际解析的过程中,可以直接将解析出来的信息注册到工厂中。

Spring原理之IOC容器

你可能感兴趣的:(spring,java,开发语言,spring)