1.场景描述
业务系统中,配置文件不同,使用的业务逻辑也不同。我们可以使用模板方法模式把业务分成多个service。如下图

1.png
sence.cascade.test=1配置为1时使用serviceImpl1 ,为2时使用serviceImpl2,但是不想在代码运行的时候总是判断使用哪个service。可以使用ConditionalOnProperty
2.ConditionalOnProperty源码说明
@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;
}
3.如何使用
AbstractServiceImpl1-- 默认使用的方法
@Service
@ConditionalOnProperty(value = "sence.cascade.test", havingValue = "0")
public class AbstractUserServiceImpl extends AbstractUserServiceImpl {
@Override
public String test(){
return "AbstractUserServiceImpl";
}
}
UserServiceImpl1--
@Service
@ConditionalOnProperty(value = "sence.cascade.test", havingValue = "1")
public class UserServiceImpl1 extends AbstractUserServiceImpl {
@Override
public String test(){
return "UserServiceImpl1";
}
}
UserServiceImpl2--
@Service
@ConditionalOnProperty(value = "sence.cascade.test", havingValue = "2")
public class UserServiceImpl2 extends AbstractUserServiceImpl {
@Override
public String test(){
return "UserServiceImpl2";
}
}
使用时,直接注入service,会根据配置文件来选择哪个service生效
@Autowired
private AbstractUserServiceImpl userService;
@Test
void testProperties() {
String str = userService.test();
System.out.println(str);
}
4.上面是针对一个配置项,如果有多个配置项,可以使用@ConditionalOnExpression,来根据表达式来选择使用哪个service
ConditionalOnExpression 源码说明
@Retention(RetentionPolicy.RUNTIME)
@Target({ ElementType.TYPE, ElementType.METHOD })
@Documented
@Conditional(OnExpressionCondition.class)
public @interface ConditionalOnExpression {
/**
* The SpEL expression to evaluate. Expression should return {@code true} if the
* condition passes or {@code false} if it fails.
* @return the SpEL expression
*/
String value() default "true";
}
使用起来也比较方便
@ConditionalOnExpression("!${sence.cascade.enable:false} && ${sence.cascade.test:0} == 2")