Spring Boot @Conditional 注解：让你的代码“随机应变”
各位看官，欢迎来到 “条件注解” 的奇妙世界！在 Spring Boot 的浩瀚星空中，@Conditional 注解就像一位身怀绝技的魔法师，它能让你的 Bean “随机应变”，根据不同的条件选择是否加入“豪华午餐”（Spring 容器）。
如果你觉得 if-else 语句已经让你头昏脑胀，@Conditional 注解绝对能让你眼前一亮，因为它能将复杂的条件判断从业务逻辑中解耦出来，让你的代码更优雅、更易维护。
1. @Conditional 的基础：你得先知道它是啥
@Conditional 注解是 Spring Framework 提供的一个核心注解，它的作用是控制 Bean 的注册。简单来说，它允许你定义一个或多个条件，只有当所有条件都满足时，被注解的 Bean 才会注册到 Spring 容器中。
想想看，这就像一个俱乐部，只有满足特定条件的人才能成为会员。
@Conditional 注解的使用方式很简单，你只需要将它放在类或者方法上，并指定一个或多个 Condition 实现类即可。
@Configuration
public class MyConfiguration {
@Bean
@Conditional(MyCondition.class)
public MyBean myBean() {
return new MyBean();
}
}在这个例子中，MyBean 只有在 MyCondition 的 matches() 方法返回 true 时才会被创建。
2. Condition 接口：条件判断的灵魂
Condition 接口是 @Conditional 注解的灵魂所在。它只有一个方法 matches(ConditionContext context, AnnotatedTypeMetadata metadata)，这个方法负责执行具体的条件判断逻辑。
ConditionContext context: 提供对当前环境的访问，比如可以获取 BeanFactory、Environment 等。AnnotatedTypeMetadata metadata: 提供对被注解的类或方法的元数据访问，比如可以获取注解的属性值。
下面是一个简单的 Condition 实现类的例子：
public class MyCondition implements Condition {
@Override
public boolean matches(ConditionContext context, AnnotatedTypeMetadata metadata) {
// 在这里编写你的条件判断逻辑
return true; // 暂时先返回 true，表示条件满足
}
}3. Spring Boot 提供的预置条件：拿来主义真香
Spring Boot 为了方便开发者，已经提供了一些常用的 Condition 实现类，你可以直接拿来使用，不用自己费力编写。
@ConditionalOnBean: 当容器中存在指定 Bean 时才注册。@ConditionalOnMissingBean: 当容器中不存在指定 Bean 时才注册。@ConditionalOnClass: 当 classpath 中存在指定类时才注册。@ConditionalOnMissingClass: 当 classpath 中不存在指定类时才注册。@ConditionalOnProperty: 当指定的属性值满足条件时才注册。@ConditionalOnResource: 当存在指定的资源文件时才注册。@ConditionalOnWebApplication: 当是 Web 应用时才注册。@ConditionalOnNotWebApplication: 当不是 Web 应用时才注册。
这些预置条件就像工具箱里的各种扳手和螺丝刀，能帮你轻松解决各种问题。
4. @ConditionalOnProperty: 根据配置文件的值来决定
@ConditionalOnProperty 注解是 Spring Boot 中最常用的条件注解之一。它可以根据配置文件中的属性值来决定是否注册 Bean。
@Configuration
public class MyConfiguration {
@Bean
@ConditionalOnProperty(name = "my.feature.enabled", havingValue = "true")
public MyBean myBean() {
return new MyBean();
}
}在这个例子中，只有当 application.properties 或者 application.yml 文件中存在 my.feature.enabled=true 这个配置时，MyBean 才会注册到 Spring 容器中。
# application.properties
my.feature.enabled=true@ConditionalOnProperty 注解还支持一些更高级的用法：
matchIfMissing: 当属性不存在时是否匹配，默认为false。prefix: 属性名前缀，可以简化配置。
例如：
@Configuration
@ConditionalOnProperty(prefix = "my.feature", name = "enabled", havingValue = "true", matchIfMissing = false)
public class MyConfiguration {
@Bean
public MyBean myBean() {
return new MyBean();
}
}如果 my.feature.enabled 属性不存在，或者它的值不是 true，MyBean 就不会被注册。
5. @ConditionalOnBean 和 @ConditionalOnMissingBean: 依赖关系的管理大师
@ConditionalOnBean 和 @ConditionalOnMissingBean 注解可以用来管理 Bean 之间的依赖关系。
@ConditionalOnBean 确保在容器中存在指定 Bean 时才注册当前 Bean。
@Configuration
public class MyConfiguration {
@Bean
@ConditionalOnBean(name = "anotherBean")
public MyBean myBean() {
return new MyBean();
}
@Bean
public AnotherBean anotherBean() {
return new AnotherBean();
}
}在这个例子中，MyBean 只有在容器中存在名为 anotherBean 的 Bean 时才会被创建。
@ConditionalOnMissingBean 则相反，它确保在容器中不存在指定 Bean 时才注册当前 Bean。这在自动配置场景中非常有用，可以避免覆盖用户自定义的 Bean。
@Configuration
public class MyAutoConfiguration {
@Bean
@ConditionalOnMissingBean(name = "myCustomBean")
public MyDefaultBean myDefaultBean() {
return new MyDefaultBean();
}
}如果用户定义了一个名为 myCustomBean 的 Bean，那么 MyDefaultBean 就不会被创建。
6. @ConditionalOnClass 和 @ConditionalOnMissingClass: 类路径的守卫者
@ConditionalOnClass 和 @ConditionalOnMissingClass 注解可以根据 classpath 中是否存在指定的类来决定是否注册 Bean。这在集成第三方库时非常有用。
@ConditionalOnClass 确保 classpath 中存在指定类时才注册当前 Bean。
@Configuration
public class MyConfiguration {
@Bean
@ConditionalOnClass(name = "com.example.MyThirdPartyClass")
public MyBean myBean() {
return new MyBean();
}
}在这个例子中，只有当 classpath 中存在 com.example.MyThirdPartyClass 类时，MyBean 才会注册。
@ConditionalOnMissingClass 则相反，它确保 classpath 中不存在指定类时才注册当前 Bean。
@Configuration
public class MyConfiguration {
@Bean
@ConditionalOnMissingClass(name = "com.example.MyThirdPartyClass")
public MyBean myBean() {
return new MyBean();
}
}在这个例子中，只有当 classpath 中不存在 com.example.MyThirdPartyClass 类时，MyBean 才会注册。
7. 自定义 Condition: 打造你的专属条件
虽然 Spring Boot 提供了很多预置的 Condition 实现类，但在某些情况下，你可能需要自定义 Condition 来满足特定的需求。
例如，你想根据操作系统的类型来决定是否注册 Bean。你可以创建一个自定义的 Condition 实现类：
public class OnWindowsCondition implements Condition {
@Override
public boolean matches(ConditionContext context, AnnotatedTypeMetadata metadata) {
String osName = System.getProperty("os.name").toLowerCase();
return osName.contains("windows");
}
}然后，你就可以使用 @Conditional 注解来应用这个条件：
@Configuration
public class MyConfiguration {
@Bean
@Conditional(OnWindowsCondition.class)
public MyBean myBean() {
return new MyBean();
}
}只有当操作系统是 Windows 时，MyBean 才会注册。
8. @Conditional 的高级用法：组合条件，玩转逻辑
你可以通过组合多个 Condition 来实现更复杂的条件判断逻辑。Spring 提供了 AllNestedConditions、AnyNestedCondition 和 NoneNestedConditions 这三个抽象类，可以用来组合多个条件。
AllNestedConditions: 所有条件都必须满足。AnyNestedCondition: 只要有一个条件满足即可。NoneNestedConditions: 所有条件都不能满足。
例如，你想创建一个 Bean，只有当 my.feature.enabled 属性为 true 并且操作系统是 Windows 时才注册。你可以使用 AllNestedConditions：
public class MyComplexCondition extends AllNestedConditions {
public MyComplexCondition(ConfigurationPhase configurationPhase) {
super(configurationPhase);
}
@ConditionalOnProperty(name = "my.feature.enabled", havingValue = "true")
static class EnabledPropertyCondition {
}
@Conditional(OnWindowsCondition.class)
static class WindowsCondition {
}
}
@Configuration
public class MyConfiguration {
@Bean
@Conditional(MyComplexCondition.class)
public MyBean myBean() {
return new MyBean();
}
}ConfigurationPhase 参数指定了条件判断的时机，可以是 REGISTER_BEAN (注册 Bean 之前) 或者 PARSE_CONFIGURATION (解析配置类之前)。
9. @Conditional 的最佳实践：让你的代码更清晰
- 避免过度使用： 不要滥用
@Conditional，只在真正需要根据条件注册 Bean 时才使用。 - 保持
Condition实现类的简洁：Condition实现类应该只包含条件判断逻辑，不要包含其他的业务逻辑。 - 编写清晰的注释： 在
@Conditional注解和Condition实现类上编写清晰的注释，解释清楚条件判断的逻辑。 - 使用预置条件： 尽量使用 Spring Boot 提供的预置条件，避免重复造轮子。
- 测试你的条件： 编写单元测试来验证你的条件判断逻辑是否正确。
10. @Conditional 的常见问题：避坑指南
- 条件不生效： 检查你的配置文件是否正确，确保属性值与条件判断逻辑一致。
- 循环依赖： 避免在
Condition实现类中依赖正在被条件化的 Bean，这可能会导致循环依赖。 - 性能问题： 如果你的条件判断逻辑非常复杂，可能会影响应用的启动性能。尽量优化你的条件判断逻辑。
总结：@Conditional，让你的 Spring Boot 应用更灵活
@Conditional 注解是 Spring Boot 中一个非常强大的工具，它可以让你根据不同的条件来注册 Bean，从而实现更灵活的配置和更易维护的代码。
掌握 @Conditional 注解，就像掌握了一门魔法，可以让你在 Spring Boot 的世界里自由翱翔，打造出更强大的应用。
希望这篇文章能帮助你更好地理解和使用 @Conditional 注解。 祝你编程愉快！