【node模块】深入解读node:assert模块

node

🧑‍💼 一名茫茫大海中沉浮的小小程序员🍬
👉 你的一键四连 (关注 点赞+收藏+评论)是我更新的最大动力❤️！

📑 目录

🔽 前言
1️⃣ 什么是node:assert模块？
2️⃣ node:assert模块的核心功能
3️⃣ node:assert的基本断言方法
4️⃣ assert和assert/strict的区别
5️⃣ 常见的高级用法
6️⃣ 断言失败的错误处理
7️⃣ node:assert模块的常见应用场景
8️⃣ 编写自定义断言函数
9️⃣ 如何提高断言代码的可读性
🔟 何时使用assert？
🔼 结语

🔽 前言

在Node.js的开发过程中，模块的合理使用是提升代码质量和开发效率的重要手段。而node:assert模块作为其中一个基础工具，提供了便捷的断言功能，能够帮助开发者快速地进行测试和验证，确保代码的逻辑和输出符合预期。本篇文章将带你深入了解node:assert模块的作用、方法、用法示例及最佳实践，让你在使用它时得心应手。

1️⃣ 什么是node:assert模块？

node:assert模块是Node.js标准库中的一部分，主要用于实现代码断言。断言的目的是在开发和测试过程中帮助开发者检查代码执行的正确性。当断言条件不满足时，assert模块会抛出异常，从而使开发者及时发现代码中的问题。

2️⃣ node:assert模块的核心功能

node:assert的核心功能是提供一系列断言方法，通过这些方法可以验证值是否满足某些预期条件，比如是否相等、是否深度相等等。如果断言失败，assert模块会抛出一个AssertionError异常，这为定位问题提供了有力的支持。

3️⃣ node:assert的基本断言方法

assert(value[, message])
该方法断言value的值为真。如果value为假，则抛出异常，可以传入message作为自定义的错误信息。

const assert = require('assert');
assert(true); // 不会抛出错误
assert(false, '断言失败，value为false'); // 抛出错误: 断言失败，value为false

assert.strictEqual(actual, expected[, message])
这个方法用来断言actual和expected是否严格相等（===）。它避免了隐式类型转换带来的影响，是一种更加严格的比较方式。
```
const assert = require('assert');
assert.strictEqual(1, 1); // 通过
assert.strictEqual(1, '1', '不严格相等'); // 抛出错误
```
assert.deepEqual(actual, expected[, message])
当我们需要比较对象或数组的内容是否相等时，可以使用assert.deepEqual。该方法会递归地比较对象的内容，而不仅仅是引用是否相等。
```
const assert = require('assert');
assert.deepEqual({ a: 1 }, { a: 1 }); // 通过
assert.deepEqual({ a: 1 }, { a: '1' }); // 抛出错误，类型不同
```

4️⃣ assert和assert/strict的区别

在Node.js 10之后，assert模块中新增了assert/strict。与普通的assert相比，assert/strict采用了严格模式断言，即所有的比较方法都强制使用严格模式，如===，以避免因隐式类型转换带来的断言错误。

const assert = require('assert/strict');
assert.strictEqual(1, '1'); // 抛出错误，严格模式不允许隐式转换

5️⃣ 常见的高级用法

assert.throws(fn[, error][, message])
断言一个函数在执行时抛出特定类型的错误。此方法适合用来测试代码是否抛出了预期的异常。
```
const assert = require('assert');
assert.throws(() => {throw new Error('故意抛出的错误');},Error,'未抛出预期的错误类型'
);
```

assert.doesNotThrow(fn[, message])
和assert.throws相反，assert.doesNotThrow用来断言函数不会抛出错误。

const assert = require('assert');
assert.doesNotThrow(() => {console.log('无错误抛出');},'有错误被抛出'
);

6️⃣ 断言失败的错误处理

在使用assert时，如果断言失败会抛出AssertionError。这类错误包含实际值、预期值和错误消息等信息。我们可以根据这些信息更容易地定位和修复代码中的问题。

try {assert.strictEqual(1, 2);
} catch (error) {console.error(error instanceof assert.AssertionError); // trueconsole.error(error.message); // 预期错误信息
}

7️⃣ node:assert模块的常见应用场景

单元测试：在代码中加入断言，通过对函数输出和预期输出的比较来验证代码的正确性。
输入验证：断言用户输入的参数是否符合要求，可以有效避免代码逻辑上的错误。
开发调试：在调试过程中可以使用断言来快速定位代码是否按预期执行。

8️⃣ 编写自定义断言函数

在某些场景下，Node.js内置的断言方法可能无法满足需求。此时可以编写自定义断言函数，通过封装更加灵活的判断逻辑来进行断言。

function assertIsPositive(value) {assert(value > 0, `Value should be positive, but got ${value}`);
}
assertIsPositive(10); // 通过
assertIsPositive(-1); // 抛出错误