如何在 Spring 单元测试中用非 Mock Bean 替换命名 Bean

本文介绍在不启动完整 spring 上下文的前提下,通过构造函数注入方式为被测组件提供自定义的、非 mock 的依赖 bean(如 `@qualifier("fooconsumers")` 的 `list`),避免空指针异常并提升测试效率与可维护性。

在 Spring 单元测试中,若目标是验证某个 @Component(如 MyHealthIndicator)的行为,而它依赖一个由配置类声明的命名 Bean(如 @Bean(name = "FooConsumers") List),直接使用 @SpringBootTest 或 @ExtendWith(SpringExtension.class) 往往是过度设计——不仅启动耗时,还容易因上下文未正确加载或 Bean 覆盖失败导致 jmsConsumersList 为 null,引发 NullPointerException。

更轻量、更可控、也更符合单元测试原则的做法是:绕过 Spring 容器,采用纯 Mockito 驱动的构造注入测试模式

✅ 正确实践:面向构造函数的测试设计

首先,确保被测类支持构造函数注入(推荐且 Spring 原生支持)。修改 MyHealthIndicator,显式暴露带 List 参数的构造

函数(保留 @RequiredArgsConstructor 即可自动生效):

@Component
@ConditionalOnEnabledHealthIndicator("barIndicator")
@RequiredArgsConstructor
public class MyHealthIndicator implements HealthIndicator {
    private final List jmsConsumersList; // final + 构造注入,清晰、安全、易测

    @Override
    public Health health() {
        int connectedCount = 0;
        Map detailsMap = new HashMap<>();
        for (JmsConsumer consumer : jmsConsumersList) { // 不再可能为 null
            if (consumer.isConnected()) {
                connectedCount++;
            }
            detailsMap.put(consumer.getAlias(), consumer.isConnected());
        }
        return Health.up().withDetails(detailsMap).build();
    }
}

接着,在测试类中彻底放弃 SpringExtension,改用 MockitoExtension,并通过手动构造传入预设的测试数据:

@ExtendWith(MockitoExtension.class)
class MyHealthIndicatorTest {

    @Mock
    JmsConsumer jmsConsumer1;

    @Mock
    JmsConsumer jmsConsumer2;

    private MyHealthIndicator myHealthIndicator;

    @BeforeEach
    void setup() {
        // 手动构造:注入你完全掌控的 List 实例
        List testConsumers = List.of(jmsConsumer1, jmsConsumer2);
        myHealthIndicator = new MyHealthIndicator(testConsumers);
    }

    @Test
    void testStatusUpAll() {
        // 配置 mock 行为
        Mockito.when(jmsConsumer1.getAlias()).thenReturn("jmsConsumer1");
        Mockito.when(jmsConsumer1.isConnected()).thenReturn(true);
        Mockito.when(jmsConsumer2.getAlias()).thenReturn("jmsConsumer2");
        Mockito.when(jmsConsumer2.isConnected()).thenReturn(true);

        // 执行被测方法
        Health result = myHealthIndicator.health();

        // 断言
        assertThat(result.getStatus()).isEqualTo(Status.UP);
        assertThat(result.getDetails()).containsEntry("jmsConsumer1", true)
                                        .containsEntry("jmsConsumer2", true);
    }
}

⚠️ 关键注意事项

  • 不要混用 @SpringBootTest / @ContextConfiguration 和手动 new 实例:二者属于不同测试范式。一旦选择构造注入测试,就应完全脱离 Spring 容器初始化逻辑,否则 @Inject 字段仍为空,@Bean 方法也不会被扫描执行。
  • @Mock 必须配合 @ExtendWith(MockitoExtension.class):确保 Mockito 自动完成字段注入和生命周期管理;若用 MockitoAnnotations.openMocks(this),需自行 close()。
  • 优先使用 List.of() 或 Arrays.asList():比 new ArrayList() + add() 更简洁;若需可变列表(如后续要 remove()),再用 new ArrayList(...) 包装。
  • 避免“伪集成”陷阱:试图在 @SpringBootTest 中用 @TestConfiguration 覆盖 @Bean 是可行的,但会引入不必要的上下文开销,且易受 @Primary、@Profile 等影响;对纯逻辑验证而言,构造注入更直接、更可靠。

✅ 总结

单元测试的核心是隔离被测对象、控制所有输入、验证明确输出。对于 MyHealthIndicator 这类职责单一、依赖明确的组件,与其费力模拟 Spring Bean 注册机制,不如拥抱构造函数注入——它让依赖显式化、测试扁平化、代码更健壮。此方案零启动延迟、零上下文干扰、零 NPE 风险,是 Spring 生态下高效单元测试的推荐实践。