本文主要是介绍spring常用注解(三)@ConditionalOnProperty,希望对大家解决编程问题提供一定的参考价值,需要的开发者们随着小编来一起学习吧!
一、介绍
ConditionalOnProperty
ConditionalOnResource
ConditionalOnBean
ConditionalOnClass
ConditionalOnMissingBean
ConditionalOnMissingClass
其中@ConditionalOnProperty是最为常见的一种,尤其用在自动配置类中。源码:
@Retention(RetentionPolicy.RUNTIME)
@Target({ ElementType.TYPE, ElementType.METHOD })
@Documented
@Conditional(OnPropertyCondition.class)
public @interface ConditionalOnProperty {//name的别名,和value不可同时使用String[] value() default {};/**配置项的前缀,例如完整的配置是config.person.enable=true* 那 prefix=“config.person”*/String prefix() default "";/**配置项的属性,例如完整的配置是config.person.enable=true在前面已经设置 prefix=“config.person”那么 name=“enable”;如果prefix没有设置,那么name可以是整个配置项,例如下面:name=“config.person.enable”,效果和上面的一样*/String[] name() default {};/*** 会将配置文件中的值和havingValue的值对比,如果一样则加载Bean,例如:* * config.person.enable=true,havingValue=“true”,加载Bean* * config.person.enable=false,havingValue=“false”,加载Bean* * config.person.enable=ok,havingValue=“ok”,加载Bean* * config.person.enable=false,havingValue=“true”,不加载Bean* * config.person.enable=ok,havingValue=“no”,不加载Bean* * 当然havingValue也可以不设置,只要配置项的值不是false或“false”,都加载Bean,例如:* * config.person.enable=ok,不设置havingValue,加载Bean* * config.person.enable=false,不设置havingValue,不加载Bean*/String havingValue() default "";/*** 如果在配置文件中没有该配置项,是否加载Bean*/boolean matchIfMissing() default false;}
二、demo
1、
import lombok.Builder;
import lombok.Data;@Data
@Builder
public class MenuDTO {private String name;private String url;
}
import lombok.extern.slf4j.Slf4j;
import org.demo.annotation.dto.MenuDTO;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;@Configuration
@Slf4j
public class MyBeanConfig {@Beanpublic MenuDTO menuDTO(){log.info("===MenuDTO init start===");return MenuDTO.builder().name("初始化name").url("初始化url").build();}
}
启动时会自动注入Bean:
2、现在加入开关
import lombok.extern.slf4j.Slf4j;
import org.demo.annotation.dto.MenuDTO;
import org.springframework.boot.autoconfigure.condition.ConditionalOnProperty;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;@Configuration
@Slf4j
public class MyBeanConfig {@Bean@ConditionalOnProperty(name = "config.switch",matchIfMissing = true)public MenuDTO menuDTO(){log.info("===MenuDTO init start===");return MenuDTO.builder().name("初始化name").url("初始化url").build();}
}
(1)设置为true
config.switch = true
启动项目后台打印同上。
(2)不设置
server.port=3333
server.servlet.context-path=/annotationDemo#config.switch = false
启动项目后台打印同上,因为设置了matchIfMissing = true
(3)config.switch 改为false,则启动项目不打印,说明bean未执行初始化
这篇关于spring常用注解(三)@ConditionalOnProperty的文章就介绍到这儿,希望我们推荐的文章对编程师们有所帮助!