Spring很常用的@Conditional注解的使用场景和源码解析

Spring中@Conditional注解的使用场景和源码解析

1. 使用场景

通俗的说，@Conditional是一个条件注解，允许我们根据特定条件来控制是否创建一个Bean。因此， @Conditional这个注解的核心就是用来控制 Bean 的创建的。

在实际开发中，我们经常会碰到类似这样的场景：我们需要根据不同的条件来决定是否创建某一个 Bean。比如，我们需要根据当前所处的环境（如开发、测试、生产）来控制 Bean 的创建。在这种场景下，就可以使用@Conditional注解。

例如，我们可以根据当前的操作系统来控制创建 Bean：

@Configuration
public class AppConfig {

    @Bean("osService")
    @Conditional(ConditionalOnWindows.class)
    public OsService windowsService() {
        return new WindowsService();
    }

    @Bean("osService")
    @Conditional(ConditionalOnLinux.class)
    public OsService linuxService() {
        return new LinuxService();
    }
}

public class ConditionalOnWindows implements Condition{

    @Override
    public boolean matches(ConditionContext context, AnnotatedTypeMetadata metadata) {
        String os = context.getEnvironment().getProperty("os.name");
        return os.toLowerCase().contains("windows");
    }
}

public class ConditionalOnLinux implements Condition{

    @Override
    public boolean matches(ConditionContext context, AnnotatedTypeMetadata metadata) {
        String os = context.getEnvironment().getProperty("os.name");
        return os.toLowerCase().contains("linux");
    }
}

在上面的代码中，我们定义了两个方法，一个是windowsService，一个是linuxService，这两个方法都使用了@Conditional注解，并且分别传入了不同的匹配条件。当我们启动程序时，Spring会通过matches方法来判断操作系统是不是Windows或Linux，从而决定创建哪个Bean。

除了可以用来控制 Bean 的创建外，@Conditional还可以用来控制@Configuration配置类的加载，达到在不同的条件下只加载特定类的目的。

2. 源码解析

@Conditional本质上是一个注解工厂，它会根据我们传入的匹配条件来实例化一个Condition实例，从而控制Bean的创建。

例如，我们举个例子，用一个小小的Java程序来演示：

public class SpringConditionalDemo {
    public static void main(String[] args) {
        AnnotationConfigApplicationContext context = new AnnotationConfigApplicationContext();
        context.register(AppConfig.class);
        context.refresh();
        OsService osService = (OsService) context.getBean("osService");
        System.out.println(osService.getOsName());
    }
}

这个程序创建了一个Spring上下文，并加载了AppConfig。在AppConfig中，我们定义了两个Bean，使用了@Conditional注解，并传入了特定的匹配条件。

我们可以通过打断点来跟踪看看Spring都做了什么：

1. 首先，AnnotationConfigApplicationContext加载了我们的AppConfig。

2. 然后，AnnotationConfigApplicationContext进行了refresh操作。

3. 在refresh过程中，AnnotationConfigApplicationContext调用了finalizeBeanFactory()方法。

4. 在这个方法中，AnnotationConfigApplicationContext会遍历到我们的@Bean注解，在遍历到@Bean注解时，Spring发现了我们的@Bean使用了@Conditional注解，并且传入了我们定义的匹配条件。

5. 在这个时候，Spring会根据我们传入的匹配条件，实例化一个Condition实例，也就是我们的ConditionalOnWindows或ConditionalOnLinux实例。

6. 这个Condition实例有一个matches方法，Spring就会通过这个matches方法来判断我们的条件是否匹配。

7. 如果条件匹配，那么就会创建Bean，否则就会跳过这个Bean的创建。

从上面的过程可以看出，@Conditional注解的关键在于Condition实例的实例化和matches方法的调用。

与此类似的，@Profile注解也是一个条件注解，其作用在于根据特定的Profile是否被激活，来控制Bean的创建。其原理和@Conditional相似，也是通过实例化一个ProfileCondition实例，然后调用matches()方法来判断特定的Profile是否被激活。

总结

@Conditional注解是一个非常有用的注解，可以根据特定的条件来控制Bean的创建。在实际开发中，我们可以根据需要自定义匹配条件，比如，根据操作系统、根据系统环境、根据特定的JVM参数等等来控制Bean的创建。