如何在 Jest 中使用 Fake Timers 进行异步代码的测试？-JavaScript中文网-JavaScript教程资源分享门户

前言

在前端开发中，异步代码已经成为了我们日常工作中不可或缺的一部分。但是，异步代码的测试却是一个比较棘手的问题。在 Jest 中，我们可以使用 Fake Timers 来模拟异步代码的执行，从而达到对异步代码的完整测试。

Fake Timers 是什么？

Fake Timers 是 Jest 的一个功能，它可以模拟 JavaScript 中的定时器，包括 setTimeout、setInterval 和 setImmediate 等。通过使用 Fake Timers，我们可以在测试中控制时间的流逝，从而模拟异步代码的执行。

如何使用 Fake Timers？

在 Jest 中，我们可以通过以下两种方式来使用 Fake Timers：

手动模拟时间

我们可以使用 jest.useFakeTimers() 来启用 Fake Timers，然后使用 jest.advanceTimersByTime() 或 jest.runAllTimers() 来手动模拟时间。

test('test async code with fake timers', () => {
  jest.useFakeTimers();
  const callback = jest.fn();
  setTimeout(callback, 1000);
  jest.advanceTimersByTime(1000);
  expect(callback).toHaveBeenCalledTimes(1);
});

上面的测试用例中，我们使用 jest.useFakeTimers() 启用 Fake Timers，然后使用 setTimeout 来模拟异步代码的执行。最后，我们使用 jest.advanceTimersByTime() 来手动模拟时间的流逝，从而让 setTimeout 中的回调函数被执行。

自动模拟时间

除了手动模拟时间之外，我们还可以使用 jest.runAllTimers() 或 jest.runOnlyPendingTimers() 来自动模拟时间。在这种情况下，Fake Timers 会自动模拟所有定时器的执行，直到所有定时器都被清空为止。

test('test async code with fake timers', () => {
  jest.useFakeTimers();
  const callback = jest.fn();
  setTimeout(callback, 1000);
  jest.runAllTimers();
  expect(callback).toHaveBeenCalledTimes(1);
});

上面的测试用例中，我们使用 jest.useFakeTimers() 启用 Fake Timers，然后使用 setTimeout 来模拟异步代码的执行。最后，我们使用 jest.runAllTimers() 来自动模拟时间的流逝，从而让 setTimeout 中的回调函数被执行。

注意事项

在使用 Fake Timers 进行测试时，需要注意以下几点：

需要启用 Fake Timers

在使用 Fake Timers 进行测试时，需要使用 jest.useFakeTimers() 来启用 Fake Timers。

需要清空定时器

在使用 Fake Timers 进行测试时，需要手动清空定时器，以免影响后续测试的执行。可以使用 jest.clearAllTimers() 来清空所有定时器，或者使用 jest.runOnlyPendingTimers() 来清空当前待执行的定时器。

test('test async code with fake timers', () => {
  jest.useFakeTimers();
  const callback = jest.fn();
  setTimeout(callback, 1000);
  jest.runOnlyPendingTimers();
  expect(callback).toHaveBeenCalledTimes(1);
  jest.clearAllTimers();
});

上面的测试用例中，我们使用 jest.useFakeTimers() 启用 Fake Timers，然后使用 setTimeout 来模拟异步代码的执行。接着，我们使用 jest.runOnlyPendingTimers() 来清空待执行的定时器，以确保测试的准确性。最后，我们使用 jest.clearAllTimers() 来清空所有定时器，以免影响后续测试的执行。

需要使用 jest.fn() 来模拟回调函数

在测试异步代码时，我们需要使用 jest.fn() 来模拟回调函数，以便进行断言和验证。可以使用 expect(callback).toHaveBeenCalledTimes(1) 来验证回调函数是否被调用了一次。

test('test async code with fake timers', () => {
  jest.useFakeTimers();
  const callback = jest.fn();
  setTimeout(callback, 1000);
  jest.runAllTimers();
  expect(callback).toHaveBeenCalledTimes(1);
});

上面的测试用例中，我们使用 jest.fn() 来模拟回调函数，然后使用 setTimeout 来模拟异步代码的执行。最后，我们使用 expect(callback).toHaveBeenCalledTimes(1) 来验证回调函数是否被调用了一次。

总结

使用 Fake Timers 是 Jest 中测试异步代码的一种常见方法。通过手动或自动模拟时间，我们可以完整地测试异步代码的执行，并保证测试的准确性。在使用 Fake Timers 进行测试时，需要注意启用 Fake Timers、清空定时器和使用 jest.fn() 来模拟回调函数。

来源：JavaScript中文网，转载请注明来源本文地址：https://www.javascriptcn.com/post/655703cfd2f5e1655d16585a