Spring Boot 条件注解详情

2024-10-01 21:31:16

@Target({ElementType.TYPE, ElementType.METHOD})
@Retention(RetentionPolicy.RUNTIME)
@Documented
public @interface Conditional {

    /**
     * 所有用于匹配的Condition接口(实现该接口的类)，只有这些类都返回true才认为是满足条件
     */
    Class<? extends Condition>[] value();
}

@Conditional注解可以添加在@Configuration、@Component、@Service等修饰的类上用于控制对应的Bean是否需要创建，或者添加在@Bean修饰的方法上用于控制方法对应的Bean是否需要创建。

@Conditional添加在@Configuration修饰的类上，用于控制该类和该类里面所有添加的@Bean方法对应的Bean是否需要创建。

一 @Conditional扩展注解

为了方便我们的使用Spring Boot对@Conditional条件注解做了一些扩展，提供了一些很实用的扩展性条件注解。

上面的扩展注解我们可以简单的分为以下几类：

Bean作为条件：@ConditionalOnBean、@ConditionalOnMissingBean、@ConditionalOnSingleCandidate。
类作为条件：@ConditionalOnClass、@ConditionalOnMissingClass。
SpEL表达式作为条件：@ConditionalOnExpression。
JAVA版本作为条件: @ConditionalOnJava
配置属性作为条件：@ConditionalOnProperty。
资源文件作为条件：@ConditionalOnResource。
是否Web应用作为判断条件：@ConditionalOnWebApplication、@ConditionalOnNotWebApplication。

1.1 Bean作为条件

1.1.1 @ConditionalOnBean

@ConditionalOnBean对应的Condition处理类是OnBeanCondition。如果Spring容器里面存在指定的Bean则生效。

@ConditionalOnBean配置参数

@Target({ ElementType.TYPE, ElementType.METHOD })
@Retention(RetentionPolicy.RUNTIME)
@Documented
@Conditional(OnBeanCondition.class)
public @interface ConditionalOnBean {
    /**
     * 需要作为条件的类的Class对象数组
     */
    Class<?>[] value() default {};
    /**
     * 需要作为条件的类的Name, Class.getName()
     */
    String[] type() default {};

    /**
     * (用于指定注解修饰的Bean)条件所需的注解类
     */
    Class<? extends Annotation>[] annotation() default {};
    /**
     * Spring容器中Bean的名字
     */
    String[] name() default {};
    /**
     * 搜索容器层级，当前容器，父容器
     */
    SearchStrategy search() default SearchStrategy.ALL;

    /**
     * 可能在其泛型参数中包含指定Bean类型的其他类
     */
    Class<?>[] parameterizedContainer() default {};
}

1.1.2 @ConditionalOnMissingBean

@ConditionalOnMissingBean对应的Condition实现类是OnBeanCondition。如果Spring容器里面不存在指定的Bean则生效。

@ConditionalOnMissingBean配置参数

@Target({ ElementType.TYPE, ElementType.METHOD })
@Retention(RetentionPolicy.RUNTIME)
@Documented
@Conditional(OnBeanCondition.class)
public @interface ConditionalOnMissingBean {
    /**
     * 需要作为条件的类的Class对象数组
     */
    Class<?>[] value() default {};

    /**
     * 需要作为条件的类的Name, Class.getName()
     */
    String[] type() default {};

    /**
     * 匹配Bean的时候需要忽视的Class对象数组，一般是父类
     * @ConditionalOnMissingBean(value = JdbcFactory.class, ignored = MySqlDefaultFactory.class)
     */
    Class<?>[] ignored() default {};

    /**
     * 匹配Bean的时候需要忽视的类的Name, Class.getName()
     */
    String[] ignoredType() default {};
    /**
     * (用于指定注解修饰的Bean)条件所需的注解类
     */
    Class<? extends Annotation>[] annotation() default {};

    /**
     * Spring容器中Bean的名字
     */
    String[] name() default {};

    /**
     * 搜索容器层级，当前容器，父容器
     */
    SearchStrategy search() default SearchStrategy.ALL;

    /**
     * 可能在其泛型参数中包含指定Bean类型的其他类
     */
    Class<?>[] parameterizedContainer() default {};
}

比如如下的实例，当容器里面不存在redisTemplate对应的Bean的时候，就会创建一个RedisTemplate添加到容器里面去。

    @Bean
    @ConditionalOnMissingBean(name = "redisTemplate")
    public RedisTemplate<Object, Object> redisTemplate(RedisConnectionFactory redisConnectionFactory)
            throws UnknownHostException {
        RedisTemplate<Object, Object> template = new RedisTemplate<>();
        template.setConnectionFactory(redisConnectionFactory);
        return template;
    }

1.1.3 @ConditionalOnSingleCandidate

@ConditionalOnSingleCandidate对应的Condition处理类是OnBeanCondition。如果当指定Bean在容器中只有一个，或者虽然有多个但是指定首选Bean的时候则生效。

@ConditionalOnSingleCandidate配置参数

@Target({ ElementType.TYPE, ElementType.METHOD })
@Retention(RetentionPolicy.RUNTIME)
@Documented
@Conditional(OnBeanCondition.class)
public @interface ConditionalOnSingleCandidate {
    /**
     * 需要作为条件的类的Class对象
     */
    Class<?> value() default Object.class;

    /**
     * 需要作为条件的类的Name, Class.getName()
     */
    String type() default "";

    /**
     * 搜索容器层级，当前容器，父容器
     */
    SearchStrategy search() default SearchStrategy.ALL;
}

1.2 类作为条件

1.2.1 @ConditionalOnClass

@ConditionalOnClass对应的Condition处理类是OnClassCondition。如果当前类路径下面有指定的类的时候则生效。

@ConditionalOnClass配置属性介绍

@Target({ ElementType.TYPE, ElementType.METHOD })
@Retention(RetentionPolicy.RUNTIME)
@Documented
@Conditional(OnClassCondition.class)
public @interface ConditionalOnClass {
    /**
     * 需要作为条件的类的Class对象数组
     */
    Class<?>[] value() default {};
    /**
     * 需要作为条件的类的Name, Class.getName()
     */
    String[] name() default {};
}

1.2.2 @ConditionalOnMissingClass

@ConditionalOnMissingClass对应的Condition处理类是OnClassCondition。如果当前类路径下面没有指定的类的时候则生效。

@Target({ ElementType.TYPE, ElementType.METHOD })
@Retention(RetentionPolicy.RUNTIME)
@Documented
@Conditional(OnClassCondition.class)
public @interface ConditionalOnMissingClass {
    /**
     * 需要作为条件的类的Name, Class.getName()
     */
    String[] value() default {};
}

1.3 SpEL表达式作为条件

@ConditionalOnExpression对应的Condition处理类是OnExpressionCondition。只有当SpEL表达式满足条件的时候则生效。

@Retention(RetentionPolicy.RUNTIME)
@Target({ ElementType.TYPE, ElementType.METHOD })
@Documented
@Conditional(OnExpressionCondition.class)
public @interface ConditionalOnExpression {
    /**
     * 要作为条件的SpEL表达式
     */
    String value() default "true";
}

例如@ConditionalOnExpression("${test.enabled:true}")，只有当配置文件里面存在test.enabled: true的时候则生效。

更加详细的用法可以去看下SpEL表达式的使用。

1.4 JAVA版本作为判断条件

@ConditionalOnJava对应的Condition处理类是OnJavaCondition。只有当指定的JAVA版本条件满足的时候，才会创建对应的Bean。

@Target({ ElementType.TYPE, ElementType.METHOD })
@Retention(RetentionPolicy.RUNTIME)
@Documented
@Conditional(OnJavaCondition.class)
public @interface ConditionalOnJava {
    /**
     * 比较方式，Range.EQUAL_OR_NEWER:当前版本等于或高于、Range.OLDER_THAN:当前版本老于，越早的版本越老
     */
    Range range() default Range.EQUAL_OR_NEWER;

    /**
     * 指定JAVA版本
     */
    JavaVersion value();
    /**
     * Range options.
     */
    enum Range {
        /**
         * Equal to, or newer than the specified {@link JavaVersion}.
         */
        EQUAL_OR_NEWER,

        /**
         * Older than the specified {@link JavaVersion}.
         */
        OLDER_THAN
    }
}

1.5 配置属性作为判断条件

@ConditionalOnProperty对应的Condition实现类OnPropertyCondition。只有当对应的配置属性和给定条件的值相等的时候则生效。

@Retention(RetentionPolicy.RUNTIME)
@Target({ ElementType.TYPE, ElementType.METHOD })
@Documented
@Conditional(OnPropertyCondition.class)
public @interface ConditionalOnProperty {
    /**
     * 对应property名称的值
     */
    String[] value() default {};
    String[] name() default {};
    /**
     * property名称的前缀，可有可无
     */
    String prefix() default "";

    /**
     * 与name组合使用，比较获取到的属性值与havingValue给定的值是否相同，相同才加载配置
     */
    String havingValue() default "";
    /**
     * 缺少该property时是否可以加载。如果为true，没有该property也会正常加载；反之报错
     */
    boolean matchIfMissing() default false;
}

@ConditionalOnProperty(prefix = “spring.aop”, name = “auto”, havingValue = “true”)表示当配置文件里面spring.aop.auto=true的时候才会加载对应的Bean。

1.6 资源文件是否存在作为判断条件

@ConditionalOnResource对应的Condition处理类OnResourceCondition。只有当指定的资源文件出现在classpath中则生效。

@ConditionalOnResource配置属性

@Target({ ElementType.TYPE, ElementType.METHOD })
@Retention(RetentionPolicy.RUNTIME)
@Documented
@Conditional(OnResourceCondition.class)
public @interface ConditionalOnResource {
    /**
     * 要作为判断条件的资源文件名称  @ConditionalOnResource(resources=”mybatis.xml”)
     */
    String[] resources() default {};
}

1.7 是否Web应用作为判断条件

1.7.1 @ConditionalOnWebApplication

@ConditionalOnWebApplication对应的Condition处理类是OnWebApplicationCondition。只有当当前项目是Web项目的时候则生效。

@Target({ ElementType.TYPE, ElementType.METHOD })
@Retention(RetentionPolicy.RUNTIME)
@Documented
@Conditional(OnWebApplicationCondition.class)
public @interface ConditionalOnWebApplication {
    /**
     * 需要作为条件的Web应用程序的必需类型
     */
    Type type() default Type.ANY;

    /**
     * Available application types.
     */
    enum Type {

        /**
         * 任何web应用都将匹配
         */
        ANY,

        /**
         * 仅基于servlet的Web应用程序将匹配
         */
        SERVLET,

        /**
         * 仅基于反应式的Web应用程序将匹配
         */
        REACTIVE
    }
}

1.7.2 @ConditionalOnNotWebApplication

@ConditionalOnNotWebApplication对应的Condition处理类是OnWebApplicationCondition。只有当当前项目不是Web项目的时候则生效。

@Target({ ElementType.TYPE, ElementType.METHOD })
@Retention(RetentionPolicy.RUNTIME)
@Documented
@Conditional(OnWebApplicationCondition.class)
public @interface ConditionalOnNotWebApplication {
}

二 @Conditional自定义

上面介绍每个扩展注解的时候都特意提到了每个注解对应的Condition实现类。其实我们可以仿照这些Condition实现类来实现我们自己的@Conditional注解。下面我们同个两个简单的实例来看下怎么实现自己的@Conditional扩展注解。

2.1 判断是否配置指定属性

注意：和@ConditionalOnProperty不一样哦，@ConditionalOnProperty是判断是否有属性并且判断值是否等于我们指定的值。我们要实现的注解只判断有没有配置属性，不管属性对应的值。

扩展注解ConditionalOnPropertyExist。指定我们的Condition实现类OnPropertyExistCondition。并且指定两个参数。一个是参数name用于指定属性。另一个参数exist用于指定是判断存在还是不存在。

@Retention(RetentionPolicy.RUNTIME)
@Target({ElementType.TYPE, ElementType.METHOD})
@Documented
@Conditional(OnPropertyExistCondition.class)
public @interface ConditionalOnPropertyExist {

    /**
     * 配置文件里面对应的key
     */
    String name() default "";

    /**
     * 是否有配置的时候判断通过
     */
    boolean exist() default true;

}

OnPropertyExistCondition类就是简单的判断下属性存在与否。

public class OnPropertyExistCondition implements Condition {
    @Override
    public boolean matches(ConditionContext conditionContext, AnnotatedTypeMetadata annotatedTypeMetadata) {
        Map<String, Object> annotationAttributes = annotatedTypeMetadata.getAnnotationAttributes(ConditionalOnPropertyExist.class.getName());
        if (annotationAttributes == null) {
            return false;
        }
        String propertyName = (String) annotationAttributes.get("name");
        boolean values = (boolean) annotationAttributes.get("exist");
        String propertyValue = conditionContext.getEnvironment().getProperty(propertyName);
        if(values) {
            return !StringUtils.isEmpty(propertyValue);
        } else {
            return StringUtils.isEmpty(propertyValue);
        }
    }
}

2.1 判断是否配置指定属性

我们简单实现这样一个功能，根据指定的系统加载不同的Bean。

@Retention(RetentionPolicy.RUNTIME)
@Target({ElementType.TYPE, ElementType.METHOD})
@Documented
@Conditional(OnSystemCondition.class)
public @interface ConditionalOnSystem {
    /**
     * 指定系统
     */
    SystemType type() default SystemType.WINDOWS;

    /**
     * 系统类型
     */
    enum SystemType {

        /**
         * windows系统
         */
        WINDOWS,

        /**
         * linux系统
         */
        LINUX,

        /**
         * mac系统
         */
        MAC

    }
}

public class OnSystemCondition implements Condition {
    @Override
    public boolean matches(ConditionContext context, AnnotatedTypeMetadata metadata) {
        Map<String, Object> annotationAttributes = metadata.getAnnotationAttributes(ConditionalOnSystem.class.getName());
        if (annotationAttributes == null) {
            return false;
        }
        ConditionalOnSystem.SystemType systemType = (ConditionalOnSystem.SystemType) annotationAttributes.get("type");
        switch (systemType) {
            case WINDOWS:
                return context.getEnvironment().getProperty("os.name").contains("Windows");
            case LINUX:
                return context.getEnvironment().getProperty("os.name").contains("Linux ");
            case MAC:
                return context.getEnvironment().getProperty("os.name").contains("Mac ");
        }
        return false;
    }
}

到此这篇关于Spring Boot 条件注解详情的文章就介绍到这了,更多相关Spring Boot内容请搜索我们以前的文章或继续浏览下面的相关文章希望大家以后多多支持我们！

Spring Boot 自动配置之条件注解浅析

Spring Boot 神奇的自动配置,主要依靠大量的条件注解来使用配置自动化. 根据满足某一个特定条件创建一个特定的Bean.比如说,在某些系统变量下创建Bean,或者只有在某个Bean创建后才去创建另外一个Bean. 就是根据条件来控制Bean的创建行为,可以利用该特性来进行一些自动配置. 一.常用的条件注解 @Conditional 依赖的条件 @ConditionalOnBean 在某个Bean存在的条件下 @ConditionalOnMissingBean 在某个Bean不存在的条件
SpringBoot中的Condition包下常用条件依赖注解案例介绍

目录一.@ConditionalOnClass() Spring中存在指定class对象时,注入指定配置 1.首先引入pom依赖 2.实体类测试对象 3.定义@ConditionalOnClass()配置类 4.启动类测试二.注入指定配置 1.首先引入pom依赖 2.实体类测试对象 3.定义@ConditionalOnMissingClass()配置类 4.启动类测试三.加载指定配置 1.首先引入pom依赖 2.实体类测试对象 2.1 引入条件判断实体类 3.定义@ConditionalO
Spring Boot 条件注解详情

目录一 @Conditional扩展注解 1.1 Bean作为条件 1.1.1 @ConditionalOnBean 1.1.2 @ConditionalOnMissingBean 1.1.3 @ConditionalOnSingleCandidate 1.2 类作为条件 1.2.1 @ConditionalOnClass 1.2.2 @ConditionalOnMissingClass 1.3 SpEL表达式作为条件 1.4 JAVA版本作为判断条件 1.5 配置属性作为判断条件 1.6 资
使用Spring Boot进行单元测试详情

目录前言使用 Spring Boot 进行测试系列文章依赖项不要在单元测试中使用Spring 创建一个可测试的类实例属性注入是不好的提供一个构造函数减少模板代码使用Mockito来模拟依赖项使用普通Mockito来模拟依赖通过Mockito的@Mock注解模拟对象使用AssertJ创建可读断言结论前言本文给你提供在Spring Boot 应用程序中编写好的单元测试的机制,并且深入技术细节. 我们将带你学习如何以可测试的方式创建Spring Bean实例,然后讨论如何使
Spring Boot 通过注解实现数据校验的方法

一.依赖  <dependency> <groupId>org.springframework.boot</groupId> <artifactId>spring-boot-starter-validation</artifactId> &l
spring boot基于注解的声明式事务配置详解

事务配置 1.配置方式一 1)开启spring事务管理,在spring boot启动类添加注解@EnableTransactionManagement(proxyTargetClass = true):等同于xml配置方式的 <tx:annotation-driven />(注意:1项目中只需配置一次,2需要配置proxyTargetClass = true) 2)在项目中需要添加事务的类或方法上添加注解@Transactional(建议添加在方法上),一般使用默认属性即可,若要使用事务各属性
Spring boot 集成 MQTT详情

目录一.简介二.主要特性三.集成步骤 1.引入相关jar包 2.核心配置类 3.网关配置 4.编写测试类 5.yml配置信息一.简介 MQTT(Message Queuing Telemetry Transport,消息队列遥测传输协议),是一种基于发布/订阅(publish/subscribe)模式的"轻量级"通讯协议,可以以极少的代码和有限的带宽为连接远程设备提供实时可靠的消息服务.目前在物联网.小型设备.移动应用等方面有较广泛的应用. 二.主要特性 (1)使用发布/订阅消
Spring Boot 利用注解方式整合 MyBatis

目录前言整合过程新建 Spring Boot 项目添加 pom 依赖准备数据库 pojo 层 dao 层 service 层 controller 层入口程序配置网页测试总结前言目前而言,国内大家使用最多的持久层框架可能还是 MyBatis 吧,那既然如此,更强大的 Spring Boot 遇上炽手可热的 MyBatis,又会擦出什么样的火花呢? 那本文就来看看,如何利用 SpringBoot 来整合 Mybatis. 如下图是总结的整合过程的大概流程,那接下来我们就来开始具
Spring Boot 基于注解的 Redis 缓存使用详解

看文本之前,请先确定你看过上一篇文章<Spring Boot Redis 集成配置>并保证 Redis 集成后正常可用,因为本文是基于上文继续增加的代码. 一.创建 Caching 配置类 RedisKeys.Java package com.shanhy.example.redis; import java.util.HashMap; import java.util.Map; import javax.annotation.PostConstruct; import org.springf
基于Spring boot @Value 注解注入属性值的操作方法

本文主要介绍Spring @Value 注解注入属性值的使用方法的分析,文章通过示例代码非常详细地介绍,对于每个人的学习或工作都有一定的参考学习价值在使用spring框架的项目中,@Value是经常使用的注解之一.其功能是将与配置文件中的键对应的值分配给其带注解的属性.在日常使用中,我们常用的功能相对简单.本文使您系统地了解@Value的用法. @Value注入形式根据注入的内容来源,@ Value属性注入功能可以分为两种:通过配置文件进行属性注入和通过非配置文件进行属性注入. 非配置文件注
spring boot@EnableXXXX注解编程模型讲解

目录 @EnableXXXX编程模型 @Import注解处理时机节点(@Confguration注解的类处理) ImportSelector ImportBeanDefinitionRegistrar处理 @Configurtion注解的类处理统一调用配置类解析出来的信息注册BeanDefinition @EnableXXXX编程模型在spring boot中,@EnableXXX注解的功能通常是开启某一种功能.根据某些外部配置自动装配一些bean,来达到开启某些功能的目的.光说很抽象,要具
Spring Boot @Conditional注解用法示例介绍

引用Spring官方文档的说法介绍一下@Conditional注解:Spring5.0.15版本@Conditional注解官方文档 @Conditional表示仅当所有指定条件都匹配时,组件才有资格注册 . 该@Conditional注释可以在以下任一方式使用: 作为任何@Bean方法的方法级注释作为任何类的直接或间接注释的类型级别注释 @Component,包括@Configuration类作为元注释,目的是组成自定义构造型注释改注解主要源码之一,通过match匹配,符合条件才装载到S

Spring Boot 条件注解详情

目录

一 @Conditional扩展注解

1.1 Bean作为条件

1.1.1 @ConditionalOnBean

1.1.2 @ConditionalOnMissingBean

1.1.3 @ConditionalOnSingleCandidate

1.2 类作为条件

1.2.1 @ConditionalOnClass

1.2.2 @ConditionalOnMissingClass

1.3 SpEL表达式作为条件

1.4 JAVA版本作为判断条件

1.5 配置属性作为判断条件

1.6 资源文件是否存在作为判断条件

1.7 是否Web应用作为判断条件

1.7.1 @ConditionalOnWebApplication

1.7.2 @ConditionalOnNotWebApplication

二 @Conditional自定义

2.1 判断是否配置指定属性

2.1 判断是否配置指定属性

相关推荐

随机推荐