【SpringIOC源码解析】二——XMl文件解析与BeanDefiniotn注册

Spring bean的定义有xml方式、注解方式等等，对他们的载体抽象是BeanDefinition，而对他们的加载解析抽象是BeanDefinitionReader。

spring启动会创建 Bean 容器，加载并注册 Bean，Bean的配置是在Xml文件中，它是如何解析的呢？

/**XmlBeanDefinitionReader303行*/
public int loadBeanDefinitions(Resource resource) throws BeanDefinitionStoreException {
    //封装扩展编码集功能的Resource，主要对资源文件的编码进行处理
	return loadBeanDefinitions(new EncodedResource(resource));
}
/**XmlBeanDefinitionReader318行*/
public int loadBeanDefinitions(EncodedResource encodedResource) throws BeanDefinitionStoreException {
		Assert.notNull(encodedResource, "EncodedResource must not be null");
		if (logger.isTraceEnabled()) {
			logger.trace("Loading XML bean definitions from " + encodedResource);
		}
        //通过属性记录已经加载的资源
		Set<EncodedResource> currentResources = this.resourcesCurrentlyBeingLoaded.get();
		if (currentResources == null) {
			currentResources = new HashSet<>(4);
			this.resourcesCurrentlyBeingLoaded.set(currentResources);
		}
		if (!currentResources.add(encodedResource)) {
			throw new BeanDefinitionStoreException(
					"Detected cyclic loading of " + encodedResource + " - check your import definitions!");
		}
		try {
            //spring顶层资源抽象类Resource获取字节输入流
			InputStream inputStream = encodedResource.getResource().getInputStream();
			try {
                //按照SAX api方式准备xml输入流
				InputSource inputSource = new InputSource(inputStream);
				if (encodedResource.getEncoding() != null) {
					inputSource.setEncoding(encodedResource.getEncoding());
				}
                //真正加载Xml文件的和兴部分
				return doLoadBeanDefinitions(inputSource, encodedResource.getResource());
			}
			finally {
                //关闭输入流
				inputStream.close();
			}
		}
		catch (IOException ex) {
			throw new BeanDefinitionStoreException(
					"IOException parsing XML document from " + encodedResource.getResource(), ex);
		}
		finally {
			currentResources.remove(encodedResource);
			if (currentResources.isEmpty()) {
				this.resourcesCurrentlyBeingLoaded.remove();
			}
		}
	}
/**XmlBeanDefinitionReader388行*/
protected int doLoadBeanDefinitions(InputSource inputSource, Resource resource)
			throws BeanDefinitionStoreException {

		try {
			Document doc = doLoadDocument(inputSource, resource);
			int count = registerBeanDefinitions(doc, resource);
			if (logger.isDebugEnabled()) {
				logger.debug("Loaded " + count + " bean definitions from " + resource);
			}
			return count;
		}
		catch (BeanDefinitionStoreException ex) {
			throw ex;
		}
		catch (SAXParseException ex) {
			throw new XmlBeanDefinitionStoreException(resource.getDescription(),
					"Line " + ex.getLineNumber() + " in XML document from " + resource + " is invalid", ex);
		}
		catch (SAXException ex) {
			throw new XmlBeanDefinitionStoreException(resource.getDescription(),
					"XML document from " + resource + " is invalid", ex);
		}
		catch (ParserConfigurationException ex) {
			throw new BeanDefinitionStoreException(resource.getDescription(),
					"Parser configuration exception parsing XML from " + resource, ex);
		}
		catch (IOException ex) {
			throw new BeanDefinitionStoreException(resource.getDescription(),
					"IOException parsing XML document from " + resource, ex);
		}
		catch (Throwable ex) {
			throw new BeanDefinitionStoreException(resource.getDescription(),
					"Unexpected exception parsing XML document from " + resource, ex);
		}
}

在上面冗长的代码中不考虑异常处理部分，try{}中其实只做了三件事：

1获取对XML文件的验证模式

2加载XML文件，并得到对应的Document

3根据返回的Document注册Bean信息

这3个步骤支撑着整个Spring容器对xml加载的实现，尤其是第3步对配置文件的解析，逻辑非常的复杂。

Doucument加载是交给DefaultDocumentLoader处理

protected Document doLoadDocument(InputSource inputSource, Resource resource) throws Exception {
		return this.documentLoader.loadDocument(inputSource, getEntityResolver(), this.errorHandler,
				getValidationModeForResource(resource), isNamespaceAware());
}

EntityResolve的作用是项目本身就可以提供一个如何寻找DTD声明的方法，即由程序来实现寻找DTD声明的过程，比如我们将DTD文件放到项目中某处，在实现时直接将此文档读取并返回给SAX 即可 这样就避免了通过网络来找相应的声明。

/**DefaultDocumentLoader 388行*/
public Document loadDocument(InputSource inputSource, EntityResolver entityResolver,
			ErrorHandler errorHandler, int validationMode, boolean namespaceAware) throws Exception {

		DocumentBuilderFactory factory = createDocumentBuilderFactory(validationMode, namespaceAware);
		if (logger.isTraceEnabled()) {
			logger.trace("Using JAXP provider [" + factory.getClass().getName() + "]");
		}
		DocumentBuilder builder = createDocumentBuilder(factory, entityResolver, errorHandler);
		return builder.parse(inputSource);
}

这是一个标准的SAX解析xml 的api套路模板。当把文件转换为Document后，接下来就是重头戏，提取及注册bean。

/**XmlBeanDefinitionReader 510行*/
public int registerBeanDefinitions(Document doc, Resource resource) throws BeanDefinitionStoreException {
    //使用 DefaultBeanDefinitionDocumentReader实例化BeanDefinitionDocumentReader
	BeanDefinitionDocumentReader documentReader = createBeanDefinitionDocumentReader();
    //记录统计前BeanDefinition加载个数
	int countBefore = getRegistry().getBeanDefinitionCount();
    //由documentReader加载及注册Bean，逻辑处理交由单一职责对象
	documentReader.registerBeanDefinitions(doc, createReaderContext(resource));
	eturn getRegistry().getBeanDefinitionCount() - countBefore;
}

在这个方法中很好的应用了面向对象中单一职责的原则，将逻辑处理交给单一的类进行处理，而这个逻辑处理类就是BeanDefinitionDocmentReader，进入 DefaultBeanDefinitionDocumentReader，看到这个方法的重要目的就是提取root，以便再次将root作为参数传递给核心方法doRegisterBeanDefinitions()。

/**DefaultBeanDefinitionDocumentReader 94行*/
public void registerBeanDefinitions(Document doc, XmlReaderContext readerContext) {
		this.readerContext = readerContext;
		doRegisterBeanDefinitions(doc.getDocumentElement());
}

/**DefaultBeanDefinitionDocumentReader 121行*/
protected void doRegisterBeanDefinitions(Element root) {
		//专门处理解析的类
		BeanDefinitionParserDelegate parent = this.delegate;
		this.delegate = createDelegate(getReaderContext(), root, parent);
        //处理profile环境属性，过滤不符合环境的xml文件
		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);
				// We cannot use Profiles.of(...) since profile expressions are not supported
				// in XML config. See SPR-12458 for details.
				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);
		parseBeanDefinitions(root, this.delegate);
        //解析后置处理，子类实现
		postProcessXml(root);

		this.delegate = parent;
}

preProcessXml(root)和postProcessXml(root)均为空方法，交由子类实现，是典型的模板方法设计。

/**DefaultBeanDefinitionDocumentReader 168行*/
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)) {
                        //解析Spring默认标签（ import alias bean beans）
						parseDefaultElement(ele, delegate);
					}
					else {
                        //解析自定义标签
						delegate.parseCustomElement(ele);
					}
				}
			}
		}
		else {
			delegate.parseCustomElement(root);
		}
}

这里我们只介绍对使用最多的bean标签解析过程。

/**DefaultBeanDefinitionDocumentReader 305行*/
protected void processBeanDefinition(Element ele, BeanDefinitionParserDelegate delegate) {
		BeanDefinitionHolder bdHolder = delegate.parseBeanDefinitionElement(ele);
		if (bdHolder != null) {
			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));
		}
}

1.首先委托BeanDefinitionDelegate类的parseBeanDefinitionElement方法进行元素解析，返回BeanDefinitionHolder类型的实例bdHolder，经过该方法后，bdHolder实例已经包含xml配置文件中配的各种属性了，例如classnam，id，alias等属性。

2.当返回的bdHolder不为null的情况下，若存在默认标签节点下再有自定义属性，还需要再次对自定义标签进行解析。

3. 解析完成后，需要对解析后的bdHolder进行注册，注册操作委托给了BeanDefinitionReaderUtlis的rgisterBeanDefinition方法。

4. 最后发出响应事件，通知相关的监听器，这个bean加载完成了。

下面我们来看Bean元素解析

/**BeanDefinitionParserDelegate 404行*/
public BeanDefinitionHolder parseBeanDefinitionElement(Element ele) {
		return parseBeanDefinitionElement(ele, null);
}
/**BeanDefinitionParserDelegate 414行*/
public BeanDefinitionHolder parseBeanDefinitionElement(Element ele, @Nullable BeanDefinition containingBean) {
        //解析id属性
		String id = ele.getAttribute(ID_ATTRIBUTE);
        //解析name属性
		String nameAttr = ele.getAttribute(NAME_ATTRIBUTE);
        //分隔name属性，即多个别名
		List<String> aliases = new ArrayList<>();
		if (StringUtils.hasLength(nameAttr)) {
			String[] nameArr = StringUtils.tokenizeToStringArray(nameAttr, MULTI_VALUE_ATTRIBUTE_DELIMITERS);
			aliases.addAll(Arrays.asList(nameArr));
		}

		String beanName = id;
        //beanName不存在，别名存在，用第一个别名作为beanName
		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) {
			checkNameUniqueness(beanName, aliases, ele);
		}

		AbstractBeanDefinition beanDefinition = parseBeanDefinitionElement(ele, beanName, containingBean);
		if (beanDefinition != null) {
            //如果beanName不存在，使用Spring命名规则生成一个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;
}

以上代码包含以下工作内容：

1.提取元素中的 id、name属性

2.进一步解析其他所有属性，并统一封装至 GenericBeanDefinition 类型的实例中

3.如果检测到bean没有指定beanName ，那么使用默认规则为此Bean生成beanName

4.将获取到的信息封装到BeanDefinitionHolder实例中

洋葱剥皮，来看第2个步骤中对其他属性的解析过程

/**BeanDefinitionParserDelegate5 00行*/
public AbstractBeanDefinition parseBeanDefinitionElement(
			Element ele, String beanName, @Nullable BeanDefinition containingBean) {

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

		String className = null;
        //解析class属性
		if (ele.hasAttribute(CLASS_ATTRIBUTE)) {
			className = ele.getAttribute(CLASS_ATTRIBUTE).trim();
		}
        //解析parent属性
		String parent = null;
		if (ele.hasAttribute(PARENT_ATTRIBUTE)) {
			parent = ele.getAttribute(PARENT_ATTRIBUTE);
		}

		try {
            //创建承载属性的GenericBeanDefinition实例
			AbstractBeanDefinition bd = createBeanDefinition(className, parent);
            //硬编码解析默认的bean的各种标签属性（lazy、depend on等）
			parseBeanDefinitionAttributes(ele, beanName, containingBean, bd);
			bd.setDescription(DomUtils.getChildElementValueByTagName(ele, DESCRIPTION_ELEMENT));
            //解析元数据
			parseMetaElements(ele, bd);
            //解析lookup-method属性
			parseLookupOverrideSubElements(ele, bd.getMethodOverrides());
            //解析replace-method属性
			parseReplacedMethodSubElements(ele, bd.getMethodOverrides());
            //解析构造函数
			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;
}

BeanDefinition是配置文件＜bean＞元素标签在容器中的内部表示形式，BeanDefinition 是个接口，在Spring中存在三个实现：RootBeanDefinition，childBeanDefinition以及GenericBeanD finition，三种实现均继承了abstractBeanDefiniton。

具体bean各种属性标签的解析过程下面就不再阐述了，有兴趣的伙伴可以自行查看源码。下面我们回到DefaultBeanDefinitionDocumentReader.processBeanDefinition()第三步注册解析后的BeanDefinition，即BeanDefinitionReaderUtils.registerBeanDefinition()。

/**BeanDefinitionReaderUtils 160行*/
public static void registerBeanDefinition(
			BeanDefinitionHolder definitionHolder, BeanDefinitionRegistry registry)
			throws BeanDefinitionStoreException {

		// 使用beanName作为唯一标识符
		String beanName = definitionHolder.getBeanName();
		registry.registerBeanDefinition(beanName, definitionHolder.getBeanDefinition());

		// 注册所有别名
		String[] aliases = definitionHolder.getAliases();
		if (aliases != null) {
			for (String alias : aliases) {
				registry.registerAlias(beanName, alias);
			}
		}
}

通过beanName注册BeanDefinition

BeanDefinition注册由BeanDefinitionRegistry接口实现类DefaultListableBeanFactory完成，它除了将BeanDefinition以beanName为key放入一个map中外，还做了其他事情

/**DefaultListableBeanFactory 160行*/
public void registerBeanDefinition(String beanName, BeanDefinition beanDefinition)
			throws BeanDefinitionStoreException {

		Assert.hasText(beanName, "Bean name must not be empty");
		Assert.notNull(beanDefinition, "BeanDefinition must not be null");

		if (beanDefinition instanceof AbstractBeanDefinition) {
			try {
                 
/*注册前的最后一次校验，这里的校验不同于之前XML文件校验，主要
*是对于AbstractBeanDefinition中的methodOverrides校验
* 校验methodOverrides是否与工厂方法并存或者methodOverrides对应
*的方法根本不存在
*/
				((AbstractBeanDefinition) beanDefinition).validate();
			}
			catch (BeanDefinitionValidationException ex) {
				throw new BeanDefinitionStoreException(beanDefinition.getResourceDescription(), beanName,
						"Validation of bean definition failed", ex);
			}
		}

		BeanDefinition existingDefinition = this.beanDefinitionMap.get(beanName);
        //处理已注册过beanName的情况
		if (existingDefinition != null) {
            //配置中不允许bean覆盖，抛出异常
			if (!isAllowBeanDefinitionOverriding()) {
				throw new BeanDefinitionOverrideException(beanName, beanDefinition, existingDefinition);
			}
            //允许覆盖，按角色顺序覆盖
			else if (existingDefinition.getRole() < beanDefinition.getRole()) {
				// e.g. was ROLE_APPLICATION, now overriding with ROLE_SUPPORT or ROLE_INFRASTRUCTURE
				if (logger.isInfoEnabled()) {
					logger.info("Overriding user-defined bean definition for bean '" + beanName +
							"' with a framework-generated bean definition: replacing [" +
							existingDefinition + "] with [" + beanDefinition + "]");
				}
			}
            //同一个bean元素覆盖
			else if (!beanDefinition.equals(existingDefinition)) {
				if (logger.isDebugEnabled()) {
					logger.debug("Overriding bean definition for bean '" + beanName +
							"' with a different definition: replacing [" + existingDefinition +
							"] with [" + beanDefinition + "]");
				}
			}
			else {
				if (logger.isTraceEnabled()) {
					logger.trace("Overriding bean definition for bean '" + beanName +
							"' with an equivalent definition: replacing [" + existingDefinition +
							"] with [" + beanDefinition + "]");
				}
			}
			this.beanDefinitionMap.put(beanName, beanDefinition);
		}
		else {
			if (hasBeanCreationStarted()) {
				// Cannot modify startup-time collection elements anymore (for stable iteration)
				synchronized (this.beanDefinitionMap) {
					this.beanDefinitionMap.put(beanName, beanDefinition);
					List<String> updatedDefinitions = new ArrayList<>(this.beanDefinitionNames.size() + 1);
					updatedDefinitions.addAll(this.beanDefinitionNames);
					updatedDefinitions.add(beanName);
					this.beanDefinitionNames = updatedDefinitions;
					if (this.manualSingletonNames.contains(beanName)) {
						Set<String> updatedSingletons = new LinkedHashSet<>(this.manualSingletonNames);
						updatedSingletons.remove(beanName);
						this.manualSingletonNames = updatedSingletons;
					}
				}
			}
			else {
				// 注册BeanDefinition
				this.beanDefinitionMap.put(beanName, beanDefinition);
                //记录beanName
				this.beanDefinitionNames.add(beanName);
				this.manualSingletonNames.remove(beanName);
			}
			this.frozenBeanDefinitionNames = null;
		}

		if (existingDefinition != null || containsSingleton(beanName)) {
            //重置beanName对应的缓存
			resetBeanDefinition(beanName);
		}
}