在 Spring Boot 中，条件注解 (@Conditional 系列) 是实现条件性 bean 加载的重要工具。它们允许开发者在特定条件满足时才注册某个 bean，从而增强了应用的灵活性和可配置性。本文将深入探讨这些注解的用法及其背后的原理，并提供示例代码。

1. 什么是 @Conditional 系列注解？

Spring 提供了多个条件注解，主要包括：

• @Conditional
• @ConditionalOnBean
• @ConditionalOnMissingBean
• @ConditionalOnProperty
• @ConditionalOnClass
• @ConditionalOnMissingClass
• @ConditionalOnResource
• @ConditionalOnExpression
• @ConditionalOnJava
• @ConditionalOnWebApplication

这些注解通常用于配置类和 bean 的声明，以控制它们的创建和注册。

2. 主要的 @Conditional 注解解析

2.1 @Conditional

@Conditional 注解可以与自定义条件类一起使用，只有在条件类的 matches 方法返回 true 时，标注的 bean 才会被加载。

示例：

import org.springframework.context.annotation.Conditional;
import org.springframework.context.annotation.Configuration;

@Configuration
@Conditional(MyCondition.class)
public class MyConditionalConfig {
    // 只有在 MyCondition 满足时，这个配置才会生效
}

2.2 @ConditionalOnBean

@ConditionalOnBean 注解允许在某个指定的 bean 存在时，才加载被标注的 bean。

示例：

import org.springframework.boot.autoconfigure.condition.ConditionalOnBean;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;

@Configuration
public class MyConfig {

    @Bean
    public MyService myService() {
        return new MyService();
    }

    @Bean
    @ConditionalOnBean(MyService.class)
    public MyDependentService myDependentService() {
        return new MyDependentService(myService());
    }
}

2.3 @ConditionalOnMissingBean

与 @ConditionalOnBean 相对，@ConditionalOnMissingBean 在某个 bean 不存在时才加载。

示例：

import org.springframework.boot.autoconfigure.condition.ConditionalOnMissingBean;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;

@Configuration
public class MyConfig {

    @Bean
    @ConditionalOnMissingBean(MyService.class)
    public MyService myService() {
        return new MyService(); // 只有在 MyService 不存在时才会被创建
    }
}

2.4 @ConditionalOnProperty

@ConditionalOnProperty 用于根据配置文件中的属性值判断是否加载该 bean。

示例：

import org.springframework.boot.autoconfigure.condition.ConditionalOnProperty;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;

@Configuration
public class MyConfig {

    @Bean
    @ConditionalOnProperty(name = "feature.enabled", havingValue = "true")
    public MyFeatureService myFeatureService() {
        return new MyFeatureService();
    }
}

2.5 @ConditionalOnClass 和 @ConditionalOnMissingClass

这两个注解用于根据类的存在与否来决定是否加载 bean。

示例：

import org.springframework.boot.autoconfigure.condition.ConditionalOnClass;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;

@Configuration
public class MyConfig {

    @Bean
    @ConditionalOnClass(name = "com.example.SomeLibrary")
    public MyService myService() {
        return new MyService(); // 只有在 SomeLibrary 存在时才会被创建
    }
}

3. 使用场景

1. 可选功能：通过 @ConditionalOnProperty 可以轻松实现某些功能的开关。
2. 依赖管理：使用 @ConditionalOnBean 和 @ConditionalOnMissingBean 可以确保依赖的 bean 存在或不存在，从而防止应用中的错误。
3. 环境适配：可以根据运行环境加载特定的配置，比如开发、测试和生产环境。

4. 小结

@Conditional 系列注解为 Spring Boot 提供了强大的条件化 bean 注册能力。通过使用这些注解，可以根据不同的条件动态地加载 bean，从而使应用更加灵活和可维护。

希望这篇博客能够帮助你理解和使用 Spring Boot 中的条件注解！如果你有任何问题，欢迎讨论！

Tags：conditionalonexpression