动态加载 Spring Bean 的实用技巧

本文介绍了如何在 Spring 应用程序中基于环境动态加载不同的 Bean 实现。通过使用 @Conditional 注解和手动配置 Bean，可以根据特定条件选择性地加载 DoThingService 或 NoopService，从而避免了 Bean 冲突问题，并简化了单元测试。

在 Spring 应用程序开发中，经常会遇到需要根据不同的环境（例如：生产环境、测试环境、开发环境）加载不同的 Bean 实现的情况。 一种常见的做法是使用 @Conditional 注解，但是当多个 Bean 实现了同一个接口时，可能会出现 Spring 无法区分应该注入哪个 Bean 的问题，导致 No qualifying bean of type ... available 错误。

本文将介绍一种通过手动配置 Bean 和使用 @Conditional 注解来解决这个问题的方法。

问题描述

假设我们有一个 DoThingInterface 接口，以及两个实现类 DoThingService 和 NoopService。 DoThingService 实现了具体的业务逻辑，而 NoopService 则是一个空操作，用于在某些环境下禁用该功能。

public interface DoThingInterface {
    void doThing();
}

public class DoThingService implements DoThingInterface {
    @Override
    public void doThing() {
        // business logic
    }
}

public class NoopService implements DoThingInterface {
    @Override
    public void doThing() {
        // noop
    }
}

我们希望根据特定的条件（例如：环境、配置属性）选择性地加载 DoThingService 或 NoopService。 传统的做法是使用 @Conditional 注解在 DoThingService 和 NoopService 类上，然后通过 @Autowired 注入 DoThingInterface。

@Conditional(DoThingCondition.class)
@Component
public class DoThingService implements DoThingInterface {
    @Override
    public void doThing() {
       // business logic
    }
}

@Conditional(DoNotDoThingCondition.class)
@Component
public class NoopService implements DoThingInterface {
    @Override
    public void doThing() {
        // noop
    }
}

public class AppController {

    @Autowired
    private DoThingInterface doThingService;

    public void businessLogicMethod() {
        doThingService.doThing();
    }
}

但是，这种做法会导致 Spring 无法区分应该注入哪个 Bean，因为 DoThingService 和 NoopService 都实现了 DoThingInterface 接口。

解决方案

解决这个问题的方法是将 @Conditional 注解移动到配置类中，并手动创建 Bean。

1. 创建 Condition 类

首先，我们需要创建两个 Condition 类，用于判断是否应该加载 DoThingService 或 NoopService。

public class DoNotDoTheThingCondition implements Condition {
    @Override
    public boolean matches(ConditionalContext context) {
        // 根据环境、配置属性等条件判断是否应该加载 NoopService
        return !(/* condition logic */);
    }
}

public class DoThingCondition implements Condition {
    @Override
    public boolean matches(ConditionalContext context) {
        // 根据环境、配置属性等条件判断是否应该加载 DoThingService
        return /* condition logic */;
    }
}

示例 Condition 实现：

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

public class DoNotDoTheThingCondition implements Condition {
    @Override
    public boolean matches(ConditionContext context, AnnotatedTypeMetadata metadata) {
        String region = System.getenv("REGION"); // 假设从环境变量中获取区域信息
        String profile = context.getEnvironment().getProperty("spring.profiles.active"); // 获取激活的 Profile

        // 简化后的条件判断：如果不是生产环境，则不执行 DoThing
        return !(region != null && region.equals("someRegion") && profile != null && profile.contains("prod"));
    }
}

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

public class DoThingCondition implements Condition {
    @Override
    public boolean matches(ConditionContext context, AnnotatedTypeMetadata metadata) {
        String region = System.getenv("REGION"); // 假设从环境变量中获取区域信息
        String profile = context.getEnvironment().getProperty("spring.profiles.active"); // 获取激活的 Profile

        // 简化后的条件判断：如果是生产环境，则执行 DoThing
        return region != null && region.equals("someRegion") && profile != null && profile.contains("prod");
    }
}

2. 创建配置类

然后，创建一个配置类，并使用 @Conditional 注解在 Bean 方法上。

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

@Configuration
public class DoThingConfiguration {
    @Conditional(DoThingCondition.class)
    @Bean
    public DoThingInterface doThingService() {
        return new DoThingService();
    }

    @Conditional(DoNotDoTheThingCondition.class)
    @Bean
    public DoThingInterface noopService() {
        return new NoopService();
    }
}

3. 修改 Controller 类

最后，修改 Controller 类，通过 @Autowired 注入 DoThingInterface。

import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.stereotype.Component;

@Component
public class AppController {

    @Autowired
    private DoThingInterface doThingService;

    public void businessLogicMethod() {
        doThingService.doThing();
    }
}

总结

通过将 @Conditional 注解移动到配置类中，并手动创建 Bean，可以避免 Spring 无法区分应该注入哪个 Bean 的问题。 这种做法的优点是可以更加灵活地控制 Bean 的加载，并且可以简化单元测试，因为不需要 Mock NoopService。

注意事项：

• 需要保证 DoThingCondition 和 DoNotDoTheThingCondition 之间的互斥性，即只有一个 Condition 能够匹配。
• 在实际开发中，Condition 的实现应该根据具体的业务需求进行调整。
• 这种方法需要在配置类中手动创建 Bean，可能会增加代码的复杂性。

总而言之，这种方法提供了一种在 Spring 应用程序中动态加载 Bean 的有效方式，特别是在需要根据环境或配置选择不同实现的情况下。