You need to enable JavaScript to run this app. 如何使用Jest模拟返回响应对象的客户端请求方法
优惠活动
大模型
产品
解决方案
定价
更多

如何使用Jest模拟返回响应对象的客户端请求方法

单测mock异常原因与正确实现方案

原测试代码核心问题

  • jest.spyOn语法使用错误:该API接收两个参数,分别是被监听的对象实例、需要监听的方法名字符串,原代码传入带作用域、带参数的字符串'this.client.request(config)',完全不符合API参数要求,是运行直接报错的核心原因。
  • 监听对象定位错误:this.client是Client类实例上的属性,指向实际发起请求的HTTP客户端,并非Service类的静态属性,无法直接对Service类本身的方法做监听。
  • 测试逻辑顺序颠倒:原代码没有实际调用被测的getFiltersList方法,直接断言mock方法的调用次数和返回值,测试链路不完整。

正确实现代码

import Client from '/dist/client';
import urls from '../services/urls';
import { API_VERSION } from '../constants';
import filtersData from '../data/filters-data.json';
import Service from '../services/Service';

const versionHeader = 'X-API-VERSION';

describe('Service Class Test', () => {
  it('Get List Test', () => {
    // 定义测试入参
    const testParams = {
      filters: 'abc,def,ghi',
    };
    // 实例化被测Service
    const serviceInstance = new Service();
    // 正确监听实例上的client.request方法
    const requestSpy = jest
      .spyOn(serviceInstance.client, 'request')
      .mockReturnValue(filtersData);
    // 实际触发被测方法
    const actualResponse = serviceInstance.getFiltersList(testParams);

    // 全链路断言
    // 校验请求方法调用次数
    expect(requestSpy).toHaveBeenCalledTimes(1);
    // 校验请求配置完全符合预期
    expect(requestSpy).toHaveBeenCalledWith({
      method: urls.View.getFilters.requestType,
      url: urls.View.getFilters.path(),
      params: testParams,
      headers: { [versionHeader]: API_VERSION },
    });
    // 校验方法返回值
    expect(actualResponse).toEqual(filtersData);

    // 测试结束还原原方法,避免状态污染
    requestSpy.mockRestore();
  });
});

实现注意事项

  • 若Client类的client属性是JS私有属性(以#前缀声明),无法从实例外部直接访问,可通过jest.mock('/dist/client')提前mock整个Client模块,给类原型的初始化逻辑添加可监听的request方法,解决私有属性访问受限的问题。
  • 不要将mock的spy对象直接和返回值做断言,必须先完整执行被测方法逻辑,再校验方法的调用情况和返回结果。
  • 单测结束后必须调用mockRestore还原被监听的原方法,避免跨测试用例的状态污染。

内容的提问来源于stack exchange,提问作者TechGeek

相关产品推荐
方舟 Agent Plan

超全模态模型 × Harness 升级,最新支持 Deepseek-V4.1-Flash、GLM-5.3 系列、Doubao-Seedream-5.0-pro、Kimi-K3 (部分), 限时 9.9 元起

最近更新时间:2026.10.31 20:45:05