SpringBoot - @ConditionalOnProperty注解使用详解

原创 已于 2022-06-30 14:33:29 修改 · 7.8k 阅读 · 60 ·
CC 4.0 BY-SA版权
版权声明：本文为博主原创文章，遵循 CC 4.0 BY-SA 版权协议，转载请附上原文出处链接和本声明。
文章标签：

#spring boot #java

于 2022-06-30 11:49:59 首次发布

写在前面

在开发基于SpringBoot框架的项目时，会用到下面的条件注解，有时会有需要控制配置类是否生效或注入到Spring上下文中的场景，可以使用@ConditionalOnProperty注解来控制@Configuration的注解是否生效。

实现原理

@ConditionalOnProperty通过havingValue与配置文件中的值进行对比，如果对比值返回TRUE则配置类生效，反之失效。
Spring Boot 对 @Conditional 注解为我们做了细化，类似的注解共有14个，这些注解都定义在 org.springframework.boot.autoconfigure.condition包下。
在这里插入图片描述

注解说明

A. 这些注解都可以应用在 TYPE 上，也就是说，Spring 自动扫描的一切类 (@Configuration, @Component, @Service, @Repository, @Controller) 都可以通过添加相应的 @ConditionalOnXxxx 来判断是否加载；
B. 这些注解都可以应用在 METHOD 上，所以有 @Bean 标记的方法也可以应用这些注解；
C. 都使用了 @Conditional 注解来标记，OnBeanCondition 等自定义 Condition 也是实现了 Condition 接口。

源码分析

@Retention(RetentionPolicy.RUNTIME)
@Target({
   
   ElementType.TYPE, ElementType.METHOD})
@Documented
@Conditional({
   
   OnPropertyCondition.class})
public @interface ConditionalOnProperty {
   
   
    // NAME和VALUE的互为别名，在使用时是互斥的
    String[] value() default {
   
   <
最低0.47元/天 解锁文章
Spring或SpringBoot中的@ConditionalOnProperty、@ConditionalOnMissingBean、@ConditionalOnExpression及SPI作用
hkl_Forever的博客
11-14 1865
Spring容器加载注册JavaBen的时候，如果在同一个 @Configuration或@Component 标注的配置类中配置多个BeanId相同的实例，那么Spring容器默认只加载第一个同名的实例，在实际应用中需要注意这一点。【1】我们可以将需要条件限制的类当做自动装配类，这样在注册Bean阶段可以保证在我们限制的类注册进容器之前、让被限制的实例先完成注册入容器中，1、因为在实际的应用过程中，我们使用第三方插件，他们的默认配置都会存在于插件的jar包中，而我们的自定义的配置类则在于自身的应用中。
Spring Boot中@ConditionalOnProperty的使用方法
08-25
主要给大家介绍了关于Spring Boot中@ConditionalOnProperty的使用方法，文中通过示例代码介绍的非常详细，对大家的学习或者使用Spring Boot具有一定的参考学习价值，需要的朋友们下面来一起学习学习吧
Springboot @ConditionalOnProperty注解
weixin_30877755的博客
07-22 288
最近看了一段代码其中用到了@ConditionalOnProperty注解，直接没有了解过这个注解，今天看到了顺便了解一下 具体代码如下 @Configuration public class WebConfig { @Bean @ConditionalOnProperty(prefix = "rest", name = "auth-open", havingValue...
Spring Boot中@ConditionalOnProperty的详解和用法
最新发布
solidsh的博客
10-11 343
本文介绍了Spring Boot中的@ConditionalOnProperty注解，该注解用于根据配置属性条件化地创建Bean或配置类。文章首先解析了注解的源码结构，包括prefix、name/value、havingValue和matchIfMissing等核心属性。
Spring Boot 条件注解：@ConditionalOnProperty 完全解析
m0_74823611的博客
01-17 913
是 Spring Boot 中非常实用的条件注解，可以通过配置文件灵活地控制 Bean 和配置类的加载，避免不必要的资源浪费，并提高系统的可维护性。在不同的环境（开发、测试、生产）中，我们可能需要加载不同的配置。在实际项目中，我们可能需要通过配置文件中的某个属性来控制某个功能的启用或禁用。在 Spring Boot 项目中，有时候我们希望根据配置文件中的某个属性值来决定是否启用某个功能或加载某个组件。注解就可以发挥作用。它通过配置文件的属性值控制 Bean 或配置类的加载，使得我们的程序更具灵活性。
@ConditionalOnProperty注解使用说明
LSW1737554365的博客
11-02 1496
在Spring Boot中，@ConditionalOnProperty注解是一种方便的工具，用于根据应用程序配置文件中的属性值来控制Bean的创建和加载。本文将详细介绍@ConditionalOnProperty注解的使用场景和方法，并通过示例演示其应用。
@ConditionalOnXXXXX条件注解
Java后端技术栈
06-21 3036
首先看matchIfMissing属性，用来指定如果配置文件中未进行对应属性配置时的默认处理：默认情况下matchIfMissing为false，也就是说如果未进行属性配置，则自动配置不生效。简单来讲，一般是在配置类上或者是@Bean修饰的方法上，添加此注解表示一个类是否要被Spring上下文加载，若满足条件则加载，若不满足条件则不加载。如：http编码的自动配置类中，当配置文件中没有配置spring.http.encoding.enabled，自动配置仍然会生效。
@ConditionalOnProperty注解
qq_35129986的博客
09-03 1400
是Spring Boot框架中的一个条件注解，它主要用于根据应用程序配置文件（如或）中的属性值来控制Bean的创建和加载。以下是对。
@ConditionalOnProperty注解详解
qq_41967563的博客
02-18 3089
Spring boot中的注解@ConditionalOnProperty，可以通过配置文件中的属性值来判定configuration是否被注入 @Retention(RetentionPolicy.RUNTIME) @Target({ ElementType.TYPE, ElementType.METHOD }) @Documented @Conditional(OnPropertyCon...
@ConditionalOnProperty 注解详解
qq_33525833的博客
07-25 2470
@ConditionalOnProperty 注解详解
SpringBoot之@ConditionalOnProperty注解
jiashn123的专栏
04-24 4655
在平时业务中，我们需要在配置文件中配置某个属性来决定是否需要将某些类进行注入，让Spring进行管理，而@ConditionalOnProperty能够实现该功能。@ConditionalOnProperty：根据属性值来控制类或某个方法是否需要加载。它既可以放在类上也可以放在方法上。
SpringBoot教程(7) @ConditionalOnProperty 详细讲解和示例
热门推荐
Java Spring Elasticsearch
03-15 3万+
@ConditionalOnProperty 详细讲解和示例一、@ConditionalOnProperty简介二、详细代码示例1. 配置文件中配置2. 指定prefix+name3. 只指定name 或者 value3. 指定了havingValue4. 配置项是false，havingValue = false"5. 配置项是false，不设置havingValue6. 缺少配置，但配置了matchIfMissing = true 一、@ConditionalOnProperty简介 在开发基于Spri
【Spring】@ConditionalOnProperty 注解的简单使用与介绍
杜小舟的博客
04-14 5002
@ConditionalOnProperty注解是Spring Boot的条件注解，主要用法是根据配置文件中的属性来控制某个配置类是否生效，或者控制某个Bean是否被创建。
ConditionalOnProperty注解使用介绍、应用场景以及示例代码
a_beiyo的博客
07-13 3642
是 Spring Framework 中的一个条件注解，用于根据配置文件中的属性值来决定是否创建特定的 bean 或者是否启用特定的配置。创建某个 bean 或者执行某个配置。它的工作方式类似于 Spring Boot 的或中的属性配置。当指定的属性在配置文件中存在且值符合条件时，相关的配置才会生效。
Spring-Boot-条件注入@ConditionalOnProperty
Java程序员的知识博客
02-16 1779
bean的条件注入，除了前面两篇博文分别介绍的通过注解配合Condition接口的基本实现，以及如何使用条件注解和本文将主要介绍根据配置来决定是否创建bean的注解。
@ConditionalOnProperty注解使用
java_liuyuan的博客
06-29 8999
@ConditionalOnProperty：Spring Boot通过@ConditionalOnProperty来控制Configuration是否生效。 作用：从配置文件中获取某个值，与定义的值比较，决定Bean是否创建； 依赖：org.springframework.boot.autoconfigure.condition.ConditionalOnProperty; 一、@ConditionalOnProperty注解介绍 @Retention(RetentionPolicy.RUNTIME)
@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
发出的红包

打赏作者

cloneme01

谢谢您的支持与鼓励！

¥1 ¥2 ¥4 ¥6 ¥10 ¥20
扫码支付：¥1
获取中
扫码支付

您的余额不足，请更换扫码支付或充值

打赏作者

实付元
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明：

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

余额充值