Spring之 @Configuration

偏执的太偏执、 2023-10-09 18:19 21阅读 0赞

![format_png][]

Spring 提供了丰富的特性和功能，包括依赖注入、面向切面编程、事务管理、数据访问、Web应用程序开发等。其中，@Configuration 是 Spring 中的一个注解，它用于标记一个类为配置类，通过配置类可以定义和组装 Spring Bean，并且支持高度灵活的配置方式。在本文中，我们将深入探讨 @Configuration 注解的底层原理，包括其与 Spring IoC 容器的集成、其对 Bean 的定义和装配的实现，以及其在 Spring 框架中的作用和用法。

### @Configuration 注解的概述 ###

@Configuration 注解是 Spring 3.0 版本引入的新特性，它用于将一个类标记为配置类，通过配置类可以定义和组装 Spring Bean。

配置类是一个普通的 Java 类，但是在类级别上添加了 @Configuration 注解，表明这个类用于配置 Spring Bean 的创建和管理。配置类可以包含多个用于定义 Bean 的方法，这些方法使用 @Bean 注解来标记，并且返回一个对象，该对象会被 Spring IoC 容器管理。

配置类可以通过多种方式创建和组装 Bean，包括使用其他配置类的 Bean、通过依赖注入注入其他 Bean、通过条件注解实现 Bean 的条件化创建等。配置类可以在 XML 配置文件、JavaConfig 类、注解等方式中进行定义，使得 Spring 的配置更加灵活和方便。

@Configuration 注解的**主要作用**有以下几点：

**定义 Bean**：通过在配置类中使用 @Bean 注解，可以定义和组装 Bean，并将其纳入 Spring IoC 容器的管理，从而使得这些 Bean 可以在应用程序中被使用。

**管理依赖关系**：配置类可以通过依赖注入的方式引入其他 Bean，从而实现 Bean 之间的依赖关系管理。这样，当创建一个 Bean 时，其依赖的其他 Bean 会被自动注入，从而方便地管理 Bean 之间的依赖关系。

**提供条件化配置**：配置类可以通过条件注解实现 Bean 的条件化创建，从而根据不同的条件创建不同的 Bean。这可以用于根据环境、配置等动态地选择 Bean 的创建方式，使得配置更加灵活。

### 底层原理 ###

@Configuration 注解的底层原理主要包括以下几个方面的内容：与 **Spring IoC 容器的集成**、**Bean 的定义和装配的实现**、**条件化配置的实现**、以及**配置类的加载和实例化过程**。

#### 与 Spring IoC 容器的集成 ####

@Configuration 注解与 Spring IoC 容器的集成是通过 **ConfigurationClassPostProcessor** 类来实现的。ConfigurationClassPostProcessor 是一个 Bean 后置处理器，它负责处理标记了 @Configuration 注解的配置类，并将其转换为 Bean 定义并注册到 Spring IoC 容器中。

ConfigurationClassPostProcessor 的处理过程分为**三个阶段**：

**解析阶段**：ConfigurationClassPostProcessor 会扫描配置类的类级别上的 @Configuration 注解，并解析其中的 Bean 定义和依赖关系，生成相应的 BeanDefinition 对象。

**注册阶段**：ConfigurationClassPostProcessor 将解析得到的 BeanDefinition 对象注册到 Spring IoC 容器中，成为真正的 Spring Bean。

**验证阶段**：ConfigurationClassPostProcessor 会验证配置类中的 Bean 定义和依赖关系是否正确，如果有错误则会抛出异常。

通过 ConfigurationClassPostProcessor 的处理，@Configuration 注解标记的配置类会被解析成真正的 BeanDefinition 对象，并注册到 Spring IoC 容器中，从而使得这些配置类中定义的 Bean 可以被 Spring 容器管理和使用。

#### Bean 的定义和装配的实现 ####

@Configuration 注解标记的配置类中，可以使用 @Bean 注解来定义 Bean，并将其纳入 Spring IoC 容器的管理。@Bean 注解的底层实现主要通过 **BeanMethod** 类来实现。

**BeanMethod** 类是一个内部类，它表示一个配置类中使用 @Bean 注解定义的方法。每个使用 @Bean 注解的方法都会被 BeanMethod 类表示，并包含相应的 Bean 定义信息，例如 Bean 的名称、类型、作用域、初始化方法、销毁方法等。

在**解析阶段**，ConfigurationClassPostProcessor 会扫描配置类中的 @Bean 注解，解析其中的 Bean 定义信息，并将其封装成 BeanMethod 对象。在注册阶段，ConfigurationClassPostProcessor 会根据 BeanMethod 对象创建相应的 BeanDefinition 对象，并注册到 Spring IoC 容器中。

在**装配阶段**，当需要获取一个使用 @Bean 注解定义的 Bean 时，Spring IoC 容器会通过调用相应的 BeanMethod 对象的方法来创建 Bean 的实例。这样，@Bean 注解的配置类中定义的 Bean 就可以被自动创建和装配到其他 Bean 中，实现了依赖注入的功能。

#### 条件化配置的实现 ####

@Configuration 注解支持条件化配置，即根据不同的条件来判断是否加载某个配置类或者创建某个 Bean。这个功能的底层实现主要依赖于 **Condition** 接口和 **ConditionContext**、**AnnotatedTypeMetadata** 两个接口的实现。

**Condition** 接口定义了一个 matches 方法，用于判断是否满足条件。当某个配置类或者 Bean 使用了 @Conditional 注解，并传入了一个实现了 Condition 接口的类时，Spring IoC 容器会在解析阶段调用这个 Condition 类的 matches 方法来判断是否满足条件。如果满足条件，那么这个配置类或者 Bean 就会被加载或者创建，否则就会被忽略。

**ConditionContext 和 AnnotatedTypeMetadata** 接口分别用于在 Condition 接口的 matches 方法中获取当前的上下文信息和注解元数据。ConditionContext 提供了获取 BeanFactory、Environment、ResourceLoader、ClassLoader 等信息的方法，可以用于判断当前环境的状态。AnnotatedTypeMetadata 则提供了获取配置类或者 Bean 的注解信息的方法，可以用于判断注解的属性值是否满足条件。

通过这些接口的实现，@Conditional 注解的配置类或者 Bean 可以根据不同的条件来进行动态加载或者创建，从而实现了条件化配置的功能。

#### 配置类的加载和实例化过程 ####

@Configuration 注解标记的配置类在 Spring IoC 容器中的加载和实例化过程主要包括以下几个步骤：

**加载配置类**：当 Spring IoC 容器启动时，会扫描所有的配置类，并将其加载到容器中。这个过程是通过 ConfigurationClassParser 类来实现的。 ConfigurationClassParser 类负责解析配置类中的注解，包括 @Configuration、@Bean、@ComponentScan 等注解，并生成相应的 BeanDefinition 对象。其中，@ComponentScan 注解用于指定需要扫描的包，从而找到其他的配置类和 Bean 定义。

**解析 Bean 定义和依赖关系**：在加载配置类的过程中，ConfigurationClassParser 会解析配置类中的 @Bean 注解，并生成相应的 BeanDefinition 对象。同时，它还会解析配置类中的其他注解，例如 @Autowired、@Value 等注解，从而生成 Bean 之间的依赖关系。

**注册 Bean 定义**：在解析完 Bean 定义和依赖关系后，ConfigurationClassParser 会将生成的 BeanDefinition 对象注册到 Spring IoC 容器中。这个过程是通过调用 BeanDefinitionRegistry 接口的 registerBeanDefinition 方法来实现的。 实例化 Bean：当需要获取某个 Bean 时，Spring IoC 容器会根据 Bean 的定义信息，实例化 Bean 并将其放入容器中。这个过程是通过调用 BeanFactory 接口的 getBean 方法来实现的。

在**实例化** Bean 的过程中，Spring IoC 容器会先判断 Bean 是否已经存在于容器中。如果存在，则直接返回已经存在的 Bean 实例；如果不存在，则会通过 Bean 的定义信息来创建新的 Bean 实例。

在**创建 Bean 实例**时，Spring IoC 容器会先检查 Bean 的构造函数是否有参数。如果有参数，则会按照参数类型或者参数名来从容器中获取对应的 Bean 实例，并传入构造函数中。如果没有参数，则直接调用无参构造函数来创建 Bean 实例。

**创建 Bean 实例后**，Spring IoC 容器会对 Bean 进行初始化，包括调用 Bean 的初始化方法（例如 @PostConstruct 注解标记的方法）、应用 Bean 的属性值（例如 @Value 注解标记的属性）、处理 Bean 的生命周期回调（例如 InitializingBean 和 DisposableBean 接口的实现）等。

最后，创建完成的 Bean 实例会被放入容器中，并可以通过 Bean 的名称或者类型来进行访问和使用。

### 总结 ###

@Configuration 注解是 Spring 框架中用于标记配置类的重要注解之一。它允许我们通过 Java 类的方式来配置和管理 Bean 实例，从而实现了面向对象的配置方式。

@Configuration 注解的底层原理涉及到了代理对象、循环依赖解决方案、刷新机制、条件化配置等多个方面。通过深入理解 @Configuration 注解的原理，我们可以更好地理解 Spring 框架中的配置方式，并在实际项目中灵活地应用。

在使用 @Configuration 注解时，需要注意一些常见的使用原则，例如避免在配置类中使用 @Autowired 注解、避免循环依赖、合理使用条件化配置等。同时，深入了解 @Configuration 注解的源码实现，对于排查和解决配置相关的问题也是非常有帮助的。

[format_png]: https://img-blog.csdnimg.cn/img_convert/5b883bf8bdd8da936cae6049c8fb11db.webp?x-oss-process=image/format,png