Spring Boot @Conditional 注解分析与实际业务场景应用

什么是 @Conditional 注解？

在 Spring Boot 中，@Conditional 是一个非常强大的注解，用于根据特定条件动态决定是否加载某个 Bean 或配置类。它是 Spring 框架条件装配的核心机制，广泛应用于自动配置（AutoConfiguration）和环境适配场景中。通过实现 Condition 接口并结合 @Conditional，我们可以自定义条件逻辑。

常见的内置条件注解包括：

@ConditionalOnProperty：根据配置文件中的属性值决定。
@ConditionalOnClass：根据类路径中是否存在某个类决定。
@ConditionalOnMissingBean：根据容器中是否缺少某个 Bean 决定。
@ConditionalOnExpression：基于 SpEL 表达式判断。

本文将通过一个实际业务场景，展示如何使用自定义 @Conditional 实现环境适配。

业务场景：根据操作系统加载不同的 Bean

假设我们正在开发一个文件处理服务，针对 Linux 和 Windows 环境需要使用不同的文件路径处理逻辑：

在 Linux 环境下，使用 /var/data/ 作为文件存储路径。
在 Windows 环境下，使用 C:\data\ 作为文件存储路径。

我们希望 Spring Boot 在启动时根据操作系统自动加载对应的 Bean，而无需手动配置。

实现步骤

1. 定义业务接口

首先，定义一个通用的文件处理服务接口：

java 复制代码

public interface FileService {
    String getFilePath();
}

2. 实现 Linux 和 Windows 的具体 Bean

分别实现针对 Linux 和 Windows 的文件服务：

java 复制代码

public class LinuxFileService implements FileService {
    @Override
    public String getFilePath() {
        return "/var/data/";
    }
}

public class WindowsFileService implements FileService {
    @Override
    public String getFilePath() {
        return "C:\\data\\";
    }
}

3. 自定义 Condition 类

创建两个 Condition 实现类，用于判断当前操作系统：

java 复制代码

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

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

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

4. 配置类中使用 @Conditional

在配置类中，使用 @Conditional 注解将 Bean 与条件绑定：

java 复制代码

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

@Configuration
public class FileServiceConfig {

    @Bean
    @Conditional(LinuxCondition.class)
    public FileService linuxFileService() {
        return new LinuxFileService();
    }

    @Bean
    @Conditional(WindowsCondition.class)
    public FileService windowsFileService() {
        return new WindowsFileService();
    }
}

5. 测试代码

创建一个简单的控制器来验证：

java 复制代码

import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.web.bind.annotation.GetMapping;
import org.springframework.web.bind.annotation.RestController;

@RestController
public class FileController {

    @Autowired
    private FileService fileService;

    @GetMapping("/file-path")
    public String getFilePath() {
        return fileService.getFilePath();
    }
}

6. 运行结果

在 Linux 环境下，访问 /file-path 返回 /var/data/。
在 Windows 环境下，访问 /file-path 返回 C:\data\。

代码分析

条件判断逻辑 ：LinuxCondition 和 WindowsCondition 通过 System.getProperty("os.name") 获取操作系统名称，并根据字符串匹配判断环境。
Bean 加载 ：Spring 在容器初始化时会调用 matches 方法，只有当条件为 true 时，对应的 Bean 才会被注册。
单一 Bean 保证 ：由于 FileService 是接口，且每次只会有一个实现类满足条件加载，因此不会出现 Bean 冲突。

面试官可能提出的问题及应对

Q1: 如果操作系统既不是 Linux 也不是 Windows，会发生什么？

回答：如果当前操作系统不匹配任何条件（例如 macOS），Spring 容器中将不会有 FileService 的 Bean 实例注入。如果尝试使用 @Autowired 注入，会抛出 NoSuchBeanDefinitionException。
解决方法 ：可以添加一个默认实现，并使用 @ConditionalOnMissingBean：

java 复制代码

@Bean
@ConditionalOnMissingBean(FileService.class)
public FileService defaultFileService() {
    return new FileService() {
        @Override
        public String getFilePath() {
            return "/default/path/";
        }
    };
}

Q2: 如何测试 @Conditional 的行为？

回答：可以使用 Spring Boot 的测试框架，结合 System.setProperty 模拟不同操作系统：

java 复制代码

import org.junit.jupiter.api.Test;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.boot.test.context.SpringBootTest;

import static org.junit.jupiter.api.Assertions.assertEquals;

@SpringBootTest
public class FileServiceTest {

    @Autowired
    private FileService fileService;

    @Test
    public void testLinuxEnvironment() {
        System.setProperty("os.name", "Linux");
        assertEquals("/var/data/", fileService.getFilePath());
    }

    @Test
    public void testWindowsEnvironment() {
        System.setProperty("os.name", "Windows 10");
        assertEquals("C:\\data\\", fileService.getFilePath());
    }
}

Q3: @Conditional 和 @Profile 有什么区别？

回答：

@Profile 是 Spring 提供的一种更粗粒度的条件机制，通常基于环境（如 dev、prod）激活整个配置类或 Bean，依赖于 spring.profiles.active 属性。
@Conditional 更灵活，可以自定义条件逻辑（如操作系统、类存在性等），适用于更细粒度的控制。
使用场景 ：如果只是简单区分开发和生产环境，@Profile 更简洁；如果需要复杂条件判断，@Conditional 更合适。

Q4: 如何处理多个条件组合？

回答：可以使用 Spring 的 @Conditional 配合多个 Condition 类，或者直接使用 @ConditionalOnExpression：

java 复制代码

@Bean
@ConditionalOnExpression("'${os.name}'.contains('linux') && '${feature.enabled}' == 'true'")
public FileService linuxFileService() {
    return new LinuxFileService();
}

这种方式可以通过 SpEL 表达式组合多个条件。

总结

通过 @Conditional 注解，我们可以轻松实现基于操作系统的动态 Bean 加载。这种方法在跨平台开发中非常实用，尤其适用于需要适配不同环境的业务场景。结合自定义 Condition 和 Spring Boot 的自动配置能力，开发者可以构建高度灵活的应用程序。

希望这篇博客能帮助你更好地理解和应用 @Conditional 注解！