
本文探讨了在单元测试中如何解决 lodash `once()` 函数因其内部状态持久化而导致的测试污染问题。通过利用 jest 等测试框架的模块模拟(mocking)能力,可以有效地重置或自定义 `once()` 的行为,确保每个测试用例都在一个干净、可控的环境中运行,从而提高测试的可靠性和隔离性。
引言:lodash.once() 的测试挑战
lodash.once() 是一个实用的工具函数,它确保一个函数无论被调用多少次,都只执行一次,并缓存其首次执行的结果。这种行为在许多场景下非常有用,例如初始化昂贵的计算或确保只执行一次副作用操作。然而,在进行单元测试时,once() 的这种状态持久化特性却可能引入问题。
当一个被 once() 包装的函数在某个测试用例中执行后,其内部状态(已执行、已缓存结果)会持续存在。如果在后续的测试用例中再次调用同一个被 once() 包装的函数,它将不会重新执行,而是直接返回之前缓存的结果。这导致了测试间的状态污染,使得测试用例不再独立,结果可能变得不可预测或难以调试。为了编写健壮且独立的单元测试,我们需要一种机制来“重置” once() 的行为,确保每个测试用例都能从一个干净、初始化的状态开始。
解决方案:利用 Jest 模块模拟重置 once() 行为
解决 lodash.once() 在单元测试中状态污染问题的核心策略是使用模块模拟(Module Mocking)。Jest 提供了强大的 jest.mock() 功能,允许我们拦截对特定模块的导入,并替换其内部的函数实现。通过模拟 lodash 模块中的 once 函数,我们可以完全控制其行为,使其在测试环境中按照我们期望的方式工作,从而实现状态的重置或自定义。
方法一:禁用 once() 的缓存行为
最直接的解决方案是完全禁用 once() 的缓存行为,使其在每次被调用时都执行原始函数。这种方法适用于那些测试场景中,我们只关心原始函数是否被调用,而不关心 once() 的缓存逻辑。
我们可以通过在 Jest 的 setupFiles 配置中或直接在测试文件中使用 jest.mock() 来实现:
// 假设这是你的 Jest 配置中指定的 setupFiles 文件,例如 setupTests.js // 或者直接在你的测试文件顶部 // 导入真实的 lodash 模块,以便我们可以复制其非 once 的部分 const lodash = jest.requireactual("lodash"); // 模拟 lodash 模块 jest.mock("lodash", () => ({ ...lodash, // 保留 lodash 模块中除 once 之外的所有导出 once: jest.fn((fn) => fn), // 模拟 once 函数,使其直接返回传入的原始函数 fn })); // --- 以下是测试文件的示例 --- import { once } from 'lodash'; // 此时导入的 once 是被模拟过的 describe('My Function with Mocked Once (Disabled Cache)', () => { let expensiveCalculation; let wrappedFunction; beforeEach(() => { // 每次测试前,创建一个新的 Jest mock 函数作为昂贵的计算 expensiveCalculation = jest.fn(() => "calculated result"); // 使用模拟的 once 包装 expensiveCalculation wrappedFunction = once(expensiveCalculation); }); afterEach(() => { // 清除所有 Jest mock 函数的调用历史,包括 expensiveCalculation jest.clearAllMocks(); }); test('should call the original function every time when cache is disabled', () => { wrappedFunction(); // 第一次调用 wrappedFunction(); // 第二次调用 expect(expensiveCalculation).toHaveBeenCalledTimes(2); // 预期原始函数被调用两次 }); test('another test should also call the original function every time (due to beforeEach)', () => { wrappedFunction(); // 再次调用 expect(expensiveCalculation).toHaveBeenCalledTimes(1); // 由于 beforeEach 重新设置了 expensiveCalculation,所以这次是第一次调用 }); });
解释: 通过 jest.fn((fn) => fn),我们让 lodash.once 的模拟版本不再执行任何缓存


