spring之@conditional注解-爱代码爱编程
目录
3.3、注解@ConditionalOnMissingBean:
3.4、注解@ConditionalOnMissingClass
1、简介
@Conditional注解是用来判断是否满足指定的条件来决定是否进行Bean的实例化及装配，下面通过示例演示@ConditionalOnMissingClass、@ConditionalOnMissingBean、@ConditionalOnClass和@ConditionalOnBean的用法。
2、定义基础类，根据这些类或实例判断指定的类是否被加载
@Component
public class BeanOne {
public void run(){
System.out.println("BeanOne.run（）方法。");
}
}
@Component
public class BeanTwo {
public void run(){
System.out.println("BeanTwo.run（）方法。");
}
}
public class BeanThree {
public void run(){
System.out.println("BeanThree.run（）方法。");
}
}
这三个类，前两个通过@Component注解，会被加载到Spring IOC容器中，第三个类没有被注解，所以在Spring IOC容器中不存在该类的实例。
3、配置测试类
3.1、注解@ConditionalOnBean
主要使用了注解@ConditionalOnBean，主要是根据Spring IOC容器中是否有该类的实例对象来进行判断。根据前面的配置，可以知道BeanOne、BeanTwo两个类的实例会被加载到Spring IOC容器中，而BeanThree类的实例不会被加载到容器中，所以第一种情况下，该类不会被加载，第二种情况该类会被加载。
@Configuration
//第一种情况：不会被加载，BeanThree不在IOC容器中
@ConditionalOnBean({BeanOne.class, BeanThree.class})
//第二种情况：会被加载，都在容器内
//@ConditionalOnBean({BeanOne.class, BeanTwo.class})
public class TestOnBean {
}3.2、注解@ConditionalOnClass:
主要使用了注解@ConditionalOnClass，主要是根据类路径下是否有该类来进行判断。根据前面的配置，可以知道BeanOne、BeanThree两个类的都存在（BeanThree在类路径存在，但是不在Spring IOC容器中），而BeanFour类在类路径下不存在，所以第一种情况下，该类会被加载，第二种情况该类不会被加载。
@Configuration
//第一中情况：存在这两个类，所以会被加载
//@ConditionalOnClass({BeanOne.class, BeanThree.class})
//第二种情况：不会被加载，因为不存在BeanFour
@ConditionalOnClass(name={"com.qriver.spring.conditional.bean.base.BeanOne", "com.qriver.spring.conditional.bean.base.BeanFour"})
public class TestOnClass {
}
3.3、注解@ConditionalOnMissingBean:
主要使用了注解@ConditionalOnMissingBean，主要是根据Spring IOC容器中是否有该类的实例对象来进行判断，和注解@ConditionalOnBean正好相反。根据前面的配置，可以知道BeanOne类的实例会被加载到Spring IOC容器中，而BeanThree类的实例不会被加载到容器中，所以第一种情况下，该类会被加载，第二种情况该类不会被加载。
@Configuration
//第一种情况：BeanThree不在IOC容器中，所以会被加载
//@ConditionalOnMissingBean(BeanThree.class)
//第二种情况：BeanOne在IOC容器中，所以不会被加载
@ConditionalOnMissingBean(BeanOne.class)
public class TestOnMissingBean {
}
3.4、注解@ConditionalOnMissingClass
主要使用了注解@ConditionalOnMissingClass，主要是根据类路径下是否有该类来进行判断，正好跟注解@ConditionalOnClass相反。根据前面的配置，可以知道BeanOne、BeanThree两个类的都存在（BeanThree在类路径存在，但是不在Spring IOC容器中），而BeanFour类在类路径下不存在，所以第一种情况下，该类不会被加载，第二种情况该类会被加载。
@Configuration
//第一中情况：存在这两个类，所以会被加载
//@ConditionalOnClass({BeanOne.class, BeanThree.class})
//第二种情况：不会被加载，因为不存在BeanFour
@ConditionalOnClass(name={"com.qriver.spring.conditional.bean.base.BeanFour"})
public class TestOnClass {
}
4、测试运行类
@Configuration
@ComponentScan("com.qriver.spring.conditional")
public class MainConfig {
public static void main(String[] args) {
ApplicationContext context = new AnnotationConfigApplicationContext(MainConfig.class);
String[] beanNames = context.getBeanDefinitionNames();
for(int i=0;i<beanNames.length;i++){
System.out.println("bean名称："+beanNames[i]);
}
}
}
运行上述代码，会根据注解条件，打印相应的被加载到Spring IOC容器中的类。这里不在展示打印结果了。
5、@Conditional注解
@Conditional注解是由Spring 4.0版本引入的新特性，可根据是否满足指定的条件来决定是否进行Bean的实例化及装配，比如，设定当类路径下包含某个jar包的时候才会对注解的类进行实例化操作。总之，就是根据一些特定条件来控制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则不注入。
5.1、示例
首先，创建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 + '}';
}
}创建BeanConfig类，用于配置两个Person实例并注入，一个是比尔盖茨，一个是林纳斯。
@Configuration
public class BeanConfig {
@Bean(name = "bill")
public Person person1(){
return new Person("Bill Gates",62);
}
@Bean("linus")
public Person person2(){
return new Person("Linus",48);
}
}接着写一个测试类进行验证这两个Bean是否注入成功。
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);
}
}运行，输出结果是这样的，两个Person实例被注入进容器。
这是一个简单的例子，现在问题来了，如果我想根据当前操作系统来注入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;
}
}matches方法的两个参数的意思在注释中讲述了，值得一提的是，conditionContext提供了多种方法，方便获取各种信息，也是SpringBoot中 @ConditonalOnXX注解多样扩展的基础。
接着，创建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;
}
}接着就是使用这两个类了，因为此注解可以标注在方法上和类上，所以分开测试：
5.2、标注在方法上
修改BeanConfig：
@Configuration
public class BeanConfig {
//只有一个类时，大括号可以省略
//如果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);
}
}修改测试方法，使其可以打印当前系统名：
@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上的所以只注入了bill，嗯，没毛病。
接着实验linux下的情况，不能运行在linux下，但可以修改运行时参数：
修改后启动测试方法：
一个方法只能注入一个bean实例，所以@Conditional标注在方法上只能控制一个bean实例是否注入。
5.3、标注在类上
一个类中可以注入很多实例，@Conditional标注在类上就决定了一批bean是否注入。
我们试一下，将BeanConfig改写，这时，如果WindowsCondition返回true，则两个Person实例将被注入(注意：上一个测试将os.name改为linux，这是我将把这个参数去掉)：
@Conditional({WindowsCondition.class})
@Configuration
public class BeanConfig {
@Bean(name = "bill")
public Person person1(){
return new Person("Bill Gates",62);
}
@Bean("linus")
public Person person2(){
return new Person("Linus",48);
}
}结果两个实例都被注入：
如果将类上的WindowsCondition.class改为LinuxCondition.class，结果应该可以猜到：
结果就是空的，类中所有bean都没有注入。
5.4、多个条件类
前言中说，@Conditional注解传入的是一个Class数组，存在多种条件类的情况。
这种情况貌似判断难度加深了，测试一波，新增新的条件类，实现的matches返回false（这种写死返回false的方法纯属测试用，没有实际意义O(∩_∩)O）
public class ObstinateCondition implements Condition {
@Override
public boolean matches(ConditionContext conditionContext, AnnotatedTypeMetadata annotatedTypeMetadata) {
return false;
}
}BeanConfig修改一下：
@Conditional({WindowsCondition.class,ObstinateCondition.class})
@Configuration
public class BeanConfig {
@Bean(name = "bill")
public Person person1(){
return new Person("Bill Gates",62);
}
@Bean("linus")
public Person person2(){
return new Person("Linus",48);
}
}结果：
现在如果将ObstinateCondition的matches方法返回值改成true，两个bean就被注入进容器：
结论得：
第一个条件类实现的方法返回true，第二个返回false，则结果false，不注入进容器。
第一个条件类实现的方法返回true，第二个返回true，则结果true，注入进容器中。