SpringBoot 高级 原理分析 -- SpringBoot 自动配置：Condition

Posted 2021-12-12 CodeJiao

1. SpringBoot 自动配置：Condition

Condition 是在Spring 4.0 增加的条件判断功能，通过这个可以功能可以实现选择性的创建 Bean 操作。

---

1.1 需求1：判断定义为静态的

在 Spring 的 IOC 容器中有一个 User 的 Bean，现要求：

1. 导入Jedis坐标后，加载该User的Bean，没导入，则不加载。

---

1.1.1 我们先创建一个SpringBoot的项目

---

1.1.2 配置User类

User.java:

package com.tian.pojo;

public class User {
}

UserConfig .java:

package com.tian.config;

import com.tian.condtion.ClassCondition;
import com.tian.pojo.User;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Conditional;
import org.springframework.context.annotation.Configuration;

@Configuration
public class UserConfig {
    @Bean
    // @Conditional注解是条件判断注解, 用于判断是否将Bean托管到IOC
    // 里面有一个参数是实现了Condition接口的类的字节码文件 
    // 实现类里面重写了里面的matches方法（返回布尔值：true表示交给IOC托管,false反之不交给IOC托管）
    @Conditional(ClassCondition.class)
    public User user() {
        return new User();
    }
}

ClassCondition.java:

package com.tian.condtion;

import org.springframework.context.annotation.Condition;
import org.springframework.context.annotation.ConditionContext;
import org.springframework.core.type.AnnotatedTypeMetadata;

public class ClassCondition implements Condition {
    /**
     * @param context  上下文对象。用于获取环境，IOC容器，ClassLoader对象
     * @param metadata 注解元对象。 可以用于获取注解定义的属性值
     */
    @Override
    public boolean matches(ConditionContext context, AnnotatedTypeMetadata metadata) {
        //1.需求： 导入Jedis坐标后创建Bean
        //思路：判断redis.clients.jedis.Jedis.class文件是否存在
        boolean flag = true;
        try {
            // 根据字节码文件是否存在判断是否引入了Jedis坐标
            Class<?> cls = Class.forName("redis.clients.jedis.Jedis");
        } catch (ClassNotFoundException e) {
            flag = false;
        }
        return flag;
    }
}

---

1.1.3 开始测试

package com.tian;

import org.springframework.boot.SpringApplication;
import org.springframework.boot.autoconfigure.SpringBootApplication;
import org.springframework.context.ConfigurableApplicationContext;

@SpringBootApplication
public class SpringbootConditionApplication {

    public static void main(String[] args) {
        // SpringApplication的run方法会返回IOC容器
        ConfigurableApplicationContext context = SpringApplication.run(SpringbootConditionApplication.class, args);
        // 打印user对象 如果可以正常输出则说明引入了Jedis坐标, 否则没有引入
        System.out.println(context.getBean("user"));
    }
}

测试结果：

---

1.2 需求2：判断定义为动态的

在 Spring 的 IOC 容器中有一个 User 的 Bean，现要求：

1. 导入Jedis坐标后，加载该Bean，没导入，则不加载。
2. 将类的判断定义为动态的。判断哪个字节码文件存在可以动态指定。

---

1.1.1 配置

ConditionOnClass.java

自定义注解，用于获取注解的value值（里面是需要判断的类的全限定类型数组）

package com.tian.condtion;


import org.springframework.context.annotation.Conditional;

import java.lang.annotation.*;


@Target({ElementType.TYPE, ElementType.METHOD})
@Retention(RetentionPolicy.RUNTIME)
@Documented
@Conditional(ClassCondition.class)
public @interface ConditionOnClass {
    String[] value();
}

ClassCondition.java

修改ClassCondition，将判断定义为动态的

package com.tian.condtion;

import org.springframework.context.annotation.Condition;
import org.springframework.context.annotation.ConditionContext;
import org.springframework.core.type.AnnotatedTypeMetadata;

import java.util.Map;

public class ClassCondition implements Condition {
    /**
     * 需求： 导入通过注解属性值value指定坐标后创建Bean
     *
     * @param context  上下文对象。用于获取环境，IOC容器，ClassLoader对象
     * @param metadata 注解元对象。 可以用于获取注解定义的属性值
     */
    @Override
    public boolean matches(ConditionContext context, AnnotatedTypeMetadata metadata) {
        //获取注解属性值  classNames
        Map<String, Object> map = metadata.getAnnotationAttributes(ConditionOnClass.class.getName());
        String[] classNames = new String[0];
        boolean flag = true;
        if (map != null) {
            classNames = (String[]) map.get("value");
        }
        try {
            for (String className : classNames) {
                Class<?> cls = Class.forName(className);
            }
        } catch (ClassNotFoundException e) {
            flag = false;
        }
        return flag;
    }
}

UserConfig.java

修改UserConfig ，加上@ConditionOnClass，里面填充需要判断的类的全限定类型数组

package com.tian.config;

import com.tian.condtion.ClassCondition;
import com.tian.condtion.ConditionOnClass;
import com.tian.pojo.User;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Conditional;
import org.springframework.context.annotation.Configuration;

@Configuration
public class UserConfig {
    @Bean
    @Conditional(ClassCondition.class)
    @ConditionOnClass(value = {"redis.clients.jedis.Jedis", "com.alibaba.fastjson.JSON"})
    public User user() {
        return new User();
    }
}

---

1.1.2 开始测试

---

1.3 思考

SpringBoot是如何知道要创建哪个Bean的？比如SpringBoot是如何知道要创建RedisTemplate的？

• 解答：其实SpringBoot会使用COndition来判断当前环境中有没有导入RedisTemplate依赖，如果有则会帮你创建RedisTemplate，否则不会创建RedisTemplate。

---

1.3.1 思考探究

演示：

RedisTemplate配置查看：

---

1.3.2 演示：

当配置文件有key为name, value为tianJiao的属性时才创建bean

package com.tian.config;

import com.tian.pojo.User;
import org.springframework.boot.autoconfigure.condition.ConditionalOnProperty;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;

@Configuration
public class UserConfig {
    @Bean
    // 当配置文件有key为name, value为tianJiao的属性时才创建bean
    @ConditionalOnProperty(name = "name", havingValue = "tianJiao")
    public User user() {
        return new User();
    }
}

运行结果：

---

1.4 小结

---

---