1. 问题背景与默认输出分析
在Node.js开发中，当我们定义了自定义类并创建其实例时，直接使用console.log()打印这些对象，往往会得到一个简洁但信息不足的输出。例如，考虑以下简单的树结构实现：
class Node {
constructor(data = null, parent = null) {
this.data = data;
this.parent = parent;
this.children = [];
}
appendChild(data) {
// 修正：新节点的父节点应为当前节点，而非树的根节点
const newNode = new Node(data, this);
this.children.push(newNode);
return newNode; // 返回新创建的子节点
}
// 原始的toString方法，对console.log对象检查影响不大
toString() {
return String(this.data);
}
}
class NTree {
constructor(data) {
this.root = null;
if (data !== undefined) {
this.addRoot(data);
}
}
addRoot(data) {
if (!this.root) {
this.root = new Node(data);
} else {
console.warn("根节点已存在，请通过现有节点添加子节点。");
}
return this.root;
}
// NTree的appendChild方法，简化为向根节点添加子节点
appendChild(data) {
if (this.root) {
this.root.appendChild(data);
} else {
console.error("树为空，请先添加根节点。");
}
}
find(data) {
// 简化查找，仅检查根节点
if (this.root && this.root.data === data) {
return this.root;
}
return null;
}
// 原始的toString方法，对console.log对象检查影响不大
toString() {
// console.log(this.root); // 直接在此处打印root会再次触发其默认检查
return `NTree (root: ${this.root ? this.root.data : 'null'})`;
}
}
const t = new NTree();
t.addRoot(1);
t.appendChild(2); // 等价于 t.root.appendChild(2);
t.appendChild(3);
t.appendChild(4);
console.log(t);运行上述代码，默认的console.log(t)输出如下：
NTree {
root: Node { data: 1, parent: null, children: [ [Node], [Node], [Node] ] }
}可以看到，children数组中的子节点被显示为[Node]，这使得我们无法直接从输出中了解子节点的具体数据，尤其是在调试复杂对象结构时，这会带来不便。
我们的目标是实现以下更具可读性的输出格式：
NTree {
root: Node { data: 1, parent: null, children: [ 2, 3, 4 ] }
}2. Node.js对象检查机制与定制
console.log()在Node.js环境中，其底层依赖于util.inspect()函数来将JavaScript值转换为字符串表示。当util.inspect()遇到一个对象时，它会尝试调用该对象上定义的特殊方法来获取其定制的字符串表示。这个特殊方法就是Symbol.for('nodejs.util.inspect.custom')。
通过实现这个Symbol.for('nodejs.util.inspect.custom')方法，我们可以完全控制console.log()如何显示我们的自定义对象。
H_Space房产网
下载
功能说明(部分): 1,后台控制；所有前台显示页面,都在后台加以控制，不需登陆FTP即可更改全部的页面显示信息。 2,可选择用户发表的信息是否要求验证，如果选择只有通过验证后的信息才能在网页上显示。 3,推荐好友支持；当浏览信息时，可以选择“推荐”好友，只要输入对方的E-mail地址即可将此条信息发送到对的邮箱中。 4,预订信息支持；当访问者看到感兴趣的信息后，可选择“我要预订”向对方发送
该方法接收两个参数：
- depth: 当前检查的递归深度。可以根据深度来决定是否显示完整信息，避免无限递归或过于冗长的输出。
- options: 一个包含各种检查选项的对象，例如颜色、显示隐藏属性等。
3. 实现自定义对象输出
为了达到预期的输出效果，我们需要在Node和NTree两个类中都实现Symbol.for('nodejs.util.inspect.custom')方法。
3.1. 修改 Node 类
在Node类中，我们希望当一个Node对象作为另一个Node的子节点被检查时，其在children数组中只显示其data属性，而不是整个Node对象。同时，当Node对象本身被直接检查时，我们希望它能显示其data、parent（简化为父节点数据）和简化的children列表。
class Node {
constructor(data = null, parent = null) {
this.data = data;
this.parent = parent;
this.children = [];
}
appendChild(data) {
const newNode = new Node(data, this);
this.children.push(newNode);
return newNode;
}
toString() {
return String(this.data);
}
// 实现自定义检查方法
[Symbol.for('nodejs.util.inspect.custom')](depth, options) {
// 当深度不足时，可以返回一个更简洁的表示，例如只返回数据
if (depth < 0) {
return `Node(${this.data})`;
}
// 递归调用时，传递新的深度和选项
const newOptions = { ...options, depth: options.depth === null ? null : options.depth - 1 };
return {
data: this.data,
// 简化父节点显示，只显示其数据
parent: this.parent ? this.parent.data : null,
// 关键：将子节点数组映射为只包含其数据的数组
children: this.children.map(child => child.data)
};
}
}3.2. 修改 NTree 类
在NTree类中，我们希望console.log(t)能显示NTree { root: ... }的结构，并且root的显示由Node类的自定义检查方法来处理。
class NTree {
constructor(data) {
this.root = null;
if (data !== undefined) {
this.addRoot(data);
}
}
addRoot(data) {
if (!this.root) {
this.root = new Node(data);
} else {
console.warn("根节点已存在，请通过现有节点添加子节点。");
}
return this.root;
}
appendChild(data) {
if (this.root) {
this.root.appendChild(data);
} else {
console.error("树为空，请先添加根节点。");
}
}
find(data) {
if (this.root && this.root.data === data) {
return this.root;
}
return null;
}
toString() {
return `NTree (root: ${this.root ? this.root.data : 'null'})`;
}
// 实现自定义检查方法
[Symbol.for('nodejs.util.inspect.custom')](depth, options) {
// 当深度不足时，返回一个简洁的NTree描述
if (depth < 0) {
return `[NTree (root: ${this.root ? this.root.data : 'null'})]`;
}
// 递归调用时，传递新的深度和选项
const newOptions = { ...options, depth: options.depth === null ? null : options.depth - 1 };
return {
// NTree只包含root属性，其检查将由Node类的inspect方法处理
root: this.root
};
}
}3.3. 完整示例代码
将上述修改整合到一起：
class Node {
constructor(data = null, parent = null) {
this.data = data;
this.parent = parent;
this.children = [];
}
appendChild(data) {
const newNode = new Node(data, this);
this.children.push(newNode);
return newNode;
}
toString() {
return String(this.data);
}
[Symbol.for('nodejs.util.inspect.custom')](depth, options) {
if (depth < 0) {
return `Node(${this.data})`;
}
return {
data: this.data,
parent: this.parent ? this.parent.data : null,
children: this.children.map(child => child.data)
};
}
}
class NTree {
constructor(data) {
this.root = null;
if (data !== undefined) {
this.addRoot(data);
}
}
addRoot(data) {
if (!this.root) {
this.root = new Node(data);
} else {
console.warn("根节点已存在，请通过现有节点添加子节点。");
}
return this.root 
