Spring中@Conditional注解的用法

 更新时间:2024年01月04日 09:49:11   作者:时间不会赖着不走  
这篇文章主要介绍了Spring中@Conditional注解的用法,@Conditional是Spring4新提供的注解,它的作用是按照一定的条件进行判断,满足条件给容器注册bean,需要的朋友可以参考下

@Conditional

@Conditional是Spring4新提供的注解,它的作用是按照一定的条件进行判断,满足条件给容器注册bean。

@Target({ElementType.TYPE, ElementType.METHOD})
@Retention(RetentionPolicy.RUNTIME)
@Documented
public @interface Conditional {
    Class<? extends Condition>[] value();
}

从代码中可以看到,需要传入一个Class数组,并且需要继承Condition接口:

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

Condition是个接口,需要实现matches方法,返回true则注入bean,false则不注入。

用法如下

在这里插入图片描述

下面举例测试Condition的注入Bean

举例测试

首先创建Dog类

@Data
@NoArgsConstructor
@AllArgsConstructor
public class Dog {
    private String name;
    private String gender;
}

然后创建MyCondition类

重写matches方法, 返回true则注入bean,false则不注入 如果容器中注入了 dog 就返回true

public class MyCondition implements Condition {
    /**
     * 重写matches方法, 返回true则注入bean,false则不注入。
     * */
    @Override
    public boolean matches(ConditionContext context, AnnotatedTypeMetadata metadata) {
        ConfigurableListableBeanFactory beanFactory = context.getBeanFactory();
        // 如果容器中注入了 dog 就返回true
        if(beanFactory.containsBean("dog")){
            return true;
        }
        return false;
    }
}

定义两个Bean

@Configuration
public class MyConfig {

    @Bean("dog")
    //@ConditionalOnBean(name = {"dog2"})
    public Dog dog1(){
        return new Dog("金毛","公");
    }

    @Bean("dog1")
    @Conditional(value = MyCondition.class)
    public Dog dog2(){
        return new Dog("拉布拉多","母");
    }
}

测试方法AnnotationConfigApplicationContext

AnnotationConfigApplicationContext是一个独立的应用上下文,它接受带注释的类作为输入。 例如@Configuration或@Component。 可以使用scan()查找 Bean,也可以使用register()注册 Bean。

public class tets {
    public static void main(String[] args) {
        AnnotationConfigApplicationContext applicationContext = new AnnotationConfigApplicationContext(MyConfig.class);
         Map<String, Dog> beansOfType = applicationContext.getBeansOfType(Dog.class);
        System.out.println(beansOfType);
    }
}

测试结果如下

[外链图片转存失败,源站可能有防盗链机制,建议将图片保存下来直接上传(img-0E3qWV9I-1673088393503)(Spring%20@Conditional%E6%B3%A8%E8%A7%A3.assets/image-20230104162057475.jpg)]

如果将MyCondition类中逻辑改为,如果如果容器中之前注入了 dog 就返回false,不注入其他的, 即:

public class MyCondition implements Condition {
    /**
     * 重写matches方法, 返回true则注入bean,false则不注入。
     * */
    @Override
    public boolean matches(ConditionContext context, AnnotatedTypeMetadata metadata) {
        ConfigurableListableBeanFactory beanFactory = context.getBeanFactory();
        // 如果容器中之前注入了 dog 就返回false
        if(beanFactory.containsBean("dog")){
            return false;
        }
        return true;
    }
}

那么结果如下:

[外链图片转存失败,源站可能有防盗链机制,建议将图片保存下来直接上传(img-Y5YxGAQx-1673088393504)(Spring%20@Conditional%E6%B3%A8%E8%A7%A3.assets/image-20230104162343817.jpg)]

@Conditional本身还是一个父注解,派生出大量的子注解,如下:

  • @ConditionalOnBean:当容器中有指定Bean的条件下进行实例化。
  • @ConditionalOnMissingBean:当容器里没有指定Bean的条件下进行实例化。
  • @ConditionalOnClass:当classpath类路径下有指定类的条件下进行实例化。
  • @ConditionalOnMissingClass:当类路径下没有指定类的条件下进行实例化。
  • @ConditionalOnWebApplication:当项目是一个Web项目时进行实例化。
  • @ConditionalOnNotWebApplication:当项目不是一个Web项目时进行实例化。
  • @ConditionalOnProperty:当指定的属性有指定的值时进行实例化。
  • @ConditionalOnExpression:基于SpEL表达式的条件判断。
  • @ConditionalOnJava:当JVM版本为指定的版本范围时触发实例化。
  • @ConditionalOnResource:当类路径下有指定的资源时触发实例化。
  • @ConditionalOnJndi:在JNDI存在的条件下触发实例化。
  • @ConditionalOnSingleCandidate:当指定的Bean在容器中只有一个,或者有多个但是指定了首选的Bean时触发实例化。

测试@ConditionalOnBean和@ConditionalOnMissingBean注解

修改之前的配置类如下

@Configuration
public class MyConfig {

    @Bean("dog")

    public Dog dog1(){
        return new Dog("金毛","公");
    }

    @Bean("dog1")
    @ConditionalOnBean(name = {"dog"})// spring容器中有dog这个Bean 才会创建dog1
//    @ConditionalOnMissingBean(name = {"dog"})// spring容器中不存在 dog这个Bean 才会创建dog1
    public Dog dog2(){
        return new Dog("拉布拉多","母");
    }
}

结果如下:

[外链图片转存失败,源站可能有防盗链机制,建议将图片保存下来直接上传(img-hPUXUWPh-1673088393505)(Spring%20@Conditional%E6%B3%A8%E8%A7%A3.assets/image-20230104163639174.jpg)]

然后再将第二个注释放开,第一个注释注释掉 结果如下:

[外链图片转存失败,源站可能有防盗链机制,建议将图片保存下来直接上传(img-z9erSSTI-1673088393505)(Spring%20@Conditional%E6%B3%A8%E8%A7%A3.assets/image-20230104163855985.jpg)]

到此这篇关于Spring中@Conditional注解的用法的文章就介绍到这了,更多相关@Conditional注解内容请搜索脚本之家以前的文章或继续浏览下面的相关文章希望大家以后多多支持脚本之家!

相关文章

  • SimpleDateFormat线程安全问题排查详解

    SimpleDateFormat线程安全问题排查详解

    这篇文章主要为大家介绍了SimpleDateFormat线程安全问题排查详解,有需要的朋友可以借鉴参考下,希望能够有所帮助,祝大家多多进步,早日升职加薪
    2022-11-11
  • springboot2 jackson实现动态返回类字段方式

    springboot2 jackson实现动态返回类字段方式

    这篇文章主要介绍了springboot2 jackson实现动态返回类字段方式,具有很好的参考价值,希望对大家有所帮助,如有错误或未考虑完全的地方,望不吝赐教
    2024-08-08
  • Java实现递归计算n的阶乘

    Java实现递归计算n的阶乘

    这篇文章主要为大家详细介绍了Java实现递归计算n的阶乘,利用递归的思想实现阶乘的计算,文中示例代码介绍的非常详细,具有一定的参考价值,感兴趣的小伙伴们可以参考一下
    2021-08-08
  • SpringBoot面试突击之过滤器和拦截器区别详解

    SpringBoot面试突击之过滤器和拦截器区别详解

    过滤器(Filter)和拦截器(Interceptor)都是基于 AOP(Aspect Oriented Programming,面向切面编程)思想实现的,用来解决项目中某一类问题的两种“工具”,但二者有着明显的差距,接下来我们一起来看
    2022-10-10
  • Java和SQL实现取两个字符间的值

    Java和SQL实现取两个字符间的值

    这篇文章主要介绍了Java和SQL实现取两个字符间的值操作,具有很好的参考价值,希望对大家有所帮助。如有错误或未考虑完全的地方,望不吝赐教
    2021-06-06
  • SpringCloud使用Nacos保存和读取变量的配置方法

    SpringCloud使用Nacos保存和读取变量的配置方法

    在使用SpringCloud开发微服务时,经常会遇到一些比较小的后台参数配置,这些配置不足以单独开一张表去存储,而且其他服务会读取该参数,这篇文章主要介绍了SpringCloud使用Nacos保存和读取变量,需要的朋友可以参考下
    2022-07-07
  • java中out.print和out.write的方法

    java中out.print和out.write的方法

    本文用一个小例子说明java out.print和out.write的方法,大家参考使用吧
    2013-11-11
  • Springboot热加载JAR包的实现方法

    Springboot热加载JAR包的实现方法

    SpringBoot作为一个开发快速、部署方便的微服务框架,具有自动配置、约定优于配置的特点,能够极大地提高开发效率,它提供了丰富的扩展点,非常适合实现动态加载Jar包的功能,本文将深入探讨如何在SpringBoot应用中实现动态加载Jar包的方案,感兴趣的朋友一起看看吧
    2024-04-04
  • IDEA关闭git管理,文件变成红色解决方案

    IDEA关闭git管理,文件变成红色解决方案

    在软件开发中,当一个文件夹内的Java项目启用Git版本控制,通常会导致该文件夹下所有项目同步开启Git,这种做法有助于保持项目的一致性和可追溯性,但也可能带来管理上的复杂性,如果需要解除某个项目的Git管理,可以通过IDE的设置选项进行调整
    2024-10-10
  • SpringBoot配置文件启动加载顺序的方法步骤

    SpringBoot配置文件启动加载顺序的方法步骤

    SpringBoot的启动加载顺序涉及多个步骤和组件,通过分层和优先级机制加载配置文件,确保在启动时正确配置应用程序,本文就来介绍一下SpringBoot配置文件启动加载顺序的方法步骤,感兴趣的可以了解一下
    2024-11-11

最新评论