【Spring高级】条件注解

Spring框架中的条件注解（Conditional Annotations）是一种强大的机制，它允许开发者根据特定的条件来决定是否创建某个bean。这种机制为Spring容器提供了更多的灵活性和控制力，使得开发者能够根据不同的环境或配置来动态地调整bean的创建。

条件注解的原理主要基于Spring的IoC容器和条件判断机制。当Spring容器启动时，它会扫描所有的bean定义，并检查是否存在条件注解。如果存在条件注解，Spring容器会根据注解中定义的条件来判断是否应该创建该bean。

具体来说，条件注解通常与一些条件类一起使用，这些条件类实现了Condition接口，并定义了具体的条件判断逻辑。在条件注解中，通过指定条件类的类名或使用其他条件表达式来定义条件。

当Spring容器扫描到带有条件注解的bean定义时，它会创建一个条件上下文（Condition Context），并将该上下文传递给条件类。条件类使用上下文中的信息来判断条件是否满足。如果条件满足，Spring容器就会创建该bean；否则，bean将不会被创建。

下面我们自己来创建一个条件注解。

首先创建我们自定义的注解：

@Retention(RetentionPolicy.RUNTIME)
@Target({ElementType.METHOD, ElementType.TYPE})
@Conditional(MyCondition.class)
@interface ConditionalOnClass {
    boolean exists(); // true 判断存在 false 判断不存在

    String className(); // 要判断的类名
}

创建条件类，它实现了Condition接口，以及他的matches方法：

static class MyCondition implements Condition {
        @Override
        public boolean matches(ConditionContext context, AnnotatedTypeMetadata metadata) {
            // 获取ConditionalOnClass的所有属性
            Map<String, Object> attributes = metadata.getAnnotationAttributes(ConditionalOnClass.class.getName());
            // 获取参数className
            String className = attributes.get("className").toString();
            // 获取参数exists
            boolean exists = (boolean) attributes.get("exists");
            // 检查类路径下是否存在指定类
            boolean present = ClassUtils.isPresent(className, null);
            // 如果要判断存在，返回上面的检查结果，否咋取反
            return exists ? present : !present;
        }
    }

上面的条件类，主要用来检查类路径下是否含有指定类名className。

然后使用的时候，在配置类上使用自定义注解即可，完整示例：

package com.cys.spring.chapter17;

import org.springframework.context.annotation.*;
import org.springframework.context.support.GenericApplicationContext;
import org.springframework.core.type.AnnotatedTypeMetadata;
import org.springframework.core.type.AnnotationMetadata;
import org.springframework.util.ClassUtils;

import java.io.IOException;
import java.lang.annotation.ElementType;
import java.lang.annotation.Retention;
import java.lang.annotation.RetentionPolicy;
import java.lang.annotation.Target;
import java.util.Map;

/**
 * @author Ethan
 * @date 2024/3/10
 * @description
 */
public class TestCondition {

    @SuppressWarnings("all")
    public static void main(String[] args) throws IOException {
        GenericApplicationContext context = new GenericApplicationContext();
        context.registerBean("config", Config.class);
        context.registerBean(ConfigurationClassPostProcessor.class);
        context.refresh();

        for (String name : context.getBeanDefinitionNames()) {
            System.out.println(name);
        }
    }

    @Configuration // 本项目的配置类
    @Import(MyImportSelector.class)
    static class Config {
    }

    static class MyImportSelector implements DeferredImportSelector {
        @Override
        public String[] selectImports(AnnotationMetadata importingClassMetadata) {
            return new String[]{AutoConfiguration1.class.getName(), AutoConfiguration2.class.getName()};
        }
    }

    /**
     * 条件类
     */
    static class MyCondition implements Condition { // 存在 Druid 依赖
        @Override
        public boolean matches(ConditionContext context, AnnotatedTypeMetadata metadata) {
            // 获取ConditionalOnClass的所有属性
            Map<String, Object> attributes = metadata.getAnnotationAttributes(ConditionalOnClass.class.getName());
            // 获取参数className
            String className = attributes.get("className").toString();
            // 获取参数exists
            boolean exists = (boolean) attributes.get("exists");
            // 检查类路径下是否存在指定类
            boolean present = ClassUtils.isPresent(className, null);
            // 如果要判断存在，返回上面的检查结果，否咋取反
            return exists ? present : !present;
        }
    }

    /**
     * 自定义条件注解
     */
    @Retention(RetentionPolicy.RUNTIME)
    @Target({ElementType.METHOD, ElementType.TYPE})
    @Conditional(MyCondition.class)
    @interface ConditionalOnClass {
        boolean exists(); // true 判断存在 false 判断不存在

        String className(); // 要判断的类名
    }

    @Configuration // 第三方的配置类
    @ConditionalOnClass(className = "com.alibaba.druid.pool.DruidDataSource", exists = false)
    static class AutoConfiguration1 {
        @Bean
        public Bean1 bean1() {
            return new Bean1();
        }
    }

    @Configuration // 第三方的配置类
    @ConditionalOnClass(className = "com.alibaba.druid.pool.DruidDataSource", exists = true)
    static class AutoConfiguration2 {
        @Bean
        public Bean2 bean2() {
            return new Bean2();
        }
    }

    static class Bean1 {

    }

    static class Bean2 {

    }


}

运行结果如下：

config
org.springframework.context.annotation.ConfigurationClassPostProcessor
com.cys.spring.chapter17.TestCondition$AutoConfiguration2
bean2

因为在Bean2的条件注解中，exists = true，且类路径下确实存在DruidDataSource，所以AutoConfiguration2可以自动装配，Bean2被创建。