Spring Conditional原理与实例

1. 简介

Spring4开始添加了一个Condition接口：

1@FunctionalInterface
2public interface Condition {
3	boolean matches(ConditionContext context, AnnotatedTypeMetadata metadata);
4}

condition就是条件的意思，就是检查条件是否满足，检查什么信息的什么条件呢？

信息是从ConditionContext条件上下文中获取：

BeanDefinitionRegistry：BeanDefinition注册中心
ConfigurableListableBeanFactory：Spring容器
Environment：环境、包括环境变量、环境属性、系统变量等
ResourceLoader：资源加载器
ClassLoader：类加载器

条件是从AnnotatedTypeMetadata注解元数据获取，所以一看这个接口就可以猜到它是专门为注解扫描准备的，所以还配套了一个@Conditional注解。

如果上面的说明有点抽象，那我们下面看一个简单的例子来加强理解。

2. 自定义Condition

1import org.springframework.context.annotation.Condition;
2import org.springframework.context.annotation.ConditionContext;
3import org.springframework.core.type.AnnotatedTypeMetadata;
4
5public class MomCondition implements Condition {
6
7    @Override
8    public boolean matches(ConditionContext conditionContext, AnnotatedTypeMetadata annotatedTypeMetadata) {
9        String dw = conditionContext.getEnvironment().getProperty("带娃");
10        return "mom".equalsIgnoreCase(dw);
11    }
12}

非常简单，继承Condition接口，实现matches方法，根据环境、容器等信息检查是否满足条件，如果满足返回true，不满足就返回false。

上面的例子就是检查环境属性中有没有"带娃"这个属性，如果有并且等于"mom"则说明满足条件。

那这个Condition到底咋用呢？

接下来，就该@Conditional这个注解上场发挥点作用了。

3. @Conditional的原理

1import org.springframework.context.annotation.Bean;
2import org.springframework.context.annotation.Conditional;
3import org.springframework.context.annotation.Configuration;
4import vip.mycollege.spring.condition.MomCondition;
5import vip.mycollege.spring.condition.PapaCondition;
6
7@Configuration
8public class ConditionConfig {
9
10    @Conditional(MomCondition.class)
11    @Bean
12    public String mom(){
13        return "allen";
14    }
15
16    @Conditional(PapaCondition.class)
17    @Bean
18    public String papa(){
19        return "bob";
20    }
21}

@Conditional注解可以放在方法和类上。

放在方法上和@Bean一起使用，表示如果@Conditional注解的参数类matches方法为true这创建这个Bean实例，否则不创建。
放在类上结合@Configuration、@ComponentScan判断被注解的类是否需要创建

Spring具体逻辑入口：

ConfigurationClassBeanDefinitionReader.loadBeanDefinitionsForBeanMethod：处理@Bean
ConfigurationClassParser.processConfigurationClass(ConfigurationClass)：处理@Configuration
ConfigurationClassParser.doProcessConfigurationClass(ConfigurationClass, SourceClass)：处理@ComponentScan

处理Condition具体逻辑实现的类与方法：

ConditionEvaluator#shouldSkip

上面的Condition可以通过下面的代码做为启动入口测试一下：

1import org.springframework.context.annotation.AnnotationConfigApplicationContext;
2import vip.mycollege.spring.config.ConditionConfig;
3
4public class AnnotationStart {
5
6    public static void main(String[] args) {
7        System.setProperty("带娃","papa");
8        System.setProperty("带娃","mom");
9        AnnotationConfigApplicationContext context = new AnnotationConfigApplicationContext(ConditionConfig.class);
10        System.out.println(context.containsBean("mom"));
11        System.out.println(context.containsBean("papa"));
12    }
13}

4. 当Condition遇上SpringBoot

Spring中的Condition看似平平无奇，但是这个平平无奇指的是古天乐的那个平平无奇。

不信，你看当Condition遇上SpringBoot之后发生了怎样的奇迹。

从此，妈妈再也不用担心我写个Hello World都要研究半天配置和依赖了。

SpringBoot的Condition核心是：SpringBootCondition

就是用模板方法模式封装了一下，主要是为了记录日志和做Condition匹配报告输出。

在SpringBoot中自定义Condition，只需要继承SpringBootCondition，然后基本上就是把matches逻辑放在getMatchOutcome方法中就可以了。

SpringBoot中一些Condition：

Conditional注解

作用

@ConditionalOnJndi

在JNDI存在的条件下查找指定的位置

@ConditionalOnBean

当容器里有指定Bean的条件下

@ConditionalOnJava

基于JVM版本作为判断条件

@ConditionalOnClass

当类路径下有指定的类的条件下

@ConditionalOnProperty

指定的属性是否有指定的值

@ConditionalOnResource

类路径是否有指定的值

@ConditionalOnExpression

基于SpEL表达式为true的时候作为判断条件才去实例化

@ConditionalOnMissingBean

当容器里没有指定Bean的情况下

@ConditionalOnMissingClass

当容器里没有指定类的情况下

@ConditionalOnWebApplication

当前项目时Web项目的条件下

@ConditionalOnOnSingleCandidate

当指定Bean在容器中只有一个，或者有多个但是指定首选的Bean

@ConditionalOnNotWebApplication

当前项目不是Web项目的条件下