自定义Conditional和Bean加载策略

工作的时候环境分为线上、测试、开发环境等,在springboot中可以通过在application.yml或者application.properties修改spring.profiles.avtive参数进行配置,有这么一种需求,对于不同的环境,需要加载的Bean也可能不同,不同的环境可能需要的加载及装配策略也是不一样的,我们需要满足不同环境的配置需求,springboot目前提供这么几种方法用于动态的根据环境进行Bean的加载

使用@Profile
最简单的一种就是@Profile注解,例子如下:

@Profile(value = "dev")
@Component
public class ProfileTest{}

这时把spring.profiles.avtive修改成dev,springboot启动则会加载ProfileTest,否则不会加载,这种方式简单方便,但是基于注解的方式不能动态且定义复杂加载规则,这时候可以使用第二种方法

使用Conditional接口和@Conditional注解
如果你需要定义比较复杂的加载策略,需求根据Bean名称,配置参数,又或者类、方法、甚至是属性上的注解等信息进行加载,那么通过Conditional接口可以很好的满足这种需求,下面我通过Conditional实现@Profile注解的功能

首先可以自定义一个注解:

@Target(ElementType.TYPE)
@Retention(RetentionPolicy.RUNTIME)
@Documented
@Conditional(value = {UseCondition.class})
public @interface Use {
  String[] value() default {};
}

然后写一个Conditional实现,需要Condition接口的matches方法,然后可以通过ConditionContext 获取到Environment对象,用于获取yml、properties的配置信息,实现如下:

public class UseCondition implements Condition {
  @Override
  public boolean matches(ConditionContext context, AnnotatedTypeMetadata metadata) {
    Environment environment = context.getEnvironment();
    String[] activeProfiles = environment.getActiveProfiles();
    MergedAnnotations annotations = metadata.getAnnotations();
    MergedAnnotation<Use> useMergedAnnotation = annotations.get(Use.class);
    String[] useValue = useMergedAnnotation.getStringArray("value");
    return Arrays.stream(useValue).anyMatch(s -> Arrays.asList(activeProfiles).contains(s));
  }
}

然后注解放到类上使用即可

@Use(value = "dev")
@Component
public class ProfileTest{}

SpringBoot会自动加载Use的条件实现,并且根据条件判断是否对Bean进行加载

上一篇:【SpringBoot_ANNOTATIONS】06 @Conditional 按照条件注册bean


下一篇:【SpringBoot2 从0开始】底层注解 - @Conditional、@ImportResource