回顾上篇
上篇文章读取配置文件中，我们已经分析到spring如何读取配置文件（BeanFactoryTest.xml），并最终把配置文件转换成Document 对象。接下来Spring会去解析Document 对象，并将解析出来的信息放到BeanDefinition中。最后BeanDefinition会被封装到BeanDefinitionHolder中。接下来我们就跟着源码，看看这一步是如何来实现的。
分析源码实现
首先我们debug一下，看看解析BeanFactoryTest.xml配置文件后创建出来的BeanDefinition里面都有什么属性。
AbstractBeanDefinition beanDefinition = parseBeanDefinitionElement(ele, beanName, containingBean);
由于我们配置文件写的比较简单，只配置了一个id和class,所以在BeanDefinition中我们就看到一个beanClass属性的值是我们再配置文件中配置的。也就是说解析完配置文件之后，我们配置的class属性，就会保存在BeanDefinition的beanClass这个字段中。
下面我们就看看Spring怎么去解析Document对象，生成BeanDefinition的。
protected int doLoadBeanDefinitions(InputSource inputSource, Resource resource)
throws BeanDefinitionStoreException {
Document doc = doLoadDocument(inputSource, resource);
int count = registerBeanDefinitions(doc, resource);
if (logger.isDebugEnabled()) {
logger.debug("Loaded " + count + " bean definitions from " + resource);
}
return count;
}
在上面代码中（为了阅读方便，这里把try-catch的代码删除了），我们看到，获取到Document对象后，就把Document作为参数，传入了registerBeanDefinitions方法里。
public int registerBeanDefinitions(Document doc, Resource resource) throws BeanDefinitionStoreException {
BeanDefinitionDocumentReader documentReader = createBeanDefinitionDocumentReader();
int countBefore = getRegistry().getBeanDefinitionCount();
documentReader.registerBeanDefinitions(doc, createReaderContext(resource));
return getRegistry().getBeanDefinitionCount() - countBefore;
}
这里首先是创建了一个BeanDefinitionDocumentReader， 然后调用BeanDefinitionDocumentReader的registerBeanDefinitions方法来去处理解析和注册的逻辑。前面读取XML，将XML配置文件转换成Document都是在XmlBeanDefinitionReader这个类里面进行处理的，现在使用BeanDefinitionDocumentReader来对Document对象进行解析和注册bean。这里很好的体现了面向对象里单一职责的原则。进入到registerBeanDefinitions方法里面，看看里面的处理逻辑。
public void registerBeanDefinitions(Document doc, XmlReaderContext readerContext) {
this.readerContext = readerContext;
doRegisterBeanDefinitions(doc.getDocumentElement());
}
protected void doRegisterBeanDefinitions(Element root) {
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);
// 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;
}
在registerBeanDefinitions中，只是提取了root。然后将root作为参数传入doRegisterBeanDefinitions中，进行解析。这里主要的解析逻辑是在parseBeanDefinitions(root, this.delegate)这行代码中。
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)) {
parseDefaultElement(ele, delegate);
}
else {
delegate.parseCustomElement(ele);
}
}
}
}
else {
delegate.parseCustomElement(root);
}
}
这里我们先看看root里面都有什么东西。
我们看到root里面保存的其实就是XML文件里面配置的beans节点的信息。在parseBeanDefinitions这个方法主要逻辑是
1、判断是否为默认命名空间。其实就是判断节点namespaceURI是不是http://www.springframework.org/schema
/beans。是的话就是默认命名空间。
2、获取root节点的子节点（NodeList nl = root.getChildNodes()）。这里获取的子节点中包含了两个text节点和一个bean节点，bean节点就是XML配置文件中我们配置的bean，而text节点是不会去解析的，这个节点只是我们在XML中配置bean的时候，换行产生的，里面就是换行符。
3、循环遍历所有子节点，默认命名空间调用默认解析方法parseDefaultElement，非默认命名空间调用自定义解析方法parseCustomElement。
由于我们配置的bean是默认的命名空间，所以应该调用默认解析方法。
private void parseDefaultElement(Element ele, BeanDefinitionParserDelegate delegate) {
if (delegate.nodeNameEquals(ele, IMPORT_ELEMENT)) {
importBeanDefinitionResource(ele);
}
else if (delegate.nodeNameEquals(ele, ALIAS_ELEMENT)) {
processAliasRegistration(ele);
}
else if (delegate.nodeNameEquals(ele, BEAN_ELEMENT)) {
processBeanDefinition(ele, delegate);
}
else if (delegate.nodeNameEquals(ele, NESTED_BEANS_ELEMENT)) {
// recurse
doRegisterBeanDefinitions(ele);
}
}
这里分别对四种节点（import、alias、bean、beans )进行判断，不同的节点使用不同的方法进行解析。我们这边传入的bean节点，所以看到解析bean节点的方法processBeanDefinition。
（解析其它节点的方法暂时先忽略，等看完如何解析bean之后，再去看就会容易很多了）
protected void processBeanDefinition(Element ele, BeanDefinitionParserDelegate delegate) {
//1、解析bean节点得到一个BeanDefinitionHolder
BeanDefinitionHolder bdHolder = delegate.parseBeanDefinitionElement(ele);
if (bdHolder != null) {
//2、如果节点存在自定义属性，那么就还需要对自定义的属性进行解析
bdHolder = delegate.decorateBeanDefinitionIfRequired(ele, bdHolder);
try {
// 3、注册BeanDefinition
BeanDefinitionReaderUtils.registerBeanDefinition(bdHolder, getReaderContext().getRegistry());
}
catch (BeanDefinitionStoreException ex) {
getReaderContext().error("Failed to register bean definition with name '" +
bdHolder.getBeanName() + "'", ele, ex);
}
// 4、发送注册事件，通知监听器，bean已经加装完成
getReaderContext().fireComponentRegistered(new BeanComponentDefinition(bdHolder));
}
}
我们先看 BeanDefinitionHolder bdHolder = delegate.parseBeanDefinitionElement(ele);这行代码。
解析bean节点得到一个BeanDefinitionHolder
public BeanDefinitionHolder parseBeanDefinitionElement(Element ele) {
return parseBeanDefinitionElement(ele, null);
}
public BeanDefinitionHolder parseBeanDefinitionElement(Element ele, @Nullable BeanDefinition containingBean) {
String id = ele.getAttribute(ID_ATTRIBUTE);
String nameAttr = ele.getAttribute(NAME_ATTRIBUTE);
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;
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) {
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属性，并将beanName的值设置为id的值。这里id的值就是我们XML配置文件中配置的id的值myTestBean。
2、进一步解析其它的属性，并返回一个AbstractBeanDefinition，这个AbstractBeanDefinition其实是GenericBeanDefinition，也是后面往Spring里注册的BeanDefinition。
这里我们看看具体代码
public AbstractBeanDefinition parseBeanDefinitionElement(
Element ele, String beanName, @Nullable BeanDefinition containingBean) {
this.parseState.push(new BeanEntry(beanName));
//解析class属性
String className = null;
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 {
//创建AbstractBeanDefinition，进入createBeanDefinition你可以看到这边创建的是一个GenericBeanDefinition
AbstractBeanDefinition bd = createBeanDefinition(className, parent);
//解析默认bean的各种属性 例如 scope、abstract、lazy-init、init-method、destroy-method
parseBeanDefinitionAttributes(ele, beanName, containingBean, bd);
bd.setDescription(DomUtils.getChildElementValueByTagName(ele, DESCRIPTION_ELEMENT));
//解析元数据
parseMetaElements(ele, bd);
//解析lookup-method属性
parseLookupOverrideSubElements(ele, bd.getMethodOverrides());
//解析replaced-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;
}
每个步骤做什么注释上都已经写了，具体怎么解析的可以进入到每一个步骤里面去详细了解。到这里所有的解析工作都已经完成了，我们已经看到Spring创建了一个AbstractBeanDefinition，这里已经包含一个bean的所有信息。
3、beanName没有值，则使用默认规则生成beanName。如果我们在xml中配置bean的时候，既没有配置bean的class属性，也没有配置name属性，那么这里beanName就会没有值。
4、将AbstractBeanDefinition、beanName、aliasesArray封装到BeanDefinitionHolder中。
到这里解析bean节点得到一个BeanDefinitionHolder的工作就已经完成了。
237
被折叠的 条评论
为什么被折叠?
到【灌水乐园】发言
