<link rel="stylesheet" href="https://csdnimg.cn/release/phoenix/template/css/ck_htmledit_views-f57960eb32.css">
<link rel="stylesheet" href="https://csdnimg.cn/release/phoenix/template/css/ck_htmledit_views-f57960eb32.css">
<div class="htmledit_views" id="content_views">
<h2><a name="t0"></a>前言:</h2>
@Conditional是Spring4新提供的注解,它的作用是按照一定的条件进行判断,满足条件给容器注册bean。
@Conditional的定义:
1.
2.
//此注解可以标注在类和方法上
3.
@Target({ElementType.TYPE, ElementType.METHOD})
4.
@Retention(RetentionPolicy.RUNTIME)
5.
@Documented
6.
public @interface Conditional {
7.
Class extends Condition>[] value();
8.
}
9.
从代码中可以看到,需要传入一个Class数组,并且需要继承Condition接口:
1.
2.
public interface Condition {
3.
boolean matches(ConditionContext var1, AnnotatedTypeMetadata var2);
4.
}
5.
Condition是个接口,需要实现matches方法,返回true则注入bean,false则不注入。
示例:
首先,创建Person类:
1.
2.
public class Person {
3.
4.
private String name;
5.
private Integer age;
6.
7.
public String getName() {
8.
return name;
9.
}
10.
11.
public void setName(String name) {
12.
this.name = name;
13.
}
14.
15.
public Integer getAge() {
16.
return age;
17.
}
18.
19.
public void setAge(Integer age) {
20.
this.age = age;
21.
}
22.
23.
public Person(String name, Integer age) {
24.
this.name = name;
25.
this.age = age;
26.
}
27.
28.
@Override
29.
public String toString() {
30.
return "Person{" + "name='" + name + '\'' + ", age=" + age + '}';
31.
}
32.
}
33.
创建BeanConfig类,用于配置两个Person实例并注入,一个是比尔盖茨,一个是林纳斯。
1.
2.
@Configuration
3.
public class BeanConfig {
4.
5.
@Bean(name = "bill")
6.
public Person person1(){
7.
return new Person("Bill Gates",62);
8.
}
9.
10.
@Bean("linus")
11.
public Person person2(){
12.
return new Person("Linus",48);
13.
}
14.
}
15.
接着写一个测试类进行验证这两个Bean是否注入成功。
1.
2.
public class ConditionalTest {
3.
4.
AnnotationConfigApplicationContext applicationContext = new AnnotationConfigApplicationContext(BeanConfig.class);
5.
6.
@Test
7.
public void test1(){
8.
Map<String, Person> map = applicationContext.getBeansOfType(Person.class);
9.
System.out.println(map);
10.
}
11.
}
12.
运行,输出结果是这样的,两个Person实例被注入进容器。
这是一个简单的例子,现在问题来了,如果我想根据当前操作系统来注入Person实例,windows下注入bill,linux下注入linus,怎么实现呢?
这就需要我们用到@Conditional注解了,前言中提到,需要实现Condition接口,并重写方法来自定义match规则。
首先,创建一个WindowsCondition类:
1.
2.
public class WindowsCondition implements Condition {
3.
4.
/**
5.
* @param conditionContext:判断条件能使用的上下文环境
6.
* @param annotatedTypeMetadata:注解所在位置的注释信息
7.
* */
8.
@Override
9.
public boolean matches(ConditionContext conditionContext, AnnotatedTypeMetadata annotatedTypeMetadata) {
10.
//获取ioc使用的beanFactory
11.
ConfigurableListableBeanFactory beanFactory = conditionContext.getBeanFactory();
12.
//获取类加载器
13.
ClassLoader classLoader = conditionContext.getClassLoader();
14.
//获取当前环境信息
15.
Environment environment = conditionContext.getEnvironment();
16.
//获取bean定义的注册类
17.
BeanDefinitionRegistry registry = conditionContext.getRegistry();
18.
19.
//获得当前系统名
20.
String property = environment.getProperty("os.name");
21.
//包含Windows则说明是windows系统,返回true
22.
if (property.contains("Windows")){
23.
return true;
24.
}
25.
return false;
26.
}
27.
}
28.
matches方法的两个参数的意思在注释中讲述了,值得一提的是,conditionContext提供了多种方法,方便获取各种信息,也是SpringBoot中 @ConditonalOnXX注解多样扩展的基础。
接着,创建LinuxCondition类:
1.
2.
public class LinuxCondition implements Condition {
3.
4.
@Override
5.
public boolean matches(ConditionContext conditionContext, AnnotatedTypeMetadata annotatedTypeMetadata) {
6.
7.
Environment environment = conditionContext.getEnvironment();
8.
9.
String property = environment.getProperty("os.name");
10.
if (property.contains("Linux")){
11.
return true;
12.
}
13.
return false;
14.
}
15.
}
16.
接着就是使用这两个类了,因为此注解可以标注在方法上和类上,所以分开测试:
标注在方法上:
修改BeanConfig:
1.
2.
@Configuration
3.
public class BeanConfig {
4.
5.
//只有一个类时,大括号可以省略
6.
//如果WindowsCondition的实现方法返回true,则注入这个bean
7.
@Conditional({WindowsCondition.class})
8.
@Bean(name = "bill")
9.
public Person person1(){
10.
return new Person("Bill Gates",62);
11.
}
12.
13.
//如果LinuxCondition的实现方法返回true,则注入这个bean
14.
@Conditional({LinuxCondition.class})
15.
@Bean("linus")
16.
public Person person2(){
17.
return new Person("Linus",48);
18.
}
19.
}
20.
修改测试方法,使其可以打印当前系统名:
1.
2.
@Test
3.
public void test1(){
4.
String osName = applicationContext.getEnvironment().getProperty("os.name");
5.
System.out.println("当前系统为:" + osName);
6.
Map<String, Person> map = applicationContext.getBeansOfType(Person.class);
7.
System.out.println(map);
8.
}
9.
运行结果如下:
我是运行在windows上的所以只注入了bill,嗯,没毛病。
接着实验linux下的情况,不能运行在linux下,但可以修改运行时参数:
修改后启动测试方法:
一个方法只能注入一个bean实例,所以@Conditional标注在方法上只能控制一个bean实例是否注入。
标注在类上:
一个类中可以注入很多实例,@Conditional标注在类上就决定了一批bean是否注入。
我们试一下,将BeanConfig改写,这时,如果WindowsCondition返回true,则两个Person实例将被注入(注意:上一个测试将os.name改为linux,这是我将把这个参数去掉):
1.
2.
@Conditional({WindowsCondition.class})
3.
@Configuration
4.
public class BeanConfig {
5.
6.
@Bean(name = "bill")
7.
public Person person1(){
8.
return new Person("Bill Gates",62);
9.
}
10.
11.
@Bean("linus")
12.
public Person person2(){
13.
return new Person("Linus",48);
14.
}
15.
}
16.
结果两个实例都被注入:
如果将类上的WindowsCondition.class改为LinuxCondition.class,结果应该可以猜到:
结果就是空的,类中所有bean都没有注入。
多个条件类:
前言中说,@Conditional注解传入的是一个Class数组,存在多种条件类的情况。
这种情况貌似判断难度加深了,测试一波,新增新的条件类,实现的matches返回false(这种写死返回false的方法纯属测试用,没有实际意义O(∩_∩)O)
1.
2.
public class ObstinateCondition implements Condition {
3.
4.
@Override
5.
public boolean matches(ConditionContext conditionContext, AnnotatedTypeMetadata annotatedTypeMetadata) {
6.
return false;
7.
}
8.
}
9.
BeanConfig修改一下:
1.
2.
@Conditional({WindowsCondition.class,ObstinateCondition.class})
3.
@Configuration
4.
public class BeanConfig {
5.
6.
@Bean(name = "bill")
7.
public Person person1(){
8.
return new Person("Bill Gates",62);
9.
}
10.
11.
@Bean("linus")
12.
public Person person2(){
13.
return new Person("Linus",48);
14.
}
15.
}
16.
结果:
现在如果将ObstinateCondition的matches方法返回值改成true,两个bean就被注入进容器:
结论得:
第一个条件类实现的方法返回true,第二个返回false,则结果false,不注入进容器。
第一个条件类实现的方法返回true,第二个返回true,则结果true,注入进容器中。