ConditionalOnProperty注解的作用和使用方式

 更新时间:2024年09月26日 08:45:55   作者:码农娟  
在SpringBoot项目开发中,@ConditionalOnProperty注解允许根据配置文件中的属性值来控制配置类是否生效,该注解通过属性name和havingValue来判断配置是否注入,如果application.properties中的对应属性值为空或不匹配havingValue设定值

ConditionalOnProperty注解的作用

在开发spring boot框架的项目时,需要控制配置类是否生效,这个时候就要用到@ConditionalOnProperty注解;

@ConditionalOnProperty注解可以通过配置文件中的属性值,来判定configuration是否被注入;

源码

ConditionalOnProperty的源码

package org.springframework.boot.autoconfigure.condition;

import java.lang.annotation.Documented;
import java.lang.annotation.ElementType;
import java.lang.annotation.Retention;
import java.lang.annotation.RetentionPolicy;
import java.lang.annotation.Target;
import org.springframework.context.annotation.Conditional;

@Retention(RetentionPolicy.RUNTIME)
@Target({ElementType.TYPE, ElementType.METHOD})
@Documented
@Conditional({OnPropertyCondition.class})
public @interface ConditionalOnProperty {
    String[] value() default {};

    String prefix() default "";

    String[] name() default {};

    String havingValue() default "";

    boolean matchIfMissing() default false;
}

属性说明

  • value: 获取对应property名称的值,与name不可同时使用
  • prefix: 配置项的前缀,可有可无
  • name: property完整名称或部分名称(可与prefix组合使用,组成完整的property名称),与value不可同时使用  
  • havingValue: 可与name组合使用,比较获取到的属性值与havingValue给定的值是否相同,当两个值相同返回true相同才加载配置
  • matchIfMissing: 如果配置文件中, 没有该配置项, 判断是否加载BEAN, 默认为false。  

用法

通过其两个属性name以及havingValue来实现的,其中name用来从application.properties中读取某个属性值。

如果该值为空,则返回false; 如果值不为空,则将该值与havingValue指定的值进行比较,

如果一样则返回true;否则返回false。 如果返回值为false,则该configuration不生效;为true则生效。

示例

以数据源配置为例:

配置文件信息:

spring:
    datasource:
        type: com.alibaba.druid.pool.DruidDataSource
        driverClassName: com.mysql.cj.jdbc.Driver
        druid:
            # 主库数据源
            master:
                url: jdbc:mysql://127.0.0.1/test1?useUnicode=true&characterEncoding=utf8&zeroDateTimeBehavior=convertToNull&useSSL=true&serverTimezone=GMT%2B8
                username: root
                password: 123456
            # 从库数据源
            slave:
                # 从数据源开关/默认关闭
                enabled: true
                url: jdbc:mysql://127.0.0.1:3306/test2?useUnicode=true&characterEncoding=utf-8&useSSL=false
                username: root
                password: 123456

注解使用:

@Configuration
public class DynamicDataSourceConfig
{
    @Bean
    @ConfigurationProperties("spring.datasource.druid.master")
    public DataSource masterDataSource(DruidProperties druidProperties)
    {
       
    }

    @Bean
    @ConfigurationProperties("spring.datasource.druid.slave")
    @ConditionalOnProperty(prefix = "spring.datasource.druid.slave", name = "enabled", havingValue = "true")
    public DataSource slaveDataSource(DruidProperties druidProperties)
    {
       
    }
    .
    .
    .
}
  • 指定了prefix,name,havingValue,因配置项为true,所以会加载slave库。

拓展

Spring Boot@Conditional 注解为我们做了细化,类似的注解共有14个,这些注解都定义在 org.springframework.boot.autoconfigure.condition包下。

以上圈起來的注解:

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

总结

以上为个人经验,希望能给大家一个参考,也希望大家多多支持脚本之家。

相关文章

  • SpringBoot的条件装配原理及实现思路

    SpringBoot的条件装配原理及实现思路

    SpringBoot的条件装配是基于@Conditional注解实现的,下面我们使用原生的@Conditional注解模拟实现类的条件装配,本文结合实例代码给大家介绍的非常详细,感兴趣的朋友跟随小编一起看看吧
    2025-08-08
  • 使用SpringBoot AOP 记录操作日志、异常日志的过程

    使用SpringBoot AOP 记录操作日志、异常日志的过程

    这篇文章主要介绍了使用SpringBoot AOP 记录操作日志、异常日志的过程,本文给大家介绍的非常详细,对大家的学习或工作具有一定的参考借鉴价值,需要的朋友可以参考下
    2021-05-05
  • SpringCloud中Eureka的配置及使用讲解

    SpringCloud中Eureka的配置及使用讲解

    Eureka 服务注册中心,主要用于提供服务注册功能,当微服务启动时,会将自己的服务注册到 Eureka Server,这篇文章主要介绍了SpringCloud中Eureka的配置及详细使用,需要的朋友可以参考下
    2023-01-01
  • Java编程—在测试中考虑多态

    Java编程—在测试中考虑多态

    这篇文章主要介绍了Java编程—在测试中考虑多态,具有一定参考价值,需要的朋友可以了解下。
    2017-11-11
  • SpringBoot使用Nacos进行application.yml配置管理详解

    SpringBoot使用Nacos进行application.yml配置管理详解

    Nacos是阿里巴巴开源的一个微服务配置管理和服务发现的解决方案,下面我们来看看在SpringBoot中如何使用Nacos进行application.yml配置管理吧
    2025-03-03
  • Spring Reactor基本介绍和案例解析

    Spring Reactor基本介绍和案例解析

    Spring Reactor 是一个响应式编程框架,非常适合类似 MXN 这样的流程编排系统,也是 Java 中异步编程的一种补充,这篇文章主要介绍了Spring Reactor基本介绍和案例解析,需要的朋友可以参考下
    2024-07-07
  • Java中break、continue、return在for循环中的使用

    Java中break、continue、return在for循环中的使用

    这篇文章主要介绍了break、continue、return在for循环中的使用,本文是小编收藏整理的,非常具有参考借鉴价值,需要的朋友可以参考下
    2017-11-11
  • Java实现获取cpu、内存、硬盘、网络等信息的方法示例

    Java实现获取cpu、内存、硬盘、网络等信息的方法示例

    这篇文章主要介绍了Java实现获取cpu、内存、硬盘、网络等信息的方法,涉及java使用第三方jar包针对本机硬件的cpu、内存、硬盘、网络信息等的读取相关操作技巧,需要的朋友可以参考下
    2018-06-06
  • Java使用多线程处理未知任务数的方案介绍

    Java使用多线程处理未知任务数的方案介绍

    这篇文章主要为大家详细介绍了Java如何使用多线程实现处理未知任务数,文中的示例代码讲解详细,感兴趣的小伙伴可以跟随小编一起学习一下
    2025-03-03
  • Java高并发系统限流算法的实现

    Java高并发系统限流算法的实现

    这篇文章主要介绍了Java高并发系统限流算法的应用,在开发高并发系统时有三把利器用来保护系统:缓存、降级和限流,限流可以认为服务降级的一种,限流是对系统的一种保护措施,需要的朋友可以参考下
    2022-05-05

最新评论