【转】@Configuration 注解：深度解析与实战指南

原文地址:@Configuration 注解：深度解析与实战指南深入挖掘 Spring @Configuration 注解，从源 - 掘金

一、前置知识：Spring 中的 Bean

1.1 什么是 Bean？

在 Spring 框架的复杂生态中，Bean 是构成应用程序的核心元素，是被 Spring 容器精心管理的对象实例。Spring 容器依据特定的规则与机制，承担着对象实例化的重任，包括运用合适的构造函数或工厂方法创建对象。在初始化阶段，容器会按照既定的配置与逻辑，对 Bean 进行属性赋值、依赖注入等关键操作，确保其处于可用状态。而在整个生命周期中，容器持续监控并管理 Bean 的状态，在特定的生命周期节点，如初始化完成后、销毁之前等，触发相应的回调方法，使得开发者能够在这些关键时机执行自定义的逻辑，如资源的初始化与释放等。这些 Bean 依据职责不同，广泛涵盖了业务逻辑层的服务类、数据持久化层的存储库类以及与用户交互紧密相关的控制器类等，它们相互协作、各司其职，共同构建起一个完整且健壮的应用程序架构。

1.2 配置类

配置类是 Spring 应用程序配置的核心枢纽，借助 Java 代码的强大表达力，对整个应用程序的运行环境与组件构成进行精确的定义与组织。其中，@Configuration 注解犹如一面鲜明的旗帜，明确无误地标识出该类在 Spring 框架中的特殊地位——配置类。它是 Spring 容器识别和处理配置信息的关键入口，在这个类中，开发者可以灵活运用各种注解与编程技巧，定义和管理 Spring 容器中的海量 Bean 资源，为整个应用程序的正常运转奠定坚实的基础。

例如：

 

java

体验AI代码助手

代码解读

复制代码

@Configuration
public class AppConfig {
    // 在此处开启 Bean 定义与配置的精彩篇章
}

二、@Configuration 注解的基本用法

2.1 声明一个简单的配置类

以下示例将为您展示使用 @Configuration 注解声明配置类的标准范式：

 

java

体验AI代码助手

代码解读

复制代码

@Configuration
public class AppConfig {

    @Bean
    public UserRepository userRepository() {
        return new UserRepository();
    }

    @Bean
    public UserService userService() {
        // 此处通过方法调用，清晰地构建起 userService 对 userRepository 的依赖链路
        return new UserService(userRepository());
    }
}

在上述代码片段中，AppConfig 类被 @Configuration 注解庄重修饰，从而晋升为配置类的一员。通过 @Bean 注解的巧妙运用，成功定义了两个关键 Bean：userRepository 和 userService。特别值得注意的是，在 userService 方法内部，通过直接调用 userRepository 方法来获取 UserRepository 实例，并将其作为参数传递给 UserService 的构造函数，这种方式极为直观地展现了 userService 对 userRepository 的紧密依赖关系。从本质上讲，这种依赖关系的定义不仅仅是简单的代码层面关联，更是 Spring 容器在进行 Bean 实例化与装配时的重要依据。当 Spring 容器启动并解析 AppConfig 类时，它会首先识别出这两个 @Bean 注解方法，并依据方法签名和返回值类型，确定需要创建的 Bean 类型。在创建 userService Bean 时，容器会自动检测到其对 userRepository Bean 的依赖，并确保先成功创建 userRepository Bean，然后将其正确注入到 userService Bean 的构造函数中，从而完美构建起二者之间的依赖关系，使得整个应用程序的组件结构得以稳固搭建。

2.2 使用配置类

在 Spring 应用程序的启动与运行过程中，我们通常借助 AnnotationConfigApplicationContext 或 AnnotationConfigWebApplicationContext 这两个强大的工具类来加载配置类，从而启动 Spring 容器并使其开始管理应用程序中的 Bean 资源。以下是一个典型的示例：

 

java

体验AI代码助手

代码解读

复制代码

public class Application {
    public static void main(String[] args) {
        ApplicationContext context = new AnnotationConfigApplicationContext(AppConfig.class);

        UserService userService = context.getBean(UserService.class);
        userService.getUserById(1L);
    }
}

在这个示例中，我们首先创建了一个 AnnotationConfigApplicationContext 实例，并将 AppConfig 类作为参数传递给它。这一操作等同于向 Spring 容器发出明确指令：“请加载并解析 AppConfig 类，根据其中的配置信息创建和管理相关 Bean。”随后，容器会依据 AppConfig 类中的 @Configuration 和 @Bean 注解信息，有条不紊地创建 UserRepository 和 UserService 等 Bean 实例，并将它们妥善存储在容器内部的 Bean 缓存池中，以便后续随时获取和使用。最后，我们通过调用 context.getBean(UserService.class) 方法，从容器中精准获取 UserService Bean 实例，并调用其 getUserById 方法执行相应的业务逻辑。这一过程充分展示了如何通过配置类与容器的交互，实现 Bean 的创建、管理与使用，是 Spring 应用程序运行的基本流程与核心机制之一。

三、@Configuration 注解的高级用法

3.1 组件扫描

@ComponentScan 注解与 @Configuration 注解的组合堪称 Spring 应用程序开发中的一把利器，它能够极大地简化 Bean 的注册过程，提高开发效率与代码的可维护性。

 

java

体验AI代码助手

代码解读

复制代码

@Configuration
@ComponentScan(basePackages = "com.example")
public class AppConfig {
    // 在此配置类中，除了享受组件扫描带来的便利，还可继续进行其他个性化的 Bean 定义或高级配置操作
}

在上述代码示例中，@ComponentScan 注解扮演着“侦察兵”的角色，其 basePackages 属性指定了一个特定的包路径——“com.example”。当 Spring 容器加载 AppConfig 类时，它会依据 @ComponentScan 注解的指示，对“com.example”包及其所有子包进行深度扫描。在扫描过程中，容器会自动识别所有被 @Component、@Service、@Repository 等特定注解标记的类，并将它们作为候选 Bean 进行注册。例如，如果在“com.example”包下存在一个被 @Service 注解标记的 UserServiceImpl 类，容器会自动创建一个对应的 UserServiceImpl Bean 实例，并将其纳入管理范围。这种自动化的组件扫描与注册机制，避免了开发者手动逐个注册 Bean 的繁琐过程，使得代码结构更加清晰，模块划分更加明确。同时，在 AppConfig 类中，开发者仍然可以继续定义其他个性化的 Bean，这些手动定义的 Bean 与通过组件扫描注册的 Bean 可以和谐共存，共同构建起一个完整的应用程序 Bean 体系。

3.2 导入其他配置类

@Import 注解为 Spring 应用程序的配置提供了强大的模块化与组合能力，使得开发者能够轻松地将多个独立开发的配置类整合在一起，形成一个功能完备、结构清晰的整体配置方案。

 

java

体验AI代码助手

代码解读

复制代码

@Configuration
@Import(DatabaseConfig.class)
public class AppConfig {
    // 在此处，既可以定义与 AppConfig 自身核心业务逻辑紧密相关的 Bean，又能够无缝集成 DatabaseConfig 中的数据库相关 Bean，实现了配置的高度复用与灵活组合
}

@Configuration
public class DatabaseConfig {

    @Bean
    public DataSource dataSource() {
        return new DriverManagerDataSource();
    }
}

在这个示例中，AppConfig 类通过 @Import 注解巧妙地引入了 DatabaseConfig 配置类。当 Spring 容器加载 AppConfig 类时，它会发现 @Import 注解，并自动加载 DatabaseConfig 类。这意味着，在处理 AppConfig 类的过程中，容器不仅会创建 AppConfig 中定义的 Bean，还会同时创建 DatabaseConfig 中定义的 DataSource Bean。这种机制使得不同功能模块的配置可以在独立开发和维护的基础上，方便地进行整合与复用。例如，在一个大型企业级应用中，可能存在多个不同的模块，每个模块都有自己独立的配置类，如用户管理模块的 UserConfig、订单管理模块的 OrderConfig 等。通过 @Import 注解，我们可以在一个核心的 ApplicationConfig 类中灵活地导入这些模块配置类，从而构建起一个完整的应用程序配置体系，既保证了各个模块的独立性和可维护性，又实现了整个应用程序配置的统一性和完整性。

3.3 条件配置

@Conditional 注解为 Spring 应用程序的配置带来了前所未有的灵活性与动态性，它允许开发者根据特定的条件来精准决定配置类或单个 Bean 是否被加载和注册，从而使应用程序能够在不同的运行环境和配置需求下自适应地调整自身行为。

 

java

体验AI代码助手

代码解读

复制代码

@Configuration
@Conditional(CustomCondition.class)
public class AppConfig {
    // 这里的 Bean 定义以及整个 AppConfig 类的加载与否，完全取决于 CustomCondition 类中定义的条件判断逻辑，只有当条件满足时，才会被 Spring 容器纳入管理范围并进行后续处理
}

public class CustomCondition implements Condition {
    @Override
    public boolean matches(ConditionContext context, AnnotatedTypeMetadata metadata) {
        // 在此处，开发者可以根据丰富的上下文信息，如环境变量、系统属性、容器中的其他 Bean 状态等，编写复杂而灵活的条件判断逻辑，以决定是否加载配置类或 Bean
        return true;
    }
}

在上述示例中，AppConfig 类被 @Conditional 注解紧紧绑定，其加载与否取决于 CustomCondition 类中 matches 方法的返回值。当 Spring 容器在加载过程中遇到 AppConfig 类时，它会首先实例化 CustomCondition 类，并调用其 matches 方法。在 matches 方法中，开发者可以通过 ConditionContext 参数获取丰富的上下文信息，例如当前的运行环境变量、系统属性、容器中已经存在的其他 Bean 实例及其状态等。基于这些信息，开发者可以编写任意复杂的条件判断逻辑，如判断当前环境是否为生产环境、某个特定的系统属性是否被设置为特定值、容器中是否已经存在某个关键 Bean 等。只有当 matches 方法返回 true 时，AppConfig 类及其内部定义的所有 Bean 才会被容器视为有效并进行加载和注册；否则，整个 AppConfig 类将被容器忽略，就好像它从未存在于配置中一样。这种条件配置机制在实际应用中具有极其广泛的用途，例如在开发过程中，我们可以根据不同的开发环境（开发环境、测试环境、生产环境）来加载不同的配置类，从而实现不同环境下的数据库连接配置、日志级别设置、功能模块启用或禁用等差异化配置；在分布式系统中，我们可以根据当前节点的角色（如主节点、从节点）来加载特定的配置，以确保每个节点只运行其所需的功能模块和配置，提高系统的整体性能和稳定性。

3.4 配置类中的 Bean 依赖

在配置类中，通过方法调用来定义 Bean 之间的依赖关系是一种既直观又高效的方式，它充分体现了 Spring 容器在 Bean 管理过程中的自动化与智能化特性。

 

java

体验AI代码助手

代码解读

复制代码

@Configuration
public class AppConfig {

    @Bean
    public UserRepository userRepository() {
        return new UserRepository();
    }

    @Bean
    public UserService userService() {
        return new UserService(userRepository());
    }
}

在这个经典示例中，userService 方法对 userRepository 方法的调用不仅仅是简单的代码逻辑关联，更是一种深度的依赖关系定义。从 Spring 容器的角度来看，当它解析 AppConfig 类并着手创建 Bean 实例时，会首先识别出 userRepository 和 userService 这两个 @Bean 注解方法。在创建 userService Bean 之前，容器会智能地检测到 userService 方法内部对 userRepository 方法的调用，从而意识到 userService 对 userRepository 存在依赖关系。基于此，容器会优先创建 userRepository Bean，并将其妥善保存。然后，当创建 userService Bean 时，容器会自动将之前创建好的 userRepository Bean 作为参数传递给 userService 的构造函数，从而完美地完成依赖注入过程。这种自动化的依赖关系处理机制极大地简化了开发者的工作，使得我们无需手动管理复杂的 Bean 依赖关系，只需专注于业务逻辑的实现即可。同时，这种机制也确保了 Bean 之间的依赖关系得到正确、高效的处理，避免了因人为错误导致的依赖混乱或错误注入等问题，提高了应用程序的稳定性和可靠性。

四、实际应用场景

4.1 配置数据源

在 Spring Boot 项目中，使用 @Configuration 注解来配置数据源是一种极为常见且关键的应用场景，它直接关系到应用程序与数据库之间的稳定连接与高效数据交互。

 

java

体验AI代码助手

代码解读

复制代码

@Configuration
public class DataSourceConfig {

    @Bean
    public DataSource dataSource() {
        DriverManagerDataSource dataSource = new DriverManagerDataSource();
        dataSource.setDriverClassName("com.mysql.cj.jdbc.Driver");
        dataSource.setUrl("jdbc:mysql://localhost:3306/mydb");
        dataSource.setUsername("root");
        dataSource.setPassword("password");
        return dataSource;
    }
}

在这个示例中，DataSourceConfig 类被 @Configuration 注解庄重标记，表明它是一个专门用于配置数据源的核心配置类。在 dataSource 方法中，我们手动创建了一个 DriverManagerDataSource 实例，并通过一系列的属性设置方法，明确指定了连接 MySQL 数据库所需的关键信息，包括驱动类名、数据库连接 URL、用户名和密码等。当 Spring 容器加载 DataSourceConfig 类时，它会识别出 dataSource 方法上的 @Bean 注解，并调用该方法创建一个 DataSource Bean 实例。这个 DataSource Bean 随后将被容器妥善管理，并可供整个应用程序中的其他组件（如数据访问层的 Repository 类）使用，以实现与数据库的连接和数据操作。在实际项目中，这种数据源配置方式具有高度的灵活性和可扩展性。例如，我们可以根据不同的环境（开发环境、测试环境、生产环境）从配置文件或环境变量中动态读取数据库连接信息，并在 dataSource 方法中根据这些信息进行动态配置，从而实现不同环境下数据库连接的自动切换；我们还可以通过集成各种数据库连接池框架（如 HikariCP、Druid 等）来优化数据源的性能，只需在 dataSource 方法中创建相应的连接池数据源实例并进行配置即可，而无需对应用程序的其他部分进行大规模修改。

4.2 配置 Web 安全

在 Spring Security 项目中，@Configuration 注解与 @EnableWebSecurity 注解紧密配合，构成了配置 Web 安全的核心机制，为应用程序的网络安全防护提供了坚实的保障。

 

java

体验AI代码助手

代码解读

复制代码

@Configuration
@EnableWebSecurity
public class SecurityConfig extends WebSecurityConfigurerAdapter {

    @Override
    protected void configure(HttpSecurity http) throws Exception {
        http
          .authorizeRequests()
              .antMatchers("/public/**").permitAll()
              .anyRequest().authenticated()
          .and()
          .formLogin()
              .loginPage("/login")
              .permitAll()
          .and()
          .logout()
              .permitAll();
    }
}

在上述代码中，SecurityConfig 类通过 @Configuration 注解被明确标识为一个配置类，同时，@EnableWebSecurity 注解的存在则激活了 Spring Security 的一系列安全功能，并指示 Spring 容器将 SecurityConfig 类作为核心安全配置类进行处理。在 configure 方法中，我们通过 HttpSecurity 对象对 Web 安全的各个方面进行了详细而精确的配置。首先，通过 authorizeRequests 方法定义了不同 URL 路径的访问权限规则。在这个示例中，我们指定了“/public/**”路径下的请求允许所有用户无需认证即可访问，而其他任何请求都需要进行身份认证。这种灵活的访问权限配置机制使得我们能够根据应用程序的业务需求，精细地划分不同页面或接口的访问级别，保护敏感信息和功能不被未授权用户访问。接着，我们通过 formLogin 方法配置了基于表单的登录页面路径为“/login”，并允许所有用户访问该登录页面，这为用户提供了一个统一的登录入口，方便用户进行身份认证。最后，通过 logout 方法配置了注销功能，同样允许所有用户访问，确保用户在完成操作后能够安全地退出系统。这种基于 @Configuration 注解的 Web 安全配置方式不仅功能强大，而且具有极高的可定制性。例如，我们可以根据不同的用户角色（如管理员、普通用户、游客）进一步细化访问权限规则，为不同角色的用户提供不同的功能和数据访问权限；我们还可以集成各种身份认证方式（如基于数据库的用户名密码认证、基于 OAuth 的第三方认证等），只需在 configure 方法中添加相应的认证配置代码即可，从而满足不同应用场景下的多样化安全需求。

五、总结

@Configuration 注解在 Spring 框架中占据着绝对核心的地位，它是构建高效、灵活、安全的 Spring 应用程序的基石与关键枢纽。通过精准地标记配置类，它为开发者打开了一扇通往精确控制 Bean 创建与管理流程的大门。借助组件扫描、导入其他配置类、条件配置等一系列强大而丰富的特性，开发者能够根据项目的复杂需求、不同的运行环境以及多样化的业务逻辑，灵活自如地构建和配置 Spring 应用程序，如同一位技艺精湛的建筑师，使用各种先进的工具与材料，精心雕琢出一座宏伟而稳固的建筑。在实际项目的各个关键环节与核心领域，如数据源配置确保数据的稳定传输与高效存储，Web 安全配置构筑起坚固

作者：灵犀架构
链接：https://juejin.cn/post/7443096113692983306
来源：稀土掘金
著作权归作者所有。商业转载请联系作者获得授权，非商业转载请注明出处。