LarryDpk
发布于 2021-03-31 / 1510 阅读
0

使用SpringBootCondition更自由地定义条件化配置

1 条件化配置

Spring提供了多种实现化条件化配置的选择,如ConditionalOnPropertyConditionalOnClass等。

用法如下:

@ConditionalOnProperty(prefix = "pkslow", name = "service", havingValue = "larry")

还有:

@ConditionalOnBean(仅仅在当前上下文中存在某个对象时,才会实例化一个Bean)
@ConditionalOnClass(某个class位于类路径上,才会实例化一个Bean)
@ConditionalOnExpression(当表达式为true的时候,才会实例化一个Bean)
@ConditionalOnMissingBean(仅仅在当前上下文中不存在某个对象时,才会实例化一个Bean)
@ConditionalOnMissingClass(某个class类路径上不存在的时候,才会实例化一个Bean)
@ConditionalOnNotWebApplication(不是web应用)

但有时候我们需要更灵活的自定义条件配置,这时可以通过继承SpringBootCondition类来实现。

2 继承SpringBootCondition

自己根据需求实现自己的判断逻辑,我的实现如下:

public class PkslowCondition extends SpringBootCondition {
  @Override
  public ConditionOutcome getMatchOutcome(ConditionContext context, AnnotatedTypeMetadata metadata) {
    BindResult<List<String>> maxBindResult = Binder.get(context.getEnvironment()).bind("pkslow.condition.max", Bindable.listOf(String.class));
    BindResult<List<String>> minBindResult = Binder.get(context.getEnvironment()).bind("pkslow.condition.min", Bindable.listOf(String.class));

    if ( (maxBindResult.isBound() && !maxBindResult.get().isEmpty()) && (minBindResult.isBound() && !minBindResult.get().isEmpty()) ) {
      List<String> maxs = maxBindResult.get();
      List<String> mins = minBindResult.get();
      int max = Integer.parseInt(maxs.get(0));
      int min = Integer.parseInt(mins.get(0));

      if (max < 1000 && min > 0) {
        return ConditionOutcome.match();
      }

    }

    return ConditionOutcome.noMatch("pkslow.condition.max/pkslow.condition.min not matches");
  }
}

表示需要有配置属性pkslow.condition.max/pkslow.condition.min才会生效,并且要求max<1000min>0

3 使用

完成自定义的条件类后,就可以使用它来限定一个配置类是否要生效了,使用如下:

@Conditional(PkslowCondition.class)
@Configuration
public class PkslowConfig {
    @PostConstruct
    public void postConstruct() {
        System.out.println("PkslowConfig called");
    }
}

4 总结

代码请查看:https://github.com/LarryDpk/pkslow-samples


参考:springboot之使用SpringBootCondition