Spring源码讲解之 parseBeanDefinitionElement

parseBeanDefinitionElement 方法是在 org.springframework.beans.factory.xml.BeanDefinitionParserDelegate 类中定义的，主要作用是解析 bean 元素并将其结果赋值给 org.springframework.beans.factory.config.BeanDefinitionHolder 实例进行存储。 该方法接收一个类型为 org.w3c.dom.Element 的参数，返回值类为 org.springframework.beans.factory.config.BeanDefinitionHolder。该方法会在org.springframework.beans.factory.xml.DefaultBeanDefinitionDocumentReader.processBeanDefinition(Element, BeanDefinitionParserDelegate) 方法中调用。

源码

@Nullable
public BeanDefinitionHolder parseBeanDefinitionElement(Element ele) {
	return parseBeanDefinitionElement(ele, null);
}

parseBeanDefinitionElement 方法的实现

@Nullable
public BeanDefinitionHolder parseBeanDefinitionElement(Element ele, @Nullable BeanDefinition containingBean) {
	// 获取 id 属性
	String id = ele.getAttribute(ID_ATTRIBUTE);
	// 获取 name 属性
	String nameAttr = ele.getAttribute(NAME_ATTRIBUTE);

	List<String> aliases = new ArrayList<>();
	if (StringUtils.hasLength(nameAttr)) {
		// 解析 name 属性中的值
		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.isTraceEnabled()) {
			logger.trace("No XML 'id' specified - using '" + beanName +
					"' as bean name and " + aliases + " as aliases");
		}
	}

	if (containingBean == null) {
		// 检查 bean 名称和 bean 别名是否唯一
		checkNameUniqueness(beanName, aliases, ele);
	}

	// 重点方法
	// 解析 bean 元素到 BeanDefinition 中
	AbstractBeanDefinition beanDefinition = parseBeanDefinitionElement(ele, beanName, containingBean);
	if (beanDefinition != null) {
		// 如果 beanName 为空，通过 beanDefinition 信息生成一个 beanName
		if (!StringUtils.hasText(beanName)) {
			try {
				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.isTraceEnabled()) {
					logger.trace("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;
}

parseBeanDefinitionElement 方法的实现

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

	// 记录 bean 的解析状态
	this.parseState.push(new BeanEntry(beanName));

	String className = null;
	if (ele.hasAttribute(CLASS_ATTRIBUTE)) {
		// 获取 calss 属性的值
		className = ele.getAttribute(CLASS_ATTRIBUTE).trim();
	}
	String parent = null;
	if (ele.hasAttribute(PARENT_ATTRIBUTE)) {
		// 获取 parent 属性的值
		parent = ele.getAttribute(PARENT_ATTRIBUTE);
	}

	try {
		// 创建一个 AbstractBeanDefinition 实例
		// 默认类型是 org.springframework.beans.factory.support.GenericBeanDefinition
		AbstractBeanDefinition bd = createBeanDefinition(className, parent);

		// 解析 bean 定义相关的属性
		parseBeanDefinitionAttributes(ele, beanName, containingBean, bd);
		bd.setDescription(DomUtils.getChildElementValueByTagName(ele, DESCRIPTION_ELEMENT));

		// 解析 meta 子元素
		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;
}

parseBeanDefinitionElement 方法讲解完毕，部分方法没有进行详细讲解（例如：parseBeanDefinitionAttributes、parseMetaElements 等方法），此部分代码都在 org.springframework.beans.factory.xml.BeanDefinitionParserDelegate 类中进行定义和实现，想了解的朋友可以去此类中进行查看。