Spring Boot的ConditionalOnProperty注解

最新推荐文章于 2025-07-25 17:30:15 发布

shixin_li

最新推荐文章于 2025-07-25 17:30:15 发布

阅读量4.7k

点赞数 2

CC 4.0 BY-SA版权

分类专栏： Spring Boot 文章标签： Spring Boot ConditionalOnProperty

本文链接：https://blog.youkuaiyun.com/shixin_li/article/details/80532866

Spring Boot 专栏收录该内容

1 篇文章

订阅专栏

本文详细介绍了Spring Boot中的@ConditionalOnProperty注解，解释了如何通过此注解控制配置项的生效条件，包括如何指定属性名、属性值及缺失处理等。

摘要生成于 C知道，由 DeepSeek-R1 满血版支持，前往体验 >

Spring boot中有个注解@ConditionalOnProperty，这个注解能够控制某个configuration是否生效。

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;
import org.springframework.core.env.Environment;

@Retention(RetentionPolicy.RUNTIME)
@Target({ ElementType.TYPE, ElementType.METHOD })
@Documented
@Conditional(OnPropertyCondition.class)
public @interface ConditionalOnProperty {
    //数组，获取对应property名称的值，与name不可同时使用。 作用：value单独使用时：当对应property名称的值为false时，该configuration不生效；当对应property名称的值为除false之外的值时，该configuration生效
	String[] value() default {};

	//字符串，property名称的前缀，可有可无,可以与name组合使用
	String prefix() default "";

	//数组，property完整名称或部分名称（可与prefix组合使用，组成完整的property名称），与value不可同时使用。 作用与value一样
	String[] name() default {};

	//可与name、value（name和value不能同时存在）组合使用，比较获取到对应property名称的值与havingValue给定的值是否相同：如果相同，该configuration生效，反之，不生效 
	String havingValue() default "";

        //缺少该property时是否可以加载。如果为true，没有该property也会正常加载；反之报错
	boolean matchIfMissing() default false;

	//不需要管它
	boolean relaxedNames() default true;

}