@Conditional的使用及使用场景

Posted 2021-02-04 liangluojun

@Conditional的使用

• 作用：根据条件，决定类是否加载到Spring Ioc容器中，在SpringBoot中有大量的运用
• 应用场景：在一些需要条件满足才是实例化的类中，使用此注解，我曾经在项目中需要根据不同的场景使用不同的mq中间件的时候使用过，在mq的实例化bean上，加上此注解，根据配置文件的不同，来决定这个bean是否加载至ioc容器中。

使用方法

1. 实现Conditional接口, 实现matches方法。

   public class MqExistsCondition implements Condition{
   
    @Override
    public boolean matches(ConditionContext context,AnnotatedTypeMetadata metadata)     {
        Environment environment = context.getEnvironment();
        //从这里获取配置文件中 active 的值，根据当前的active值决定是否加载类
           String[] activeProfiles = environment.getActiveProfiles();
        for (String active : activeProfiles) {
            if(active.equals(ActiveEnum.open_active.getActive().toString())){
                return true;
            }
        }
        return false;
    }
   }

2. 在需要判断条件的bean上，加上@Conditional(TestExistsCondition.class) 即可在满足条件的时候加载对应的类。

    @Bean
       @Conditional(TestMqExistsCondition.class)
       public TestBean getTestBean(){
        TestBean testBean = new TestBean();
        return testBean;
       }

其他派生的的conditional

@ConditionalOnClass

? 如果此class不存在

@ConditionalOnMissingBean

? 只有对应的ban在系统中都没有被创建，它修饰的初始化代码块才会执行，用户自己手动创建的bean优先

@ConditionalOnBean

仅仅在当前上下文中存在某个对象时，才会实例化一个Bean。

@ConditionalOnClass

? 某个class位于类路径上，才会实例化一个Bean

@ConditionalOnExpression

? 当表达式为true的时候，才会实例化一个Bean。

比如：

@ConditionalOnExpression("true")

@ConditionalOnExpression("${my.controller.enabled:false}")

@ConditionalOnMissingBean

? 仅仅在当前上下文中不存在某个对象时，才会实例化一个Bean

@ConditionalOnMissingClass

某个class类路径上不存在的时候，才会实例化一个Bean

@ConditionalOnNotWebApplication

? 不是web应用