Chai 是前端最常用的断言库之一，它为我们提供了相对友好的语法，以及丰富的 API。然而，在实际应用中，我们有时候会遇到一些代码臃肿、难以测试和没有可读性的情况。因此，本文将简单介绍如何编写干净的 Chai 断言，从而提高代码可维护性、可读性以及可测试性。
了解 Chai
在开始编写干净的 Chai 断言之前，我们首先需要了解一些 Chai 的基本语法。
expect
expect 是 Chai 最常用的方法之一。它是一个断言对象，它允许您断言目标对象的预期值。
// 举例
let foo = 6;
expect(foo).to.be.a('number');should
should 是另一种形式的断言。它通过 JavaScript 的 Object.defineProperty() 功能将断言方法注入到每个对象中，并提供一些额外的语法糖。
// 举例
let foo = 'bar';
foo.should.be.a('string');assert
assert 与 expect 和 should 不同，assert 是 Node.js 核心模块的一部分，并且它不需要引入 Chai。assert 很简单，仅仅是一个标准的 JavaScript 断言库。
// 举例 let foo = 'bar'; assert.typeOf(foo, 'string');
在了解了 Chai 这些基本语法后，下面将介绍如何编写干净的 Chai 断言。
1. 使用链式语法
在编写测试代码时，我们经常需要测试一个对象的多种性质。这时，Chai 提供了链式语法来使代码更加清晰和易于理解。
// 不好的写法
expect(array).to.be.an('array');
expect(array.length).to.equal(3);
expect(array[0]).to.equal('foo');
// 好的写法
expect(array).to.be.an('array').that.includes('foo');2. 使用断言提示
当一个测试用例失败时，我们通常会看到一个提醒，说明测试用例失败的原因。Chai 允许我们为每个测试用例提供一个自定义的断言消息，以便更好地理解断言失败的原因。
// 不好的写法 expect(add(1, 2)).to.equal(3); // 好的写法 expect(add(1, 2), 'add(1, 2) should equal 3').to.equal(3);
3. 使用描述性的断言
有时候，在测试中我们需要使用多个断言来检查一个实例的多个属性。使用描述性的断言来避免冗长和难以读懂的测试代码。
-- -------------------- ---- ------- -- ----- ----------------------------------- ------------------------------ ------------------------------------- -- ---- ------------------------------------- -------- ------------------------------------ ---- --------------------------------------- --------
4. 避免无意义的测试
在编写测试代码时，避免测试一些无意义的条件，这只会降低代码的可读性和可维护性。
-- -------------------- ---- -------
-- -----
----------------------------
-----------------------------
----------------------------------
-- ----
------------ ------- ---- ------- -- -- -
---------- ---- ---------- ---- ---------- -- -- -
-- ---- -------------- ---- ----
---
---示例代码
下面是一个示例代码，它演示了如何使用上述技巧来编写干净的 Chai 断言：
-- -------------------- ---- -------
-- --- -------
----------------- -- -- -
---------- ----- ------- -- -- -
----- ----- - --- -- ---
------------------------------
---------------------------------
---
---
-- ---- -------
----------------- -- -- -
---------- ----- ------- -- -- -
----- ----- - ---
--------------------------
---
---在上述示例代码中，我们使用了链式语法、断言提示、描述性的断言和避免了无意义的测试。
总结
通过本文的介绍，我们可以掌握一些基本的 Chai 用法，并学会使用一些技巧来编写干净的测试代码。这些技巧可以使我们的测试代码更可维护和可读，从而提高我们工作的效率和质量。当然，这些技巧仅仅是入门级的，如果想要更深入地使用 Chai 断言，您可以查看官方文档，学会更多的运用技巧。
来源：JavaScript中文网 ，转载请注明来源 https://www.javascriptcn.com/post/65bb16dcadd4f0e0ff3b2451