Spring BeanDefinition

1. BeanDefinition

1.1 BeanDefinition概述

还是跟往常一样，先对 BeanDefinition 有一个整体的认识。

前面我们已经知道，BeanDefinition 也是一种配置元信息，它描述了 Bean 的定义信息。下面咱还是通过多个途径来试着了解 BeanDefinition 的概念。

1.1.1 官方文档

官方文档对于 BeanDefinition 的介绍并没有使用很大的篇幅，基本也只是概述一下就完事了：

docs.spring.io/spring/docs…

A bean definition can contain a lot of configuration information, including constructor arguments, property values, and container-specific information, such as the initialization method, a static factory method name, and so on. A child bean definition inherits configuration data from a parent definition. The child definition can override some values or add others as needed. Using parent and child bean definitions can save a lot of typing. Effectively, this is a form of templating.

bean 的定义信息可以包含许多配置信息，包括构造函数参数，属性值和特定于容器的信息，例如初始化方法，静态工厂方法名称等。子 bean 定义可以从父 bean 定义继承配置数据。子 bean 的定义信息可以覆盖某些值，或者可以根据需要添加其他值。使用父 bean 和子 bean 的定义可以节省很多输入（实际上，这是一种模板的设计形式）。

文档已经解释的比较清楚了，bean 的定义就是包含了这个 bean 应该有的所有重要信息，并且它又提到了一个概念：bean 的定义信息也是有层次性的（联想 BeanFactory 的层次性），bean 的定义信息可以继承自某个已经有的定义信息，并覆盖父信息的一些配置值（而且文档最后也说了这相当于模板的设计）。

1.1.2 javadoc

翻开 BeanDefinition 接口的 javadoc ，里面写的不多，不过也已经很精确的说明了 BeanDefinition 的基本作用：

A BeanDefinition describes a bean instance, which has property values, constructor argument values, and further information supplied by concrete implementations. This is just a minimal interface: The main intention is to allow a BeanFactoryPostProcessor such as PropertyPlaceholderConfigurer to introspect and modify property values and other bean metadata.

BeanDefinition 描述了一个 bean 的实例，该实例具有属性值，构造函数参数值以及具体实现所提供的更多信息。 这只是一个最小的接口，它的主要目的是允许 BeanFactoryPostProcessor（例如 PropertyPlaceholderConfigurer ）内省和修改属性值和其他 bean 的元数据。

对比起官方文档，javadoc 额外提了编码设计中 BeanDefinition 的使用：BeanFactoryPostProcessor 可以任意修改 BeanDefinition 中的信息。这里面又提到了一个 BeanFactoryPostProcessor 的概念，不要着急不要慌张，后面我们马上就学到后置处理器的部分，自然就都学到啦 ~

1.1.3 BeanDefinition接口的方法定义

借助 IDE ，打开 BeanDefinition 的接口定义，从方法列表上看，BeanDefinition 整体包含以下几个部分：

  • Bean 的类信息 - 全限定类名 ( beanClassName )

  • Bean 的属性 - 作用域 ( scope ) 、是否默认 Bean ( primary ) 、描述信息 ( description ) 等

  • Bean 的行为特征 - 是否延迟加载 ( lazy ) 、是否自动注入 ( autowireCandidate ) 、初始化 / 销毁方法 ( initMethod / destroyMethod ) 等

  • Bean 与其他 Bean 的关系 - 父 Bean 名 ( parentName ) 、依赖的 Bean ( dependsOn ) 等

  • Bean 的配置属性 - 构造器参数 ( constructorArgumentValues ) 、属性变量值 ( propertyValues ) 等

由此可见，BeanDefinition 几乎把 bean 的所有信息都能收集并封装起来，可以说是很全面了。

1.1.4 面试中如何概述BeanDefinition

以下答案仅供参考，可根据自己的理解调整回答内容：

**BeanDefinition** 描述了 SpringFramework 中 bean 的元信息，它包含 bean 的类信息、属性、行为、依赖关系、配置信息等。**BeanDefinition** 具有层次性，并且可以在 IOC 容器初始化阶段被 **BeanDefinitionRegistryPostProcessor** 构造和注册，被 **BeanFactoryPostProcessor** 拦截修改等。

1.2 BeanDefinition的结构

跟上一章一样，搞明白了 BeanDefinition 是什么，下面咱来看看 BeanDefinition 在 SpringFramework 中是如何设计的：

借助 IDEA ，可以形成如下的继承关系图：

img

可以发现这里面涉及到的接口、抽象类和扩展居然如此之多，当然我们也不会全部都去探索，只挑其中重要的来看就好啦。

1.2.1 AttributeAccessor

看类名就知道，它是属性的访问器，那它一定具有可以访问对象属性的功能咯？文档注释写的非常简单，就一句话：

Interface defining a generic contract for attaching and accessing metadata to/from arbitrary objects.

定义用于将元数据附加到任意对象，或从任意对象访问元数据的通用协定的接口。

看上去，它很像是类中定义的 getter 和 setter 方法呀，不过实际上它与 getter 、setter 方法有所区别。

1.2.1.1 回顾元信息的概念

元信息的部分我们有说过，一个类中有什么属性、什么方法，是封装在 **Class** 类对象中的，通过反射可以获取类的属性、方法定义信息。

比方说以下一个例子：

public class Person {
    private String name;
    
    public String getName() {
        return name;
    }
    
    public void setName(String name) {
        this.name = name;
    }
}

像这样的一个简单的类，如果用定义性质的语言描述，可以抽象成如下内容：

className: Person
attributes: [name]
methods: [getName, setName]

1.2.1.2 AttributeAccessor的设计

翻看 AttributeAccessor 的接口方法，会发现它不只是简单的 getter 和 setter ，它还能移除属性信息（此处的属性就是 bean 的成员属性）。

public interface AttributeAccessor {
    // 设置bean中属性的值
    void setAttribute(String name, @Nullable Object value);

    // 获取bean中指定属性的值
    Object getAttribute(String name);

    // 移除bean中的属性
    Object removeAttribute(String name);

    // 判断bean中是否存在指定的属性
    boolean hasAttribute(String name);

    // 获取bean的所有属性
    String[] attributeNames();
}

由此，我们就可以总结出第一个 BeanDefinition 的特征：**BeanDefinition** 继承了 **AttributeAccessor** 接口，具有配置 bean 属性的功能。（注意此处的措辞，配置 bean 就包含了访问、修改、移除在内的操作）

1.2.2 BeanMetadataElement

看到 metadata ，是不是立马就回想起元信息的概念了？其实这个类名已经把它的功能都告诉我们了：它存放了 bean 的元信息。这个接口只有一个方法，是获取 bean 的资源来源：

public interface BeanMetadataElement {
    default Object getSource() {
        return null;
    }
}

资源来源，说白了，就是 bean 的文件 /url 路径。咱们前面写的所有示例，都是在本地磁盘上的 .class 文件加载进来的，所以对应的也就应该是 FileSystemResource 。

1.2.3 AbstractBeanDefinition

到了 BeanDefinition 的第一个实现类了，作为 BeanDefinition 的抽象实现，它里面已经定义好了一些属性和功能（大部分都有了），大体包含以下内容：

    // bean的全限定类名
    private volatile Object beanClass;

    // 默认的作用域为单实例
    private String scope = SCOPE_DEFAULT;

    // 默认bean都不是抽象的
    private boolean abstractFlag = false;

    // 是否延迟初始化
    private Boolean lazyInit;
    
    // 自动注入模式(默认不自动注入)
    private int autowireMode = AUTOWIRE_NO;

    // 是否参与IOC容器的自动注入(设置为false则它不会注入到其他bean，但其他bean可以注入到它本身)
    // 可以这样理解：设置为false后，你们不要来找我，但我可以去找你们
    private boolean autowireCandidate = true;

    // 同类型的首选bean
    private boolean primary = false;

    // bean的构造器参数和参数值列表
    private ConstructorArgumentValues constructorArgumentValues;

    // bean的属性和属性值集合
    private MutablePropertyValues propertyValues;

    // bean的初始化方法
    private String initMethodName;

    // bean的销毁方法
    private String destroyMethodName;

    // bean的资源来源
    private Resource resource;

可以发现，基本上前面提到的，这里都有了！那它干嘛还要抽象出来呢？看看文档注释怎么说：

Base class for concrete, full-fledged BeanDefinition classes, factoring out common properties of GenericBeanDefinition, RootBeanDefinition, and ChildBeanDefinition. The autowire constants match the ones defined in the AutowireCapableBeanFactory interface.

它是 BeanDefinition 接口的抽象实现类，其中排除了 GenericBeanDefinition ，RootBeanDefinition 和 ChildBeanDefinition 的常用属性。 自动装配常量与 AutowireCapableBeanFactory 接口中定义的常量匹配。

哦，看样子它还不是最全的咯？针对不同的 BeanDefinition 落地实现，还有一些特殊的属性咯，所以还是需要抽象出一个父类才行哈。

在继续往下走之前，这里有必要插入一点东西，就是这个 autowireMode 属性，我们之前在 bean 的依赖注入中没有讲到，这里补充一下。

1.2.3.1 自动注入模式

其实这个自动注入模式，在前面第 22 章就已经有提过一嘴了（ default-autowire ），不过它的作用小册没有提及，这里咱讲解一下。

正常来讲，bean 中的组件依赖注入，是需要在 xml 配置文件，或者在属性 / 构造器 / setter 方法上标注注入的注解（ @Autowired / @Resource / @Inject 的。不过，SpringFramework 为我们提供了另外一种方式，如果组件中的类型 / 属性名与需要注入的 bean 的类型 / name 完全一致，可以不标注依赖注入的注解，也能实现依赖注入。

一般情况下，自动注入只会在 xml 配置文件中出现，注解配置中 @Bean 注解的 autowire 属性在 SpringFramework 5.1 之后被标记为已过时，替代方案是使用 @Autowired 等注解。

使用方式很简单，譬如前面的依赖注入章节中，basic_di/inject-set.xml 配置文件里面，cat 注入的 Person 完全可以不写，只需要在 <bean> 标签上声明自动注入模式为按名称注入即可，运行效果是完全一样的。

<bean id="cat" class="com.linkedbear.spring.basic_di.a_quickstart_set.bean.Cat" autowire="byName">
    <property name="name" value="test-cat"/>
    <!-- <property name="master" ref="person"/> 可以不写 -->
</bean>

自动注入的模式有 5 种选择：AUTOWIRE_NO（不自动注入）、AUTOWIRE_BY_NAME（根据 bean 的名称注入）、AUTOWIRE_BY_TYPE（根据 bean 的类型注入）、AUTOWIRE_CONSTRUCTOR（根据 bean 的构造器注入）、AUTOWIRE_AUTODETECT（借助内省决定如何注入，3.0 即弃用），默认是不开启的（所以才需要我们开发者对需要注入的属性标注注解，或者在 xml 配置文件中配置）。

下面咱继续看几个具体的落地实现，看它们里面有什么特殊的设计。

1.2.4 GenericBeanDefinition

又看到 Generic 了，它代表着通用、一般的，所以这种 BeanDefinition 也具有一般性。GenericBeanDefinition 的源码实现非常简单，仅仅是比 AbstractBeanDefinition 多了一个 parentName 属性而已。

由这个设计，可以得出以下几个结论：

  • AbstractBeanDefinition 已经完全可以构成 BeanDefinition 的实现了

  • GenericBeanDefinition 就是 AbstractBeanDefinition 的非抽象扩展而已

  • GenericBeanDefinition 具有层次性（可从父 BeanDefinition 处继承一些属性信息）

不过，相比较下面的而言，它的层次性体现的不是那么强烈，下面的这两种 BeanDefinition 就有非常强的层次性关系了。

1.2.5 RootBeanDefinition与ChildBeanDefinition

root 和 child ，很明显这是父子关系的意思了呀。对于 ChildBeanDefinition ，它的设计实现与 GenericBeanDefinition 如出一辙，都是集成一个 parentName 来作为父 BeanDefinition 的 “指向引用” 。不过有一点要注意， ChildBeanDefinition 没有默认的无参构造器，必须要传入 parentName 才可以，但 GenericBeanDefinition 则有两种不同的构造器。

RootBeanDefinition 有着 “根” 的概念在里面，它只能作为单体独立的 BeanDefinition ，或者父 BeanDefinition 出现（不能继承其他 BeanDefinition ）。它里面的设计也复杂得多，从源码的篇幅上就能看得出来（接近 500 行，而 GenericBeanDefinition 只有 100 行多一点）。不过这里我们不去挨个属性研究它的作用，只了解重要的组成部分就好啦。

下面是 RootBeanDefinition 的一些重要的成员属性：

    // BeanDefinition的引用持有，存放了Bean的别名
    private BeanDefinitionHolder decoratedDefinition;

    // Bean上面的注解信息
    private AnnotatedElement qualifiedElement;

    // Bean中的泛型
    volatile ResolvableType targetType;

    // BeanDefinition对应的真实的Bean
    volatile Class<?> resolvedTargetType;

    // 是否是FactoryBean
    volatile Boolean isFactoryBean;
    // 工厂Bean方法返回的类型
    volatile ResolvableType factoryMethodReturnType;
    // 工厂Bean对应的方法引用
    volatile Method factoryMethodToIntrospect;

可以发现，RootBeanDefinition 在 AbstractBeanDefinition 的基础上，又扩展了这么些 Bean 的信息：

  • Bean 的 id 和别名

  • Bean 的注解信息

  • Bean 的工厂相关信息（是否为工厂 Bean 、工厂类、工厂方法等）

而且这里面直接把一些反射相关的元素都包含进来了，可见 BeanDefinition 在底层可是要在反射上 “大动干戈”了。

1.2.6 AnnotatedBeanDefinition

最后，提一下这个家伙。它并不是 BeanDefinition 的实现类，而是一个子接口：

public interface AnnotatedBeanDefinition extends BeanDefinition {
    
	AnnotationMetadata getMetadata();
    
	MethodMetadata getFactoryMethodMetadata();
}

由这个接口定义的方法，大概就可以猜测到，它可以把 Bean 上的注解信息提供出来。借助 IDEA ，发现它的子类里，有一个 AnnotatedGenericBeanDefinition ，还有一个 ScannedGenericBeanDefinition ，它们都是基于注解驱动下的 Bean 的注册，封装的 BeanDefinition 。现在我们没有必要对这些 BeanDefinition 深入研究，到后面 IOC 原理中，遇到咱们会解释的。

1.3 体会BeanDefinition

下面，咱们使用一些简单的 Demo ，帮助小伙伴们体会 BeanDefinition 中的设计，以及封装的内容。本章只会了解 BeanDefinition 的设计部分，至于如何利用它们，咱们统一放到下一章讲解。

1.3.1 基于xml的BeanDefinition

使用 xml 配置文件的方式，每定义一个 <bean> 标签，就相当于构建了一个 BeanDefinition ，下面咱来演示基于 xml 的 BeanDefinition 。

1.3.1.1 编写Bean与xml

还是拿最最简单的 Person 举例吧，按照依赖注入的最简单示例编写 Person 与 xml 配置文件就好：

public class Person {
    
    private String name;
    
    public String getName() {
        return name;
    }
    
    public void setName(String name) {
        this.name = name;
    }
}
<?xml version="1.0" encoding="UTF-8"?>
<beans xmlns="http://www.springframework.org/schema/beans"
       xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
       xsi:schemaLocation="http://www.springframework.org/schema/beans
        https://www.springframework.org/schema/beans/spring-beans.xsd">

    <bean id="person" class="com.linkedbear.spring.definition.a_quickstart.bean.Person">
        <property name="name" value="zhangsan"/>
    </bean>
</beans>

1.3.1.2 测试获取BeanDefinition

使用 xml 驱动 IOC 容器，并尝试获取 BeanDefinition ：

public class BeanDefinitionQuickstartXmlApplication {
    
    public static void main(String[] args) throws Exception {
        ClassPathXmlApplicationContext ctx = new ClassPathXmlApplicationContext("definition/definition-beans.xml");
        // ？？？
    }
}

到了这里，要写下一步的代码，发现 ClassPathXmlApplicationContext 里没有 getBeanDefinition 方法：

img

woc ？这可咋整？难不成我还要取出所有的 BeanDefinition ，再筛选出 person 吗？这显然不合理吧！既然能获取多个，那就肯定能获取一个！那这里到底是出了什么问题呢？

别慌，回想前面学习的知识，ApplicationContext 中最终是组合了一个 BeanFactory 来存放 Bean 的，那 ApplicationContext 没有，BeanFactory 里有没有呢？

打开 DefaultListableBeanFactory ，搜索 getBeanDefintion ，发现真的能找到了：

img

往上看这个方法的定义，发现它定义在 ConfigurableListableBeanFactory 中。虽说前面 14 章中没有介绍过 ConfigurableListableBeanFactory ，但它的特性应该也能猜得到吧：同时具备 “可配置” 和 “可列举” 的特性（当然人家也在此基础上又扩充了其他方法），更多的方法定义和用法，小伙伴们可以自行查看源码，小册不在此展开。

回到正题，既然 ClassPathXmlApplicationContext 没有这个方法，那就由它获取到 BeanFactory 再调用吧：

public class BeanDefinitionQuickstartXmlApplication {
    
    public static void main(String[] args) throws Exception {
        ClassPathXmlApplicationContext ctx = new ClassPathXmlApplicationContext("definition/definition-beans.xml");
        BeanDefinition personBeanDefinition = ctx.getBeanFactory().getBeanDefinition("person");
        System.out.println(personBeanDefinition);
    }
}

运行 main 方法，控制台可以打印出 person 的 BeanDefinition 信息：

Generic bean: class [com.linkedbear.spring.definition.a_quickstart.bean.Person]; scope=; abstract=false; lazyInit=false; autowireMode=0; dependencyCheck=0; autowireCandidate=true; primary=false; factoryBeanName=null; factoryMethodName=null; initMethodName=null; destroyMethodName=null; defined in class path resource [definition/definition-beans.xml]

由这个打印信息，可以获取到一个 bean 的所有基本信息了。

值得注意的是，它是一个 Generic bean （打印 personBeanDefinition 的类型可得 org.springframework.beans.factory.support.GenericBeanDefinition ），这个信息比较重要哦。

1.3.2 基于@Component的BeanDefinition

给 Person 上打一个 @Component 注解，然后使用 AnnotationConfigApplicationContext 来驱动扫描 Person 类，其余的代码不变：

（注意 AnnotationConfigApplicationContext 可以直接调用 getBeanDefinition 方法哦）

public class BeanDefinitionQuickstartComponentApplication {
    
    public static void main(String[] args) throws Exception {
        AnnotationConfigApplicationContext ctx = new AnnotationConfigApplicationContext(
                "com.linkedbear.spring.definition.a_quickstart.bean");
        BeanDefinition personBeanDefinition = ctx.getBeanDefinition("person");
        System.out.println(personBeanDefinition);
        System.out.println(personBeanDefinition.getClass().getName());
    }
}

运行 main 方法，控制台打印出来的依然是一个 Generic bean ，但类型与上面的 xml BeanDefinition 不太一致：

Generic bean: class [com.linkedbear.spring.definition.a_quickstart.bean.Person]; scope=singleton; abstract=false; lazyInit=null; autowireMode=0; dependencyCheck=0; autowireCandidate=true; primary=false; factoryBeanName=null; factoryMethodName=null; initMethodName=null; destroyMethodName=null; defined in file [E:\IDEA\spring-framework-projects\spring-01-ioc\target\classes\com\linkedbear\spring\definition\a_quickstart\bean\Person.class]
org.springframework.context.annotation.ScannedGenericBeanDefinition

可以发现，BeanDefinition 的打印信息里，最大的不同是加载来源：基于 xml 解析出来的 bean ，定义来源是 xml 配置文件；基于 **@Component** 注解解析出来的 bean ，定义来源是类的 .class 文件中。

1.3.3 基于@Bean的BeanDefinition

编写一个配置类 BeanDefinitionQuickstartConfiguration ，使用 @Bean 注册一个 Person ：

@Configuration
public class BeanDefinitionQuickstartConfiguration {
    
    @Bean
    public Person person() {
        return new Person();
    }
}

之后，使用这个配置类驱动 IOC 容器，并直接获取 BeanDefinition ：

public class BeanDefinitionQuickstartBeanApplication {
    
    public static void main(String[] args) throws Exception {
        AnnotationConfigApplicationContext ctx = new AnnotationConfigApplicationContext(
                BeanDefinitionQuickstartConfiguration.class);
        BeanDefinition personBeanDefinition = ctx.getBeanDefinition("person");
        System.out.println(personBeanDefinition);
        System.out.println(personBeanDefinition.getClass().getName());
    }
}

运行 main 方法，发现控制台打印的内容与前面相比有很大的区别：

Root bean: class [null]; scope=; abstract=false; lazyInit=null; autowireMode=3; dependencyCheck=0; autowireCandidate=true; primary=false; factoryBeanName=beanDefinitionQuickstartConfiguration; factoryMethodName=person; initMethodName=null; destroyMethodName=(inferred); defined in com.linkedbear.spring.definition.a_quickstart.config.BeanDefinitionQuickstartConfiguration
org.springframework.context.annotation.ConfigurationClassBeanDefinitionReader$ConfigurationClassBeanDefinition

具体区别可以发现有这么几个：

  • Bean 的类型是 Root bean （ ConfigurationClassBeanDefinition 继承自 RootBeanDefinition ）

  • Bean 的 className 不见了

  • 自动注入模式为 AUTOWIRE_CONSTRUCTOR （构造器自动注入）

  • 有 factoryBean 了：person 由 beanDefinitionQuickstartConfiguration 的 person 方法创建

这一切的一切都是怎么搞得呢？下面咱解释这种现象与设计。

1.3.4 BeanDefinition是如何生成的

这个问题说实话如果想完全彻底的解释清楚，有点费劲，我们放到后面的 IOC 原理篇，BeanDefinition 的解析阶段解释，这里只是让小伙伴们有一个认识和印象即可。

  1. 通过 xml 加载的 BeanDefinition ，它的读取工具是 XmlBeanDefinitionReader ，它会解析 xml 配置文件，最终来到 DefaultBeanDefinitionDocumentReader 的 doRegisterBeanDefinitions 方法，根据 xml 配置文件中的 bean 定义构造 BeanDefinition ，最底层创建 BeanDefinition 的位置在 org.springframework.beans.factory.support.BeanDefinitionReaderUtils#createBeanDefinition 。

  2. 通过模式注解 + 组件扫描的方式构造的 BeanDefinition ，它的扫描工具是 ClassPathBeanDefinitionScanner ，它会扫描指定包路径下包含特定模式注解的类，核心工作方法是 doScan 方法，它会调用到父类 ClassPathScanningCandidateComponentProvider 的 findCandidateComponents 方法，创建 ScannedGenericBeanDefinition 并返回。

  3. 通过配置类 + @Bean 注解的方式构造的 BeanDefinition 最复杂，它涉及到配置类的解析。配置类的解析要追踪到 ConfigurationClassPostProcessor 的 processConfigBeanDefinitions 方法，它会处理配置类，并交给 ConfigurationClassParser 来解析配置类，取出所有标注了 @Bean 的方法。随后，这些方法又被 ConfigurationClassBeanDefinitionReader 解析，最终在底层创建 ConfigurationClassBeanDefinition 并返回。

2. BeanDefinitionRegistry

2.1 BeanDefinitionRegistry概述

还是那个老套路，先对 BeanDefinitionRegistry 有个整体的认识。

由于官方文档中并没有提及 BeanDefinitionRegistry 的设计，故我们只尝试从 javadoc 中获取一些信息。

Interface for registries that hold bean definitions, for example RootBeanDefinition and ChildBeanDefinition instances. Typically implemented by BeanFactories that internally work with the AbstractBeanDefinition hierarchy. This is the only interface in Spring's bean factory packages that encapsulates registration of bean definitions. The standard BeanFactory interfaces only cover access to a fully configured factory instance. Spring's bean definition readers expect to work on an implementation of this interface. Known implementors within the Spring core are DefaultListableBeanFactory and GenericApplicationContext.

包含 bean 定义的注册表的接口（例如 RootBeanDefinition 和 ChildBeanDefinition 实例）。通常由内部与 AbstractBeanDefinition 层次结构一起工作的 BeanFactorty 实现。 这是 SpringFramework 的 bean 工厂包中唯一封装了 bean 的定义注册的接口。标准 BeanFactory 接口仅涵盖对完全配置的工厂实例的访问。 BeanDefinition 的解析器希望可以使用此接口的实现类来支撑逻辑处理。SpringFramework 中的已知实现者是 DefaultListableBeanFactory 和 GenericApplicationContext 。

其实 javadoc 已经把 BeanDefinitionRegistry 的设计都讲得七七八八了，小册重新解读一下，帮助小伙伴们理解。

2.1.1 BeanDefinitionRegistry中存放了所有BeanDefinition

Registry 有注册表的意思，联想下 Windows 的注册表，它存放了 Windows 系统中的应用和设置信息。如果按照这个设计理解，那 BeanDefinitionRegistry 中存放的就应该是 BeanDefinition 的设置信息。其实 SpringFramework 中的底层，对于 BeanDefinition 的注册表的设计，就是一个 **Map** ：

// 源自DefaultListableBeanFactory
private final Map<String, BeanDefinition> beanDefinitionMap = new ConcurrentHashMap<>(256);

2.1.2 BeanDefinitionRegistry中维护了BeanDefinition

另外，Registry 还有注册器的意思，既然 Map 有增删改查，那作为 BeanDefinition 的注册器，自然也会有 BeanDefinition 的注册功能咯。BeanDefinitionRegistry 中有 3 个方法，刚好对应了 BeanDefinition 的增、删、查：

void registerBeanDefinition(String beanName, BeanDefinition beanDefinition)
            throws BeanDefinitionStoreException;

void removeBeanDefinition(String beanName) throws NoSuchBeanDefinitionException;

BeanDefinition getBeanDefinition(String beanName) throws NoSuchBeanDefinitionException;

2.1.3 BeanDefinitionRegistry支撑其它组件运行

javadoc 的最后一段，说起来有点有趣：

Spring's bean definition readers expect to work on an implementation of this interface.

BeanDefinition 的加载器希望可以使用此接口的实现类来支撑逻辑处理。

这句话似乎不是那么好理解，小册尝试用一个例子来引导小伙伴理解 BeanDefinitionRegistry 的支撑作用。

javadoc 中的 Reader 可以参照上一章提到了 XmlBeanDefinitionReader ，它是用来读取和加载 xml 配置文件的组件。加载 xml 配置文件的目的就是读取里面的配置，和定义好要注册到 IOC 容器的 bean 。XmlBeanDefinitionReader 要在加载完 xml 配置文件后，将配置文件的流对象也好，文档对象也好，交给解析器来解析 xml 文件，解析器拿到 xml 文件后要解析其中定义的 bean ，并且封装为 BeanDefinition 注册到 IOC 容器，这个时候就需要 BeanDefinitionRegistry 了。所以在这个过程中，**BeanDefinitionRegistry** 会支撑 **XmlBeanDefinitionReader** 完成它的工作。

当然，BeanDefinitionRegistry 不止支撑了这一个哈，还记得之前小册 17 章，学习模块装配时用到的 ImportBeanDefinitionRegistrar 吗？它的 registerBeanDefinitions 方法是不是也传入了一个 BeanDefinitionRegistry 呀？所以说这个 BeanDefinitionRegistry 用到的位置还是不少的，小伙伴们要予以重视哦。

2.1.4 BeanDefinitionRegistry的主要实现是DefaultListableBeanFactory

注意这个地方我没说是唯一实现哦，是因为 BeanDefinitionRegistry 除了有最最常用的 DefaultListableBeanFactory 之外，还有一个不常用的 SimpleBeanDefinitionRegistry ，但这个 SimpleBeanDefinitionRegistry 基本不会去提它，是因为这个设计连内部的 IOC 容器都没有，仅仅是一个 BeanDefinitionRegistry 的表面实现而已，所以我们当然不会用它咯。

可能有的小伙伴借助 IDE 发现很多 ApplicationContext 也实现了它，但我想请这部分小伙伴回想一下，ApplicationContext 本身管理 Bean 吗？不吧，ApplicationContext 不都是内部组合了一个 DefaultListableBeanFactory 来实现的嘛，所以我们说，唯一真正落地实现的是 DefaultListableBeanFactory 这话是正确合理的。

2.1.5 面试中如何概述BeanDefinitionRegistry

以下答案仅供参考，可根据自己的理解调整回答内容：

**BeanDefinitionRegistry** 是维护 **BeanDefinition** 的注册中心，它内部存放了 IOC 容器中 bean 的定义信息，同时 **BeanDefinitionRegistry** 也是支撑其它组件和动态注册 Bean 的重要组件。在 SpringFramework 中，**BeanDefinitionRegistry** 的实现是 **DefaultListableBeanFactory** 。

2.2 BeanDefinitionRegistry维护BeanDefinition的使用

对于 BeanDefinitionRegistry 内部的设计，倒是没什么好说的，主要还是研究它如何去维护 BeanDefinition 。

2.2.1 BeanDefinition的注册

对于 BeanDefinition 的注册，目前我们接触到的方式是在 17 章模块装配中使用的 ImportBeanDefinitionRegistrar ：

public class WaiterRegistrar implements ImportBeanDefinitionRegistrar {
    
    @Override
    public void registerBeanDefinitions(AnnotationMetadata metadata, BeanDefinitionRegistry registry) {
        registry.registerBeanDefinition("waiter", new RootBeanDefinition(Waiter.class));
    }
}

之前的这个例子中是直接 new 了一个 RootBeanDefinition ，其实 BeanDefinition 的构造可以借助建造器生成，下面我们再演示一个例子。

2.2.1.1 声明Person类

像往常一样，搞一个比较简单的 Person 就好啦，记得声明几个属性和 toString 方法：

public class Person {
    
    private String name;
    
    public String getName() {
        return name;
    }
    
    public void setName(String name) {
        this.name = name;
    }
    
    @Override
    public String toString() {
        return "Person{" + "name='" + name + '\'' + '}';
    }
}

2.2.1.2 编写ImportBeanDefinitionRegistrar的实现类

编写一个 PersonRegister ，让它实现 ImportBeanDefinitionRegistrar ，这样就可以拿到 BeanDefinitionRegistry 了：

public class PersonRegister implements ImportBeanDefinitionRegistrar {
    
    @Override
    public void registerBeanDefinitions(AnnotationMetadata importingClassMetadata, BeanDefinitionRegistry registry) {
        registry.registerBeanDefinition("person",
                BeanDefinitionBuilder.genericBeanDefinition(Person.class).addPropertyValue("name", "zhangsan")
                        .getBeanDefinition());
    }
}

注意这里面的写法，使用 BeanDefinitionBuilder ，是可以创建 GenericBeanDefinition 、RootBeanDefinition 和 ChildBeanDefinition 三种类型的，此处小册使用 GenericBeanDefinition ，后续直接向 BeanDefinition 中添加 bean 中属性的值就好，整个构造过程一气呵成，非常的简单。

2.2.1.3 编写配置类导入PersonRegister

编写一个配置类，把上面刚写好的 PersonRegister 导入进去（这一步不要忘了哦）：

@Configuration
@Import(PersonRegister.class)
public class BeanDefinitionRegistryConfiguration {
    
}

2.2.1.4 测试获取Person

万事俱备，下面编写测试启动类，使用 BeanDefinitionRegistryConfiguration 驱动 IOC 容器，并从容器中取出 Person 并打印：

public class BeanDefinitionRegistryApplication {
    
    public static void main(String[] args) throws Exception {
        AnnotationConfigApplicationContext ctx = new AnnotationConfigApplicationContext(
                BeanDefinitionRegistryConfiguration.class);
        Person person = ctx.getBean(Person.class);
        System.out.println(person);
    }
}

运行 main 方法，控制台中打印了 Person 的 name 属性是有值的，说明 SpringFramework 已经按照我们预先定义好的 BeanDefinition ，注册到 IOC 容器，并且生成了对应的 Bean 。

Person{name='zhangsan'}

2.2.2 BeanDefinition的移除

BeanDefinitionRegistry 除了能给 IOC 容器中添加 BeanDefinition ，还可以移除掉一些特定的 BeanDefinition 。这种操作可以在 Bean 的实例化之前去除，以阻止 IOC 容器创建。

要演示 BeanDefinition 的移除，需要一个现阶段没见过的 API ，咱们先学着用一下，到后面我们会系统的学习它的用法。

2.2.2.1 声明Person

这次声明的 Person 类要加一个特殊的属性：sex ，性别，它在后面会起到判断作用。

声明好 getter 、setter 和 toString 方法即可。

public class Person {
    
    private String name;
    private String sex;
    
    // getter 、setter 、 toString
}

2.2.2.2 声明配置类

接下来要注册两个 Person ，分别注册一男一女。

由上一章 BeanDefinition 的注册方式与实现类型，可知如果此处使用注解配置类的方式注册 Bean ( @Bean ) ，生成的 BeanDefinition 将无法取到 beanClassName （也无法取到 PropertyValues ），故此处选用 xml 方式注册 Bean 。

<?xml version="1.0" encoding="UTF-8"?>
<beans xmlns="http://www.springframework.org/schema/beans"
       xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
       xmlns:context="http://www.springframework.org/schema/context"
       xsi:schemaLocation="http://www.springframework.org/schema/beans
        https://www.springframework.org/schema/beans/spring-beans.xsd http://www.springframework.org/schema/context https://www.springframework.org/schema/context/spring-context.xsd">

    <bean id="aqiang" class="com.linkedbear.spring.definition.c_removedefinition.bean.Person">
        <property name="name" value="阿强"/>
        <property name="sex" value="male"/>
    </bean>

    <bean id="azhen" class="com.linkedbear.spring.definition.c_removedefinition.bean.Person">
        <property name="name" value="阿珍"/>
        <property name="sex" value="female"/>
    </bean>

    <!-- 注意此处要开启包扫描 -->
    <context:component-scan base-package="com.linkedbear.spring.definition.c_removedefinition.config"/>
</beans>

2.2.2.3 编写剔除BeanDefinition的后置处理器

这里涉及到后置处理器的概念了，没见过没关系，不会搞没关系，先照着葫芦画瓢，后面马上就学到了。

要剔除 BeanDefinition ，需要实现 BeanFactoryPostProcessor 接口，并重写 postProcessBeanFactory 方法：

@Component
public class RemoveBeanDefinitionPostProcessor implements BeanFactoryPostProcessor {
    
    @Override
    public void postProcessBeanFactory(ConfigurableListableBeanFactory beanFactory) throws BeansException {
    
    }
}

注意方法的入参，它是一个 ConfigurableListableBeanFactory ，不用想，它的唯一实现一定是 DefaultListableBeanFactory 。又从前面了解到 DefaultListableBeanFactory 实现了 BeanDefinitionRegistry 接口，所以这里我们就可以直接将 beanFactory 强转为 BeanDefinitionRegistry 类型。

于是，我们就可以编写如下的剔除逻辑：移除 IOC 容器中所有性别为 male 的 Person 。

@Override
public void postProcessBeanFactory(ConfigurableListableBeanFactory beanFactory) throws BeansException {
    BeanDefinitionRegistry registry = (BeanDefinitionRegistry) beanFactory;
    // 获取IOC容器中的所有BeanDefinition
    for (String beanDefinitionName : beanFactory.getBeanDefinitionNames()) {
        // 判断BeanDefinition对应的Bean是否为Person类型
        BeanDefinition beanDefinition = beanFactory.getBeanDefinition(beanDefinitionName);
        if (Person.class.getName().equals(beanDefinition.getBeanClassName())) {
            // 判断Person的性别是否为male
            // 使用xml配置文件对bean进行属性注入，最终取到的类型为TypedStringValue，这一点不需要记住
            TypedStringValue sex = (TypedStringValue) beanDefinition.getPropertyValues().get("sex");
            if ("male".equals(sex.getValue())) {
                // 移除BeanDefinition
                registry.removeBeanDefinition(beanDefinitionName);
            }
        }
    }
}

2.2.2.4 测试获取“阿强”

这一次我们又要用 ClassPathXmlApplicationContext 来加载配置文件驱动 IOC 容器了，写法很简单，直接从 IOC 容器中取 “aqiang” 就好：

public class RemoveBeanDefinitionApplication {
    
    public static void main(String[] args) throws Exception {
        ClassPathXmlApplicationContext ctx = new ClassPathXmlApplicationContext("definition/remove-definitions.xml");
        Person aqiang = (Person) ctx.getBean("aqiang");
        System.out.println(aqiang);
    }
}

运行 main 方法，控制台打印 NoSuchBeanDefinitionException 的异常，证明 “aqiang” 对应的 BeanDefinition 已经被移除了，无法创建 Person 实例。

好了，到这里，对 BeanDefinitionRegistry 有一个比较清晰的认识就好，具体操作不需要太深入了解，会用就够啦。

2.3 BeanDefinition的合并

了解完 BeanDefinitionRegistry ，回过头来再学习一个 BeanDefinition 的特性：合并。

关于合并这个概念，可能有些小伙伴没有概念，小册先来解释一下合并的意思。

2.3.1 如何理解BeanDefinition的合并

上一章我们知道，之前在 xml 配置文件中定义的那些 bean ，最终都转换为一个个的 GenericBeanDefinition ，它们都是相互独立的。比如这样：

<bean class="com.linkedbear.spring.basic_dl.b_bytype.bean.Person"></bean>
<bean class="com.linkedbear.spring.basic_dl.b_bytype.dao.impl.DemoDaoImpl"/>

但其实，bean 也是存在父子关系的。与 Class 的抽象、继承一样，<bean> 标签中有 abstract 属性，有 parent 属性，由此就可以形成父子关系的 BeanDefinition 了。

下面小册演示一个实例，讲解 BeanDefinition 的合并。

2.3.2 BeanDefinition合并的体现

先构建一个比较简单的场景吧：所有的动物都归人养，动物分很多种（猫啊 狗啊 猪啊 巴拉巴拉）。

下面我们基于这个场景来编码演绎。

2.3.2.1 声明实体类

对于这几个实体类，前面已经写过很多次了，这里快速编写出来就 OK ：

public class Person {
    
}
public abstract class Animal {

    private Person person;
    
    public Person getPerson() {
        return person;
    }
    
    public void setPerson(Person person) {
        this.person = person;
    }
}

Cat 要继承自 Animal ，并且为了方便打印出 person ，这里就不直接使用 IDEA 的 toString 方法生成了，而是在此基础上改造一下：

public class Cat extends Animal {
    
    private String name;
    
    public String getName() {
        return name;
    }
    
    public void setName(String name) {
        this.name = name;
    }
    
    @Override
    public String toString() {
        return "Cat{" + "name=" + name + ", person='" + getPerson() + '\'' + "}";
    }
}

2.3.2.2 编写xml配置文件

要体现 BeanDefinition 的合并，要使用配置文件的形式，前面也说过了。那下面咱就来造一个配置文件，先把 Person 注册上去。

<?xml version="1.0" encoding="UTF-8"?>
<beans xmlns="http://www.springframework.org/schema/beans"
       xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
       xsi:schemaLocation="http://www.springframework.org/schema/beans http://www.springframework.org/schema/beans/spring-beans.xsd">

    <bean id="person" class="com.linkedbear.spring.definition.d_merge.bean.Person"/>
</beans>

接下来要注册 Animal 和 Cat 了。按照之前的写法，这里只需要注册 Cat 就可以了，像这样写就 OK ：

<bean class="com.linkedbear.spring.definition.d_merge.bean.Cat" parent="abstract-animal">
    <property name="person" ref="person"/>
    <property name="name" value="咪咪"/>
</bean>

但试想，如果要创建的猫猫狗狗猪猪太多的话，每个 bean 都要注入 property ，这样可不是好办法。由此，就可以使用 BeanDefinition 合并的特性来优化这个问题。

我们直接在 xml 中注册一个 Animal ：

<bean class="com.linkedbear.spring.definition.d_merge.bean.Animal"></bean>

但这样写完之后，IDEA 会报红，给出这样的提示：

img

很明显嘛，抽象类怎么能靠一个 <bean> 标签构造出对象呢？所以，<bean> 标签里有一个属性，就是标注这个 bean 是否是抽象类：

img

如此，咱就可以把这个 Animal 声明好了，由于是 abstract 类型的 bean ，那也就可以搞定注入的事了：

<bean id="abstract-animal" class="com.linkedbear.spring.definition.d_merge.bean.Animal" abstract="true">
    <property name="person" ref="person"/>
</bean>

接下来要声明 Cat 了，有 abstract 就有 parent ，想必不用我多说小伙伴们也能猜到如何写了：

<bean id="cat" class="com.linkedbear.spring.definition.d_merge.bean.Cat" parent="abstract-animal">
    <property name="name" value="咪咪"/>
</bean>

这里就不再需要声明 person 属性的注入了，因为继承了 abstract-animal ，相应的依赖注入也就都可以继承过来。

这样 xml 配置文件就写完了。

2.3.2.3 测试运行

编写启动类，使用 xml 配置文件驱动 IOC 容器，并从 BeanFactory 中取出 cat 的 BeanDefinition ：

public class MergeBeanDefinitionApplication {
    
    public static void main(String[] args) throws Exception {
        ClassPathXmlApplicationContext ctx = new ClassPathXmlApplicationContext("definition/definition-merge.xml");
        Cat cat = (Cat) ctx.getBean("cat");
        System.out.println(cat);
        
        BeanDefinition catDefinition = ctx.getBeanFactory().getBeanDefinition("cat");
        System.out.println(catDefinition);
    }
}

运行 main 方法，发现 Cat 里确实注入了 person 对象，可是获取出来的 BeanDefinition ，除了有了一个 parentName 之外，跟普通的 bean 没有任何不一样的地方。

Cat{name=咪咪, person='com.linkedbear.spring.definition.d_merge.bean.Person@31dc339b'}
Generic bean with parent 'abstract-animal': class [com.linkedbear.spring.definition.d_merge.bean.Cat]; scope=;   ......(太长省略)

可能会有小伙伴产生疑惑了：这就算是 BeanDefinition 的合并了吗？哪里有体现呢？要么我 Debug 看下结构？

以 Debug 的形式重新运行 main 方法，发现获取到的 catDefinition 里并没有把 person 的依赖带进来：

img

哦，合着并没有合并 BeanDefinition 呗？那这一套花里胡哨的搞蛇皮呢？

等一下，先冷静冷静，会不会是我们的方法不对呢？既然是 BeanDefinition 的合并，那不加个 merge 的关键字，好意思说是合并吗？

试着重新调一下方法，发现 ConfigurableListableBeanFactory 里竟然也有一个 getMergedBeanDefinition 方法！它来自 ConfigurableBeanFactory ，它就是用来将本身定义的 bean 定义信息，与继承的 bean 定义信息进行合并后返回的。

2.3.2.4 换用getMergedBeanDefinition

修改下测试运行，将 getBeanDefinition 换为 getMergedBeanDefinition ，重新运行 main 方法，发现控制台打印的 BeanDefinition 的类型变为了 RootBeanDefinition ，而且也没有 parentName 相关的信息了：

Root bean: class [com.linkedbear.spring.definition.d_merge.bean.Cat]; scope=singleton; abstract=false; lazyInit=false; autowireMode=0; dependencyCheck=0; autowireCandidate=true; primary=false; factoryBeanName=null; factoryMethodName=null; initMethodName=null; destroyMethodName=null; defined in class path resource [definition/definition-merge.xml]

以 Debug 方式运行，此时的 propertyvalues 中已经有两个属性键值对了：

到这里，BeanDefinition 的合并就算了解的差不多了。至于里面的原理，我们会到后面的 IOC 原理部分解析，这里就先不搞那么难的内容了。

2.4 设计BeanDefinition的意义

看到这里，小伙伴们可能会有一个大大的问号，也有可能是大大的感叹号，那就是：SpringFramework 为什么会设计 **BeanDefinition** **呢？直接注册 Bean 不好吗？**这个问题的回答，在不同的阶段学习中，这个答案可能会不太一样。在刚学习完 BeanDefinition 的设计后，小册想先让小伙伴们理解这样的一个设计：定义信息 → 实例。

其实这个设计，在前面的元定义章节就已经反复解释过了，这里小册想再解释一下，因为它真的太太太重要了！

像我们平时编写 Class 再 new 出对象一样，SpringFramework 面对一个应用程序，它也需要对其中的 bean 进行定义抽取，只有抽取成可以统一类型 / 格式的模型，才能在后续的 bean 对象管理时，进行统一管理，也或者是对特定的 bean 进行特殊化的处理。而这一切的一切，最终落地到统一类型上，就是 **BeanDefinition** 这个抽象化的模型。

这段解释中可能现在小伙伴们只能体会到部分的解释（如 SpringFramework 对 Bean 的作用域控制），没有关系不要慌，接下来的两章，学习完后置处理器，到时候小册再拿出这段话来，或许小伙伴们就更能理解这段话想表达的意思了。

上一页Spring IOC下一页Java FrameWorks

最后更新于