Spring Java 配置中 @Bean 方法可见性深度解析

1. @Bean 方法的本质

在spring框架中，@bean 注解用于标记一个方法，该方法将实例化、配置并初始化一个由spring ioc容器管理的新bean。这些方法通常被称为“工厂方法”，它们返回的对象会被注册为spring容器中的一个bean。

考虑以下基本的Spring Java配置结构：

@Configuration
class AppConfig {

  @Bean
  public MyComponent myComponent() {
    return new MyComponent();
  }

  // 其他 @Bean 注解方法
}

这里，myComponent() 方法的可见性修饰符是 public。那么，如果将其改为 protected、包私有或 private，会有什么影响呢？

2. @Bean 方法的可见性修饰符与 @Configuration 模式

Spring的@Configuration类有两种处理模式：“全模式”和“精简模式”，这两种模式下@Bean方法的可见性影响有所不同。

2.1 全模式 @Configuration (Full @Configuration)

当一个类被 @Configuration 注解时，Spring会对其进行CGLIB代理。这意味着Spring容器在运行时会创建一个该配置类的子类，并拦截所有对 @Bean 方法的调用。这种代理机制的目的是确保：

立即学习“Java免费学习笔记（深入）”；

1. 单例语义：即使在同一个配置类中多次调用同一个 @Bean 方法，Spring也会确保返回的是同一个单例Bean实例。
2. 内部Bean依赖：当一个 @Bean 方法依赖于另一个由同一配置类定义的 @Bean 时，Spring会通过代理确保注入的是容器中已存在的Bean实例，而不是每次都创建一个新实例。

可见性影响：

• public、protected 或 包私有 (default)：这些可见性修饰符允许CGLIB代理正常工作。CGLIB能够创建子类并覆盖这些方法，从而实现拦截和管理。这是推荐的实践，并且能够保证单例语义和正确的依赖注入。

  @Configuration
  class FullConfigExample {
  
    @Bean
    public ServiceA serviceA() {
      System.out.println("Creating ServiceA");
      return new ServiceA();
    }
  
    @Bean
    protected ServiceB serviceB() { // protected 也可以
      System.out.println("Creating ServiceB, depends on ServiceA");
      return new ServiceB(serviceA()); // 这里的 serviceA() 调用会被代理拦截，返回单例ServiceA
    }
  
    // 包私有 (default) 也可以
    @Bean
    DataSource dataSource() {
      System.out.println("Creating DataSource");
      return new DataSource();
    }
  }

  登录后复制

• private：private 方法无法被CGLIB代理的子类覆盖。如果一个 @Configuration 类中的 @Bean 方法是 private，Spring将无法对其进行拦截和管理。这意味着：

  

  百度AI开放平台

  百度提供的综合性AI技术服务平台，汇集了多种AI能力和解决方案

  42

  查看详情
  • 单例破坏：如果同一个 private @Bean 方法在配置类内部被多次调用（例如，被其他 @Bean 方法依赖），每次调用都会创建一个新的实例，而不是从容器中获取单例，从而破坏了单例语义。
  • 依赖注入问题：当一个 private @Bean 方法内部调用另一个 private @Bean 方法时，它将直接调用原始方法，而不是通过Spring容器获取已管理的Bean。

  @Configuration
  class PrivateBeanConfigExample {
  
    @Bean
    private ServiceA privateServiceA() { // 这是个问题！
      System.out.println("Creating private ServiceA");
      return new ServiceA();
    }
  
    @Bean
    public ServiceB publicServiceB() {
      System.out.println("Creating public ServiceB, depends on private ServiceA");
      // 这里的 privateServiceA() 调用将直接执行方法，而不是获取Spring管理的单例
      return new ServiceB(privateServiceA());
    }
  }
  
  // 假设 ServiceA 和 ServiceB 是简单的类
  class ServiceA {}
  class ServiceB {
      ServiceA serviceA;
      public ServiceB(ServiceA serviceA) { this.serviceA = serviceA; }
  }

  登录后复制

  在上述例子中，如果 publicServiceB 依赖 privateServiceA，那么每次请求 publicServiceB 时，privateServiceA 都会被重新创建，而不是使用Spring容器中的单例。这通常不是我们期望的行为。

2.2 精简模式 @Configuration (Lite @Configuration)

当一个类包含 @Bean 方法，但其本身没有被 @Configuration 注解（例如，它被 @Component、@Service、@Repository 注解，或者根本没有Spring注解），则Spring会将其视为“精简模式”配置。在这种模式下，Spring不会对该类进行CGLIB代理。@Bean 方法的行为更像普通的工厂方法。

可见性影响：

• public、protected、包私有 (default) 或 private：在精简模式下，CGLIB代理不发生。Spring容器会直接调用 @Bean 方法来获取Bean实例。因此，可见性修饰符主要受限于Java语言的访问规则：

  • public、protected、包私有方法可以被Spring容器（通常位于不同的包）访问并调用。
  • private 方法无法被Spring容器直接访问和调用，因此@Bean注解在private方法上通常是无效的，Spring无法发现和处理它。如果一个类是精简模式，并且它的@Bean方法是private，Spring在启动时会抛出异常或无法找到该Bean。

  @Component // 或没有任何Spring注解的普通类
  class LiteConfigExample {
  
    @Bean
    public ServiceA serviceA() { // public 正常
      System.out.println("Creating ServiceA in Lite mode");
      return new ServiceA();
    }
  
    @Bean
    protected ServiceB serviceB() { // protected 正常
      System.out.println("Creating ServiceB in Lite mode");
      return new ServiceB();
    }
  
    // @Bean
    // private ServiceC serviceC() { // private 在 Lite 模式下无法被Spring访问和发现
    //   System.out.println("Creating private ServiceC in Lite mode");
    //   return new ServiceC();
    // }
  }

  登录后复制

  在精简模式下，如果一个 @Bean 方法内部调用了另一个 @Bean 方法，Spring不会进行拦截。每次内部调用都会创建一个新的实例。因此，精简模式通常不适用于那些内部存在复杂Bean依赖关系的配置类。

3. 可见性修饰符的影响总结

4. 最佳实践与建议

1. 始终使用 public 可见性修饰符：对于 @Configuration 类中的所有 @Bean 方法，强烈建议使用 public。这能够确保CGLIB代理机制正常工作，从而保证单例Bean的正确性以及内部Bean依赖的正确解析。它也使得代码更具可读性和一致性。
2. 避免 private @Bean 方法：无论是在全模式还是精简模式下，private @Bean 方法都应避免。在全模式下，它会破坏Spring的核心管理能力；在精简模式下，它根本无法被Spring发现和使用。
3. 理解 @Configuration 的两种模式：清楚你的配置类是在全模式还是精简模式下运行，这将帮助你理解 @Bean 方法的实际行为。通常情况下，如果你希望配置类像一个真正的Spring配置源，并利用其所有高级特性，那么就使用 @Configuration 并保持 @Bean 方法为 public。

5. 结论

在Spring的纯Java配置中，@Bean 方法的可见性并非随意选择。它与Spring容器如何管理Bean、特别是与 @Configuration 类中的CGLIB代理机制紧密相关。为了确保Spring应用程序的健壮性、可预测性和正确性，始终将 @Configuration 类中的 @Bean 方法声明为 public 是最佳实践。这不仅符合Spring框架的设计哲学，也能避免潜在的运行时问题，简化调试过程，并提高代码的可维护性。

以上就是Spring Java 配置中 @Bean 方法可见性深度解析的详细内容，更多请关注php中文网其它相关文章！