Java注解@Conditional与@Profile的使用区别

 更新时间:2025年05月10日 16:42:11   作者:Stay Passion  
这篇文章主要介绍了Java注解@Conditional与@Profile的使用区别,@Profile和@Conditional是Spring提供的两种常用机制,它们可以根据不同的条件动态决定某些Bean是否加载,从而实现环境隔离、模块选择、特性开关等功能,需要的朋友可以参考下

前言

在 Spring 应用开发中,条件化 Bean 注册是配置灵活性的关键一环。@Profile@Conditional 是 Spring 提供的两种常用机制,它们可以根据不同的条件动态决定某些 Bean 是否加载,从而实现环境隔离、模块选择、特性开关等功能。本文将系统讲解这两个注解的作用、使用方式及它们之间的区别与协同方式。

一、什么是@Profile

基本概念

@Profile 注解用于指定某个 Bean 或配置类仅在指定的 Profile 环境下生效。它常用于区分开发、测试和生产环境的配置。

@Configuration
@Profile("dev")
public class DevDataSourceConfig {
    @Bean
    public DataSource dataSource() {
        return new HikariDataSource("jdbc:mysql://localhost/dev_db");
    }
}

激活方式

  • application.yml: spring.profiles.active: dev
  • 启动参数:--spring.profiles.active=dev
  • SpringApplicationBuilder: .profiles("dev")

二、什么是@Conditional

基本概念

@Conditional 注解提供更通用的条件判断能力。它的参数是一个实现了 Condition 接口的类,Spring 会调用该类的 matches 方法决定是否加载对应的 Bean。

@Bean
@Conditional(WindowsCondition.class)
public ListService windowsListService() {
    return new WindowsListService();
}

自定义Condition 示例

public class WindowsCondition implements Condition {
    @Override
    public boolean matches(ConditionContext context, AnnotatedTypeMetadata metadata) {
        return context.getEnvironment().getProperty("os.name").contains("Windows");
    }
}

三、两者的对比

维度@Profile@Conditional
粒度环境级别配置代码级别、属性级别、任意条件
简洁性简洁易用,约定大于配置灵活但需要手动实现 Condition 接口
适用场景多环境配置隔离(dev/test/prod)按任意运行时条件控制 Bean 加载,如系统变量、类存在性等
可组合性可配合 @Configuration@Component 使用可与任意 Spring 注解组合
底层原理本质是 @Conditional(ProfileCondition.class)完全自定义 Condition 实现类

四、实战示例

Profile+Conditional联合使用

@Configuration
@Profile("prod")
public class CacheConfig {
    @Bean
    @Conditional(RedisPresentCondition.class)
    public CacheManager redisCacheManager() {
        return new RedisCacheManager();
    }
}

此配置表示仅在 prod 环境下,且类路径中存在 RedisClient 类时,才创建 redisCacheManager Bean。

五、进阶@Conditional派生注解

Spring Boot 提供了多个 @Conditional 的派生注解,简化了常见场景的条件配置:

@ConditionalOnProperty

作用:根据配置文件中某个属性是否存在及其值决定是否加载 Bean

@Bean
@ConditionalOnProperty(name = "feature.user.enable", havingValue = "true", matchIfMissing = false)
public UserFeatureService featureService() {
    return new UserFeatureService();
}

@ConditionalOnMissingBean

作用:仅在指定 Bean 不存在时注册当前 Bean,用于提供默认实现。

@Bean
@ConditionalOnMissingBean(DataSource.class)
public DataSource defaultDataSource() {
    return new HikariDataSource();
}

@ConditionalOnBean

作用:当 Spring 上下文中存在某个 Bean 时,才注入当前 Bean。

@Bean
@ConditionalOnBean(RedisClient.class)
public CacheManager redisCacheManager() {
    return new RedisCacheManager();
}

@ConditionalOnClass

作用:当类路径下存在某个类时才加载 Bean,适合做组件自动装配。

@Bean
@ConditionalOnClass(name = "com.fasterxml.jackson.databind.ObjectMapper")
public JsonConverter jsonConverter() {
    return new JacksonJsonConverter();
}

这些注解极大简化了自动配置的条件逻辑,是 Spring Boot 自动装配机制的核心支撑。

六、总结

注解作用适合场景
@Profile按环境(如 dev/prod)激活 Bean多环境隔离配置
@Conditional根据任意条件(如操作系统、类路径)激活 Bean灵活控制、扩展性强的模块化配置

在实际项目中,两者可结合使用,构建高度灵活、可配置的应用架构,是 Spring 框架解耦和模块控制的重要工具。

建议在配置类中大量使用 @Profile 做环境隔离,在具体 Bean 中使用 @Conditional 做条件控制。

以上就是Java注解@Conditional与@Profile的使用区别的详细内容,更多关于Java注解@Conditional与@Profile的资料请关注脚本之家其它相关文章!

相关文章

  • Java代码中4种字符串拼接方式分析

    Java代码中4种字符串拼接方式分析

    本文主要介绍了Java代码中4种字符串拼接方式分析,主要介绍了“+”号、StringBuilder、StringJoiner、String#join,文中通过示例代码介绍的非常详细,具有一定的参考价值,感兴趣的小伙伴们可以参考一下
    2022-02-02
  • Springboot详解如何实现SQL注入过滤器过程

    Springboot详解如何实现SQL注入过滤器过程

    这篇文章主要介绍了基于springboot实现SQL注入过滤器,具有很好的参考价值,希望对大家有所帮助。一起跟随小编过来看看吧
    2022-06-06
  • java学习笔记之马踏棋盘算法

    java学习笔记之马踏棋盘算法

    这篇文章主要为大家详细介绍了java学习笔记之马踏棋盘算法,文中示例代码介绍的非常详细,具有一定的参考价值,感兴趣的小伙伴们可以参考一下
    2022-02-02
  • Javadoc标签和Javadoc注释规范说明

    Javadoc标签和Javadoc注释规范说明

    这篇文章主要介绍了Javadoc标签和Javadoc注释规范说明,具有很好的参考价值,希望对大家有所帮助。一起跟随小编过来看看吧
    2021-02-02
  • spring框架学习总结

    spring框架学习总结

    Spring是于2003 年兴起的一个轻量级的Java 开发框架,由Rod Johnson创建。简单来说,Spring是一个分层的JavaSE/EE full-stack(一站式) 轻量级开源框架
    2021-06-06
  • Java面向对象之什么是异常

    Java面向对象之什么是异常

    Java 把异常当作对象来处理,并定义一个基类,java.lang.Throwable 作为所有异常的超类。今天通过本文给大家分享Java面向对象之什么是异常,感兴趣的朋友一起看看吧
    2021-07-07
  • Java集合操作之List接口及其实现方法详解

    Java集合操作之List接口及其实现方法详解

    这篇文章主要介绍了Java集合操作之List接口及其实现方法,详细分析了Java集合操作中List接口原理、功能、用法及操作注意事项,需要的朋友可以参考下
    2015-07-07
  • Java利用WatchService监听文件变化示例

    Java利用WatchService监听文件变化示例

    本篇文章主要介绍了Java利用WatchService监听文件变化示例,小编觉得挺不错的,现在分享给大家,也给大家做个参考。一起跟随小编过来看看吧
    2017-10-10
  • java 查询oracle数据库所有表DatabaseMetaData的用法(详解)

    java 查询oracle数据库所有表DatabaseMetaData的用法(详解)

    下面小编就为大家带来一篇java 查询oracle数据库所有表DatabaseMetaData的用法(详解)。小编觉得挺不错的,现在就分享给大家,也给大家做个参考。一起跟随小编过来看看吧
    2016-11-11
  • Java 中的静态字段和静态方法 

    Java 中的静态字段和静态方法 

    这篇文章主要介绍了Java中的静态字段和静态方法,文章围绕Java 静态方法展开详细内容,具有一定的参考价值,需要的小伙伴可以参考一下
    2022-03-03

最新评论