首页 > Java > java教程 > 正文

Mockito Spy实战:高效测试调用内部方法的Java函数

霞舞
发布: 2025-11-17 17:51:01
原创
258人浏览过

mockito spy实战:高效测试调用内部方法的java函数

当单元测试中需要测试一个方法,而该方法又会调用同一类中的其他内部方法时,直接使用`@InjectMocks`并尝试`when()`这些内部方法可能导致`NullPointerException`。本文将深入探讨此问题的原因,并提供使用`Mockito.spy`进行部分模拟的解决方案。通过`doReturn().when()`语法,我们能够灵活地存根(stub)内部方法的行为,从而有效测试复杂业务逻辑,即使内部方法处理动态值也能应对自如,同时强调使用`spy`的注意事项。

单元测试中的挑战:内部方法调用与NullPointerException

在Java开发中,我们经常会遇到一个类中的方法(例如 rollDays)会调用同一类中的其他私有或保护方法(例如 Closed 或 NonSettle)。当尝试为 rollDays 方法编写单元测试时,如果 Closed 或 NonSettle 方法内部又依赖于其他未被正确模拟的对象,或者它们本身没有被存根,就可能导致 NullPointerException。

考虑以下 CalculateDateService 类结构:

import java.time.LocalDate;

public class CalculateDateService {

    // 假设这里可能有一个 DateService 的依赖,但在本示例中我们简化它
    // private DateService dateService;

    LocalDate rollDays(int days, LocalDate date, String mar) {
        int dir = days > 0 ? 1 : -1;
        // 循环条件中调用了 closed 方法
        for(int numOfDays = Math.abs(days); closed(date, mar) || numOfDays-- > 0; date = date.plusDays((long) dir)) {
            // 循环体为空,仅根据条件推进日期
        }
        return date;
    }

    Boolean closed(LocalDate date, String mar){
        // closed 方法内部调用了 nonSettle 方法
        // 简化:这里不再依赖外部dateService,仅依赖nonSettle
        return this.nonSettle(date);
    }

    Boolean nonSettle(LocalDate date) {
        int year = LocalDate.now().getYear(); // 假设这里获取当前年份
        LocalDate dayBeforeChristmas = LocalDate.of(year, 12, 24);
        LocalDate dayBeforenewYear = LocalDate.of(year, 12, 31);
        return (date.isEqual(dayBeforeChristmas) || date.isEqual(dayBeforenewYear));
    }
}
登录后复制

在上述 CalculateDateService 中,rollDays 调用 closed,closed 又调用 nonSettle。如果在测试 rollDays 时,尝试使用以下方式:

立即学习Java免费学习笔记(深入)”;

@Mock
private DateService dateService; // 假设存在外部依赖
@InjectMocks
private CalculateDateService tested;

@Test
public void testRollDaysInitialAttempt() {
    LocalDate initDate = LocalDate.of(2022, 12, 22);

    // 尝试直接在 @InjectMocks 对象上 stub 内部方法
    // when(tested.Closed(initDate, dateService.marID)).thenReturn(Boolean.FALSE); // 这将导致问题
    // when(tested.NonSettle(initDate)).thenReturn(Boolean.FALSE); // 这也将导致问题

    // ... 其他测试逻辑
}
登录后复制

当执行 tested.rollDays(...) 时,rollDays 方法内部会真实地调用 this.closed(...),进而调用 this.nonSettle(...)。由于 tested 是一个通过 @InjectMocks 创建的真实对象实例(或部分注入了 @Mock 依赖的真实对象),而不是一个完全的 Mock 对象或 Spy 对象,因此对其内部方法的 when().thenReturn() 调用不会生效。内部方法会执行其真实逻辑,如果 nonSettle 方法内部有未被处理的依赖(例如 LocalDate.now() 或更复杂的外部服务),或者 nonSettle 本身没有被正确地模拟,就会抛出 NullPointerException。核心原因在于:tested 实例本身既不是一个 Mock 也不是一个 Spy,所以对它的内部方法进行 when 操作是无效的。

解决方案:使用Mockito Spy进行部分模拟

为了解决这个问题,我们需要使用 Mockito 的 spy 功能。spy 允许我们对一个真实对象进行部分模拟,这意味着我们可以选择性地存根(stub)对象的某些方法,而让其他方法执行它们的真实实现。

Mockito Spy的工作原理

Mockito.spy(new MyClass()) 会创建一个 MyClass 的真实实例的副本。你可以对这个 Spy 对象上的任何方法进行 when().thenReturn() 或 doReturn().when() 操作。对于被存根的方法,它会返回你指定的值;对于没有被存根的方法,它会执行真实对象的方法逻辑。

注意: 当存根一个 Spy 对象的方法时,推荐使用 doReturn(value).when(spyObject).method(args) 语法,而不是 when(spyObject.method(args)).thenReturn(value)。这是因为 when() 语法在执行 spyObject.method(args) 时会先调用真实方法,这可能导致意外的副作用,尤其是在方法内部有状态修改或异常抛出时。而 doReturn().when() 则会直接设置存根行为,避免真实方法的执行。

青柚面试
青柚面试

简单好用的日语面试辅助工具

青柚面试 57
查看详情 青柚面试

实战示例

让我们使用 Mockito.spy 来正确测试 CalculateDateService 的 rollDays 方法。

首先,确保你的 pom.xml 中包含 Mockito 依赖:

<dependency>
    <groupId>org.mockito</groupId>
    <artifactId>mockito-core</artifactId>
    <version>4.x.x</version> <!-- 使用最新稳定版本 -->
    <scope>test</scope>
</dependency>
<dependency>
    <groupId>org.junit.jupiter</groupId>
    <artifactId>junit-jupiter-api</artifactId>
    <version>5.x.x</version> <!-- 使用最新稳定版本 -->
    <scope>test</scope>
</dependency>
<dependency>
    <groupId>org.junit.jupiter</groupId>
    <artifactId>junit-jupiter-engine</artifactId>
    <version>5.x.x</version> <!-- 使用最新稳定版本 -->
    <scope>test</scope>
</dependency>
登录后复制

接下来是测试代码:

import org.junit.jupiter.api.Assertions;
import org.junit.jupiter.api.Test;
import org.mockito.Mockito;
import java.time.LocalDate;

public class CalculateDateServiceTest {

    // 示例一:测试 rollDays 在 nonSettle 始终为 false 的情况下
    @Test
    void testSpyFalseRollByDays() {
        var year = LocalDate.now().getYear();
        // 创建 CalculateDateService 的 Spy 对象
        var spy = Mockito.spy(new CalculateDateService());

        // 存根 nonSettle 方法,使其对任何 LocalDate 参数都返回 false
        // 使用 doReturn().when() 避免真实方法被调用
        Mockito.doReturn(false).when(spy).nonSettle(Mockito.any(LocalDate.class));

        // 调用 rollDays 方法,起始日期为当年12月1日,滚动24天
        var result = spy.rollDays(24, LocalDate.of(year, 12, 1), "");

        // 预期结果:12月1日 + 24天 = 12月25日 (因为 nonSettle 始终为 false,没有跳过日期)
        Assertions.assertEquals(LocalDate.of(year, 12, 25), result);
    }

    // 示例二:测试 rollDays 在特定日期 nonSettle 为 true 的情况下
    @Test
    void testSpyTrueOnSpecificDateRollByDays() {
        var year = LocalDate.now().getYear();
        var spy = Mockito.spy(new CalculateDateService());

        // 默认情况下,nonSettle 对任何日期都返回 false
        Mockito.doReturn(false).when(spy).nonSettle(Mockito.any(LocalDate.class));
        // 特别地,存根 nonSettle 方法,使其在 12月24日 返回 true (模拟非结算日)
        Mockito.doReturn(true).when(spy).nonSettle(LocalDate.of(year, 12, 24));

        // 调用 rollDays 方法,起始日期为当年12月1日,滚动24天
        var result = spy.rollDays(24, LocalDate.of(year, 12, 1), "");

        // 预期结果:
        // 从 12月1日 开始滚动24天。
        // 正常情况下会到 12月25日。
        // 但由于 12月24日 是 nonSettle 日期,在循环中 nonSettle(12月24日) 会返回 true,
        // 导致 12月24日 这一天被跳过,实际天数计数器 numOfDays 不会减少。
        // 因此,需要额外一天来完成24天的滚动,最终日期是 12月26日。
        Assertions.assertEquals(LocalDate.of(year, 12, 26), result);
    }
}
登录后复制

在这些示例中:

  1. 我们通过 Mockito.spy(new CalculateDateService()) 创建了一个 CalculateDateService 的 Spy 对象。
  2. 使用 Mockito.doReturn(false).when(spy).nonSettle(Mockito.any(LocalDate.class)) 存根了 nonSettle 方法,使其在任何日期都返回 false。Mockito.any(LocalDate.class) 是一个参数匹配器,表示匹配任何 LocalDate 类型的参数。
  3. 在第二个测试中,我们进一步使用 Mockito.doReturn(true).when(spy).nonSettle(LocalDate.of(year, 12, 24)) 为特定日期 12月24日 设置了不同的存根行为,模拟了特殊日期的场景。

通过这种方式,我们成功地控制了 rollDays 内部调用的 closed 和 nonSettle 方法的行为,从而能够专注于测试 rollDays 的核心逻辑,避免了 NullPointerException。

注意事项与最佳实践

尽管 Mockito.spy 是一个强大的工具,但它应该被谨慎且偶尔地使用,尤其是在处理遗留代码时。

  1. 谨慎使用:Mockito 官方文档明确指出:“真正的 Spy 应该谨慎且偶尔使用,例如在处理遗留代码时。”这是因为 Spy 实际上创建了真实对象的一个副本,而不是像 Mock 对象那样完全模拟。对 Spy 的操作可能会有真实对象的副作用。过度使用 Spy 可能掩盖代码中存在的结构性问题,例如类职责过重或耦合度过高。
  2. 理解其工作原理:Mockito.spy() 不会将调用委托给传入的真实实例,而是实际创建它的一个副本。这意味着对 Spy 对象的字段或状态的更改可能不会反映在原始对象上,反之亦然。
  3. 考虑重构:如果一个类频繁需要使用 Spy 来测试其内部方法,这可能是一个“设计异味”。它可能表明该类承担了过多的职责,或者其内部方法过于复杂且难以独立测试。在这种情况下,考虑将内部方法提取到独立的辅助类或服务中,并通过依赖注入的方式引入,这样就可以使用更简单的 Mock 对象进行测试。例如,可以将 closed 和 nonSettle 方法封装到一个 DateRuleService 中,然后将 DateRuleService 注入到 CalculateDateService 中。
  4. doReturn().when() 优先:如前所述,当存根 Spy 对象的方法时,优先使用 doReturn(value).when(spy).method(args) 语法,以避免真实方法在存根设置时被意外调用。

总结

当需要测试一个方法,而该方法又会调用同一类中的其他内部方法,并且这些内部方法可能导致 NullPointerException 或需要特定行为时,Mockito.spy 提供了一个有效的解决方案。通过对真实对象创建 Spy,并结合 doReturn().when() 语法,我们可以精确地控制内部方法的行为,从而实现对复杂业务逻辑的有效单元测试。然而,使用 Spy 需谨慎,并应将其视为一种在特定情况下(如遗留系统)的权宜之计,而不是常规的测试策略。在可能的情况下,通过重构来提高代码的可测试性是更优的选择。

以上就是Mockito Spy实战:高效测试调用内部方法的Java函数的详细内容,更多请关注php中文网其它相关文章!

最佳 Windows 性能的顶级免费优化软件
最佳 Windows 性能的顶级免费优化软件

每个人都需要一台速度更快、更稳定的 PC。随着时间的推移,垃圾文件、旧注册表数据和不必要的后台进程会占用资源并降低性能。幸运的是,许多工具可以让 Windows 保持平稳运行。

下载
来源:php中文网
本文内容由网友自发贡献,版权归原作者所有,本站不承担相应法律责任。如您发现有涉嫌抄袭侵权的内容,请联系admin@php.cn
最新问题
开源免费商场系统广告
热门教程
更多>
最新下载
更多>
网站特效
网站源码
网站素材
前端模板
关于我们 免责申明 举报中心 意见反馈 讲师合作 广告合作 最新更新 English
php中文网:公益在线php培训,帮助PHP学习者快速成长!
关注服务号 技术交流群
PHP中文网订阅号
每天精选资源文章推送
PHP中文网APP
随时随地碎片化学习

Copyright 2014-2025 https://www.php.cn/ All Rights Reserved | php.cn | 湘ICP备2023035733号