Chai 断言库中 deep 属性的使用详解
在前端开发中，测试工具是必不可少的一部分。而断言库就是测试工具中的重要组成部分之一。其中，Chai 是一个非常流行的断言库，它提供了多种断言方式，可以让我们更加方便地编写测试用例。
在 Chai 中，除了常见的基本断言之外，还有一个非常重要的属性：deep。这个属性可以让我们比较两个对象是否相等，包括嵌套对象以及数组等复合类型。接下来，我们就来详细了解一下 Chai 中的 deep 属性的使用。
一、基本的 deep 属性使用
要想使用 deep 属性，我们可以采用 should 或 expect 两种方式来进行断言。这里我们以 expect 为例，示例如下：
const expect = require('chai').expect;
const obj1 = { a: 1, b: { c: 'hello' }, d: [1, 2, 3] };
const obj2 = { a: 1, b: { c: 'hello' }, d: [1, 2, 3] };
expect(obj1).to.deep.equal(obj2);
在这个测试用例中，我们将 obj1 和 obj2 进行了比较，并使用了 deep 属性。这里的 deep.equal 就是 deep 属性的一种形式，它表示待比较对象应该是深度相等的，也就是说，在比较时要考虑嵌套对象和数组等复合类型的情况。如果两个对象的属性相等且属性值也相等，则这两个对象才会被认为是相等的。
需要注意的是，这里的 deep.equal 不是严格相等的比较方式。在严格相等的比较方式中，两个对象的引用值必须相等才会被认为是相等的。而在 deep.equal 中，我们只需要判断它们的属性值是否相等，而不必考虑引用值是否相等。
二、深度比较
在实际开发中，我们经常会遇到 JSON 对象的比较。因为 JSON 对象可能会包含很多嵌套对象和数组等复合类型，所以我们需要使用 deep 属性来进行比较。以下为一个示例：
// javascriptcn.com 代码示例
const expect = require('chai').expect;
const expectedJSON = `{
"name": "test",
"age": 20,
"hobby": ["reading", "swimming"],
"address": {
"province": "Zhejiang",
"city": "Hangzhou",
"detail": {
"street": "Xihu",
"building": "No.888"
}
}
}`;
const actualJSON = `{
"name": "test",
"age": 20,
"hobby": ["reading", "swimming"],
"address": {
"province": "Zhejiang",
"city": "Hangzhou",
"detail": {
"street": "Xihu",
"building": "No.888"
}
}
}`;
expect(JSON.parse(actualJSON)).to.deep.equal(JSON.parse(expectedJSON));在这个测试用例中，我们使用了 JSON.parse() 方法将字符串转换成了 JSON 对象。接下来，我们使用 deep 属性进行比较，判断这两个 JSON 对象是否相等，包括嵌套对象、数组等复合类型。
三、深度包含
除了深度比较之外，Chai 还支持另一种常见的操作：深度包含。即判断一个对象是否包含另一个对象，即便两个对象的属性名不相同，只要其中的属性值相等，就可以被认为是包含的。
const expect = require('chai').expect;
const obj1 = { name: 'Jim', age: 10, address: { city: 'Beijing' } };
const obj2 = { name: 'Jim', age: 10, phone: '123456' };
expect(obj1).to.deep.include(obj2);在这个测试用例中，我们判断 obj1 是否包含 obj2，也就是说，obj1 是否至少包含了 obj2 所包含的所有属性和属性值。
需要注意的是，深度包含和深度比较不同，它不仅仅是比较两个对象是否相等，而是判断一个对象是否包含另一个对象。
四、deep.property
除了上述两种常用方式之外，Chai 还提供了 deep.property 方法，该方法对嵌套对象的属性进行断言。
const expect = require('chai').expect;
const obj = { name: 'Jim', age: 10, address: { city: 'Beijing' } };
expect(obj).to.have.deep.property('address.city', 'Beijing');在这个测试用例中，我们判断 obj 对象的 address.city 属性是否等于 'Beijing'。
需要注意的是，当你使用 Chai 的 property 方法时，它只会断言指定属性是否存在，而不会做对象值的比较。如果你想进行深度比较，就需要使用 deep.property 方法。
五、总结
综上所述，我们可以将 Chai 中的 deep 属性的使用归纳为以下几个方面：
- 深度比较
- 深度包含
- 判断嵌套对象的属性
使用 Chai 中的 deep 属性可以方便地实现复合对象的比较，大大提高了代码的开发效率。同时，需要注意的是，对于复合对象的比较，不同的属性值可能会引起不同的结果，因此我们需要谨慎使用。
来源：JavaScript中文网 ，转载请注明来源 本文地址：https://www.javascriptcn.com/post/653b04c87d4982a6eb5547c6