Springboot核心注解之Condition

一.Condition注解

1.Condition注解概述

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

下面通过一个小案例来了解Condition注解

在SpringIOC容器中有一个User的Bean，现要求：
（1）导入Jedis坐标后，加载该Bean，未导入，则不加载；
（2）将类的判断定义为动态的。判断哪个字节码文件存在可以动态指定。

实现：

0.引入依赖，配置文件

        <dependency>
            <groupId>com.alibaba</groupId>
            <artifactId>fastjson</artifactId>
            <version>1.2.4</version>
        </dependency>

tangbb=18

1.创建User实体类

public class User {
}

2.创建ClassCondition类实现Condition接口，实现matches方法

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

import java.util.Map;

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

        //2.需求： 导入通过注解属性值value指定坐标后创建Bean

        //获取注解属性值  value
        Map<String, Object> map = metadata.getAnnotationAttributes(ConditionOnClass.class.getName());
        //System.out.println(map);
        String[] value = (String[]) map.get("value");

        boolean flag = true;
        try {
            for (String className : value) {
                Class<?> cls = Class.forName(className);
            }
        } catch (ClassNotFoundException e) {
            flag = false;
        }
        return flag;

    }
}

3.创建注解ConditionOnClass

import org.springframework.context.annotation.Conditional;

import java.lang.annotation.*;


@Target({ElementType.TYPE, ElementType.METHOD})
@Retention(RetentionPolicy.RUNTIME)
@Documented
@Conditional(ClassCondition.class)//class为上面自定义的condition
public @interface ConditionOnClass {
    String[] value();
}

4.创建UserConfig

import com.itheima.springbootcondition.condtion.ClassCondition;
import com.itheima.springbootcondition.condtion.ConditionOnClass;
import com.itheima.springbootcondition.domain.User;
import org.springframework.boot.autoconfigure.condition.ConditionalOnClass;
import org.springframework.boot.autoconfigure.condition.ConditionalOnProperty;
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("com.alibaba.fastjson.JSON")//使用创建的注解实现bean的加载
    public User user(){
        return new User();
    }

    @Bean
    @ConditionalOnProperty(name = "tangbb",havingValue = "18")//配置文件中需要有tangbb:18的配置项才会注入bean
    public User user2(){
        return new User();
    }

}

5.测试

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) {
        //启动SpringBoot的应用，返回Spring的IOC容器
        ConfigurableApplicationContext context = SpringApplication.run(SpringbootConditionApplication.class, args);
        
        Object user = context.getBean("user");
        System.out.println(user);
        Object user2 = context.getBean("user2");
        System.out.println(user2);
    }

}

2.Condition小结
（1）自定义条件：
        定义条件类：自定义类实现Condition接口，重写matches方法，在matches方法中进行逻辑判断，返回boolean值。matches方法两个参数：context 上下文对象，可以获取属性值，类加载器，BeanFactory等。metadata 元数据对象，勇于获取注解属性。
（2）判断条件：在初始化Bean时，使用@Conditional(条件类.class)注解
SpringBoot提供的常用条件注解：
《1》ConditionalOnProperty：判断配置文件中是否有对应属性和值才初始化Bean
《2》ConditionalOnClass：判断环境中是否有对应字节码文件才初始化Bean
《3》ConditionalOnMissingBean：判断环境汇总没有对应的Bean才初始化Bean