Spring Boot条件装配详解：@Conditional注解深度解析-CSDN博客

本文链接：https://blog.csdn.net/gitblog_00265/article/details/148941937

Spring Boot条件装配详解：@Conditional注解深度解析

spring-boot-learning 🍀 Hướng dẫn tất tần tật về Spring Boot, Spring Cloud ☘️ Code mẫu tiếng việt, có bài viết hướng dẫn đi kèm hình ảnh dễ hiểu 🍄 项目地址: https://gitcode.com/gh_mirrors/sp/spring-boot-learning

前言

在Spring Boot应用开发过程中，我们经常会遇到需要根据特定条件来创建Bean的场景。比如：

只在测试环境加载某些Bean
当某个配置项开启时才初始化特定组件
根据运行环境决定是否启用某些功能

Spring Boot提供了强大的@Conditional注解系列来解决这类需求。本文将全面解析Spring Boot中的条件装配机制，帮助开发者掌握这一重要特性。

条件装配基础

什么是条件装配

条件装配指的是在Spring容器启动时，根据特定条件决定是否创建和注册某个Bean。这种机制使得应用程序可以更加灵活地适应不同的运行环境。

基本使用方式

在Spring Boot中，所有条件注解都可以应用于以下场景：

方法级别：与@Bean注解一起使用

@Configuration
public class AppConfig {
    @Bean
    @Conditional(...)
    public MyBean myBean() {
        return new MyBean();
    }
}

类级别：与@Configuration、@Component等注解一起使用

@Conditional(...)
@Configuration
public class AppConfig {
    // 所有@Bean方法都会受条件影响
}

常用条件注解详解

1. @ConditionalOnBean

作用：当容器中存在指定Bean时才创建当前Bean

典型场景：

某个功能需要依赖特定Bean存在时才启用
避免重复注册相同功能的Bean

示例：

@Configuration
public class DatabaseConfig {
    @Bean
    @ConditionalOnBean(DataSource.class)
    public JdbcTemplate jdbcTemplate() {
        return new JdbcTemplate(dataSource());
    }
}

2. @ConditionalOnProperty

作用：根据配置属性决定是否创建Bean

关键参数：

value：配置属性名
havingValue：匹配的值
matchIfMissing：属性不存在时的默认行为

示例：

@Bean
@ConditionalOnProperty(
    name = "app.feature.enabled",
    havingValue = "true",
    matchIfMissing = false
)
public FeatureService featureService() {
    return new FeatureService();
}

3. @ConditionalOnExpression

作用：支持SpEL表达式形式的复杂条件判断

典型场景：

需要同时满足多个条件
条件判断逻辑比较复杂

示例：

@Configuration
@ConditionalOnExpression(
    "${app.module1.enabled:true} and ${app.module2.enabled:false}"
)
public class ComplexModuleConfig {
    // 配置类
}

4. @ConditionalOnMissingBean

作用：当容器中不存在指定类型的Bean时才创建

典型场景：

提供默认实现
避免Bean重复定义

示例：

@Bean
@ConditionalOnMissingBean
public CacheService cacheService() {
    return new DefaultCacheService();
}

5. @ConditionalOnClass

作用：当classpath中存在指定类时才创建Bean

典型场景：

自动配置类中检查依赖是否存在
功能模块的条件加载

示例：

@Configuration
@ConditionalOnClass(name = "com.example.SomeLibrary")
public class SomeLibraryAutoConfig {
    // 自动配置
}

6. @ConditionalOnResource

作用：当指定资源存在时才创建Bean

典型场景：

配置文件存在性检查
资源依赖验证

示例：

@Configuration
@ConditionalOnResource(resources = "/config/special.properties")
public class SpecialConfig {
    // 特殊配置
}

高级用法

组合条件

多个条件注解可以组合使用，实现更复杂的判断逻辑：

@Bean
@ConditionalOnClass(name = "com.example.SomeService")
@ConditionalOnProperty(name = "app.some-service.enabled", havingValue = "true")
public SomeServiceWrapper someServiceWrapper() {
    return new SomeServiceWrapper();
}

自定义条件

虽然Spring Boot提供了丰富的内置条件注解，但有时我们需要自定义条件逻辑：

实现Condition接口
使用@Conditional注解引用自定义条件

示例：

public class CustomCondition implements Condition {
    @Override
    public boolean matches(ConditionContext context, AnnotatedTypeMetadata metadata) {
        // 自定义条件逻辑
        return true;
    }
}

@Configuration
@Conditional(CustomCondition.class)
public class CustomConfig {
    // 配置
}