本文旨在深入探讨 Spring Boot 中如何使用 @ConditionalOnProperty 注解实现 Bean 的条件化加载。我们将通过一个实际示例，详细讲解如何配置和使用该注解，以实现根据配置属性动态地加载不同的 Bean。通过本文的学习，你将掌握根据不同环境或配置选择性加载 Bean 的方法，从而提高 Spring Boot 应用的灵活性和可维护性。
使用 @ConditionalOnProperty 实现 Bean 的条件化加载
在 Spring Boot 应用中，我们经常需要根据不同的配置来加载不同的 Bean。例如，在开发环境和生产环境中使用不同的数据源，或者根据用户的配置启用或禁用某些功能。Spring Boot 提供了 @ConditionalOnProperty 注解，可以方便地实现 Bean 的条件化加载。
@ConditionalOnProperty 注解允许我们根据指定的属性值来决定是否创建 Bean。该注解包含以下几个重要的属性：
- prefix: 属性的前缀，用于指定配置属性的命名空间。
- name: 属性的名称，用于指定需要检查的配置属性。
- havingValue: 属性的值，只有当配置属性的值与 havingValue 相同时，才会创建 Bean。
- matchIfMissing: 如果配置属性不存在，是否匹配。默认为 false，表示不匹配。
示例：根据配置选择加载不同的 Component
假设我们有一个应用，需要根据配置选择加载 ComponentAConfig 或 ComponentBConfig。首先，我们定义一个通用的 ComponentConfigPart 类，用于表示组件的配置部分：
@Data
@NoArgsConstructor
public class ComponentConfigPart {
private String ex1;
private String ex2;
private String ex3;
}然后，我们定义一个抽象的 ComponentConfig 类，作为 ComponentAConfig 和 ComponentBConfig 的基类：
@Data
public abstract class ComponentConfig {
private List parts = new ArrayList<>();
@PostConstruct
public void init() {
System.out.println("Created instance of " + this.getClass().getSimpleName());
System.out.println("Created " + this);
}
} 接下来，我们定义 ComponentAConfig 和 ComponentBConfig 类，并使用 @ConditionalOnProperty 注解来指定加载条件：
@Component
@ConfigurationProperties(prefix = "application.components.a")
@ConditionalOnProperty(prefix = "application", name = "use", havingValue = "componentA")
@ToString(callSuper = true)
public class ComponentAConfig extends ComponentConfig {
}@Component
@ConfigurationProperties(prefix = "application.components.b")
@ConditionalOnProperty(prefix = "application", name = "use", havingValue = "componentB")
@ToString(callSuper = true)
public class ComponentBConfig extends ComponentConfig {
}在上面的代码中，ComponentAConfig 只有当 application.use 属性的值为 componentA 时才会被加载，而 ComponentBConfig 只有当 application.use 属性的值为 componentB 时才会被加载。
最后，我们定义一个 MainConfig 类，用于注入选择的 Component：
@Configuration
public class MainConfig {
@Autowired
private ComponentConfig config;
@PostConstruct
public void init() {
System.out.println("MainConfig has autowired class of " + config.getClass().getSimpleName());
}
}配置属性
为了让示例正常工作，我们需要在 application.properties 或 application.yml 文件中配置相应的属性。以下是一个 application.yml 文件的示例：
application:
components:
a:
parts:
- ex1: a
ex2: aa
ex3: aaa
- ex1: a2
ex2: aa2
ex3: aaa2
b:
parts:
- ex1: b
ex2: bb
ex3: bbb
- ex1: b2
ex2: bb2
ex3: bbb2
use: componentA在这个配置中，application.use 属性的值为 componentA，因此只有 ComponentAConfig 会被加载。
运行结果
当 application.use 属性的值为 componentA 时，控制台会输出以下信息：
Created instance of ComponentAConfig Created ComponentAConfig(super=ComponentConfig(parts=[ComponentConfigPart(ex1=a, ex2=aa, ex3=aaa), ComponentConfigPart(ex1=a2, ex2=aa2, ex3=aaa2)])) MainConfig has autowired class of ComponentAConfig
当 application.use 属性的值为 componentB 时，控制台会输出以下信息：
Created instance of ComponentBConfig Created ComponentBConfig(super=ComponentConfig(parts=[ComponentConfigPart(ex1=b, ex2=bb, ex3=bbb), ComponentConfigPart(ex1=b2, ex2=bb2, ex3=bbb2)])) MainConfig has autowired class of ComponentBConfig
注意事项
- @ConditionalOnProperty 注解只能用于配置类或组件类上。
- @ConditionalOnProperty 注解可以与其他条件化注解（如 @ConditionalOnClass、@ConditionalOnBean 等）一起使用，以实现更复杂的条件化加载逻辑。
- 确保配置属性的名称和值与 @ConditionalOnProperty 注解中的配置一致。
总结
通过本文的学习，我们了解了如何使用 @ConditionalOnProperty 注解实现 Spring Boot 中 Bean 的条件化加载。@ConditionalOnProperty 注解提供了一种简单而强大的方式，可以根据配置属性动态地加载不同的 Bean，从而提高 Spring Boot 应用的灵活性和可维护性。在实际开发中，我们可以根据具体的需求，灵活地使用 @ConditionalOnProperty 注解，以实现各种复杂的条件化加载场景。
