[死磕 Spring 9/43] --- IOC 之解析 bean 标签：BeanDefinition

Posted 2022-01-05 wei198621

引用文章： https://www.cmsblogs.com/article/1391375337862074368
[死磕 Spring 9/43] — IOC 之解析 bean 标签：BeanDefinition

定位

本编文章 3/5 BeanDefinitionReader ,
XmlBeanDefinitionReader.loadBeanDefinitions() 介绍

正文

前面历经千辛万苦终于到达解析 bean 标签步骤来了，解析 bean 标签的过程其实就是构造一个 BeanDefinition 对象的过程， 元素标签拥有的配置属性，BeanDefinition 均提供了相应的属性，与之一一对应。所以我们有必要对 BeanDefinition 有一个整体的认识。

BeanDefinition

BeanDefinition 是一个接口，它描述了一个 Bean 实例，包括属性值、构造方法值和继承自它的类的更多信息。它继承 AttributeAccessor 和 BeanMetadataElement 接口。两个接口定义如下：

AttributeAccessor ：定义了与其它对象的（元数据）进行连接和访问的约定，即对属性的修改，包括获取、设置、删除。
BeanMetadataElement：Bean 元对象持有的配置元素可以通过getSource() 方法来获取。

BeanDefinition 整个结构如下图： spring-201806201001 我们常用的三个实现类有：ChildBeanDefinition、GenericBeanDefinition、RootBeanDefinition，三者都继承 AbstractBeanDefinition。如果配置文件中定义了父 和 子 ，则父 用 RootBeanDefinition表示，子 用 ChildBeanDefinition 表示，而没有父 的就使用RootBeanDefinition 表示。GenericBeanDefinition 为一站式服务类。AbstractBeanDefinition对三个子类共同的类信息进行抽象。

解析 Bean 标签

在 BeanDefinitionParserDelegate.parseBeanDefinitionElement() 中完成 Bean 的解析，返回的是一个已经完成对 标签解析的 BeanDefinition 实例。在该方法内部，首先调用 createBeanDefinition() 方法创建一个用于承载属性的 GenericBeanDefinition 实例，如下：

            protected AbstractBeanDefinition createBeanDefinition(@Nullable String className, @Nullable String parentName)
                    throws ClassNotFoundException 
                return BeanDefinitionReaderUtils.createBeanDefinition(
                        parentName, className, this.readerContext.getBeanClassLoader());
            
        

委托 BeanDefinitionReaderUtils 创建，如下：

        public static AbstractBeanDefinition createBeanDefinition(
                @Nullable String parentName, @Nullable String className, @Nullable ClassLoader classLoader) throws ClassNotFoundException 
    
            GenericBeanDefinition bd = new GenericBeanDefinition();
            bd.setParentName(parentName);
            if (className != null) 
                if (classLoader != null) 
                    bd.setBeanClass(ClassUtils.forName(className, classLoader));
                
                else 
                    bd.setBeanClassName(className);
                
            
            return bd;
        

该方法主要是设置 parentName 、className、classLoader。 创建完 GenericBeanDefinition 实例后，再调用 parseBeanDefinitionAttributes() ，该方法将创建好的 GenericBeanDefinition 实例当做参数，对 Bean 标签的所有属性进行解析，如下：

        public AbstractBeanDefinition parseBeanDefinitionAttributes(Element ele, String beanName,
                                                                    @Nullable BeanDefinition containingBean, AbstractBeanDefinition bd) 
            // 解析 scope 标签
            if (ele.hasAttribute(SINGLETON_ATTRIBUTE)) 
                error("Old 1.x 'singleton' attribute in use - upgrade to 'scope' declaration", ele);
            
            else if (ele.hasAttribute(SCOPE_ATTRIBUTE)) 
                bd.setScope(ele.getAttribute(SCOPE_ATTRIBUTE));
            
            else if (containingBean != null) 
                // Take default from containing bean in case of an inner bean definition.
                bd.setScope(containingBean.getScope());
            
    
            // 解析 abstract 标签
            if (ele.hasAttribute(ABSTRACT_ATTRIBUTE)) 
                bd.setAbstract(TRUE_VALUE.equals(ele.getAttribute(ABSTRACT_ATTRIBUTE)));
            
    
            // 解析 lazy-init 标签
            String lazyInit = ele.getAttribute(LAZY_INIT_ATTRIBUTE);
            if (DEFAULT_VALUE.equals(lazyInit)) 
                lazyInit = this.defaults.getLazyInit();
            
            bd.setLazyInit(TRUE_VALUE.equals(lazyInit));
    
            // 解析 autowire 标签
            String autowire = ele.getAttribute(AUTOWIRE_ATTRIBUTE);
            bd.setAutowireMode(getAutowireMode(autowire));
    
            // 解析 depends-on 标签
            if (ele.hasAttribute(DEPENDS_ON_ATTRIBUTE)) 
                String dependsOn = ele.getAttribute(DEPENDS_ON_ATTRIBUTE);
                bd.setDependsOn(StringUtils.tokenizeToStringArray(dependsOn, MULTI_VALUE_ATTRIBUTE_DELIMITERS));
            
    
            // 解析 autowire-candidate 标签
            String autowireCandidate = ele.getAttribute(AUTOWIRE_CANDIDATE_ATTRIBUTE);
            if ("".equals(autowireCandidate) || DEFAULT_VALUE.equals(autowireCandidate)) 
                String candidatePattern = this.defaults.getAutowireCandidates();
                if (candidatePattern != null) 
                    String[] patterns = StringUtils.commaDelimitedListToStringArray(candidatePattern);
                    bd.setAutowireCandidate(PatternMatchUtils.simpleMatch(patterns, beanName));
                
            
            else 
                bd.setAutowireCandidate(TRUE_VALUE.equals(autowireCandidate));
            
    
            // 解析 primay 标签
            if (ele.hasAttribute(PRIMARY_ATTRIBUTE)) 
                bd.setPrimary(TRUE_VALUE.equals(ele.getAttribute(PRIMARY_ATTRIBUTE)));
            
    
            // 解析 init-method 标签
            if (ele.hasAttribute(INIT_METHOD_ATTRIBUTE)) 
                String initMethodName = ele.getAttribute(INIT_METHOD_ATTRIBUTE);
                bd.setInitMethodName(initMethodName);
            
            else if (this.defaults.getInitMethod() != null) 
                bd.setInitMethodName(this.defaults.getInitMethod());
                bd.setEnforceInitMethod(false);
            
    
            // 解析 destroy-mothod 标签
            if (ele.hasAttribute(DESTROY_METHOD_ATTRIBUTE)) 
                String destroyMethodName = ele.getAttribute(DESTROY_METHOD_ATTRIBUTE);
                bd.setDestroyMethodName(destroyMethodName);
            
            else if (this.defaults.getDestroyMethod() != null) 
                bd.setDestroyMethodName(this.defaults.getDestroyMethod());
                bd.setEnforceDestroyMethod(false);
            
    
            // 解析 factory-method 标签
            if (ele.hasAttribute(FACTORY_METHOD_ATTRIBUTE)) 
                bd.setFactoryMethodName(ele.getAttribute(FACTORY_METHOD_ATTRIBUTE));
            
            if (ele.hasAttribute(FACTORY_BEAN_ATTRIBUTE)) 
                bd.setFactoryBeanName(ele.getAttribute(FACTORY_BEAN_ATTRIBUTE));
            
    
            return bd;
        

从上面代码我们可以清晰地看到对 Bean 标签属性的解析，这些属性我们在工作中都或多或少用到过。 完成 Bean 标签基本属性解析后，会依次调用 parseMetaElements()、parseLookupOverrideSubElements()、parseReplacedMethodSubElements() 对子元素 meta、lookup-method、replace-method 完成解析。下篇博文将会对这三个子元素进行详细说明。