Springboot 按条件装配类
ConditionalOnProperty注解
@ConditionalOnProperty注解用于类装载时检查程序是否注入了某变量,如果符合条件则注册bean工厂,若否则不能注入。
@Retention(RetentionPolicy.RUNTIME)
@Target({ ElementType.TYPE, ElementType.METHOD })
@Documented
@Conditional(OnPropertyCondition.class)
public @interface ConditionalOnProperty {
// 数组,获取对应property名称的值,与name不可同时使用
String[] value() default {};
// 配置属性名称的前缀,比如spring.http.encoding
String prefix() default "";
// 数组,配置属性完整名称或部分名称
// 可与prefix组合使用,组成完整的配置属性名称,与value不可同时使用
String[] name() default {};
// 可与name组合使用,比较获取到的属性值与havingValue给定的值是否相同,相同才加载配置
String havingValue() default "";
// 缺少该配置属性时是否可以加载。如果为true,没有该配置属性时也会正常加载;反之则不会生效
boolean matchIfMissing() default false;
}
一个简单的例子 是用于stub中,通过不同环境的yml中的变量,我们可以决定stub类在哪个环境生效
@Primary
@Component
@ConditionalOnProperty(name="mock.XXX",havingValue="stub")
public class XXX implements XXXFeign {
...
}
比如application-dev.yml中声明对应变量即可使dev环境该类生效,而其余环境失效
mock:
XXX: "stub"
ConditionalOnClass注解
与上面的注解相似,不过判断条件从属性变成了类
简单例子是用于feign在更换了OkHttp时的装配
@Configuration
@ConditionalOnClass({Feign.class,OkHttpClient.class})
public class FeignClientConfig {
@Bean
public Client feignClient(OkHttpClient okHttpClient) {
return new feign.okhttp.OkHttpClient(okHttpClient);
}
}