深入理解Jest中rejects.toThrowError的使用

Jest中异步函数异常测试的核心原理

在javascript的测试框架jest中，测试函数是否抛出异常是一个常见的需求。对于同步函数，我们通常使用.tothrow()匹配器，它期望接收一个会抛出错误的函数作为参数，例如expect(() => syncfun()).tothrowerror(errorobj)。然而，当涉及到异步函数时，情况变得更加复杂，因为异步操作返回的是promise。jest为此提供了.rejects匹配器，专门用于断言一个promise是否被拒绝（rejected），并且在拒绝时携带了预期的错误。

理解.rejects的关键在于它操作的是一个Promise对象，而不是一个返回Promise的函数。当一个异步函数在执行过程中抛出错误时，它会导致其返回的Promise被拒绝。因此，我们的测试目标是检查这个被拒绝的Promise是否携带了特定的错误信息。

正确姿势：直接操作Promise

在Jest中测试异步函数抛出异常的正确且推荐方式是直接将异步函数执行后返回的Promise传递给expect()。

示例代码：

// 假设有一个异步函数，它会因某些条件拒绝Promise
async function fetchDataWithError() {
  return new Promise((resolve, reject) => {
    setTimeout(() => {
      // 模拟异步操作失败，拒绝Promise并抛出错误
      reject(new Error('数据加载失败：网络连接中断！'));
    }, 100);
  });
}

describe('测试异步函数抛出异常的正确方式', () => {
  test('fetchDataWithError 应该拒绝并抛出指定错误', async () => {
    // 正确的测试方式：直接将 asyncFun() 执行后返回的 Promise 传递给 expect
    await expect(fetchDataWithError()).rejects.toThrowError('数据加载失败：网络连接中断！');
  });

  test('fetchDataWithError 应该拒绝并抛出 Error 类的实例', async () => {
    // 也可以检查错误类型
    await expect(fetchDataWithError()).rejects.toThrow(Error);
  });

  test('fetchDataWithError 应该拒绝并抛出具有特定属性的错误对象', async () => {
    // 如果错误对象有特定属性，可以匹配正则表达式或部分文本
    await expect(fetchDataWithError()).rejects.toThrowError(/网络连接中断/);
  });
});

解析：asyncFun()（如fetchDataWithError()）在被调用时会立即开始执行，并返回一个Promise。expect()接收到这个Promise后，await会等待这个Promise的状态。如果Promise被拒绝，.rejects匹配器会捕获这个拒绝，并允许我们链式调用.toThrowError()来验证拒绝的原因是否是预期的错误。这种方式清晰地表达了“我们期望这个Promise会被拒绝并携带一个特定的错误”。

误区解析：将函数传递给expect

另一种常见的尝试是像同步函数那样，将一个包装了异步函数调用的匿名函数传递给expect()，例如：

钉钉 AI 助理

钉钉AI助理汇集了钉钉AI产品能力，帮助企业迈入智能新时代。

21

查看详情

// 错误的示例（不推荐）
// await expect(async () => {
//   await asyncFun();
// }).rejects.toThrowError(errorObj);

为什么这种方式是错误的或不推荐的？

1. 违背设计意图： Jest的.rejects匹配器是专门为Promise设计的。它的核心功能是检查一个Promise的拒绝状态。当它接收到一个函数时，它并非被设计为去执行这个函数并检查其内部的Promise。虽然在某些Jest版本或特定场景下，这种写法可能“碰巧”工作，但这并非其官方文档所推荐或保证的行为。
2. 不必要的抽象： 这种写法引入了一个额外的匿名异步函数，其唯一目的是包装对asyncFun()的调用。这增加了代码的复杂性，却没有带来任何语义上的好处。
3. 潜在的不稳定性： 由于这种用法不是.rejects的预期行为，未来的Jest版本更新可能会改变其内部实现，导致这种测试突然失效。依赖未文档化的行为总是存在风险。
4. 混淆概念： 这种写法容易让人联想到同步的.toThrow()，它确实需要一个抛出错误的函数。但这会将异步和同步的错误处理机制混淆，不利于对Promise链式操作的理解。

本质上，当您写await expect(async () => { await asyncFun() })时，您传递给expect的是一个函数，而不是asyncFun()执行后返回的Promise。rejects应该直接作用于Promise对象，而不是一个返回Promise的函数。

注意事项与最佳实践

• 理解匹配器输入： 始终明确你传递给expect()的是什么类型的数据。toThrow()期望一个会同步抛出错误的函数；rejects期望一个Promise。
• Promise的返回： 确保你的异步函数确实返回了一个Promise（或者是一个async函数，它隐式返回一个Promise）。如果异步函数没有返回Promise，.rejects将无法正常工作。
• 避免副作用： 确保你的测试是独立的，并且异步函数在测试期间不会产生意外的副作用。
• 查阅官方文档： 遇到不确定的用法时，Jest的官方文档是最佳的参考来源。它详细说明了每个匹配器的预期输入和行为。

总结

在Jest中测试异步函数抛出异常时，请务必遵循官方推荐的最佳实践：直接将异步函数执行后返回的Promise传递给expect()，然后链式调用.rejects.toThrowError()。这种方式不仅语义清晰、代码简洁，而且符合Jest的设计哲学，能够确保你的测试在未来具有更好的稳定性和可维护性。避免使用将包装函数传递给expect的写法，因为它依赖于未文档化的行为，可能导致不可预测的结果。理解Promise的工作机制是编写健壮异步测试的关键。

以上就是深入理解Jest中rejects.toThrowError的使用的详细内容，更多请关注php中文网其它相关文章！