【Spring】IOC：初始化源码流程（中）加载 BeanDefinition

Love The Way You Lie 2022-10-31 01:46 250阅读 0赞

![在这里插入图片描述][20201208152409976.png]

装载就是 BeanDefinition 的载入。BeanDefinitionReader 读取、解析 Resource 资源，也就是将用户定义的 Bean 表示成 IOC 容器的内部数据结构：BeanDefinition。在 IOC 容器内部维护着一个 BeanDefinition Map 的数据结构，在配置文件中每一个都对应着一个BeanDefinition对象。

## 1.分配解析策略 (XmlBeanDefinitionReader) ##

### doLoadBeanDefinition(Doc,Res) ###

**XmlBeanDefinitionReader** 类中的 doLoadBeanDefinition() 方法是从特定 XML 文件中实际载入 Bean 配置资源的方法，该方法在载入 Bean 配置资源之后将其转换为 Document 对象，接下来调用 registerBeanDefinitions() 启动 Spring IOC 容器对 Bean 定 义 的解析过程 ， registerBeanDefinitions()方法源码如下：

// 按照Spring的Bean语义要求将Bean定义资源解析并转换为容器内部数据结构
    public int registerBeanDefinitions(Document doc, Resource resource) throws BeanDefinitionStoreException { 
    	// 得到BeanDefinitionDocumentReader来对xml格式的BeanDefinition解析
    	BeanDefinitionDocumentReader documentReader = createBeanDefinitionDocumentReader();
    	// 获得容器中注册的Bean数量
    	int countBefore = getRegistry().getBeanDefinitionCount();
    	// 解析过程入口，这里使用了委派模式，BeanDefinitionDocumentReader只是个接口,
    	// 具体的解析实现过程有实现类DefaultBeanDefinitionDocumentReader完成
    	documentReader.registerBeanDefinitions(doc, createReaderContext(resource));
    	// 统计解析的Bean数量
    	return getRegistry().getBeanDefinitionCount() - countBefore;
    }

Bean配置资源的载入解析分为以下两个过程：

1.  首先，通过调用 XML解析器将 Bean 配置信息转换得到 Document对象，但是这些 Document对象并没有按照Spring的Bean规则进行解析。这一步是载入的过程。
2.  其次，在完成通用的 XML解析之后，按照 Spring Bean 的定义规则对 Document 对象进行解析，其解析过程是在接口 BeanDefinitionDocumentReader 的实现类DefaultBeanDefinitionDocumentReader中实现。

## 2.将配置载入内存(DefaultBeanDefinitionDocumentReader) ##

### registerBeanDefinitions() ###

BeanDefinitionDocumentReader 接口通过 registerBeanDefinitions() 方法调用其实现**DefaultBeanDefinitionDocumentReader** 对 Document 对象进行解析，解析的代码如下：

// 根据Spring DTD对Bean的定义规则解析Bean定义Document对象
    @Override
    public void registerBeanDefinitions(Document doc, XmlReaderContext readerContext) { 
    	// 获得XML描述符
    	this.readerContext = readerContext;
    	logger.debug("Loading bean definitions");
    	// 获得Document的根元素
    	Element root = doc.getDocumentElement();
    	doRegisterBeanDefinitions(root);
    }

### doRegisterBeanDefinitions() ###

protected void doRegisterBeanDefinitions(Element root) { 
    		
    		// 具体的解析过程由BeanDefinitionParserDelegate实现，BeanDefinitionParserDelegate中定义了Spring Bean定义XML文件的各种元素
    		BeanDefinitionParserDelegate parent = this.delegate;
    		this.delegate = createDelegate(getReaderContext(), root, parent);
    
    		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);
    				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;
    				}
    			}
    		}
    
    		// 在解析Bean定义之前，进行自定义的解析，增强解析过程的可扩展性
    		preProcessXml(root);
    		// 从Document的根元素开始解析Bean定义的Document对象
    		parseBeanDefinitions(root, this.delegate);
    		// 在解析Bean定义之后，进行自定义的解析，增加解析过程的可扩展性
    		postProcessXml(root);
    
    		this.delegate = parent;
    }

### createDelegate() ###

创建BeanDefinitionParserDelegate，用于完成真正的解析过程

protected BeanDefinitionParserDelegate createDelegate(XmlReaderContext readerContext, Element root,
    								 @Nullable BeanDefinitionParserDelegate parentDelegate) { 
    
    	BeanDefinitionParserDelegate delegate = new BeanDefinitionParserDelegate(readerContext);
    	// BeanDefinitionParserDelegate初始化Document根元素
    	delegate.initDefaults(root, parentDelegate);
    	return delegate;
    }

### parseBeanDefinitions() ###

使用Spring的Bean规则从Document的根元素开始解析Bean定义的Document对象

protected void parseBeanDefinitions(Element root, BeanDefinitionParserDelegate delegate) { 
    	// Bean定义的Document对象使用了Spring默认的XML命名空间
    	if (delegate.isDefaultNamespace(root)) { 
    		// 获取Bean定义的Document对象根元素的所有子节点
    		NodeList nl = root.getChildNodes();
    		for (int i = 0; i < nl.getLength(); i++) { 
    			Node node = nl.item(i);
    			// 获得Document节点是XML元素节点
    			if (node instanceof Element) { 
    				Element ele = (Element) node;
    				// Bean定义的Document的元素节点使用的是Spring默认的XML命名空间
    				if (delegate.isDefaultNamespace(ele)) { 
    					// 使用Spring的Bean规则解析元素节点
    					parseDefaultElement(ele, delegate);
    				}
    				else { 
    					// 没有使用Spring默认的XML命名空间，则使用用户自定义的解//析规则解析元素节点
    					delegate.parseCustomElement(ele);
    				}
    			}
    		}
    	}
    	else { 
    		// Document的根节点没有使用Spring默认的命名空间，则使用用户自定义的解析规则解析Document根节点
    		delegate.parseCustomElement(root);
    	}
    }

### parseDefaultElement() ###

使用Spring的Bean规则解析Document元素节点

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>元素，按照Spring的Bean规则解析元素
    	else if (delegate.nodeNameEquals(ele, BEAN_ELEMENT)) { 
    		processBeanDefinition(ele, delegate);
    	}
    	else if (delegate.nodeNameEquals(ele, NESTED_BEANS_ELEMENT)) { 
    		// recurse
    		doRegisterBeanDefinitions(ele);
    	}
    }

### importBeanDefinitionResource() ###

解析导入元素，从给定的导入路径加载Bean定义资源到Spring IoC容器中

protected void importBeanDefinitionResource(Element ele) { 
    		// 获取给定的导入元素的location属性
    		String location = ele.getAttribute(RESOURCE_ATTRIBUTE);
    		// 如果导入元素的location属性值为空，则没有导入任何资源，直接返回
    		if (!StringUtils.hasText(location)) { 
    			getReaderContext().error("Resource location must not be empty", ele);
    			return;
    		}
    
    		// Resolve system properties: e.g. "${user.dir}"
    		// 使用系统变量值解析location属性值
    		location = getReaderContext().getEnvironment().resolveRequiredPlaceholders(location);
    
    		Set<Resource> actualResources = new LinkedHashSet<>(4);
    
    		// Discover whether the location is an absolute or relative URI
    		// 标识给定的导入元素的location是否是绝对路径
    		boolean absoluteLocation = false;
    		try { 
    			absoluteLocation = ResourcePatternUtils.isUrl(location) || ResourceUtils.toURI(location).isAbsolute();
    		}
    		catch (URISyntaxException ex) { 
    			// cannot convert to an URI, considering the location relative
    			// unless it is the well-known Spring prefix "classpath*:"
    			// 给定的导入元素的location不是绝对路径
    		}
    
    		// Absolute or relative?
    		// 给定的导入元素的location是绝对路径
    		if (absoluteLocation) { 
    			try { 
    				//使用资源读入器加载给定路径的Bean定义资源
    				int importCount = getReaderContext().getReader().loadBeanDefinitions(location, actualResources);
    				if (logger.isDebugEnabled()) { 
    					logger.debug("Imported " + importCount + " bean definitions from URL location [" + location + "]");
    				}
    			}
    			catch (BeanDefinitionStoreException ex) { 
    				getReaderContext().error(
    						"Failed to import bean definitions from URL location [" + location + "]", ele, ex);
    			}
    		}
    		else { 
    			// No URL -> considering resource location as relative to the current file.
    			// 给定的导入元素的location是相对路径
    			try { 
    				int importCount;
    				// 将给定导入元素的location封装为相对路径资源
    				Resource relativeResource = getReaderContext().getResource().createRelative(location);
    				// 封装的相对路径资源存在
    				if (relativeResource.exists()) { 
    					// 使用资源读入器加载Bean定义资源
    					importCount = getReaderContext().getReader().loadBeanDefinitions(relativeResource);
    					actualResources.add(relativeResource);
    				}
    				//封装的相对路径资源不存在
    				else { 
    					// 获取Spring IOC容器资源读入器的基本路径
    					String baseLocation = getReaderContext().getResource().getURL().toString();
    					// 根据Spring IOC容器资源读入器的基本路径加载给定导入路径的资源
    					importCount = getReaderContext().getReader().loadBeanDefinitions(
    							StringUtils.applyRelativePath(baseLocation, location), actualResources);
    				}
    				if (logger.isDebugEnabled()) { 
    					logger.debug("Imported " + importCount + " bean definitions from relative location [" + location + "]");
    				}
    			}
    			catch (IOException ex) { 
    				getReaderContext().error("Failed to resolve current resource location", ele, ex);
    			}
    			catch (BeanDefinitionStoreException ex) { 
    				getReaderContext().error("Failed to import bean definitions from relative location ["
    				 + location + "]",ele, ex);
    			}
    		}
    		Resource[] actResArray = actualResources.toArray(new Resource[actualResources.size()]);
    		// 在解析完<Import>元素之后，发送容器导入其他资源处理完成事件
    		getReaderContext().fireImportProcessed(location, actResArray, extractSource(ele));
    	}

### processAliasRegistration() ###

解析`<Alias>`别名元素，为Bean向Spring IoC容器注册别名

protected void processAliasRegistration(Element ele) { 
    		// 获取<Alias>别名元素中name的属性值
    		String name = ele.getAttribute(NAME_ATTRIBUTE);
    		// 获取<Alias>别名元素中alias的属性值
    		String alias = ele.getAttribute(ALIAS_ATTRIBUTE);
    		boolean valid = true;
    		// <alias>别名元素的name属性值为空
    		if (!StringUtils.hasText(name)) { 
    			getReaderContext().error("Name must not be empty", ele);
    			valid = false;
    		}
    		// <alias>别名元素的alias属性值为空
    		if (!StringUtils.hasText(alias)) { 
    			getReaderContext().error("Alias must not be empty", ele);
    			valid = false;
    		}
    		if (valid) { 
    			try { 
    				// 向容器的资源读入器注册别名
    				getReaderContext().getRegistry().registerAlias(name, alias);
    			}
    			catch (Exception ex) { 
    				getReaderContext().error("Failed to register alias '" + alias 
    				+"' for bean with name '" + name + "'", ele, ex);
    			}
    			// 在解析完<Alias>元素之后，发送容器别名处理完成事件
    			getReaderContext().fireAliasRegistered(name, alias, extractSource(ele));
    		}
    	}

### processBeanDefinition() ###

解析Bean定义资源Document对象的普通元素

protected void processBeanDefinition(Element ele, BeanDefinitionParserDelegate delegate) { 
    		BeanDefinitionHolder bdHolder = delegate.parseBeanDefinitionElement(ele);
    		// BeanDefinitionHolder是对BeanDefinition的封装，即Bean定义的封装类
    		// 对Document对象中<Bean>元素的解析由BeanDefinitionParserDelegate实现
    		// BeanDefinitionHolder bdHolder = delegate.parseBeanDefinitionElement(ele);
    		if (bdHolder != null) { 
    			bdHolder = delegate.decorateBeanDefinitionIfRequired(ele, bdHolder);
    			try { 
    				// Register the final decorated instance.
    				// 向Spring IOC容器注册解析得到的Bean定义，这是Bean定义向IOC容器注册的入口
    				BeanDefinitionReaderUtils.registerBeanDefinition(bdHolder, getReaderContext().getRegistry());
    			}
    			catch (BeanDefinitionStoreException ex) { 
    				getReaderContext().error("Failed to register bean definition with name '" 
    				+ bdHolder.getBeanName() + "'", ele, ex);
    			}
    			// Send registration event.
    			// 在完成向Spring IOC容器注册解析得到的Bean定义之后，发送注册事件
    			getReaderContext().fireComponentRegistered(new BeanComponentDefinition(bdHolder));
    		}
    	}

通过上述 Spring IOC 容器对载入的 Bean 定义 Document 解析可以看出，我们使用 Spring 时，在Spring配置文件中可以使用`<import>`元素来导入 IOC 容器所需要的其他资源，Spring IOC 容器在解析时会首先将指定导入的资源加载进容器中。使用`<ailas>`别名时，SpringIOC 容器首先将别名元素所定义的别名注册到容器中。

对于既不是`<import>`元素，又不是`<alias>`元素的元素，即 Spring配置文件中普通的`<bean>`元素的解析由BeanDefinitionParserDelegate 类的parseBeanDefinitionElement()方法来实现。这个解析的过程非常复杂

## 3.载入bean元素 (BeanDefinitionParserDelegate) ##

Bean 配置信息中的和元素解析在 DefaultBeanDefinitionDocumentReader 中已经完成，对 Bean 配置信息中使用最多的`<bean>`元素交由 **BeanDefinitionParserDelegate** 来解析

### parseBeanDefinitionElement() ###

// 解析<Bean>元素的入口
        @Nullable
        public BeanDefinitionHolder parseBeanDefinitionElement(Element ele) { 
            return parseBeanDefinitionElement(ele, null);
        }

// 解析Bean定义资源文件中的<Bean>元素，这个方法中主要处理<Bean>元素的id，name和别名属性
    	@Nullable
    	public BeanDefinitionHolder parseBeanDefinitionElement(Element ele, @Nullable BeanDefinition containingBean) { 
    		// 获取<Bean>元素中的id属性值
    		String id = ele.getAttribute(ID_ATTRIBUTE);
    		// 获取<Bean>元素中的name属性值
    		String nameAttr = ele.getAttribute(NAME_ATTRIBUTE);
    
    		// 获取<Bean>元素中的alias属性值
    		List<String> aliases = new ArrayList<>();
    
    		// 将<Bean>元素中的所有name属性值存放到别名中
    		if (StringUtils.hasLength(nameAttr)) { 
    			String[] nameArr = StringUtils.tokenizeToStringArray(nameAttr, 
    			MULTI_VALUE_ATTRIBUTE_DELIMITERS);
    			aliases.addAll(Arrays.asList(nameArr));
    		}
    
    		String beanName = id;
    		// 如果<Bean>元素中没有配置id属性时，将别名中的第一个值赋值给beanName
    		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");
    			}
    		}
    
    		// 检查<Bean>元素所配置的id或者name的唯一性，containingBean标识<Bean>元素中是否包含子<Bean>元素
    		if (containingBean == null) { 
    			// 检查<Bean>元素所配置的id、name或者别名是否重复
    			checkNameUniqueness(beanName, aliases, ele);
    		}
    
    		// 详细对<Bean>元素中配置的Bean定义进行解析的地方
    		AbstractBeanDefinition beanDefinition = parseBeanDefinitionElement(ele, beanName, containingBean);
    		if (beanDefinition != null) { 
    			if (!StringUtils.hasText(beanName)) { 
    				try { 
    					if (containingBean != null) { 
    						// 如果<Bean>元素中没有配置id、别名或者name，且没有包含子元素<Bean>元素，为解析的Bean生成一个唯一beanName并注册
    						beanName = BeanDefinitionReaderUtils.generateBeanName(
    								beanDefinition, this.readerContext.getRegistry(), true);
    					}
    					else { 
    						// 如果<Bean>元素中没有配置id、别名或者name，且包含了子元素<Bean>元素，为解析的Bean使用别名向IOC容器注册
    						beanName = this.readerContext.generateBeanName(beanDefinition);
    						
    						// 为解析的Bean使用别名注册时，为了向后兼容Spring1.2/2.0，给别名添加类名后缀
    						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);
    		}
    		// 当解析出错时，返回null
    		return null;
    	}

### checkNameUniqueness() ###

protected void checkNameUniqueness(String beanName, List<String> aliases, Element beanElement) { 
    		String foundName = null;
    
    		if (StringUtils.hasText(beanName) && this.usedNames.contains(beanName)) { 
    			foundName = beanName;
    		}
    		if (foundName == null) { 
    			foundName = CollectionUtils.findFirstMatch(this.usedNames, aliases);
    		}
    		if (foundName != null) { 
    			error("Bean name '" + foundName + "' is already used in this <beans> element", beanElement);
    		}
    
    		this.usedNames.add(beanName);
    		this.usedNames.addAll(aliases);
    	}

### parseBeanDefinitionElement() ###

详细对`<Bean>`元素中配置的Bean定义其他属性进行解析。由于上面的方法中已经对Bean的id、name和别名等属性进行了处理,该方法中主要处理除这三个以外的其他属性数据

@Nullable
    	public AbstractBeanDefinition parseBeanDefinitionElement(
    			Element ele, String beanName, @Nullable BeanDefinition containingBean) { 
    		// 记录解析的<Bean>
    		this.parseState.push(new BeanEntry(beanName));
    
    		// 这里只读取<Bean>元素中配置的class名字，然后载入到BeanDefinition中去
    		//只是记录配置的class名字，不做实例化，对象的实例化在依赖注入时完成
    		String className = null;
    
    		// 如果<Bean>元素中配置了parent属性，则获取parent属性的值
    		if (ele.hasAttribute(CLASS_ATTRIBUTE)) { 
    			className = ele.getAttribute(CLASS_ATTRIBUTE).trim();
    		}
    		String parent = null;
    		if (ele.hasAttribute(PARENT_ATTRIBUTE)) { 
    			parent = ele.getAttribute(PARENT_ATTRIBUTE);
    		}
    
    		try { 
    			// 根据<Bean>元素配置的class名称和parent属性值创建BeanDefinition，为载入Bean定义信息做准备
    			AbstractBeanDefinition bd = createBeanDefinition(className, parent);
    
    			// 对当前的<Bean>元素中配置的一些属性进行解析和设置，如配置的单态(singleton)属性等
    			parseBeanDefinitionAttributes(ele, beanName, containingBean, bd);
    			// 为<Bean>元素解析的Bean设置description信息
    			bd.setDescription(DomUtils.getChildElementValueByTagName(ele, DESCRIPTION_ELEMENT));
    
    			// 对<Bean>元素的meta(元信息)属性解析
    			parseMetaElements(ele, bd);
    			// 对<Bean>元素的lookup-method属性解析
    			parseLookupOverrideSubElements(ele, bd.getMethodOverrides());
    			// 对<Bean>元素的replaced-method属性解析
    			parseReplacedMethodSubElements(ele, bd.getMethodOverrides());
    
    			// 解析<Bean>元素的构造方法设置
    			parseConstructorArgElements(ele, bd);
    			// 解析<Bean>元素的<property>设置
    			parsePropertyElements(ele, bd);
    			// 解析<Bean>元素的qualifier属性
    			parseQualifierElements(ele, bd);
    
    			// 为当前解析的Bean设置所需的资源和依赖对象
    			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();
    		}
    
    		// 解析<Bean>元素出错时，返回null
    		return null;
    	}

## 4.载入property元素 (BeanDefinitionParserDelegate) ##

**BeanDefinitionParserDelegate** 在解析`<Bean>`调用 parsePropertyElements()方法解析`<Bean>`元素中的`<property>`属性子元素，解析源码如下：

### parsePropertyElements() ###

// 解析<Bean>元素中的<property>子元素
    	public void parsePropertyElements(Element beanEle, BeanDefinition bd) { 
    		// 获取<Bean>元素中所有的子元素
    		NodeList nl = beanEle.getChildNodes();
    		for (int i = 0; i < nl.getLength(); i++) { 
    			Node node = nl.item(i);
    			// 如果子元素是<property>子元素，则调用解析<property>子元素方法解析
    			if (isCandidateElement(node) && nodeNameEquals(node, PROPERTY_ELEMENT)) { 
    				parsePropertyElement((Element) node, bd);
    			}
    		}
    	}
    
    	// 解析<property>元素
    	public void parsePropertyElement(Element ele, BeanDefinition bd) { 
    		// 获取<property>元素的名字
    		String propertyName = ele.getAttribute(NAME_ATTRIBUTE);
    		if (!StringUtils.hasLength(propertyName)) { 
    			error("Tag 'property' must have a 'name' attribute", ele);
    			return;
    		}
    		this.parseState.push(new PropertyEntry(propertyName));
    		try { 
    			// 如果一个Bean中已经有同名的property存在，则不进行解析，直接返回。
    			// 即如果在同一个Bean中配置同名的property，则只有第一个起作用
    			if (bd.getPropertyValues().contains(propertyName)) { 
    				error("Multiple 'property' definitions for property '" + propertyName + "'", ele);
    				return;
    			}
    			// 解析获取property的值
    			Object val = parsePropertyValue(ele, bd, propertyName);
    			// 根据property的名字和值创建property实例
    			PropertyValue pv = new PropertyValue(propertyName, val);
    			// 解析<property>元素中的属性
    			parseMetaElements(ele, pv);
    			pv.setSource(extractSource(ele));
    			bd.getPropertyValues().addPropertyValue(pv);
    		}
    		finally { 
    			this.parseState.pop();
    		}
    	}

### parsePropertyValue() ###

解析获取property值

@Nullable
    	public Object parsePropertyValue(Element ele, BeanDefinition bd, @Nullable String propertyName) { 
    		String elementName = (propertyName != null) ?
    						"<property> element for property '" + propertyName + "'" :"<constructor-arg> element";
    
    		// Should only have one child element: ref, value, list, etc.
    		// 获取<property>的所有子元素，只能是其中一种类型:ref,value,list,etc等
    		NodeList nl = ele.getChildNodes();
    		Element subElement = null;
    		for (int i = 0; i < nl.getLength(); i++) { 
    			Node node = nl.item(i);
    			// 子元素不是description和meta属性
    			if (node instanceof Element && !nodeNameEquals(node, DESCRIPTION_ELEMENT) 
    								&& !nodeNameEquals(node, META_ELEMENT)) { 
    				// Child element is what we're looking for.
    				if (subElement != null) { 
    					error(elementName + " must not contain more than one sub-element", ele);
    				}
    				else { 
    					// 当前<property>元素包含有子元素
    					subElement = (Element) node;
    				}
    			}
    		}
    
    		// 判断property的属性值是ref还是value，不允许既是ref又是value
    		boolean hasRefAttribute = ele.hasAttribute(REF_ATTRIBUTE);
    		boolean hasValueAttribute = ele.hasAttribute(VALUE_ATTRIBUTE);
    		if ((hasRefAttribute && hasValueAttribute) ||
    				((hasRefAttribute || hasValueAttribute) && subElement != null)) { 
    			error(elementName +
    					" is only allowed to contain either 'ref' attribute OR 'value' attribute OR sub-element", ele);
    		}
    
    		// 如果属性是ref，创建一个ref的数据对象RuntimeBeanReference。这个对象封装了ref信息
    		if (hasRefAttribute) { 
    			String refName = ele.getAttribute(REF_ATTRIBUTE);
    			if (!StringUtils.hasText(refName)) { 
    				error(elementName + " contains empty 'ref' attribute", ele);
    			}
    			// 一个指向运行时所依赖对象的引用
    			RuntimeBeanReference ref = new RuntimeBeanReference(refName);
    			// 设置这个ref的数据对象是被当前的property对象所引用
    			ref.setSource(extractSource(ele));
    			return ref;
    		}
    		// 如果属性是value，创建一个value的数据对象TypedStringValue。这个对象封装了value信息
    		else if (hasValueAttribute) { 
    			//一个持有String类型值的对象
    			TypedStringValue valueHolder = new TypedStringValue(ele.getAttribute(VALUE_ATTRIBUTE));
    			// 设置这个value数据对象是被当前的property对象所引用
    			valueHolder.setSource(extractSource(ele));
    			return valueHolder;
    		}
    		// 如果当前<property>元素还有子元素
    		else if (subElement != null) { 
    			// 解析<property>的子元素
    			return parsePropertySubElement(subElement, bd);
    		}
    		else { 
    			// Neither child element nor "ref" or "value" attribute found.
    			// propery属性中既不是ref，也不是value属性，解析出错返回null
    			error(elementName + " must specify a ref or value", ele);
    			return null;
    		}
    	}

通过对上述源码的分析，我们可以了解在Spring配置文件中，`<Bean>`元素中`<property>`元素的相关配置是如何处理的：

1.  ref被封装为指向依赖对象一个引用。
2.  value配置都会封装成一个字符串类型的对象。
3.  ref和value都通过“解析的数据类型属性值.setSource(extractSource(ele));”方法将属性值/引用与所引用的属性关联

在方法的最后对于`<property>`元素的子元素通过 parsePropertySubElement()方法解析，我们继续分析该方法的源码，了解其解析过程。

## 5.载入property子元素 (BeanDefinitionParserDelegate) ##

### parsePropertySubElement() ###

解析`<property>`元素中ref,value或者集合等子元素

@Nullable
    	public Object parsePropertySubElement(Element ele, @Nullable BeanDefinition bd, 
    								@Nullable String defaultValueType) { 
    		// 如果<property>没有使用Spring默认的命名空间，则使用用户自定义的规则解析内嵌元素
    		if (!isDefaultNamespace(ele)) { 
    			return parseNestedCustomElement(ele, bd);
    		}
    		// 如果子元素是bean，则使用解析<Bean>元素的方法解析
    		else if (nodeNameEquals(ele, BEAN_ELEMENT)) { 
    			BeanDefinitionHolder nestedBd = parseBeanDefinitionElement(ele, bd);
    			if (nestedBd != null) { 
    				nestedBd = decorateBeanDefinitionIfRequired(ele, nestedBd, bd);
    			}
    			return nestedBd;
    		}
    		// 如果子元素是ref，ref中只能有以下3个属性：bean、local、parent
    		else if (nodeNameEquals(ele, REF_ELEMENT)) { 
    			// A generic reference to any name of any bean.
    			// 可以不再同一个Spring配置文件中，具体请参考Spring对ref的配置规则
    			String refName = ele.getAttribute(BEAN_REF_ATTRIBUTE);
    			boolean toParent = false;
    			if (!StringUtils.hasLength(refName)) { 
    				// A reference to the id of another bean in a parent context.
    				// 获取<property>元素中parent属性值，引用父级容器中的Bean
    				refName = ele.getAttribute(PARENT_REF_ATTRIBUTE);
    				toParent = true;
    				if (!StringUtils.hasLength(refName)) { 
    					error("'bean' or 'parent' is required for <ref> element", ele);
    					return null;
    				}
    			}
    			if (!StringUtils.hasText(refName)) { 
    				error("<ref> element contains empty target attribute", ele);
    				return null;
    			}
    			// 创建ref类型数据，指向被引用的对象
    			RuntimeBeanReference ref = new RuntimeBeanReference(refName, toParent);
    			// 设置引用类型值是被当前子元素所引用
    			ref.setSource(extractSource(ele));
    			return ref;
    		}
    		// 如果子元素是<idref>，使用解析ref元素的方法解析
    		else if (nodeNameEquals(ele, IDREF_ELEMENT)) { 
    			return parseIdRefElement(ele);
    		}
    		// 如果子元素是<value>，使用解析value元素的方法解析
    		else if (nodeNameEquals(ele, VALUE_ELEMENT)) { 
    			return parseValueElement(ele, defaultValueType);
    		}
    		// 如果子元素是null，为<property>设置一个封装null值的字符串数据
    		else if (nodeNameEquals(ele, NULL_ELEMENT)) { 
    			// It's a distinguished null value. Let's wrap it in a TypedStringValue
    			// object in order to preserve the source location.
    			TypedStringValue nullHolder = new TypedStringValue(null);
    			nullHolder.setSource(extractSource(ele));
    			return nullHolder;
    		}
    		// 如果子元素是<array>，使用解析array集合子元素的方法解析
    		else if (nodeNameEquals(ele, ARRAY_ELEMENT)) { 
    			return parseArrayElement(ele, bd);
    		}
    		// 如果子元素是<list>，使用解析list集合子元素的方法解析
    		else if (nodeNameEquals(ele, LIST_ELEMENT)) { 
    			return parseListElement(ele, bd);
    		}
    		// 如果子元素是<set>，使用解析set集合子元素的方法解析
    		else if (nodeNameEquals(ele, SET_ELEMENT)) { 
    			return parseSetElement(ele, bd);
    		}
    		// 如果子元素是<map>，使用解析map集合子元素的方法解析
    		else if (nodeNameEquals(ele, MAP_ELEMENT)) { 
    			return parseMapElement(ele, bd);
    		}
    		// 如果子元素是<props>，使用解析props集合子元素的方法解析
    		else if (nodeNameEquals(ele, PROPS_ELEMENT)) { 
    			return parsePropsElement(ele);
    		}
    		// 既不是ref，又不是value，也不是集合，则子元素配置错误，返回null
    		else { 
    			error("Unknown property sub-element: [" + ele.getNodeName() + "]", ele);
    			return null;
    		}
    	}

通过上述源码分析，我们明白了在Spring配置文件中，对`<property>`元素中配置的array、list、set、map、prop 等各种集合子元素的都通过上述方法解析，生成对应的数据对象，比如 ManagedList、ManagedArray、ManagedSet 等，这些Managed类是 Spring对象BeanDefiniton的数据封装，对集合数据类型的具体解析有各自的解析方法实现，解析方法的命名非常规范，一目了然。

下面，我们对`<list>`集合元素的解析方法进行源码分析，了解其实现过程。

## 6.载入list子元素 (BeanDefinitionParserDelegate) ##

### parseListElement() ###

在 **BeanDefinitionParserDelegate** 类中的 parseListElement()方法就是具体实现解析`<property>`元素中的`<list>`集合子元素，源码如下：

// 解析<list>集合子元素
    	public List<Object> parseListElement(Element collectionEle, @Nullable BeanDefinition bd) { 
    		//获取<list>元素中的value-type属性，即获取集合元素的数据类型
    		String defaultElementType = collectionEle.getAttribute(VALUE_TYPE_ATTRIBUTE);
    		//获取<list>集合元素中的所有子节点
    		NodeList nl = collectionEle.getChildNodes();
    		// Spring中将List封装为ManagedList
    		ManagedList<Object> target = new ManagedList<>(nl.getLength());
    		target.setSource(extractSource(collectionEle));
    		// 设置集合目标数据类型
    		target.setElementTypeName(defaultElementType);
    		target.setMergeEnabled(parseMergeAttribute(collectionEle));
    		// 具体的<list>元素解析
    		parseCollectionElements(nl, target, bd, defaultElementType);
    		return target;
    	}

### parseCollectionElements() ###

具体解析集合元素，、和都使用该方法解析

protected void parseCollectionElements(NodeList elementNodes, Collection<Object> target, 
    						@Nullable BeanDefinition bd, String defaultElementType) { 
    		// 遍历集合所有节点
    		for (int i = 0; i < elementNodes.getLength(); i++) { 
    			Node node = elementNodes.item(i);
    			// 节点不是description节点
    			if (node instanceof Element && !nodeNameEquals(node, DESCRIPTION_ELEMENT)) { 
    				// 将解析的元素加入集合中，递归调用下一个子元素
    				target.add(parsePropertySubElement((Element) node, bd, defaultElementType));
    			}
    		}
    	}

经过对Spring Bean配置信息转换的Document对象中的元素层层解析， Spring IOC现在已经将XML形式定义的 Bean配置信息转换为 Spring IOC 所识别的数据结构——BeanDefinition，它是 Bean配置信息中配置的 POJO 对象在 Spring IOC 容器中的映射，我们可以通过 AbstractBeanDefinition 为入口，看到了IOC 容器进行索引、查询和操作。

通过 Spring IOC 容器对 Bean 配置资源的解析后，IOC 容器大致完成了管理 Bean 对象的准备工作，即初始化过程，但是最为重要的依赖注入还没有发生，现在在IOC 容器中 BeanDefinition存储的只是一些静态信息，接下来需要向容器注册Bean定义信息才能全部完成IOC 容器的初始化过程。

[20201208152409976.png]: /images/20221024/bc125301448e4e608478d641cc34dbd3.png?