【@Conditional】@Conditional注解使用方法

最新推荐文章于 2023-05-19 15:42:09 发布

原创最新推荐文章于 2023-05-19 15:42:09 发布 · 668 阅读

0 ·

CC 4.0 BY-SA版权

文章标签：

#springboot

java 同时被 2 个专栏收录

36 篇文章

订阅专栏

开发框架

10 篇文章

订阅专栏

本文讲解如何使用Spring的Condition接口自定义Bean注入条件，通过示例介绍如何确保JdbcTemplate存在时才注入MyService。同时，列举了多种条件化注解，如@ConditionalOnBean和@ConditionalOnClass等，用于配置生效条件。

举例

通过Condition可以自定义注入bean的条件，如：注入一个MyService的bean，前提条件是JdbcTemplate这个bean要注入成功，代码如下：

条件类

public class JdbcTemplateCondition implements Condition {
    @Override
    public boolean matches(ConditionContext contextm AnnotatedTypeMetadata metadata) {
        try {
            context.getClassLoader().loadClass("org.springframework.jdbc.core.JdbcTemplate");
            return true;
        } catch (Exception e) {
            return false;
        }
    }
}

准备注入MyService，加前提条件

@Conditional(JdbcTemplateCondition.class)
public MyService myService() {...}

以上代码的意思是只有当JdbcTemplateCondition类的条件成立时才会创建MyService这个bean。也就是说MyService bean创建的条件是Classpath里有JdbcTemplate，否则这个bean的声明就会被忽略。

补充

条件化注解	配置生效条件
@ConditionalOnBean	配置了某个指定的类
@ConditionalOnMissBean	没有配置特定的类
@ConditionalOnClass	Classpath里有指定的类
@ConditionalOnMissClass	Classpath里缺少指定的类
@ConditionalOnExpression	给定的Spring Expression Language(SpEl)表达式计算结果为true
@ConditionalOnJava	Java的版本匹配特定值或者一个范围值
@ConditionalOnJndi	参数中给定的JNDI位置必须存在一个，如果没有给参数，则要有JDNI InitialContext
@ConditionalOnProperty	指定的配置属性要有一个明确的值
@ConditionalOnResource	Classpath里有指定的资源
@ConditionalOnWebApplication	这是一个web应用程序
@ConditionalOnNotWebApplication	这不是一个web应用程序

springboot实例

@Configuration
@ConditionalOnClass({DataSource.class, EmbeddedDatabaseType.class})
@EnableConfigurationProperties(DataSourceProperties.class)
@Import({Register.class, DataSourcePoolMetadataProvidersConfiguration.class})
public class DataSourceAutoConfiguration {...}

DataSourceAutoConfiguration添加了@Configuration注解，它从其他配置类里导入了一些额外的配置，还自己定义了一些bean。最重要的是，DataSourceAutoConfiguration上添加了@ConditionalOnClass注解，要求Classpath里必须有DataSource和EmbeddedDatabaseType。如果它们不存在，条件就不成立，DataSourceAutoConfiguration提供的配置都会被忽略掉。