【SpringBoot】根据条件加载Bean之@ConditionalOnExpression

Spring Boot作为当今最流行的Java开发框架之一，为开发者提供了诸多便捷的特性。其中，@ConditionalOnExpression注解是Spring Boot条件注解中的重要一员，它允许我们在配置类中根据表达式的结果来决定是否创建Bean。

本文将详细介绍@ConditionalOnExpression注解的含义、参数意义、源码分析及使用场景。

一、@ConditionalOnExpression注解的含义

@ConditionalOnExpression是Spring Boot提供的一个条件注解，用于根据SpEL（Spring Expression Language）表达式的结果来决定是否创建Bean。当表达式的值为true时，对应的Bean将被创建；否则，不会被创建。

二、参数的意义

@ConditionalOnExpression注解只有一个参数：value。该参数用于指定SpEL表达式，其类型为String。以下是一个简单的示例：

@Configuration
public class MyConfig {
    @Bean
    @ConditionalOnExpression("${myProperty} == 'true'")
    public MyBean myBean() {
        return new MyBean();
    }
}

在这个例子中，${myProperty}是一个配置属性，当其值为“true”时，MyBean这个Bean会被创建。

三、源码分析

@ConditionalOnExpression注解的源码如下：

@Target({ElementType.TYPE, ElementType.METHOD})
@Retention(RetentionPolicy.RUNTIME)
@Documented
@Conditional(OnExpressionCondition.class)
public @interface ConditionalOnExpression {
    /**
     * The SpEL expression to evaluate. Expression should return 'true' if the condition passes.
     * @return the SpEL expression
     */
    String value();
}

从源码可以看出，@ConditionalOnExpression注解使用了@Conditional注解，并将OnExpressionCondition.class作为参数。这意味着，当@ConditionalOnExpression注解被使用时，OnExpressionCondition类将负责评估表达式。

OnExpressionCondition类的核心方法如下：

@Override
public boolean matches(ConditionContext context, AnnotatedTypeMetadata metadata) {
    String expression = (String) metadata.getAnnotationAttributes(getAnnotationClass().getName()).get("value");
    ExpressionParser parser = new SpelExpressionParser();
    StandardEvaluationContext evaluationContext = new StandardEvaluationContext();
    evaluationContext.setBeanResolver(new BeanFactoryResolver(context.getBeanFactory()));
    return parser.parseExpression(expression).getValue(evaluationContext, Boolean.class);
}

这段代码首先获取@ConditionalOnExpression注解中的value值，然后使用SpEL解析器解析表达式，并设置EvaluationContext。最后，通过getValue方法获取表达式的值，如果为true，则返回true，表示条件匹配；否则返回false。

四、使用场景

1. 根据配置文件动态创建Bean

在实际项目中，我们可能需要根据配置文件中的不同值来创建不同的Bean。例如，根据不同的环境（开发、测试、生产）创建不同的数据源。使用@ConditionalOnExpression注解可以实现这一需求。

@Configuration
public class DataSourceConfig {
    @Bean
    @ConditionalOnExpression("${env} == 'dev'")
    public DataSource devDataSource() {
        // 创建开发环境数据源
    }
    @Bean
    @ConditionalOnExpression("${env} == 'test'")
    public DataSource testDataSource() {
        // 创建测试环境数据源
    }
    @Bean
    @ConditionalOnExpression("${env} == 'prod'")
    public DataSource prodDataSource() {
        // 创建生产环境数据源
    }
}

2. 动态开启或关闭功能

在某些场景下，我们可能需要根据配置动态开启或关闭某些功能。例如，根据配置决定是否开启日志记录功能。

@Configuration
public class LogConfig {
    @Bean
    @ConditionalOnExpression("${enableLog} == 'true'")
    public LogAspect logAspect() {
        // 创建日志切面
    }
}

3. 复杂条件判断

在某些复杂场景下，我们需要根据多个条件判断来决定是否创建Bean。使用@ConditionalOnExpression注解可以轻松实现这一需求。

@Bean
@ConditionalOnExpression("${condition1} && ${condition2} || ${condition3}")
public MyBean myBean() {
    // 创建Bean
}

五、总结

@ConditionalOnExpression注解是Spring Boot中一个强大的条件注解，它允许我们根据SpEL表达式的结果来决定是否创建Bean。通过本文的介绍，我们了解了@ConditionalOnExpression注解的含义、参数意义、源码分析及使用场景。
在实际项目中，合理使用@ConditionalOnExpression注解，可以让我们更加灵活地控制Bean的创建，提高代码的可维护性。