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内容请搜索脚本之家以前的文章或继续浏览下面的相关文章希望大家以后多多支持脚本之家!

相关文章

  • java 调用wsdl协议接口简单实用方法最新推荐

    java 调用wsdl协议接口简单实用方法最新推荐

    文章介绍了如何使用POM导入依赖,并编写一个测试类来调用不同的Web服务接口,通过访问接口地址,我们可以获取请求和返回的body,并进一步解析返回的JSON结果,感兴趣的朋友一起看看吧
    2025-03-03
  • 使用Java解析JSON数据并提取特定字段的实现步骤(以提取mailNo为例)

    使用Java解析JSON数据并提取特定字段的实现步骤(以提取mailNo为例)

    在现代软件开发中,处理JSON数据是一项非常常见的任务,无论是从API接口获取数据,还是将数据存储为JSON格式,解析和提取JSON中的特定字段都是开发人员需要掌握的基本技能,本文将以一个实际案例为例,详细介绍如何使用Java解析JSON数据并提取其中的mailNo字段
    2025-01-01
  • java实现excel导出合并单元格的步骤详解

    java实现excel导出合并单元格的步骤详解

    这篇文章主要介绍了java实现excel导出合并单元格,通过使用Apache POI库,我们可以方便地创建Excel文件、填充数据、合并单元格和导出Excel文件,需要的朋友可以参考下
    2023-04-04
  • java学习笔记之eclipse+tomcat 配置

    java学习笔记之eclipse+tomcat 配置

    俗话说:工欲善其事必先利其器,既然要学习java,首先把java的开发环境捣鼓一下吧,这里我们来谈谈eclipse+tomcat的配置方法。
    2014-11-11
  • 基于params、@PathVariabl和@RequestParam的用法与区别说明

    基于params、@PathVariabl和@RequestParam的用法与区别说明

    这篇文章主要介绍了方法参数相关属性params、@PathVariabl和@RequestParam用法与区别,具有很好的参考价值,希望对大家有所帮助。如有错误或未考虑完全的地方,望不吝赐教
    2021-08-08
  • Spring的事务机制实例代码

    Spring的事务机制实例代码

    这篇文章主要介绍了Spring的事务机制实例代码,分享了相关代码示例,小编觉得还是挺不错的,具有一定借鉴价值,需要的朋友可以参考下
    2018-02-02
  • logback之自定义指定日志文件存储目录方式

    logback之自定义指定日志文件存储目录方式

    这篇文章主要介绍了logback之自定义指定日志文件存储目录方式,具有很好的参考价值,希望对大家有所帮助。如有错误或未考虑完全的地方,望不吝赐教
    2023-03-03
  • Java编程实现月食简单代码分享

    Java编程实现月食简单代码分享

    这篇文章主要介绍了Java编程实现月食简单代码分享,程序很简单,喜欢的朋友可以拿过去玩玩。
    2017-11-11
  • Java实现将二叉树展开为链表的两种方法

    Java实现将二叉树展开为链表的两种方法

    文章介绍了两种方法将二叉树按前序遍历顺序展开为单链表,方法一为迭代法,方法二为前序遍历+列表重建,两者各有优缺点,选择时需根据实际需求和场景考虑,下面小编给大家详细说说
    2025-05-05
  • 分析Java非阻塞算法Lock-Free的实现

    分析Java非阻塞算法Lock-Free的实现

    非阻塞算法一般会使用CAS来协调线程的操作。虽然非阻塞算法有诸多优点,但是在实现上要比基于锁的算法更加繁琐和负责。本文将会介绍两个是用非阻塞算法实现的数据结构。
    2021-06-06

最新评论