SpringBoot单元测试中@SpyBean使用小结

 更新时间:2025年08月25日 10:08:08   作者:zru_9602  
本文主要介绍了SpringBoot单元测试中@SpyBean使用小结,@SpyBean用于部分模拟SpringBean,文中通过示例代码介绍的非常详细,对大家的学习或者工作具有一定的参考学习价值,需要的朋友们下面随着小编来一起学习学习吧

1. 什么是@SpyBean?

@SpyBean 是 Spring Boot Test 提供的一个注解,用于在单元测试中**部分模拟(Partial Mock)**一个 Spring Bean。它类似于 Mockito 的 @Spy,但专门用于 Spring 容器中的 Bean。

  • @MockBean:完全模拟一个 Bean,所有方法都需要手动定义行为。
  • @SpyBean:基于真实 Bean,只重写(Mock)部分方法,其余方法仍然调用真实逻辑。

2. 何时使用@SpyBean?

适用场景

  • 你只想修改某个 Bean 的某个方法,但其他方法仍然走真实逻辑。
  • 你希望测试依赖某个 Bean 的真实逻辑,但需要控制其中某个方法的返回值。

不适用场景

  • 需要完全模拟整个 Bean(用 @MockBean)。
  • Bean 的方法是 finalstatic(Mockito 无法 Spy final 方法)。

3. 基本用法

示例场景

假设有一个 UserService 依赖 UserRepository,我们想测试 UserService,但只重写 UserRepositoryfindById() 方法,其他方法(如 save())仍然走真实逻辑。

@Service
public class UserService {
    @Autowired
    private UserRepository userRepository;

    public String getUserName(Long id) {
        User user = userRepository.findById(id).orElseThrow();
        return user.getName();
    }
}

测试代码

@SpringBootTest
public class UserServiceTest {

    @Autowired
    private UserService userService;

    @SpyBean  // 对 UserRepository 进行 Spy,未 Mock 的方法仍然走真实逻辑
    private UserRepository userRepository;

    @Test
    public void testGetUserName() {
        // 准备测试数据
        User mockUser = new User(1L, "Alice");
        userRepository.save(mockUser);  // 真实调用 save()

        // 只 Mock findById(),让它返回自定义数据
        doReturn(Optional.of(new User(1L, "Mocked Alice")))
            .when(userRepository).findById(1L);

        // 调用测试方法
        String userName = userService.getUserName(1L);

        // 验证
        assertEquals("Mocked Alice", userName);

        // 其他方法仍然走真实逻辑
        User savedUser = userRepository.findById(2L).orElse(null);
        assertNull(savedUser);  // 因为没有存 ID=2 的用户
    }
}

4.@SpyBean的常用 Mock 方式

(1)doReturn().when(spy).method()

// 让方法返回固定值
doReturn("Mocked Result").when(mySpyBean).someMethod();

// 带参数匹配
doReturn("Hello").when(mySpyBean).greet(anyString());

(2)doAnswer()(自定义逻辑)

doAnswer(invocation -> {
    String arg = invocation.getArgument(0);
    return "Processed: " + arg;
}).when(mySpyBean).process(anyString());

(3)doThrow()(模拟异常)

doThrow(new RuntimeException("DB Error"))
    .when(mySpyBean).save(any());

(4)doCallRealMethod()(显式调用真实方法)

// 默认会走真实方法,但也可以显式声明
doCallRealMethod().when(mySpyBean).someMethod();

5.@SpyBeanvs@MockBean

特性@SpyBean@MockBean
默认行为未 Mock 的方法调用真实逻辑未 Mock 的方法返回默认值(null/0/false)
适用场景只修改部分方法,其他方法仍需真实逻辑完全模拟 Bean,不依赖真实实现
性能稍慢(需代理真实对象)更快(纯 Mock 对象)

6. 常见问题

Q1:@SpyBean能用于final方法吗?

不能! Mockito 无法 Spy final 方法。如果遇到 final 方法,考虑:

  • 改用 @MockBean 完全模拟。
  • 重构代码,避免 final 方法。

Q2:@SpyBean和@Spy的区别?

  • @Spy 是 Mockito 提供的,用于普通对象。
  • @SpyBean 是 Spring Boot 提供的,用于 Spring Bean。

Q3: 如何验证方法调用次数?

// 验证 someMethod 被调用 1 次
verify(mySpyBean, times(1)).someMethod();

7. 总结

  • @SpyBean 适合部分 Mock,只修改某些方法,其余方法仍然走真实逻辑。
  • 常用方式
    • doReturn().when(spy).method():返回固定值。
    • doAnswer():自定义逻辑。
    • doThrow():模拟异常。
  • 不要用于 final 方法。

到此这篇关于SpringBoot单元测试中@SpyBean使用小结的文章就介绍到这了,更多相关SpringBoot @SpyBean内容请搜索脚本之家以前的文章或继续浏览下面的相关文章希望大家以后多多支持脚本之家!

相关文章

  • 解决Maven项目pom.xml导入了Junit包还是用不了@Test注解问题

    解决Maven项目pom.xml导入了Junit包还是用不了@Test注解问题

    在Maven项目中,如果在非test目录下使用@Test注解,可能会因为pom.xml中<scope>test</scope>的设置而无法使用,正确做法是将测试代码放在src/test/java目录下,或去除<scope>test</scope>限制,这样可以确保Junit依赖正确加载并应用于适当的代码部分
    2024-10-10
  • windows下vscode+vs2019开发JNI的示例

    windows下vscode+vs2019开发JNI的示例

    本文给大家普及windows下vscode+vs2019开发JNI的示例以及各个环节的注意事项,文章通过示例代码图文相结合给大家介绍的非常详细,需要的朋友可以参考下
    2021-06-06
  • idea maven项目不支持发行版本问题及解决过程

    idea maven项目不支持发行版本问题及解决过程

    这段描述主要讲解了解决Maven项目中JDK版本问题的方法,包括修改环境变量、配置IDEA编译器版本以及调整pom.xml文件等内容,通过这些步骤,可以有效解决项目运行中的兼容性问题
    2026-06-06
  • 在js与java中判断json数据中是否含有某字段的案例

    在js与java中判断json数据中是否含有某字段的案例

    这篇文章主要介绍了在js与java中判断json数据中是否含有某字段的案例,具有很好的参考价值,希望对大家有所帮助。一起跟随小编过来看看吧
    2020-12-12
  • Java ByteBuffer网络编程用法实例解析

    Java ByteBuffer网络编程用法实例解析

    这篇文章主要介绍了Java ByteBuffer网络编程用法实例解析,文中通过示例代码介绍的非常详细,对大家的学习或者工作具有一定的参考学习价值,需要的朋友可以参考下
    2020-10-10
  • Spring boot 整合CXF开发web service示例

    Spring boot 整合CXF开发web service示例

    这篇文章主要介绍了Spring boot 整合CXF开发web service示例,小编觉得挺不错的,现在分享给大家,也给大家做个参考。一起跟随小编过来看看吧
    2017-05-05
  • Java使用FTPClient类读写FTP

    Java使用FTPClient类读写FTP

    这篇文章主要为大家详细介绍了Java使用FTPClient类读写FTP的相关资料,具有一定的参考价值,感兴趣的小伙伴们可以参考一下
    2017-04-04
  • Java冒泡排序简单实现

    Java冒泡排序简单实现

    这篇文章主要介绍了Java冒泡排序简单实现,具有一定借鉴价值,需要的朋友可以参考下。
    2017-12-12
  • 使用Spring Cloud Feign作为HTTP客户端调用远程HTTP服务的方法(推荐)

    使用Spring Cloud Feign作为HTTP客户端调用远程HTTP服务的方法(推荐)

    在Spring Cloud中使用Feign, 我们可以做到使用HTTP请求远程服务时能与调用本地方法一样的编码体验,开发者完全感知不到这是远程方法,更感知不到这是个HTTP请求,具体内容详情大家参考下本文
    2018-01-01
  • Arthas-java程序运行时debug工具使用

    Arthas-java程序运行时debug工具使用

    这篇文章主要介绍了Arthas-java程序运行时debug工具使用,具有很好的参考价值,希望对大家有所帮助,如有错误或未考虑完全的地方,望不吝赐教
    2023-11-11

最新评论