Spring Boot 3.4.0 中替换弃用的 @MockBeans

问题描述

在 Spring Boot 3.4.0 中，@MockBean 和 @MockBeans 注解被正式标记为弃用（deprecated）。这影响了使用组合注解简化测试配置的场景，尤其是当需要集中声明多个 Mock 对象时。例如以下常见模式：

@Target(ElementType.TYPE)
@Retention(RetentionPolicy.RUNTIME)
@Documented
@Inherited
@MockBeans({
    @MockBean(ServiceA.class),
    @MockBean(ServiceB.class),
    @MockBean(ServiceC.class) // 可能包含20+服务类
})
public @interface MyMocksTest {}

@MyMocksTest 注解通过 @MockBeans 组合多个服务的模拟声明，避免了在每个测试类中重复配置。随着新版本中这些注解被弃用，开发者需要迁移到官方推荐的 @MockitoBean 方案，但该方案缺乏直接的 @MockitoBeans 替换方式。

解决方案

1. 使用类级 @MockitoBean(types={}) 声明

这是最直接的迁移方案，将原有的 @MockBeans 替换为单行声明：

@Target(ElementType.TYPE)
@Retention(RetentionPolicy.RUNTIME)
@Documented
@Inherited
// 替代方案
@MockitoBean(types = {
    ServiceA.class,
    ServiceB.class,
    ServiceC.class // 可扩展至任意数量
})
public @interface MyMocksTest {}

关键变化：

• 移除 @MockBeans 包裹层
• 改为单注解 @MockitoBean
• 在 types 属性中声明需模拟的类数组

2. 基于类型重复声明方案

对于偏好精细控制的场景，可使用重复注解方式：

@Target(ElementType.TYPE)
@Retention(RetentionPolicy.RUNTIME)
@Documented
@Inherited
@MockitoBean(ServiceA.class)
@MockitoBean(ServiceB.class)
@MockitoBean(ServiceC.class)
public @interface MyMocksTest {}

选择建议

• 批处理模式（方案1）：适合集中管理大量Mock对象（推荐超过5个服务时使用）
• 分散模式（方案2）：需要对不同服务进行精细控制时适用

3. 实例级字段的迁移

对于直接测试类中的字段级声明：

// 弃用方式
@MockBean private ServiceA serviceA;

// 替代方案
@MockitoBean private ServiceA serviceA;

迁移注意事项

重要提示

1. 包路径变更
   新注解位于新的包结构中：

   import org.springframework.test.context.bean.override.mockito.MockitoBean;

   取代了原有的：

   import org.springframework.boot.test.mock.mockito.MockBean;

2. 兼容性过渡
   官方文档表明已弃用注解将持续支持至 Spring Boot 3.5.0：

   | 版本        | 支持状态       |
   |------------|---------------|
   | 3.4.x      | 已弃用但仍可用  |
   | 3.5.0+     | 完全移除       |

3. @SpyBean 的替换
   如果需要部分模拟（Spy）行为，使用：

   @MockitoSpyBean private ServiceD serviceD;

结论

对于大量重复的测试Mock配置，核心迁移策略如下：

1. 类级批量声明 → @MockitoBean(types={ClassA.class, ClassB.class})
2. 单个服务声明 → @MockitoBean（字段级）或重复类级声明
3. 监控真实对象 → @MockitoSpyBean

迁移后完整代码示例：

// 正确导入
import org.springframework.test.context.bean.override.mockito.MockitoBean;

@Target(ElementType.TYPE)
@Retention(RetentionPolicy.RUNTIME)
@Documented
@Inherited
@MockitoBean(types = {ServiceA.class, ServiceB.class, ServiceC.class})
public @interface MyMocksTest {
    // 新标准实现
}

这种方法保持原有的简洁性，完全兼容 Spring Boot 3.4+ 的测试框架，且符合官方推荐的 Mock 管理规范。