spring4.0 源码分析 bean标签的解析(三)

最新推荐文章于 2023-05-31 13:07:23 发布

原创最新推荐文章于 2023-05-31 13:07:23 发布 · 3.2k 阅读

0 ·

CC 4.0 BY-SA版权

文章标签：

#spring4.0 #源码分析 bean标签的解析三

Spring4.0 源码解析专栏收录该内容

4 篇文章

订阅专栏

本文深入解析Spring框架中Bean标签的处理流程，从读取配置文件开始，详细介绍如何解析Bean标签及内部属性，包括生成BeanDefinition的过程。

摘要生成于 C知道，由 DeepSeek-R1 满血版支持，前往体验 >

一、软件版本

spring-framework-4.0.7.RELEASE-dist

jdk1.7.0.79

myeclipse9.1

二、默认标签的解析

默认标签有：import 、alias、bean、beans

在DefaultBeanDefinitionDocumentReader.java类中，对spring的默认标签做了处理，看源码：

	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标签的解析
		else if (delegate.nodeNameEquals(ele, NESTED_BEANS_ELEMENT)) {
			// recurse
			doRegisterBeanDefinitions(ele);
		}
	}

在这段代码中，对四种标签做了解析，但是作为bean的解析最为复杂，如果能对bean的解析了如指掌的话，其他的解析也就不再话下了。在DefaultBeanDefinitionDocumentReader.java中我们进入bean的解析中，详见方法：

       protected void processBeanDefinition(Element ele, BeanDefinitionParserDelegate delegate) {
		//parseBeanDefinitionElement解析，返回实例bdHolder
		BeanDefinitionHolder bdHolder = delegate.parseBeanDefinitionElement(ele);
		if (bdHolder != null) {
			//bdHolder实例不为空，需要对标签下的自定义标签，再次解析
			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));
		}
	}

初看代码，逻辑并不是很明显，只能看出个大概的逻辑：首先方法利用BeanDefinitionParserDelegate的实例，调用parseBeanDefinitionElement方法对元素进行解析，返回BeanDefinitionHolder实例，BeanDefinitionHolder实例包含了哪些东西呢（可以先说下成员变量BeanDefinition beanDefinition、String beanName、String[] aliases）。接着往下说，返回的BeanDefinitionHolder实例bdHolder，如果bdHolder在不为空的情况下，还要对子标签下的自定义属性调用decorateBeanDefinitionIfRequired方法进行解析，解析完成后，需要调用BeanDefinitionReaderUtils类的registerBeanDefinition方法对bdHolder进行注册。最后通过getReaderContext().fireComponentRegistered()方法将事件发送出去，通知相关的监听器，bean加载完成了。

Bean标签解析详细过程

首先进入BeanDefinitionParserDelegate类的parseBeanDefinitionElement方法，因为这个方法首先处理解析了Element元素下面我们来看下它的源码：

	public BeanDefinitionHolder parseBeanDefinitionElement(Element ele) {
		return parseBeanDefinitionElement(ele, null);
	}
	
	
	public BeanDefinitionHolder parseBeanDefinitionElement(Element ele, BeanDefinition containingBean) {
		//解析ID属性
		String id = ele.getAttribute(ID_ATTRIBUTE);
		//解析NAME属性
		String nameAttr = ele.getAttribute(NAME_ATTRIBUTE);

		List<String> aliases = new ArrayList<String>();
		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.isDebugEnabled()) {
				logger.debug("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 {
					//如果不存在beanName，spring为当前bean生成对应的beanName
					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.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);
			return new BeanDefinitionHolder(beanDefinition, beanName, aliasesArray);
		}

		return null;
	}	

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

		this.parseState.push(new BeanEntry(beanName));

		String className = null;
		if (ele.hasAttribute(CLASS_ATTRIBUTE)) {
			className = ele.getAttribute(CLASS_ATTRIBUTE).trim();
		}

		try {
			String parent = null;
			if (ele.hasAttribute(PARENT_ATTRIBUTE)) {
				parent = ele.getAttribute(PARENT_ATTRIBUTE);
			}
			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;
		}
		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;
	}

上面便是对默认标签解析的全过程了。首先方法获取元素中的id和name，然后进一步的获取其他的属性并封装起来，如果检测到bean没有给出beanName属性，那么spring将生成beanName，最后将获取到的信息封装到BeanDefinitionHolder对象中去。在上述parseBeanDefinitionElement方法中，bean标签的属性都将被解析。接下来继续解析一些大家都想见到的元素属性。