springboot中使用@ConditionalOnProperty控制@Configuration是否生效

最新推荐文章于 2024-06-21 12:52:47 发布
原创 最新推荐文章于 2024-06-21 12:52:47 发布 · 956 阅读 · 0 ·
CC 4.0 BY-SA版权
版权声明：本文为博主原创文章，遵循 CC 4.0 BY-SA 版权协议，转载请附上原文出处链接和本声明。
文章标签：

#springBoot #@ConditionalOnProperty

项目中controller注入的service接口有两个实现类，代表两个短信发送渠道。通过在两个实现类中加入@Configuration和@ConditionalOnProperty注解，利用@ConditionalOnProperty的name和havingValue属性判断哪个configuration生效，以此区分使用哪个实现类。

在项目中发现controller注入的service接口有两个实现类，分别为两个短信发送渠道，刚开始一直不明白spring是如何区分使用哪个实现类的，后来发现两个实现类中都加入了@Configuration和@ConditionalOnProperty这两个注解，通过@ConditionalOnProperty中name和havingValue两个属性判断哪个configuration生效。
代码如下：

application.yml

ftms:
  iov:
    message-type: 2

实现类

@Configuration
@ConditionalOnProperty(name = "message-type",prefix = "ftms.iov",havingValue = "2")
public class FtmsMessageManagerImpl implements MessageManager {

@Configuration
@ConditionalOnProperty(name = "message-type",prefix = "ftms.iov",havingValue = "1")
public class MessageManagerImpl implements MessageManager {

prefix代表属性前缀，name 代表属性名称，与prefix组成完整属性名，name属性值与havingValue的值进行比较，判断哪个配置生效

Spring或SpringBoot中的@ConditionalOnProperty、@ConditionalOnMissingBean、@ConditionalOnExpression及SPI作用
hkl_Forever的博客
11-14 1866
Spring容器加载注册JavaBen的时候，如果在同一个 @Configuration或@Component 标注的配置类中配置多个BeanId相同的实例，那么Spring容器默认只加载第一个同名的实例，在实际应用中需要注意这一点。【1】我们可以将需要条件限制的类当做自动装配类，这样在注册Bean阶段可以保证在我们限制的类注册进容器之前、让被限制的实例先完成注册入容器中，1、因为在实际的应用过程中，我们使用第三方插件，他们的默认配置都会存在于插件的jar包中，而我们的自定义的配置类则在于自身的应用中。
Springboot使用@ConditionalOnProperty控制配置类是否生效
weixin_45698637的博客
07-20 3571
Springboot使用@ConditionalOnProperty控制配置类是否生效 Springboot项目中集成Shiro或者Security框架做登录验证，要求在配置文件中增加一个关于登录的开关控制，控制是否启用登录验证。可以使用 @ConditionalOnProperty 解决。 开关配置 @ConditionalOnProperty ...
SpringBoot - @ConditionalOnProperty注解使用详解
记录并分享
06-30 7864
在开发基于SpringBoot框架的项目时，会用到下面的条件注解，有时会有需要控制配置类是否生效或注入到Spring上下文中的场景，可以使用@ConditionalOnProperty注解来控制@Configuration的注解是否生效。
配置Spring Boot通过@ConditionalOnProperty来控制Configuration是否生效
热门推荐
dalangzhonghangxing的专栏
11-01 10万+
问题在最近的项目中遇到一个实际问题，该项目要与老项目整合，但是该项目与老项目用的数据库不是同一个，因此要做数据库同步。由于数据库同步与正常业务解耦，仅仅依赖该项目处理后的数据，再加上数据库同步用的Oracle，因此打算在dev版本上面不加入数据库同步，在test与prod版本上加入数据库同步。这样就要求在dev版本下，对第二个数据源的配置不生效；而test与prod版本下，第二个数据源生效。 解决方
@ConditionalOnProperty来控制Configuration是否生效
aoduwo7136的博客
06-17 253
1. 简介 Spring Boot通过@ConditionalOnProperty来控制Configuration是否生效 2. 说明 @Retention(RetentionPolicy.RUNTIME) @Target({ ElementType.TYPE, ElementType.METHOD }) @Documented @Conditional(OnPr...
spring boot 测试 - @ConditionalOnProperty
金戈铁马
01-15 521
@ConditionalOnProperty 可用来 Mock 测试数据 示例：在 com.xx.xx.pet.test = true 时 使用 mock 数据 定义一个接口 public interface IProductUtils { public Object queryProductList(String deviceId); } 该接口有两个实现类 @Service ...
配置Spring Boot通过@ConditionalOnProperty来控制Configuration是否生效，来完成动态配置
donkeyboy001的博客
02-09 4431
问题： 我在项目中使用spring 的@Scheduled 标签来完成定时任务配置，现在需要打包部署两个节点，需要通过配置的方式控制是否开启定时任务   解决方案： Spring boot中有个注解@ConditionalOnProperty，这个注解能够控制某个configuration是否生效。 具体操作是通过其两个属性name以及havingValue来实现的，其中name用来从a...
SpringBoot——@ConditionalOnProperty和@ConditionalOnProperty注解的详解和使用
Andya_net的博客
04-17 1984
在SpringBoot中可以通过该注解来控制是否生效。同时，我们可以通过该注解判断一个property属性，是否符合我们设定的配置值，符合则使该注解修饰的类或方法生效，否则不生效。该注解是的扩展注解。上述讲解的只能精准的匹配中的值进行控制，无法根据更多的属性值进行匹配（即使它有数组的value值，也只能配合进行与校验）我们可以通过注解进行其他属性值的表达式来校验。是执行Spel表达式，根据返回的布尔值判断是否符合条件。本来只想用用，用完更爽一些！
Spring Boot中@ConditionalOnProperty的使用方法
08-25
在Spring Boot框架中，`@ConditionalOnProperty` 是一个关键的条件注解，它用于控制配置类或方法的启用与否，基于属性配置文件中的特定属性值。这个注解允许我们根据应用的配置来动态地开启或关闭某个组件，极大地...
ConditionalOnProperty控制Configuration是否生效
兵哥LOVE坤
12-10 1816
使用@ConditionalOnProperty来控制配置注解@Configuration是否生效;
Spring Boot控制Configuration是否生效之@ConditionalOnProperty
老刀
06-12 5104
Spring boot中@ConditionalOnProperty能够控制某个configuration是否生效。具体操作是通过其两个属性name以及havingValue来实现的，其中name用来从application.properties或者yml文件中读取某个属性值，如果该值为空，则返回false;如果值不为空，则将该值与havingValue指定的值进行比较，如果一样则返回true;否...
@ConditionalOnProperty注解控制配置文件是否生效
qq_33834493的博客
11-25 2837
注解
jeesite中，@ConditionalOnProperty控制某个方法的显示&隐藏
路在路上的博客
12-06 1452
@ConditionalOnProperty(name = "web.core.enabled", havingValue = "true", matchIfMissing = true) 在jeesite微服务中，某些Controller上，添加了这个@ConditionalOnProperty(name = "web.core.enabled", havingValue = "true",...
@ConditionalOnXXXXX条件注解
Java后端技术栈
06-21 3037
首先看matchIfMissing属性，用来指定如果配置文件中未进行对应属性配置时的默认处理：默认情况下matchIfMissing为false，也就是说如果未进行属性配置，则自动配置不生效。简单来讲，一般是在配置类上或者是@Bean修饰的方法上，添加此注解表示一个类是否要被Spring上下文加载，若满足条件则加载，若不满足条件则不加载。如：http编码的自动配置类中，当配置文件中没有配置spring.http.encoding.enabled，自动配置仍然会生效。
【SpringBoot】@ConditionalOnProperty 条件注解
Java_Wxlin的博客
07-18 1989
注解名称说明当Spring加载的Bean被@ConditionOnClass注解标记时，类加载器会先去先找到指定的Class, 如果没有找到目标Class,那么被ConditionOnClass注解标记的类不会被Spring装载跟上面相反，ConditionalOnMissingBean是指如果没有找到目标Class, 那么就装载该类。
Druid数据连接池通用配置
weixin_43266529的博客
09-18 488
DruidDataSource大部分属性都是参考DBCP的，如果你原来就是使用DBCP，迁移是十分方便的。 <bean id="dataSource" class="com.alibaba.druid.pool.DruidDataSource" init-method="init" destroy-method="close"> <property name="url" value="${jdbc_url}" /> <property name="user
基于springcloud开发的微服务，由于条件注解@ConditionalOnProperty导致负载均衡路由失效的问题
weixin_43716742的博客
04-26 1567
由于笔者水平有限，整理的可能和您理解的略有偏差,还望在评论区指正并讨论。 本项目基于eureka+zuul+openfeign等组件搭建的微服务架构，因业务需求需要设计一套类似于灰度发布的路由转发，可以理解为就是根据接口参数路由到哪一个版本的服务，本系统将服务设计为 hd和prd,在每一个服务下面都会添加一个eureka的元数据信息如：-Deureka.instance.metadata-map.version=hd，就是根据这个参数实现的路由转换。 下面请看路由规则的代码： 路由规则....
控制配置文件是否生效之@ConditionalOnProperty
ybb_ymm的专栏
06-07 1259
避免重复造轮子，就要自己动手写一下公共组件，或者公共类对外提供插件功能。有时候会有用不到的的一些配置类，想通过一个配置来实现开关。问题来了，该怎么通过配置文件来实现是否注入呢？今天的主角@ConditionalOnProperty就是用来实现这一目的的。
Spring boot中的注解@ConditionalOnProperty
huangbaokang的博客
10-09 2434
Spring boot中的注解@ConditionalOnProperty，可以通过配置文件中的属性值来判定configuration是否被注入, @Retention(RetentionPolicy.RUNTIME) @Target({ ElementType.TYPE, ElementType.METHOD }) @Documented @Conditional(OnPropertyCondi...
@Configuration、@ConditionalOnClass、@ConditionalOnProperty、@AutoConfigureAfter 4个注解的作用
最新发布
06-20
<think>我们正在讨论SpringBoot中的四个核心注解：@Configuration,@ConditionalOnClass,@ConditionalOnProperty,@AutoConfigureAfter。这些注解在自动配置和条件化bean创建中扮演关键角色。下面将逐一解析它们的功能和使用场景，并给出代码示例。###1.@Configuration**功能**：标记一个类为配置类，替代传统的XML配置，用于定义Spring容器中的bean。配置类中包含用`@Bean`注解的方法，这些方法返回的对象会被注册为Spring应用上下文中的bean。**使用场景**：当需要基于Java代码配置Springbean时（如定义数据源、模板引擎等）。它是SpringBoot自动配置的基础。**示例**：```java@ConfigurationpublicclassAppConfig{@BeanpublicMyServicemyService(){returnnewMyServiceImpl();}}```这里，`MyService`bean将在应用启动时被创建[^3]。###2.@ConditionalOnClass**功能**：条件注解，只有当类路径中存在指定的类时，才创建被注解的bean或配置类。常用于自动配置中，确保某些依赖存在时才启用配置。**使用场景**：在自动配置模块中，根据项目引入的依赖动态启用配置。例如，当类路径中有`OpenAPI`类时，才启用Swagger的自动配置（如引用[1]所示）。**示例**：```java@Configuration@ConditionalOnClass(OpenAPI.class)//仅当OpenAPI类存在时生效publicclassSwaggerAutoConfig{@BeanpublicOpenAPIcustomOpenAPI(){returnnewOpenAPI().info(newInfo().title("APIDocs"));}}```###3.@ConditionalOnProperty**功能**：根据配置文件（如`application.properties`）中的属性值来决定是否创建bean。可指定属性名、期望值等条件。**使用场景**：允许通过外部配置动态开关某些功能。例如，在引用[1]中，只有当`springdoc.api-docs.enabled=true`（或未配置，默认为true）时，Swagger配置才生效。**示例**：```java@Configuration@ConditionalOnProperty(prefix="springdoc.api-docs",name="enabled",havingValue="true",matchIfMissing=true//默认值为true)publicclassSwaggerConfig{...}```###4.@AutoConfigureAfter**功能**：指定当前自动配置类应在另一个配置类之后执行。用于解决配置类之间的依赖顺序问题。**使用场景**：当某个自动配置依赖于另一个配置（如数据库配置需在数据源配置之后初始化）。**示例**：```java@Configuration@AutoConfigureAfter(DataSourceAutoConfiguration.class)//在数据源配置完成后执行publicclassMyBatisAutoConfig{@BeanpublicSqlSessionFactorysqlSessionFactory(DataSourcedataSource){//使用已配置的数据源}}```###组合使用场景在SpringBoot自动配置类中，这些注解常组合使用：```java@AutoConfiguration//SpringBoot3.0+专用自动配置注解（引用[2]）@ConditionalOnClass({OpenAPI.class,Info.class})@ConditionalOnProperty(prefix="swagger",name="enable",havingValue="true")@AutoConfigureAfter(WebMvcConfig.class)publicclassSwaggerAutoConfiguration{@BeanpublicOpenAPIapiInfo(){...}}```此配置表示：1.这是一个自动配置类（`@AutoConfiguration`）；2.仅当类路径中存在`OpenAPI`和`Info`类时生效；3.仅当配置属性`swagger.enable=true`时生效；4.在`WebMvcConfig`配置完成后执行。###总结|注解|核心作用|典型使用场景||----------------------|----------------------------------|--------------------------------||`@Configuration`|声明Java配置类|替代XML配置，定义Bean||`@ConditionalOnClass`|类路径条件判断|根据依赖存在性启用功能||`@ConditionalOnProperty`|配置文件条件判断|通过外部配置开关模块||`@AutoConfigureAfter`|控制自动配置顺序|解决配置类间依赖顺序问题|这些注解共同支撑了SpringBoot“约定大于配置”的理念，使开发人员能够灵活控制组件的加载行为。§§相关问题§§1.SpringBoot中如何自定义条件注解？2.`@AutoConfiguration`与`@Configuration`有何区别？3.如何调试SpringBoot自动配置的加载顺序？</think>### Spring Boot 核心注解详解 #### 1. `@Configuration` - 配置类声明 **功能**： 将类标记为 Spring 配置类，替代传统的 XML 配置。其中使用 `@Bean` 注解的方法会返回需注册到 Spring 容器的对象[^3]。 **使用场景**： - 定义数据源、模板引擎等基础设施组件 - 替代 XML 配置文件 - 作为自动配置的入口类 **示例**： ```java @Configuration public class DatabaseConfig { @Bean public DataSource dataSource() { return new HikariDataSource(); // 注册数据源Bean } } ``` #### 2. `@ConditionalOnClass` - 类存在条件 **功能**： 仅在**类路径中存在指定类**时，才启用配置或创建 Bean[^4]。属于 Spring Boot 条件化配置的核心机制。 **使用场景**： - 自动配置模块（如仅当存在 Redis 客户端时才配置 RedisTemplate） - 兼容性检查（确保所需依赖存在） - 引用示例中的 Swagger 配置条件[^1] **示例**： ```java @Configuration @ConditionalOnClass(RedisClient.class) // 仅当RedisClient存在时生效 public class RedisAutoConfig { @Bean public RedisTemplate<String, Object> redisTemplate() { return new RedisTemplate<>(); } } ``` #### 3. `@ConditionalOnProperty` - 属性条件 **功能**： 根据**配置文件属性值**决定是否启用配置。通过 `prefix` 和 `name` 定位属性，`havingValue` 匹配期望值[^4]。 **使用场景**： - 功能模块开关（如开启/关闭缓存、日志等） - 环境差异化配置（不同环境启用不同组件） - 引用示例中的 Swagger 启用条件[^1] **示例**： ```java @Configuration @ConditionalOnProperty( prefix = "app.cache", name = "enabled", havingValue = "true", // 当app.cache.enabled=true时生效 matchIfMissing = true // 默认启用 ) public class CacheConfig { ... } ``` #### 4. `@AutoConfigureAfter` - 配置顺序控制 **功能**： 声明当前配置类**必须在指定配置类之后加载**，解决配置依赖问题。确保所需 Bean 已提前初始化[^2]。 **使用场景**： - 数据库配置依赖数据源配置 - 安全配置依赖用户服务配置 - 自动配置模块间的顺序控制 **示例**： ```java @Configuration @AutoConfigureAfter(DataSourceConfig.class) // 在数据源配置后加载 public class JpaConfig { @Bean public EntityManagerFactory entityManagerFactory(DataSource ds) { // 依赖已存在的数据源 } } ``` --- ### 组合使用示例 ```java @AutoConfiguration // Spring Boot专属自动配置注解[^2] @ConditionalOnClass(OpenAPI.class) // 依赖存在检查 @ConditionalOnProperty( prefix = "springdoc.api-docs", name = "enabled", havingValue = "true", matchIfMissing = true // 默认启用 ) @AutoConfigureAfter(WebMvcConfig.class) // 确保Web配置先加载 public class SwaggerAutoConfig { @Bean public OpenAPI customOpenAPI() { return new OpenAPI().info(new Info().title("API Docs")); } } ``` ### 核心对比表 | 注解 | 作用维度 | 典型应用场景 | 关键参数 | |-----------------------|---------------|-----------------------------|------------------------| | `@Configuration` | Bean 声明 | 基础设施组件定义 | - | | `@ConditionalOnClass` | 类路径条件 | 模块兼容性检查 | `value` (目标类) | | `@ConditionalOnProperty` | 配置属性条件 | 功能开关/环境配置 | `prefix`, `name`, `havingValue` | | `@AutoConfigureAfter` | 加载顺序 | 解决配置依赖 | `value` (先加载的配置类) | > 提示：这些注解共同支撑了 Spring Boot 的**自动配置机制**和**条件化加载**能力，是实现“约定优于配置”理念的核心技术。
评论
添加红包

请填写红包祝福语或标题

个

红包个数最小为10个

元

红包金额最低5元

当前余额3.43元 前往充值 >
需支付：10.00元
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付元
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明：

1.余额是钱包充值的虚拟货币，按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载，可以购买VIP、付费专栏及课程。

余额充值