脚本之家 服务器常用软件
快捷导航
您的位置：首页 → 软件编程 → java → Spring注解@Conditional

Spring注解@Conditional案例解析

 更新时间：2019年10月25日 09:12:16   作者：ねぇ  
这篇文章主要介绍了Spring注解@Conditional案例解析,文中通过示例代码介绍的非常详细，对大家的学习或者工作具有一定的参考学习价值,需要的朋友可以参考下

【1】@Conditional介绍

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

@Conditional源码：

//此注解可以标注在类和方法上
@Target({ElementType.TYPE, ElementType.METHOD})
@Retention(RetentionPolicy.RUNTIME) 
@Documented
public @interface Conditional {
  Class<? extends Condition>[] value();
}

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

public interface Condition {
  boolean matches(ConditionContext var1, AnnotatedTypeMetadata var2);
}

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

【2】@Conditional示例

首先，创建Person类：

public class Person {
 
  private String name;
  private Integer age;
 
  public String getName() {
    return name;
  }
 
  public void setName(String name) {
    this.name = name;
  }
 
  public Integer getAge() {
    return age;
  }
 
  public void setAge(Integer age) {
    this.age = age;
  }
 
  public Person(String name, Integer age) {
    this.name = name;
    this.age = age;
  }
 
  @Override
  public String toString() {
    return "Person{" + "name='" + name + '\'' + ", age=" + age + '}';
  }
}

创建MyConfig类，用于配置两个Person实例并注入，一个是Bill Gates，一个是linus。

@Configuration
public class MyConfig {
 
  @Bean(name = "bill")
  public Person person1(){
    return new Person("Bill Gates",62);
  }
 
  @Bean("linus")
  public Person person2(){
    return new Person("Linus",48);
  }
}

写一个测试类，测试是否注入成功

public class ConditionalTest {
  AnnotationConfigApplicationContext applicationContext = new AnnotationConfigApplicationContext(BeanConfig.class);
 
  @Test
  public void test1(){
    Map<String, Person> map = applicationContext.getBeansOfType(Person.class);
    System.out.println(map);
  }
}
/**测试结果
{bill=Person{name='Bill Gates',age=62},linus=Person{name='Linus',age='48'}}
*/

这是一个简单的例子，现在问题来了，如果我想根据当前操作系统来注入Person实例，windows下注入bill，linux下注入linus，怎么实现呢？

这就需要我们用到@Conditional注解了，前言中提到，需要实现Condition接口，并重写方法来自定义match规则。

首先，创建一个WindowsCondition类：

public class WindowsCondition implements Condition {
 
  /**
   * @param conditionContext:判断条件能使用的上下文环境
   * @param annotatedTypeMetadata:注解所在位置的注释信息
   * */
  @Override
  public boolean matches(ConditionContext conditionContext, AnnotatedTypeMetadata annotatedTypeMetadata) {
    //获取ioc使用的beanFactory
    ConfigurableListableBeanFactory beanFactory = conditionContext.getBeanFactory();
    //获取类加载器
    ClassLoader classLoader = conditionContext.getClassLoader();
    //获取当前环境信息
    Environment environment = conditionContext.getEnvironment();
    //获取bean定义的注册类
    BeanDefinitionRegistry registry = conditionContext.getRegistry();
 
    //获得当前系统名
    String property = environment.getProperty("os.name");
    //包含Windows则说明是windows系统，返回true
    if (property.contains("Windows")){
      return true;
    }
    return false;
  }
}

接着，创建LinuxCondition类：

public class LinuxCondition implements Condition {
  @Override
  public boolean matches(ConditionContext conditionContext, AnnotatedTypeMetadata annotatedTypeMetadata) { 
    Environment environment = conditionContext.getEnvironment();
    String property = environment.getProperty("os.name");
    if (property.contains("Linux")){
      return true;
    }
    return false;
  }
}

修改MyConfig：

@Configuration
public class MyConfig { 
  //只有一个类时，大括号可以省略
  //如果WindowsCondition的实现方法返回true，则注入这个bean  
  @Conditional({WindowsCondition.class})
  @Bean(name = "bill")
  public Person person1(){
    return new Person("Bill Gates",62);
  }
  //如果LinuxCondition的实现方法返回true，则注入这个bean
  @Conditional({LinuxCondition.class})
  @Bean("linus")
  public Person person2(){
    return new Person("Linus",48);
  }
}

标注在方法上：

​ 修改测试程序，开始测试：

public class ConditionalTest {
  AnnotationConfigApplicationContext applicationContext = new AnnotationConfigApplicationContext(BeanConfig.class);
 
  @Test
  public void test1(){
    String osName = applicationContext.getEnvironment().getProperty("os.name");
    System.out.println("当前系统为：" + osName)；
    Map<String, Person> map = applicationContext.getBeansOfType(Person.class);
    System.out.println(map);
  }
}
/**测试结果
当前系统为：Windows 10
{bill=Person{name='Bill Gates',age=62}}
*/

一个方法只能注入一个bean实例，所以@Conditional标注在方法上只能控制一个bean实例是否注入

标注在类上:

@Configuration
@Conditional({WindowsCondition.class})
public class MyConfig {
 
  //只有一个类时，大括号可以省略
  //如果WindowsCondition的实现方法返回true，则注入这个bean  
  @Bean(name = "bill")
  public Person person1(){
    return new Person("Bill Gates",62);
  }
 
  //如果LinuxCondition的实现方法返回true，则注入这个bean
  @Bean("linus")
  public Person person2(){
    return new Person("Linus",48);
  }
}

一个类中可以注入很多实例，@Conditional标注在类上就决定了一批bean是否注入。

以上就是本文的全部内容，希望对大家的学习有所帮助，也希望大家多多支持脚本之家。

您可能感兴趣的文章:

相关文章

  • 教你怎么用idea创建web项目

    教你怎么用idea创建web项目

    好多朋友在使用IDEA创建项目时,总会碰到一些小问题.现在我们就演示一下使用IDEA创建web项目的完整步骤吧.文中有非常详细的图文示例哦,,需要的朋友可以参考下
    2021-05-05
  • java数据结构与算法之中缀表达式转为后缀表达式的方法

    java数据结构与算法之中缀表达式转为后缀表达式的方法

    这篇文章主要介绍了java数据结构与算法之中缀表达式转为后缀表达式的方法,简单分析了java中缀表达式转为后缀表达式的相关实现方法与技巧,需要的朋友可以参考下
    2016-08-08
  • SWT JFace 拖曳效果

    SWT JFace 拖曳效果

    SWT(JFace)体验之拖曳效果
    2009-06-06
  • LeetCode -- Path Sum III分析及实现方法

    LeetCode -- Path Sum III分析及实现方法

    这篇文章主要介绍了LeetCode -- Path Sum III分析及实现方法的相关资料,希望通过本文能帮助到大家，需要的朋友可以参考下
    2017-10-10
  • Mybatis的parameterType造成线程阻塞问题分析

    Mybatis的parameterType造成线程阻塞问题分析

    这篇文章主要详细分析了Mybatis的parameterType造成线程阻塞问题，文中有详细的解决方法，及相关的代码示例，具有一定的参考价值，感兴趣的朋友可以借鉴阅读
    2023-06-06
  • Maven工程搭建spring boot+spring mvc+JPA的示例

    Maven工程搭建spring boot+spring mvc+JPA的示例

    本篇文章主要介绍了Maven工程搭建spring boot+spring mvc+JPA的示例，小编觉得挺不错的，现在分享给大家，也给大家做个参考。一起跟随小编过来看看吧
    2018-01-01
  • java数字和中文算数验证码的实现

    java数字和中文算数验证码的实现

    这篇文章主要介绍了java数字和中文算数验证码的实现，文中通过示例代码介绍的非常详细，对大家的学习或者工作具有一定的参考学习价值，需要的朋友们下面随着小编来一起学习学习吧
    2020-07-07
  • 浅谈java中的路径表示

    浅谈java中的路径表示

    下面小编就为大家带来一篇浅谈java中的路径表示。小编觉得挺不错的，现在就分享给大家，也给大家做个参考。一起跟随小编过来看看吧
    2017-04-04
  • SpringMvc+POI处理excel表数据导入

    SpringMvc+POI处理excel表数据导入

    这篇文章主要为大家详细介绍了SpringMvc+POI处理excel表数据导入，具有一定的参考价值，感兴趣的小伙伴们可以参考一下
    2018-06-06
  • JAVA多线程实现生产者消费者的实例详解

    JAVA多线程实现生产者消费者的实例详解

    这篇文章主要介绍了JAVA多线程实现生产者消费者的实例详解的相关资料,需要的朋友可以参考下
    2017-06-06

最新评论