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 接口

总结

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

相关文章

  • Java 数组元素倒序的三种方式(小结)

    Java 数组元素倒序的三种方式(小结)

    这篇文章主要介绍了Java 数组元素倒序的三种方式(小结),文中通过示例代码介绍的非常详细,对大家的学习或者工作具有一定的参考学习价值,需要的朋友们下面随着小编来一起学习学习吧
    2019-09-09
  • 基于Lombok集成springboot遇到的坑

    基于Lombok集成springboot遇到的坑

    这篇文章主要介绍了Lombok集成springboot遇到的坑,具有很好的参考价值,希望对大家有所帮助。如有错误或未考虑完全的地方,望不吝赐教
    2021-12-12
  • 详解Java中List的正确的删除方法

    详解Java中List的正确的删除方法

    这篇文章主要为大家详细介绍了Java中List的正确的删除方法,文中的示例代码讲解详细,对我们学习有一定帮助,需要的可以参考一下
    2022-05-05
  • Java常用函数式接口总结

    Java常用函数式接口总结

    今天给大家带来的是关于Java的相关知识,文章围绕着Java常用函数式接口展开,文中有非常详细的介绍及代码示例,需要的朋友可以参考下
    2021-06-06
  • springboot的maven多模块混淆jar包的实现方法

    springboot的maven多模块混淆jar包的实现方法

    springboot可以使用proguard-maven-plugin 这个插件 在 pom.xml 中自定义proguard 的指令,本文基于 springboot + maven + proguard 的maven多模块架构进行代码混淆,需要的朋友可以参考下
    2024-03-03
  • Spring解决循环依赖的方法(三级缓存)

    Spring解决循环依赖的方法(三级缓存)

    今天,我们要说的是spring是如何解决循环依赖的。对于一个问题说解决之前,我们首先要先明确形成问题的本因。那么循环依赖,何为循环依赖呢?感兴趣的朋友跟随小编一起看看吧
    2021-11-11
  • java使用监听器实现一个统计网站在线人数的示例

    java使用监听器实现一个统计网站在线人数的示例

    本文主要介绍了java使用监听器实现一个统计网站在线人数的示例,具有一定的参考价值,有需要的朋友可以了解一下。
    2016-10-10
  • Java线程安全的计数器简单实现代码示例

    Java线程安全的计数器简单实现代码示例

    这篇文章主要介绍了Java线程安全的计数器简单实现代码示例,具有一定参考价值,需要的朋友可以了解下。
    2017-10-10
  • 使用jdk1.8实现将list根据指定的值去分组的操作

    使用jdk1.8实现将list根据指定的值去分组的操作

    这篇文章主要介绍了使用jdk1.8实现将list根据指定的值去分组的操作,具有很好的参考价值,希望对大家有所帮助。一起跟随小编过来看看吧
    2020-10-10
  • 使用MyBatis返回其它类对象的字段处理

    使用MyBatis返回其它类对象的字段处理

    这篇文章主要介绍了使用MyBatis返回其它类对象的字段处理方式,具有很好的参考价值,希望对大家有所帮助。如有错误或未考虑完全的地方,望不吝赐教
    2021-08-08

最新评论