当前位置： 首页 > news >正文

Spring 及 Spring Boot 条件化注解(15个）完整列表及示例

news 来源：原创 2025/5/22 15:32:29

Spring 及 Spring Boot 条件化注解完整列表及示例

1. 所有条件化注解列表

Spring 和 Spring Boot 提供了以下条件化注解（共 15 个），用于在配置类或方法上实现条件化注册 Bean 或配置：

注解名称作用来源框架
@Conditional自定义条件逻辑。Spring Core
@ConditionalOnClass类路径存在指定类时触发。Spring Core
@ConditionalOnMissingClass类路径不存在指定类时触发。Spring Core
@ConditionalOnBean指定 Bean 存在时触发。Spring Core
@ConditionalOnMissingBean指定 Bean 不存在时触发。Spring Core
@ConditionalOnExpressionSpEL 表达式为 true 时触发。Spring Core
@ConditionalOnJava当前 Java 版本满足条件时触发。Spring Core
@ConditionalOnProperty配置属性存在且符合指定值时触发。Spring Core
@ConditionalOnResource类路径存在指定资源文件时触发。Spring Boot
@ConditionalOnWebApplication当应用是 Web 应用时触发。Spring Boot
@ConditionalOnNotWebApplication当应用不是 Web 应用时触发。Spring Boot
@ConditionalOnSingleCandidate指定类型只有一个候选 Bean 或类型匹配时触发。Spring Boot
@ConditionalOnJndiJNDI 资源存在时触发。Spring Boot
@ConditionalOnMissingJndiJNDI 资源不存在时触发。Spring Boot
@ConditionalOnCloudPlatform当运行在指定云平台（如 AWS、Azure）时触发。Spring Cloud
2. 完整代码示例
(1) @Conditional（自定义条件）

作用：通过实现 Condition 接口自定义条件逻辑。

// 自定义条件类
public class CustomCondition implements Condition {
    @Override
    public boolean matches(ConditionContext context, AnnotatedTypeMetadata metadata) {
        return context.getEnvironment().containsProperty("custom.key");
    }
}

// 配置类
@Configuration
@Conditional(CustomCondition.class) // 自定义条件
public class CustomConditionConfig {
    @Bean
    public String customConditionBean() {
        return "Bean created by custom condition";
    }
}

// 测试类
@SpringBootTest(properties = "custom.key=true")
class CustomConditionTest {
    @Autowired(required = false)
    private String customConditionBean;

    @Test
    void testWithCustomKey() {
        assertNotNull(customConditionBean);
    }
}
(2) @ConditionalOnClass

作用：类路径存在指定类时触发。

@Configuration
@ConditionalOnClass(DataSource.class) // 当存在 DataSource 类时触发
public class ClassConditionConfig {
    @Bean
    public String dataSourceBean() {
        return "DataSource exists";
    }
}
(3) @ConditionalOnMissingClass

作用：类路径不存在指定类时触发。

@Configuration
@ConditionalOnMissingClass("org.springframework.jdbc.datasource.DataSource") // 当无 DataSource 类时触发
public class MissingClassConditionConfig {
    @Bean
    public String noDataSourceBean() {
        return "DataSource does NOT exist";
    }
}
(4) @ConditionalOnBean

作用：指定 Bean 存在时触发。

@Configuration
@ConditionalOnBean(name = "dataSource") // 当存在 dataSource Bean 时触发
public class BeanConditionConfig {
    @Bean
    public String dataSourceDependentBean() {
        return "Bean created because dataSource exists";
    }
}
(5) @ConditionalOnMissingBean

作用：指定 Bean 不存在时触发。

@Configuration
public class MissingBeanConditionConfig {
    @Bean
    @ConditionalOnMissingBean(name = "myBean") // 当无 myBean 时触发
    public String missingBean() {
        return "Bean created because 'myBean' is missing";
    }
}
(6) @ConditionalOnExpression

作用：SpEL 表达式为 true 时触发。

@Configuration
@ConditionalOnExpression("${app.env} == 'prod'") // 当 env 为 prod 时触发
public class ExpressionConditionConfig {
    @Bean
    public String prodBean() {
        return "Bean for prod environment";
    }
}
(7) @ConditionalOnJava

作用：Java 版本满足条件时触发。

@Configuration
@ConditionalOnJava(baseline = JavaVersion.EIGHT, fallback = JavaVersion.TEN) // Java 8-10 时触发
public class JavaVersionConditionConfig {
    @Bean
    public String java8To10Bean() {
        return "Java 8-10 compatible";
    }
}
(8) @ConditionalOnProperty

作用：配置属性存在且符合指定值时触发。

@Configuration
@ConditionalOnProperty(name = "feature.enabled", havingValue = "true") // 当 feature.enabled 为 true 时触发
public class PropertyConditionConfig {
    @Bean
    public String enabledFeatureBean() {
        return "Feature enabled";
    }
}
(9) @ConditionalOnResource

作用：类路径存在指定资源文件时触发（Spring Boot）。

@Configuration
@ConditionalOnResource(resources = "classpath:config/application-prod.properties") // 当资源存在时触发
public class ResourceConditionConfig {
    @Bean
    public String prodResourceBean() {
        return "Resource exists";
    }
}
(10) @ConditionalOnWebApplication

作用：应用是 Web 应用时触发（Spring Boot）。

@Configuration
@ConditionalOnWebApplication // Web 应用时触发
public class WebConditionConfig {
    @Bean
    public String webBean() {
        return "Web application";
    }
}
(11) @ConditionalOnNotWebApplication

作用：应用不是 Web 应用时触发（Spring Boot）。

@Configuration
@ConditionalOnNotWebApplication // 非 Web 应用时触发
public class NonWebConditionConfig {
    @Bean
    public String nonWebBean() {
        return "Non-web application";
    }
}
(12) @ConditionalOnSingleCandidate

作用：指定类型只有一个候选 Bean 时触发（Spring Boot）。

@Configuration
@ConditionalOnSingleCandidate(DataSource.class) // 当唯一 DataSource 存在时触发
public class SingleCandidateConditionConfig {
    @Bean
    public String singleDataSourceBean() {
        return "Single DataSource candidate";
    }
}
(13) @ConditionalOnJndi

作用：JNDI 资源存在时触发（Spring Boot）。

@Configuration
@ConditionalOnJndi("java:comp/env/jdbc/MyDB") // 当 JNDI 资源存在时触发
public class JndiConditionConfig {
    @Bean
    public String jndiBean() {
        return "JNDI resource exists";
    }
}
(14) @ConditionalOnMissingJndi

作用：JNDI 资源不存在时触发（Spring Boot）。

@Configuration
@ConditionalOnMissingJndi("java:comp/env/jdbc/MyDB") // 当 JNDI 资源不存在时触发
public class MissingJndiConditionConfig {
    @Bean
    public String noJndiBean() {
        return "JNDI resource does NOT exist";
    }
}
(15) @ConditionalOnCloudPlatform

作用：运行在指定云平台时触发（Spring Cloud）。

@Configuration
@ConditionalOnCloudPlatform(Azure.class) // 当运行在 Azure 时触发
public class CloudConditionConfig {
    @Bean
    public String azureBean() {
        return "Bean for Azure environment";
    }
}
3. 条件注解对比表
注解触发条件典型场景参数示例来源框架
@Conditional自定义 Condition 接口实现的逻辑。灵活的自定义条件。@Conditional(CustomCondition.class)Spring Core
@ConditionalOnClass类路径存在指定类。检测依赖是否存在。@ConditionalOnClass(DataSource.class)Spring Core
@ConditionalOnMissingClass类路径不存在指定类。检测依赖缺失。@ConditionalOnMissingClass("DataSource")Spring Core
@ConditionalOnBean指定 Bean 存在。依赖其他 Bean 的存在。@ConditionalOnBean(name = "dataSource")Spring Core
@ConditionalOnMissingBean指定 Bean 不存在。避免重复注册 Bean。@ConditionalOnMissingBean(name = "myBean")Spring Core
@ConditionalOnExpressionSpEL 表达式为 true。复杂条件判断。@ConditionalOnExpression("${app.env} == 'prod'")Spring Core
@ConditionalOnJava当前 Java 版本满足条件。根据 Java 版本启用功能。@ConditionalOnJava(baseline = JavaVersion.EIGHT)Spring Core
@ConditionalOnProperty配置属性存在且符合指定值。根据配置启用功能。@ConditionalOnProperty(name = "feature.enabled", havingValue = "true")Spring Core
@ConditionalOnResource类路径存在指定资源文件。根据资源文件存在与否配置。@ConditionalOnResource("classpath:config/prod.properties")Spring Boot
@ConditionalOnWebApplication应用是 Web 应用。Web 相关配置。@ConditionalOnWebApplicationSpring Boot
@ConditionalOnNotWebApplication应用不是 Web 应用。非 Web 应用配置。@ConditionalOnNotWebApplicationSpring Boot
@ConditionalOnSingleCandidate指定类型只有一个候选 Bean 或类型匹配。确保唯一 Bean。@ConditionalOnSingleCandidate(DataSource.class)Spring Boot
@ConditionalOnJndiJNDI 资源存在。根据 JNDI 资源触发配置。@ConditionalOnJndi("java:comp/env/jdbc/MyDB")Spring Boot
@ConditionalOnMissingJndiJNDI 资源不存在。根据 JNDI 缺失触发配置。@ConditionalOnMissingJndi("java:comp/env/jdbc/MyDB")Spring Boot
@ConditionalOnCloudPlatform运行在指定云平台（如 AWS、Azure）。云平台相关配置。@ConditionalOnCloudPlatform(Azure.class)Spring Cloud
4. 总结

Spring 及 Spring Boot 的条件化注解通过 条件判断 实现配置的动态加载，核心是 Condition 接口和其衍生注解。关键点如下：

  • 依赖检测：@ConditionalOnClass、@ConditionalOnMissingClass、@ConditionalOnJndi。
  • Bean 状态：@ConditionalOnBean、@ConditionalOnMissingBean、@ConditionalOnSingleCandidate。
  • 属性/环境：@ConditionalOnProperty、@ConditionalOnExpression、@ConditionalOnJava。
  • 应用类型：@ConditionalOnWebApplication、@ConditionalOnNotWebApplication。
  • 云平台：@ConditionalOnCloudPlatform（Spring Cloud）。
  • 自定义条件：通过 @Conditional 实现灵活扩展。

这些注解帮助开发者根据运行时环境、依赖、配置等条件动态注册 Bean，减少硬编码，提升代码的灵活性和可维护性。例如：

  • Spring Boot 的 @ConditionalOnResource 可用于根据配置文件是否存在来启用功能。
  • @ConditionalOnCloudPlatform 可在不同云平台（如 AWS、Azure）间切换配置。
  • @ConditionalOnJndi 适用于需要 JNDI 资源的环境（如企业级应用服务器）。

根据具体需求选择合适的注解，可显著简化配置逻辑并增强代码的适应性。

相关文章：

  • matlab仿真MIMO天线
  • 深度学习篇---paddleocr正则化提取
  • 系统如何查找文件？inode号又是什么？
  • 0 基础速成 AI 编程指南
  • Vue 项目中使用$refs来访问组件实例或 DOM 元素，有哪些注意事项？
  • 基础认证-判断题
  • NX二次开发刻字功能——拉伸功能
  • 【质量管理】防错（POKA-YOKE）的概念、特点和作用解析
  • 如何降低频谱分析仪的底噪
  • 并查集解题记录128最长连续序列200岛屿数量547省份数量684冗余连接
  • 【人工智能】从 Llama 到 DeepSeek：开源大模型的演进与技术对比
  • 青少年编程与数学 02-011 MySQL数据库应用 19课题、存储引擎
  • 第三卷：覆舟山决战（85-108回）
  • 环境试验中温湿度循环测试的常见盲区分析
  • 第38周：文献阅读
  • kafka 4.x docker启动kafka4.0.0 docker-compose启动最新版kafka 如何使用docker容器启动最新版kafka
  • 步进电机 cia402协议 报文自己的理解 （笔记）
  • 怎么在一台服务器上配置两套不同的前后端分离系统
  • Docker 环境安装步骤
  • 《初级社会工作者》考试题，附答案解析
  • 定制虚拟偶像汉化破解版/深圳seo优化推广
  • 网站推广有哪些方式/东莞关键词优化实力乐云seo
  • 制作一般网站/aso优化报价
  • WordPress全站转webp/seo外包优化网站
  • 太原网站建设baidu/谷歌paypal官网入口
  • 木门行业做网站有什么好处/产品推广宣传方案