0

0

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

碧海醫心

碧海醫心

发布时间:2025-09-15 11:06:31

|

344人浏览过

|

来源于php中文网

原创

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

本文深入探讨了在Jest中测试异步函数抛出异常的正确方法。我们将明确指出await expect(asyncFun()).rejects.toThrowError(errorObj)是官方推荐且符合语义的用法,而await expect(async () => { await asyncFun() }).rejects.toThrowError(errorObj)虽然可能在某些情况下有效,但并非rejects的预期设计,可能导致不可预测的行为。文章将通过示例代码详细解析这两种方式的本质区别及最佳实践。

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(),例如:

宠物商店
宠物商店

目前,PetShop已经从最初的2.0、3.0等版本,发展到了最新的4.0版本。PetShop 4.0使用ASP.NET 2.0技术开发,其中加入了众多新增特性,因此,在性能、代码数量、可扩展性等方面有了重大改善。可以说,学习PetShop 4.0是深入掌握ASP.NET 2.0技术的捷径。本节将引领读者逐步了解PetShop 4.0的方方面面,包括应用程序安装、功能和用户界面简介、解决方案和体系

下载
// 错误的示例(不推荐)
// 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的工作机制是编写健壮异步测试的关键。

相关专题

更多
js获取数组长度的方法
js获取数组长度的方法

在js中,可以利用array对象的length属性来获取数组长度,该属性可设置或返回数组中元素的数目,只需要使用“array.length”语句即可返回表示数组对象的元素个数的数值,也就是长度值。php中文网还提供JavaScript数组的相关下载、相关课程等内容,供大家免费下载使用。

554

2023.06.20

js刷新当前页面
js刷新当前页面

js刷新当前页面的方法:1、reload方法,该方法强迫浏览器刷新当前页面,语法为“location.reload([bForceGet]) ”;2、replace方法,该方法通过指定URL替换当前缓存在历史里(客户端)的项目,因此当使用replace方法之后,不能通过“前进”和“后退”来访问已经被替换的URL,语法为“location.replace(URL) ”。php中文网为大家带来了js刷新当前页面的相关知识、以及相关文章等内容

374

2023.07.04

js四舍五入
js四舍五入

js四舍五入的方法:1、tofixed方法,可把 Number 四舍五入为指定小数位数的数字;2、round() 方法,可把一个数字舍入为最接近的整数。php中文网为大家带来了js四舍五入的相关知识、以及相关文章等内容

731

2023.07.04

js删除节点的方法
js删除节点的方法

js删除节点的方法有:1、removeChild()方法,用于从父节点中移除指定的子节点,它需要两个参数,第一个参数是要删除的子节点,第二个参数是父节点;2、parentNode.removeChild()方法,可以直接通过父节点调用来删除子节点;3、remove()方法,可以直接删除节点,而无需指定父节点;4、innerHTML属性,用于删除节点的内容。

477

2023.09.01

JavaScript转义字符
JavaScript转义字符

JavaScript中的转义字符是反斜杠和引号,可以在字符串中表示特殊字符或改变字符的含义。本专题为大家提供转义字符相关的文章、下载、课程内容,供大家免费下载体验。

394

2023.09.04

js生成随机数的方法
js生成随机数的方法

js生成随机数的方法有:1、使用random函数生成0-1之间的随机数;2、使用random函数和特定范围来生成随机整数;3、使用random函数和round函数生成0-99之间的随机整数;4、使用random函数和其他函数生成更复杂的随机数;5、使用random函数和其他函数生成范围内的随机小数;6、使用random函数和其他函数生成范围内的随机整数或小数。

991

2023.09.04

如何启用JavaScript
如何启用JavaScript

JavaScript启用方法有内联脚本、内部脚本、外部脚本和异步加载。详细介绍:1、内联脚本是将JavaScript代码直接嵌入到HTML标签中;2、内部脚本是将JavaScript代码放置在HTML文件的`<script>`标签中;3、外部脚本是将JavaScript代码放置在一个独立的文件;4、外部脚本是将JavaScript代码放置在一个独立的文件。

657

2023.09.12

Js中Symbol类详解
Js中Symbol类详解

javascript中的Symbol数据类型是一种基本数据类型,用于表示独一无二的值。Symbol的特点:1、独一无二,每个Symbol值都是唯一的,不会与其他任何值相等;2、不可变性,Symbol值一旦创建,就不能修改或者重新赋值;3、隐藏性,Symbol值不会被隐式转换为其他类型;4、无法枚举,Symbol值作为对象的属性名时,默认是不可枚举的。

551

2023.09.20

高德地图升级方法汇总
高德地图升级方法汇总

本专题整合了高德地图升级相关教程,阅读专题下面的文章了解更多详细内容。

26

2026.01.16

热门下载

更多
网站特效
/
网站源码
/
网站素材
/
前端模板

精品课程

更多
相关推荐
/
热门推荐
/
最新课程
React 教程
React 教程

共58课时 | 3.7万人学习

TypeScript 教程
TypeScript 教程

共19课时 | 2.2万人学习

Bootstrap 5教程
Bootstrap 5教程

共46课时 | 2.9万人学习

关于我们 免责申明 举报中心 意见反馈 讲师合作 广告合作 最新更新
php中文网:公益在线php培训,帮助PHP学习者快速成长!
关注服务号 技术交流群
PHP中文网订阅号
每天精选资源文章推送

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