天天看點

spring-mvc源碼-bean定義加載-預設标簽解析(bean)

接上篇:bean定義加載整體流程:https://blog.csdn.net/matt8/article/details/106352083

看下預設命名空間标簽的解析過程,也就是http://www.springframework.org/schema/beans命名空間下标簽的解析過程。

bean标簽的解析是從org.springframework.beans.factory.xml.DefaultBeanDefinitionDocumentReader#parseDefaultElement這個方法開始的,源碼如下:

private void parseDefaultElement(Element ele, BeanDefinitionParserDelegate delegate) {
        //處理 <import> 标簽,将資源進行合并再統一解析
		if (delegate.nodeNameEquals(ele, IMPORT_ELEMENT)) {
			importBeanDefinitionResource(ele);
		}
        //處理 <alias> 标簽
		else if (delegate.nodeNameEquals(ele, ALIAS_ELEMENT)) {
			processAliasRegistration(ele);
		}
        //處理 <bean> 标簽
		else if (delegate.nodeNameEquals(ele, BEAN_ELEMENT)) {
			processBeanDefinition(ele, delegate);
		}
        //處理 <beans> 标簽,回到開始解析 document 的地方
		else if (delegate.nodeNameEquals(ele, NESTED_BEANS_ELEMENT)) {
			// recurse
			doRegisterBeanDefinitions(ele);
		}
	}
           

上面的代碼很簡單,主要是對預設命名空間下支援的import、beans、alias、bean标簽的解析處理,我們先看下bean标簽的處理方法org.springframework.beans.factory.xml.DefaultBeanDefinitionDocumentReader#processBeanDefinition

protected void processBeanDefinition(Element ele, BeanDefinitionParserDelegate delegate) {
		//委托delegate來完成解析過程,并傳回BeanDefinitionHolder對象,該對象存儲了BeanDefinition的基本資訊
		BeanDefinitionHolder bdHolder = delegate.parseBeanDefinitionElement(ele);

		if (bdHolder != null) {
			//委托delegate來完成bdHolder修飾過程
			bdHolder = delegate.decorateBeanDefinitionIfRequired(ele, bdHolder);
			try {
				//裝飾後的bdHolder注冊到容器
				BeanDefinitionReaderUtils.registerBeanDefinition(bdHolder, getReaderContext().getRegistry());
			}
			catch (BeanDefinitionStoreException ex) {
				getReaderContext().error("Failed to register bean definition with name '" +
						bdHolder.getBeanName() + "'", ele, ex);
			}
			//發送注冊事件
			getReaderContext().fireComponentRegistered(new BeanComponentDefinition(bdHolder));
		}
	}
           

接着看bean的解析過程,調用org.springframework.beans.factory.xml.BeanDefinitionParserDelegate#parseBeanDefinitionElement(org.w3c.dom.Element)這個方法,這個方法直接調用的parseBeanDefinitionElement(ele, null),源碼如下:

public BeanDefinitionHolder parseBeanDefinitionElement(Element ele, BeanDefinition containingBean) {
		//取得 <bean> 标簽的 id 屬性
		String id = ele.getAttribute(ID_ATTRIBUTE);
		//取得 <bean> 标簽的 name 屬性
		String nameAttr = ele.getAttribute(NAME_ATTRIBUTE);

		//建立 List 用于存 alias(别名)集合
		List<String> aliases = new ArrayList<String>();
		if (StringUtils.hasLength(nameAttr)) {
			//将 nameArr 按照(,)或(;)分割成數組
			String[] nameArr = StringUtils.tokenizeToStringArray(nameAttr, MULTI_VALUE_ATTRIBUTE_DELIMITERS);
			//添加到别名集合
			aliases.addAll(Arrays.asList(nameArr));
		}

		//判斷 id 是否為空,若為空則取别名集合的第一個元素當作 id ,并将其從别名集合當中移除
		String beanName = id;
		if (!StringUtils.hasText(beanName) && !aliases.isEmpty()) {
			beanName = aliases.remove(0);
			if (logger.isDebugEnabled()) {
				logger.debug("No XML 'id' specified - using '" + beanName +
						"' as bean name and " + aliases + " as aliases");
			}
		}

		// 檢查 beanName 是否已經被使用
		if (containingBean == null) {
			checkNameUniqueness(beanName, aliases, ele);
		}

		//解析 <bean> 标簽的屬性以及相關特性标簽,并将其添加進 beanDefinition 傳回
		AbstractBeanDefinition beanDefinition = parseBeanDefinitionElement(ele, beanName, containingBean);
		if (beanDefinition != null) {
			//判斷是否存在 beanName
			if (!StringUtils.hasText(beanName)) {
				try {
					if (containingBean != null) {
						beanName = BeanDefinitionReaderUtils.generateBeanName(
								beanDefinition, this.readerContext.getRegistry(), true);
					}
					else {
						//由 Spring 自動生成 beanName
						beanName = this.readerContext.generateBeanName(beanDefinition);
						//取得 bean 的完整類名
						String beanClassName = beanDefinition.getBeanClassName();
						//将 beanClassName 添加進 alais 集合
						if (beanClassName != null &&
								beanName.startsWith(beanClassName) && beanName.length() > beanClassName.length() &&
								!this.readerContext.getRegistry().isBeanNameInUse(beanClassName)) {
							aliases.add(beanClassName);
						}
					}
					if (logger.isDebugEnabled()) {
						logger.debug("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);
			//傳回一個 BeanDefinitionHolder 執行個體
			return new BeanDefinitionHolder(beanDefinition, beanName, aliasesArray);
		}

		return null;
	}
           

再往裡看解析bean标簽的屬性及相關特性的方法是parseBeanDefinitionElement(ele, beanName, containingBean),源碼如下:

public AbstractBeanDefinition parseBeanDefinitionElement(
			Element ele, String beanName, BeanDefinition containingBean) {

		//入棧操作,往 parseState 中添加一個 建立的 BeanEntry
		this.parseState.push(new BeanEntry(beanName));

		//取得 <bean> 标簽的 class 屬性
		String className = null;
		if (ele.hasAttribute(CLASS_ATTRIBUTE)) {
			className = ele.getAttribute(CLASS_ATTRIBUTE).trim();
		}

		try {
			//取得 <bean> 标簽的 parent 屬性
			String parent = null;
			if (ele.hasAttribute(PARENT_ATTRIBUTE)) {
				parent = ele.getAttribute(PARENT_ATTRIBUTE);
			}
			//根據 class,parent 的屬性值建立一個 BeanDefinition
			AbstractBeanDefinition bd = createBeanDefinition(className, parent);

			// 取得 <bean> 标簽的其他屬性,并添加進 BeanDefinition 。如:
	        // scope、
	        // lazy-init
	        // autowire
	        // primary、autowire-candidate
	        // depends-on、dependency-check
	        // init-method、destroy-method
	        // factory-method、factory-bean
			parseBeanDefinitionAttributes(ele, beanName, containingBean, bd);
			bd.setDescription(DomUtils.getChildElementValueByTagName(ele, DESCRIPTION_ELEMENT));

			//解析 <mate> 标簽
			parseMetaElements(ele, bd);
			//解析 <lookup-method> 标簽
			parseLookupOverrideSubElements(ele, bd.getMethodOverrides());
			//解析 <replaced-method> 标簽
			parseReplacedMethodSubElements(ele, bd.getMethodOverrides());

			//解析 <constructor-arg> 标簽
			parseConstructorArgElements(ele, bd);
			//解析 <property> 标簽
			parsePropertyElements(ele, bd);
			//解析 <qualifier> 标簽
			parseQualifierElements(ele, bd);

			bd.setResource(this.readerContext.getResource());
			bd.setSource(extractSource(ele));

			return bd;
		}
		catch (ClassNotFoundException ex) {
			error("Bean class [" + className + "] not found", ele, ex);
		}
		catch (NoClassDefFoundError err) {
			error("Class that bean class [" + className + "] depends on not found", ele, err);
		}
		catch (Throwable ex) {
			error("Unexpected failure during bean definition parsing", ele, ex);
		}
		finally {
			this.parseState.pop();
		}

		return null;
	}
           

至此,一個bean标簽便解析完了,解析完拿到BeanDefinitionHolder bdHolder這個之後,會調delegate.decorateBeanDefinitionIfRequired(ele, bdHolder)這個方法,對bdHolder做一次裝飾處理,主要場景是:

1、attr屬性命名空間與bean命名空間不一緻

<!--外部命名空間為bean  内部卻為p-->
<bean id="viewResolver" p:prefix="/WEB-INF/view/" p:suffix=".jsp"/>
           

2、子标簽内外命名空間不一緻

<bean>
        <!-- 外部為bean命名空間,内部為task命名空間-->
        <task:scheduler id=""/>
</bean>
           

裝飾處理的主要邏輯是找到對應命名空間的處理器,對這些标簽做解析,并将這些标簽的資訊補充到BeanDefinitionHolder bdHolder中,處理完這一步後,就可以注冊bean資訊到容器中了,通過org.springframework.beans.factory.support.BeanDefinitionReaderUtils#registerBeanDefinition這個方法,源碼如下:

public static void registerBeanDefinition(
			BeanDefinitionHolder definitionHolder, BeanDefinitionRegistry registry)
			throws BeanDefinitionStoreException {

		String beanName = definitionHolder.getBeanName();
		//調用容器的注冊bean方法,将bean資訊注冊到容器
		registry.registerBeanDefinition(beanName, definitionHolder.getBeanDefinition());

		// Register aliases for bean name, if any.
		String[] aliases = definitionHolder.getAliases();
		if (aliases != null) {
			for (String alias : aliases) {
				//别名注冊到容器
				registry.registerAlias(beanName, alias);
			}
		}
	}
           

至此,一個bean的解析就完成了