基于属性配置动态创建Spring Boot Bean

本文介绍了如何在spring Boot应用中，根据配置属性的值动态创建Bean。通过使用@ConditionalOnProperty注解，可以灵活地控制Bean的实例化，从而实现基于不同配置启用不同的Bean，避免了不必要的资源消耗和潜在的冲突。本文将提供详细的示例代码，并解释@ConditionalOnProperty注解的使用方法和注意事项。

在spring boot应用开发中，我们经常需要根据不同的配置来决定是否创建某个Bean。例如，在不同的环境下，我们可能需要使用不同的数据源连接池，或者启用不同的消息队列客户端。Spring Boot提供了@ConditionalOnProperty注解，可以方便地根据配置属性的值来控制Bean的创建。

@ConditionalOnProperty注解的使用

@ConditionalOnProperty注解可以标注在@Bean方法上，也可以标注在类上（通常是配置类）。它的作用是，只有当指定的配置属性满足条件时，才会创建对应的Bean。

@ConditionalOnProperty注解有以下几个常用的属性：

• prefix: 配置属性的前缀。例如，如果配置属性是my.property.name，那么prefix可以设置为my.property。
• name: 配置属性的名称。例如，如果配置属性是my.property.name，那么name可以设置为name。
• value: 配置属性的值。只有当配置属性的值与value相等时，才会创建Bean。可以指定多个值，使用数组表示。
• havingValue: 配置属性的值。只有当配置属性的值与havingValue相等时，才会创建Bean。与value不同的是，havingValue可以进行更复杂的匹配，例如使用正则表达式。
• matchIfMissing: 如果配置属性不存在，是否创建Bean。默认为false，即如果配置属性不存在，则不创建Bean。

示例代码

假设我们有两个Bean：CachingConnectionFactory和UserCredentialsConnectionFactoryAdapter。我们希望根据配置属性enable.userconnection的值来决定创建哪个Bean。如果enable.userconnection的值为true，则创建UserCredentialsConnectionFactoryAdapter；如果enable.userconnection的值为false，则创建CachingConnectionFactory。

Bing图像创建器

必应出品基于DALL·E的AI绘图工具

45

查看详情

以下是示例代码：

import org.springframework.boot.autoconfigure.condition.ConditionalOnProperty; import org.springframework.context.annotation.Bean; import org.springframework.context.annotation.Configuration; import org.springframework.jms.connection.CachingConnectionFactory; import org.springframework.jms.connection.UserCredentialsConnectionFactoryAdapter;  import Javax.jms.ConnectionFactory;  @Configuration public class ConnectionFactoryConfig {      @Bean     @ConditionalOnProperty(prefix = "enable", name = "userconnection", havingValue = "false", matchIfMissing = true)     public CachingConnectionFactory connectionFactory() {         CachingConnectionFactory connectionFactory = new CachingConnectionFactory();         // Set properties for CachingConnectionFactory         connectionFactory.setReconnectOnException(true);         connectionFactory.setSessionCacheSize(10);         return connectionFactory;     }      @Bean     @ConditionalOnProperty(prefix = "enable", name = "userconnection", havingValue = "true")     public UserCredentialsConnectionFactoryAdapter userCredentialsConnectionFactoryAdapter(ConnectionFactory targetConnectionFactory) throws Exception {         UserCredentialsConnectionFactoryAdapter connectionFactoryAdapter = new UserCredentialsConnectionFactoryAdapter();         // Set properties for UserCredentialsConnectionFactoryAdapter         connectionFactoryAdapter.setTargetConnectionFactory(targetConnectionFactory);         connectionFactoryAdapter.setUsername("username");         connectionFactoryAdapter.setPassword("password");         return connectionFactoryAdapter;     }      @Bean     public ConnectionFactory messagingJMSService(){         //Simulate getting ConnectionFactory from external service         return new com.sun.messaging.jms.ConnectionFactory();     } }

在这个例子中，我们使用了@ConditionalOnProperty注解来控制CachingConnectionFactory和UserCredentialsConnectionFactoryAdapter的创建。

• 对于CachingConnectionFactory，我们设置了prefix为enable，name为userconnection，havingValue为false，matchIfMissing为true。这意味着，只有当enable.userconnection的值为false或者该属性不存在时，才会创建CachingConnectionFactory。
• 对于UserCredentialsConnectionFactoryAdapter，我们设置了prefix为enable，name为userconnection，havingValue为true。这意味着，只有当enable.userconnection的值为true时，才会创建UserCredentialsConnectionFactoryAdapter。

注意事项

• @ConditionalOnProperty注解只能用于控制Bean的创建，不能用于控制方法的执行。
• 如果配置属性的值是字符串类型，那么value和havingValue属性的值也应该是字符串类型。
• 如果配置属性不存在，并且matchIfMissing为false，那么对应的Bean将不会被创建。
• 确保配置属性在Spring Boot的配置源中可用，例如在application.properties或application.yml文件中。

总结

@ConditionalOnProperty注解是Spring Boot提供的一个强大的工具，可以根据配置属性的值动态创建Bean。通过合理地使用@ConditionalOnProperty注解，我们可以编写更加灵活和可配置的Spring Boot应用。 在上述示例中，如果enable.userconnection属性不存在，CachingConnectionFactory bean会被创建，因为matchIfMissing被设置为true。 如果enable.userconnection属性存在且值为true，那么UserCredentialsConnectionFactoryAdapter bean会被创建。如果该属性存在且值为false，那么CachingConnectionFactory bean会被创建。