spring源码:注册BeanDefinition(xml方式)

一、目的

前面讲到spring读取xml文件后,会得到一个Document对象。接下来就要解析Document转换为spring认识的BeanDefinition( 具体实现为GenericBeanDefinition)对象,这个转换的过程即注册BeanDefinition(简称注册bean)。注册BeanDefinition的目的在于,后面spring使用到xml的配置信息时,无需每次都从Document中解析读取,直接从BeanDefinition中即可轻松获取想要的配置信息。

二、相关类

  • org.springframework.beans.factory.xml.XmlBeanDefinitionReader:加载和注册bean的入口
  • org.springframework.beans.factory.xml.DefaultBeanDefinitionDocumentReader:真正执行注册bean的逻辑

三、源码分析

  1. XmlBeanDefinitionReader加载BeanDefinition
	protected int doLoadBeanDefinitions(InputSource inputSource, Resource resource)
			throws BeanDefinitionStoreException {
		try {
			// 1.从xml文档中读取Document
			Document doc = doLoadDocument(inputSource, resource);
			// 2.注册BeanDefinition,本篇主要分析这个
			return registerBeanDefinitions(doc, resource);
		}
		// 省略异常代码
		... ...
	}

	public int registerBeanDefinitions(Document doc, Resource resource) throws BeanDefinitionStoreException {
		// 1.实例化一个DefaultBeanDefinitionDocumentReader对象并强转为BeanDefinitionDocumentReader 
		BeanDefinitionDocumentReader documentReader = createBeanDefinitionDocumentReader();
		// 2.记录已注册BeanDefinition的个数
		int countBefore = getRegistry().getBeanDefinitionCount();
		// 3.注册bean  继续分析这个方法(见2)
		documentReader.registerBeanDefinitions(doc, createReaderContext(resource));
		// 4.返回本次注册的个数
		return getRegistry().getBeanDefinitionCount() - countBefore;
	}

可以看到我们常说的加载BeanDefinition,可分为两步:获取Document、注册BeanDefinition。
2. DefaultBeanDefinitionDocumentReader执行注册bean的逻辑

	@Override
	public void registerBeanDefinitions(Document doc, XmlReaderContext readerContext) {
		this.readerContext = readerContext;
		logger.debug("Loading bean definitions");
		// document转element,即beans标签的抽象
		Element root = doc.getDocumentElement();
		// doXxx()来执行真正的注册逻辑
		doRegisterBeanDefinitions(root);
	}
	protected void doRegisterBeanDefinitions(Element root) {
		BeanDefinitionParserDelegate parent = this.delegate;
		this.delegate = createDelegate(getReaderContext(), root, parent);
		if (this.delegate.isDefaultNamespace(root)) {
			// 获取beans标签中profile的属性值
			String profileSpec = root.getAttribute(PROFILE_ATTRIBUTE);
			// 若profile的属性值存在,则需要判断当前环境中是否有与之匹配的profile值
			if (StringUtils.hasText(profileSpec)) {
				String[] specifiedProfiles = StringUtils.tokenizeToStringArray(
						profileSpec, BeanDefinitionParserDelegate.MULTI_VALUE_ATTRIBUTE_DELIMITERS);
				// 当前环境中spring.profiles.active/spring.profiles.default作为key对应的值需要与之匹配,才能加载该beans标签
				// 可以通过启动参数指定,如:-Dspring.profiles.active=test
				if (!getReaderContext().getEnvironment().acceptsProfiles(specifiedProfiles)) {
					if (logger.isInfoEnabled()) {
						logger.info("Skipped XML bean definition file due to specified profiles [" + profileSpec +
								"] not matching: " + getReaderContext().getResource());
					}
					return;
				}
			}
		}
		// 空方法,由子类做具体实现 
		preProcessXml(root);
		// 解析beanDefinition
		parseBeanDefinitions(root, this.delegate);
		// 空方法,由子类做具体实现 
		postProcessXml(root);
		
		this.delegate = parent;
	}

	protected void parseBeanDefinitions(Element root, BeanDefinitionParserDelegate delegate) {
		if (delegate.isDefaultNamespace(root)) {
			// 获取beans标签的字标签,即bean标签
			NodeList nl = root.getChildNodes();
			// 循环处理bean标签
			for (int i = 0; i < nl.getLength(); i++) {
				Node node = nl.item(i);
				if (node instanceof Element) {
					Element ele = (Element) node;
					// 使用node.getNamespaceURI()获取命名空间与“http://www.springframework.org/schema/beans”
					// 相比较,判断是否为spring的默认标签
					if (delegate.isDefaultNamespace(ele)) {
						// 默认标签解析
						parseDefaultElement(ele, delegate);
					}
					else {
						// 自定义标签解析
						delegate.parseCustomElement(ele);
					}
				}
			}
		}
		else {
			delegate.parseCustomElement(root);
		}
	}

四、总结

  1. XmlBeanDefinitionReader加载xml获取Document,传递给DefaultBeanDefinitionDocumentReader去注册bean。
  2. DefaultBeanDefinitionDocumentReader先判断beans标签是否存在profile属性,若存在则判断当前beans标签与当前环境中的profile值是否匹配。若匹配继续加载;若不匹配则结束该文档的解析。
  3. DefaultBeanDefinitionDocumentReader的parseBeanDefinitions()方法在解析bean时,使用node.getNamespaceURI()获取该节点命名空间。根据此命名空间来判断使用默认解析,还是使用自定义标签解析。

具体节点的解析内容,后面的文章会继续分析,本章重点在于注册bean的整体过程。

五、借鉴点

  1. org.springframework.beans.factory.xml.DefaultBeanDefinitionDocumentReader#doRegisterBeanDefinitions
    使用模板方法模式定义定义调用各个方法的顺序,这些方法可以由子类去实现扩展。
	// 此方法就是一个方法调用的模板,里面的各个子方法可由子类实现扩展
	protected void doRegisterBeanDefinitions(Element root) {
		BeanDefinitionParserDelegate parent = this.delegate;
		this.delegate = createDelegate(getReaderContext(), root, parent);

		if (this.delegate.isDefaultNamespace(root)) {
			... ...
		}

		// 可由子类实现扩展
		preProcessXml(root);
		parseBeanDefinitions(root, this.delegate);
		// 可由子类实现扩展
		postProcessXml(root);

		this.delegate = parent;
	}
  • 0
    点赞
  • 0
    收藏
    觉得还不错? 一键收藏
  • 0
    评论
评论
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

当前余额3.43前往充值 >
需支付:10.00
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明:

1.余额是钱包充值的虚拟货币,按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载,可以购买VIP、付费专栏及课程。

余额充值