JS怎么打印对象的Symbol属性和不可枚举属性

作者:异步漫步时间:2026-11-18 12:45:48浏览:298

在JavaScript中,普通遍历和打印方法无法输出Symbol属性与不可枚举属性。本文详解导致这一现象的底层机制,并提供利用Object.getOwnPropertySymbols、Object.getOwnPropertyNames以及Reflect.ownKeys全面提取与打印对象所有属性的具体方案和工具函数。

JS怎么打印对象的Symbol属性和不可枚举属性
JavaScript 隐藏属性检测与打印方案总览

假设你正在调试一个第三方复杂库生成的实例,或者排查基于 Object.defineProperty 定义内部元数据的对象。当你执行 console.log(obj)、Object.keys(obj) 或者 JSON.stringify(obj) 时,控制台给出的输出干干净净,似乎这些字段从未存在过。然而底层逻辑却真实依赖着一个名为 Symbol(id) 的标识符或不可枚举的 _config 属性。

在 JavaScript 中,要想完整打印并读取这类“隐身”属性,核心答案非常明确:打印所有 Symbol 属性使用 Object.getOwnPropertySymbols(obj),打印包含不可枚举的所有普通字符串属性使用 Object.getOwnPropertyNames(obj),而一键收集所有自身键(无论 Symbol 还是不可枚举)的最佳标准方法是 Reflect.ownKeys(obj)。

一、为什么常规方法会“遗漏”它们?

JavaScript 对象的属性并非简单的键值对集合,每个属性都具备两个关键维度的特征:

  • 键的类型维度:常规字符串键(String)与唯一符号键(Symbol)。
  • 描述符特性维度:可枚举性标志(enumerable: true 或 false)。

开发者常用的 Object.keys()、Object.values()、Object.entries()、for...in 循环以及 JSON.stringify() 序列化,在底层规范设计上全部只针对“自身可枚举的字符串键”。这就意味着,只要一个属性使用了 Symbol 作为键,或者其 enumerable 描述符被明确置为 false,它就会从常规遍历列表中完全消失。

JS怎么打印对象的Symbol属性和不可枚举属性
图 1:JavaScript 对象属性的维度分类与常规 API 遍历盲区

如图 1 所示,常规 API 的覆盖面仅仅局限在左上角的象限中。针对其余三个象限中的属性,必须依赖专用的底层反射方法才能提取。

二、针对性提取两类属性的核心 API

1. 获取对象的 Symbol 属性

ECMAScript 2015 (ES6) 引入了 Symbol 作为原始数据类型,同时也引入了 Object.getOwnPropertySymbols() 方法。该方法接收一个目标对象,返回一个数组,包含该对象自身声明的所有 Symbol 键,无论是可枚举还是不可枚举的:

// 构造包含 Symbol 属性的对象
const idSymbol = Symbol('userId');
const roleSymbol = Symbol('userRole');

const user = {
  name: '张三'
};

user[idSymbol] = 10086;
Object.defineProperty(user, roleSymbol, {
  value: 'admin',
  enumerable: false // 显式设为不可枚举
});

// 提取所有 Symbol 键并打印值
const symbolKeys = Object.getOwnPropertySymbols(user);
console.log('获取到的 Symbol 属性数组:', symbolKeys);

symbolKeys.forEach(sym => {
  console.log(`键: ${sym.toString()}, 值: ${user[sym]}`);
});

输出示例:

获取到的 Symbol 属性数组: [ Symbol(userId), Symbol(userRole) ]
键: Symbol(userId), 值: 10086
键: Symbol(userRole), 值: admin

2. 获取对象的不可枚举属性

要获取不可枚举的字符串属性,可以使用自 ES5 时代就存在的 Object.getOwnPropertyNames()。它会返回对象自身拥有的所有字符串键,包括可枚举和不可枚举的属性(但不会包含 Symbol 键)。

如果你只想筛选出纯粹的不可枚举属性,可以结合 Object.getOwnPropertyDescriptor() 判断其 enumerable 是否为 false:

const config = {
  env: 'production'
};

// 定义不可枚举属性
Object.defineProperty(config, 'internalSecret', {
  value: '9f8e7d6c5b',
  enumerable: false,
  writable: false,
  configurable: true
});

// 获取所有字符串键并过滤不可枚举项
const allStringKeys = Object.getOwnPropertyNames(config);
const nonEnumerableKeys = allStringKeys.filter(key => {
  const descriptor = Object.getOwnPropertyDescriptor(config, key);
  return descriptor && descriptor.enumerable === false;
});

console.log('全部字符串属性:', allStringKeys);
console.log('仅不可枚举属性:', nonEnumerableKeys);
nonEnumerableKeys.forEach(key => {
  console.log(`隐藏属性 [${key}]: ${config[key]}`);
});

输出示例:

全部字符串属性: [ 'env', 'internalSecret' ]
仅不可枚举属性: [ 'internalSecret' ]
隐藏属性 [internalSecret]: 9f8e7d6c5b

三、一步到位:使用 Reflect.ownKeys 全量获取

在实际工程场景中,我们往往既不希望遗漏 Symbol 属性,也不希望遗漏不可枚举属性。如果分别调用 Object.getOwnPropertyNames 和 Object.getOwnPropertySymbols 再合并,代码会显得冗长且不够直接。

JavaScript 提供了 Reflect.ownKeys(target)。根据 ECMAScript 规范定义,Reflect.ownKeys 内部调用的正是底层对象的 [[OwnPropertyKeys]] 内部方法。它的返回结果精确等价于:

Object.getOwnPropertyNames(target).concat(Object.getOwnPropertySymbols(target))
JS怎么打印对象的Symbol属性和不可枚举属性
图 2:常用属性提取 API 的作用范围与全能方案对比

通过图 2 的矩阵对比可以清晰发现,Reflect.ownKeys 是唯一具备 100% 自身键捕获能力的内置 API。

API 方法 可枚举字符串 不可枚举字符串 可枚举 Symbol 不可枚举 Symbol 原型链属性
Object.keys() ✔ 支持 ✘ 忽略 ✘ 忽略 ✘ 忽略 ✘ 忽略
for...in ✔ 支持 ✘ 忽略 ✘ 忽略 ✘ 忽略 ✔ 包含继承
Object.getOwnPropertyNames() ✔ 支持 ✔ 支持 ✘ 忽略 ✘ 忽略 ✘ 忽略
Object.getOwnPropertySymbols() ✘ 忽略 ✘ 忽略 ✔ 支持 ✔ 支持 ✘ 忽略
Reflect.ownKeys() ✔ 支持 ✔ 支持 ✔ 支持 ✔ 支持 ✘ 忽略

四、编写实用工具函数:完整打印对象全部属性

直接通过键取值时,如果属性配置了带有副作用的 getter,可能会在读取瞬间触发未预期的计算甚至抛出错误。稳妥的做法是结合 Object.getOwnPropertyDescriptor,同时打印属性值与元信息。

JS怎么打印对象的Symbol属性和不可枚举属性
图 3:全面提取并格式化打印对象属性的操作流程

按照图 3 所示的流水线逻辑,我们可以封装一个可直接复用的打印工具函数:

/**
 * 完整打印对象的所有属性(含不可枚举属性与 Symbol 属性)
 * @param {object} target - 待检查的目标对象
 */
function inspectAllProperties(target) {
  if (target === null || (typeof target !== 'object' && typeof target !== 'function')) {
    console.warn('目标并非对象类型,无法进行属性反射检查');
    return;
  }

  const allKeys = Reflect.ownKeys(target);
  const rows = [];

  for (const key of allKeys) {
    const desc = Object.getOwnPropertyDescriptor(target, key);
    const keyType = typeof key === 'symbol' ? 'Symbol' : 'String';
    const keyDisplay = typeof key === 'symbol' ? key.toString() : key;
    
    let resolvedValue;
    if (desc.get) {
      resolvedValue = '[Getter 函数]';
    } else {
      resolvedValue = desc.value;
    }

    rows.push({
      '属性键': keyDisplay,
      '键类型': keyType,
      '可枚举(enumerable)': desc.enumerable,
      '可写(writable)': desc.writable ?? '-',
      '属性值': resolvedValue
    });
  }

  console.log(`\n========== 检查对象属性 (共 ${allKeys.length} 项) ==========`);
  console.table(rows);
}

// 验证示例
const sample = { regular: '公开属性' };
Object.defineProperty(sample, 'hiddenKey', {
  value: '机密标记',
  enumerable: false
});
sample[Symbol('uuid')] = 'abc-123';
Object.defineProperty(sample, Symbol('cachedStatus'), {
  value: 200,
  enumerable: false
});

inspectAllProperties(sample);

控制台运行效果示例:

========== 检查对象属性 (共 4 项) ==========
┌─────────┬────────────────────────┬─────────┬──────────────────────┬─────────────┬────────────┐
│ (index) │ 属性键                 │ 键类型  │ 可枚举(enumerable)   │ 可写(writable) │ 属性值     │
├─────────┼────────────────────────┼─────────┼──────────────────────┼─────────────┼────────────┤
│    0    │ 'regular'              │ 'String'│ true                 │ true        │ '公开属性' │
│    1    │ 'hiddenKey'            │ 'String'│ false                │ false       │ '机密标记' │
│    2    │ 'Symbol(uuid)'         │ 'Symbol'│ true                 │ true        │ 'abc-123'  │
│    3    │ 'Symbol(cachedStatus)' │ 'Symbol'│ false                │ false       │ 200        │
└─────────┴────────────────────────┴─────────┴──────────────────────┴─────────────┴────────────┘

五、控制台与调试器中的快速查看技巧

如果是在日常排查问题,无需编写业务代码,可以使用宿主环境自带的高级调试手段。

1. Node.js 环境:console.dir

在 Node.js 中,console.log 会默认折叠或隐藏不可枚举属性。但你可以借助 console.dir 的 showHidden 选项:

console.dir(target, { showHidden: true, depth: null, colors: true });

此外,使用内置模块 const util = require('util'); console.log(util.inspect(target, { showHidden: true })); 同样能够直接在终端中输出包含不可枚举属性和 Symbol 属性的高亮文本。

2. 浏览器 DevTools 开发者工具

在 Chrome 或 Edge 控制台中直接输入对象名时,展开对象箭头后:

  • 所有不可枚举的字符串属性会以浅灰色斜体字体展示。
  • 所有 Symbol 属性会被归集在单独的 [[Entries]] 或直接列出的 Symbol(...) 项中。
JS怎么打印对象的Symbol属性和不可枚举属性
图 4:JavaScript 对象属性调试与查看方案决策树

六、注意事项与边界场景

注意事项一:原型链属性的追溯边界
不管是 Object.getOwnPropertyNames 还是 Reflect.ownKeys,名称中的 own 均代表仅获取对象自身的属性。如果目标对象通过原型继承了某个 Symbol 或不可枚举方法(例如 Array.prototype[Symbol.iterator]),这些 API 在传入子实例时不会返回该方法。如需深层追溯,需结合 Object.getPrototypeOf(obj) 沿原型链逐级向上遍历。
注意事项二:Proxy 代理拦截机制
如果目标对象是一个 Proxy 实例,调用 Reflect.ownKeys、Object.getOwnPropertyNames 或 Object.getOwnPropertySymbols 时,都会触发 Proxy 上的 ownKeys 陷阱钩子。如果代理内部故意过滤了特定键,返回的结果可能受到代理逻辑影响。

掌握了上述 API 的组合与底层特征,面对各类库对象或复杂数据结构时,便能轻松穿透属性的可枚举限制与 Symbol 隔离,准确调试与获取对象的完整信息。

作者最新文章
相关文章
更多