厌倦了重复的 Spring Bean 注册？你并不孤单！

是否曾因 Spring Boot 中重复的 bean 定义而陷入困境？你并不孤单！管理具有不同配置的同一类的多个 bean 可能会变得乏味且混乱。假设您需要这样的东西：

@Bean
MyService beanA() {
    // Set Configuration for bean A
    Configuration a = new...
    a.setUrl(.....)
    return new MyService(a);
}

@Bean
MyService beanB() {
    // Set Configuration for bean A
    Configuration b = new...
    b.setUrl(.....)
    return new MyService(b);
}

这段代码并不复杂，但它很快就会变得重复，特别是在处理多个相同类型的 bean 时。理想情况下，您可以通过不同的设置注册多个实例，而无需冗余代码。

这与为接口的每个实现拥有唯一的 bean 不同。相反，我们正在讨论建立一个具有变化的类。例如，考虑一个连接到多个数据库（例如客户、报告和备份）的应用程序。每个连接都需要自己的配置，这使得管理变得混乱而具有挑战性。你最终可能会写出这样的东西：

@Bean
DatabaseService primaryDatabaseService() {
    return new DatabaseService("db-url-primary");
}

@Bean
DatabaseService reportDatabaseService() {
    return new DatabaseService("db-url-report");
}

拥有更简单的解决方案可以显着简化您的配置，让您更加关注应用程序逻辑。输入 MultiBeanConfig — 我构建的一个小型库，用于帮助管理同一个 Spring bean 的多个配置。

介绍 MultiBeanConfig

MultiBeanConfig 通过单独的配置简化了 Bean 的多个实例的设置。有了它，您可以：

• 减少重复代码
• 集中配置管理
• 保持代码库整洁有序

核心特点

• 多 Bean 设置：定义单个类的多个实例。
• 自定义配置：通过应用程序属性控制每个实例的设置。
• 默认值：如果缺少特定配置，自动应用默认值。
• 自动注入：轻松使用@Autowired进行依赖注入。

分步指南

1. 将 MultiBeanConfig 添加到您的项目中

在 pom.xml 中包含依赖项：

io.github.olufemithompsonmultibeanconfig0.0.3

2. 设置Bean类

使用 @MultiBean 标记您的类，使其符合多个实例的条件：

@MultiBean
public class DatabaseService {
    // Your service logic
}

3. 在配置文件中定义 Bean

在属性或 YAML 文件中定义唯一版本：

multibean:
  primary-database-service:
    class: DatabaseService
  report-database-service:
    class: DatabaseService

这会使用默认配置注册primaryDatabaseService 和reportDatabaseService bean。 MultiBeanConfig 自动将名称从短横线命名法转换为驼峰命名法。

自定义每个 Bean 的配置

要分配单独的设置，请将属性直接添加到每个 bean 的配置中。这是每个实例连接到不同数据库的示例：

@MultiBean
public class DatabaseService {
   @Value("${database-config.connection-url}")
   private String connectionUrl;
}

配置application.yml中的每个实例：

database-config:
  connection-url: 'jdbc:h2:default-url'

multibean:
  primary-database-service:
    class: DatabaseService
    database-config:
      connection-url: 'jdbc:mysql:primary-db-url'
  report-database-service:
    class: DatabaseService
    database-config:
      connection-url: 'jdbc:postgresql:report-db-url'

此设置为每个 bean 提供了唯一的连接 URL。共享设置也可以在常规部分中定义，从而使配置高效并减少冗余。

注入配置的替代方法

您不必仅依赖 @Value 来注入配置。 Spring的@ConfigurationProperties允许将属性封装在配置类中：

@ConfigurationProperties("database-config")
@Configuration
public class DatabaseConfig {
    private String connectionUrl;
    private int connectionTimeout;
    // Getters and Setters
}

然后，直接注入DatabaseConfig：

@MultiBean
public class DatabaseService {
   private final DatabaseConfig databaseConfig;
   public DatabaseService(DatabaseConfig databaseConfig) {
       this.databaseConfig = databaseConfig;
   }
}

使用配置的 Bean

使用 MultiBeanConfig ，像使用任何 Spring 依赖项一样注入您独特配置的 bean：

@Service
public class ApplicationService {
   private final DatabaseService primaryDatabaseService;
   private final DatabaseService reportDatabaseService;

   public ApplicationService(DatabaseService primaryDatabaseService, DatabaseService reportDatabaseService) {
       this.primaryDatabaseService = primaryDatabaseService;
       this.reportDatabaseService = reportDatabaseService;
   }
}

最后的想法

MultiBeanConfig 简化了 Spring Boot 应用程序中的 bean 管理，特别是在处理功能标志、数据源或不同的 API 连接时。它减少了冗余，保持代码整洁，并增强了可维护性。尝试一下，让我知道它如何适用于您的项目！