Chai.js 如何进行 “深度”（deep）比较？

在前端开发中，我们经常需要比较两个对象是否相等。但是，浅比较只能比较对象的引用，而不能比较对象的属性值。如果我们需要比较对象的属性值，就需要进行深度比较。这时候，Chai.js 就派上用场了。

Chai.js 是一个 JavaScript 的断言库，可以用来编写测试用例。它提供了多种比较方法，其中包括深度比较方法。

深度比较方法

Chai.js 提供了两种深度比较方法：deep.equal 和 eql。

deep.equal

deep.equal 方法比较两个对象是否相等，包括对象的属性值、属性名和属性个数。如果两个对象相等，返回 true，否则返回 false。

const obj1 = { a: 1, b: 2 };
const obj2 = { b: 2, a: 1 };

expect(obj1).to.deep.equal(obj2); // true

eql

eql 方法也比较两个对象是否相等，但是它不比较属性名和属性个数。只要两个对象的属性值相等，就返回 true。

const obj1 = { a: 1, b: 2 };
const obj2 = { b: 2, a: 1, c: 3 };

expect(obj1).to.eql(obj2); // true

深度比较的限制

深度比较虽然方便，但是也有一些限制。

循环引用

如果对象存在循环引用，深度比较会陷入死循环。为了避免这种情况，Chai.js 提供了 deep.equal 方法的限制，可以通过 maxDepth 选项来指定最大比较深度。如果比较的深度超过了指定的最大深度，就会抛出异常。

const obj1 = { a: 1 };
const obj2 = { b: obj1 };
obj1.b = obj2;

expect(obj1).to.deep.equal(obj2); // throw Error('Circular reference detected')
expect(obj1).to.deep.equal(obj2, { maxDepth: 3 }); // true

不同类型的对象

如果两个对象的类型不同，深度比较会返回 false。

const obj1 = { a: 1 };
const obj2 = [1];

expect(obj1).to.deep.equal(obj2); // false

总结

Chai.js 提供了深度比较方法，可以比较对象的属性值、属性名和属性个数。但是，深度比较也有一些限制，如循环引用和不同类型的对象。在编写测试用例时，需要注意这些限制，以便正确地进行深度比较。

示例代码：

// javascriptcn.com 代码示例
const expect = require('chai').expect;

describe('Chai.js', () => {
  describe('deep.equal', () => {
    it('should compare two objects with the same properties', () => {
      const obj1 = { a: 1, b: 2 };
      const obj2 = { b: 2, a: 1 };
      expect(obj1).to.deep.equal(obj2);
    });
  });

  describe('eql', () => {
    it('should compare two objects with the same properties', () => {
      const obj1 = { a: 1, b: 2 };
      const obj2 = { b: 2, a: 1, c: 3 };
      expect(obj1).to.eql(obj2);
    });
  });
});

来源：JavaScript中文网 ，转载请注明来源 本文地址：https://www.javascriptcn.com/post/655e99dbd2f5e1655d8c33ec