JS怎么输出对象中的不可枚举属性和Symbol属性

作者:闭包旅人

时间:2026-11-18

浏览:575

在JavaScript中,传统的Object.keys和for...in无法获取不可枚举属性和Symbol属性。本文详解使用Object.getOwnPropertyNames、Object.getOwnPropertySymbols以及Reflect.ownKeys的具体输出方法与完整代码示例。

文章目录
JS怎么输出对象中的不可枚举属性和Symbol属性
图 0:JavaScript 对象属性遍历维度与反射 API 全景概览

在 JavaScript 中输出对象属性时,常规的 Object.keys() 和 for...in 循环只能捕获可枚举的字符串属性。要完整输出对象中的不可枚举属性和 Symbol 属性,有两条清晰的路径:单一目标提取使用 Object.getOwnPropertyNames() 结合枚举状态过滤不可枚举属性,使用 Object.getOwnPropertySymbols() 获取 Symbol 属性;一站式全量提取则直接使用 ES6 提供的反射方法 Reflect.ownKeys()。

一、常规方法为什么会遗漏这两类属性

JavaScript 对象中的每个属性并非只有一个“键”和“值”,底层引擎为它们维护着一组控制行为的特性标志(Property Descriptor)。其中,enumerable(可枚举性)布尔值决定了该属性是否能被传统的遍历结构检索到:

  • 不可枚举属性:对象的 enumerable 特性被显式设定为 false(例如通过 Object.defineProperty 创建),或是内置原型上的原生属性(如 Array.prototype.length、Object.prototype.toString)。它们常用于封装内部状态或隐藏底层实现。
  • Symbol 属性:ES6 引入的基本类型,键名具有全局唯一性。由于 Symbol 设计的初衷之一是提供非字符串的元编程接口,语言规范从定义上便将其从常规字符串枚举流程中完全剥离。
JS怎么输出对象中的不可枚举属性和Symbol属性
图 1:对象属性四象限分类与常规遍历方法的可见盲区

正如上图所示,传统的 Object.keys() 仅能命中左上角的“常规可见区”,对其余三个象限的属性完全不具备读取能力。

二、如何输出对象中的不可枚举属性

要输出不可枚举属性,核心工具是 Object.getOwnPropertyNames(target)。该方法会返回一个由对象自身所有字符串属性名组成的数组,无论它们是否可枚举。

JS怎么输出对象中的不可枚举属性和Symbol属性
图 2:精准提取不可枚举属性的4个关键操作步骤

1. 完整提取与筛选代码示例

如果我们的目标是仅输出不可枚举属性(即排除掉普通可枚举属性),则需要配合 Object.prototype.propertyIsEnumerable 进行反向过滤。以下是完整可执行的代码:

// 1. 构建包含可枚举与不可枚举属性的测试对象
const user = {
  username: "zhangsan",
  role: "admin"
};

// 定义一个不可枚举属性 'internalId'
Object.defineProperty(user, "internalId", {
  value: "SYS_9527",
  writable: false,
  enumerable: false, // 关键:设置为不可枚举
  configurable: false
});

// 2. 获取自身全部字符串键(含不可枚举)
const allStringKeys = Object.getOwnPropertyNames(user);

// 3. 筛选出所有不可枚举属性名
const nonEnumerableKeys = allStringKeys.filter(key => {
  return !Object.prototype.propertyIsEnumerable.call(user, key);
});

// 4. 输出键与对应的值
console.log("全部自身字符串属性:", allStringKeys);
console.log("仅不可枚举属性键:", nonEnumerableKeys);

// 构造键值对对象输出
const nonEnumEntries = nonEnumerableKeys.reduce((acc, key) => {
  acc[key] = user[key];
  return acc;
}, {});
console.log("不可枚举属性与对应值:", nonEnumEntries);
示例运行输出
全部自身字符串属性: [ 'username', 'role', 'internalId' ]
仅不可枚举属性键: [ 'internalId' ]
不可枚举属性与对应值: { internalId: 'SYS_9527' }
注意事项:为什么推荐 Object.prototype.propertyIsEnumerable.call
直接调用 user.propertyIsEnumerable(...) 在对象没有重写该方法时有效;但如果对象是通过 Object.create(null) 创建的无原型对象,或者自身定义了名为 propertyIsEnumerable 的属性,直接调用会抛出异常。使用 Object.prototype.propertyIsEnumerable.call(target, key) 是更健壮的防御性写法。

三、如何输出对象中的 Symbol 属性

无论是可枚举还是不可枚举的 Symbol 属性,Object.getOwnPropertyNames() 都不会包含它们。输出 Symbol 属性的标准 API 是 Object.getOwnPropertySymbols(target)。

1. Symbol 属性提取与值获取代码示例

// 1. 构建包含 Symbol 属性的对象
const secretKey = Symbol("apiKey");
const lockSymbol = Symbol("isLocked");

const serviceConfig = {
  serviceName: "AuthService",
  [secretKey]: "sk-live-abcdef123456"
};

// 附加一个不可枚举的 Symbol 属性
Object.defineProperty(serviceConfig, lockSymbol, {
  value: true,
  enumerable: false,
  writable: false
});

// 2. 提取对象自身的所有 Symbol 键
const symbolKeys = Object.getOwnPropertySymbols(serviceConfig);

console.log("获取到的 Symbol 键数组:", symbolKeys);

// 3. 遍历输出 Symbol 键的描述与对应的值
symbolKeys.forEach(sym => {
  const descriptor = Object.getOwnPropertyDescriptor(serviceConfig, sym);
  console.log(`键: ${sym.toString()} | 描述: ${sym.description} | 值: ${serviceConfig[sym]} | 可枚举: ${descriptor.enumerable}`);
});
示例运行输出
获取到的 Symbol 键数组: [ Symbol(apiKey), Symbol(isLocked) ]
键: Symbol(apiKey) | 描述: apiKey | 值: sk-live-abcdef123456 | 可枚举: true
键: Symbol(isLocked) | 描述: isLocked | 值: true | 可枚举: false

可以看到,Object.getOwnPropertySymbols 会无差别地返回对象自身持有的所有 Symbol 键,不受其 enumerable 状态的影响。

四、一步到位的统一输出方案:Reflect.ownKeys

在实际开发(如深拷贝、状态序列化、调试审计工具)中,逐一调用 getOwnPropertyNames 和 getOwnPropertySymbols 再进行数组拼接相对繁琐。ES6 提供了反射接口 Reflect.ownKeys(target),它是目前 JavaScript 规范中穿透力最强的对象自身键遍历方法。

JS怎么输出对象中的不可枚举属性和Symbol属性
图 3:常用遍历与反射 API 在 5 个维度上的特性对照

1. 使用 Reflect.ownKeys 全量输出

Reflect.ownKeys(target) 在底层等价于 [...Object.getOwnPropertyNames(target), ...Object.getOwnPropertySymbols(target)]。不仅包含了常规可枚举属性,还完整覆盖了不可枚举属性和所有 Symbol 属性。

const secretId = Symbol("secretId");

const mixedObj = {
  regularProp: "可见数据"
};

// 添加不可枚举字符串属性
Object.defineProperty(mixedObj, "hiddenToken", {
  value: "TOKEN_888",
  enumerable: false
});

// 添加 Symbol 属性
mixedObj[secretId] = "SYMBOL_VAL";

// 一站式获取所有自身键
const allOwnKeys = Reflect.ownKeys(mixedObj);
console.log("全量自身键:", allOwnKeys);

// 完整打印每个属性的键、值与枚举性
allOwnKeys.forEach(key => {
  const desc = Object.getOwnPropertyDescriptor(mixedObj, key);
  const keyLabel = typeof key === "symbol" ? key.toString() : key;
  console.log(`- 键名: ${keyLabel.padEnd(15)} | 值: ${mixedObj[key]} | enumerable: ${desc.enumerable}`);
});
示例运行输出
全量自身键: [ 'regularProp', 'hiddenToken', Symbol(secretId) ]
- 键名: regularProp | 值: 可见数据 | enumerable: true
- 键名: hiddenToken | 值: TOKEN_888 | enumerable: false
- 键名: Symbol(secretId) | 值: SYMBOL_VAL | enumerable: true

2. 使用 Object.getOwnPropertyDescriptors 一次性提取描述符

若不仅要输出键和值,还要完整导出配置(例如 writable、configurable、get/set 存取器),ES2017 引入的 Object.getOwnPropertyDescriptors(target) 是极佳的选择。它返回一个对象,其键包含所有自身字符串和 Symbol 键,其值为对应的完整属性描述符:

const descriptors = Object.getOwnPropertyDescriptors(mixedObj);
console.log("完整属性描述符映射:", descriptors);

五、进阶场景:输出原型链上的隐藏属性

需要特别强调的是:Object.getOwnPropertyNames、Object.getOwnPropertySymbols 和 Reflect.ownKeys 的名称中都有 Own,这意味着它们只作用于目标对象自身,不会沿原型链向上追溯。

如果某个不可枚举属性或 Symbol 属性定义在对象的原型链上,而你需要全部输出,必须结合 Object.getPrototypeOf 进行循环回溯:

function getAllPropertiesAlongPrototype(target) {
  const result = [];
  let current = target;

  // 循环向上查找原型,直到到达 Object.prototype 的上层 null
  while (current && current !== Object.prototype) {
    const keys = Reflect.ownKeys(current);
    keys.forEach(key => {
      result.push({
        key: typeof key === "symbol" ? key.toString() : key,
        rawKey: key,
        value: current[key],
        isOwn: current === target,
        owner: current.constructor ? current.constructor.name : "Anonymous"
      });
    });
    current = Object.getPrototypeOf(current);
  }

  return result;
}

六、总结与 API 选型指南

面对不同的业务需求,选择最简洁精准的 API 能让代码意图更清晰、执行更高效。以下是常见的选型对照逻辑:

JS怎么输出对象中的不可枚举属性和Symbol属性
图 4:对象属性输出需求与 API 选型决策树
  1. 若仅需获取不可枚举属性:调用 Object.getOwnPropertyNames(obj),配合 !Object.prototype.propertyIsEnumerable.call(obj, key) 过滤即可。
  2. 若仅需获取 Symbol 属性:直接调用 Object.getOwnPropertySymbols(obj)。
  3. 若需要获取对象自身的全部属性(包含常规、不可枚举与 Symbol):首选 Reflect.ownKeys(obj)。
  4. 若需要完整克隆或审计属性的底层修饰符:首选 Object.getOwnPropertyDescriptors(obj)。
  5. 若涉及继承属性的隐藏属性排查:必须借助 Object.getPrototypeOf(obj) 沿原型链逐级回溯反射。

实用工具推荐

电子包浆

绿化、压缩、噪点和虚拟水印,自由调节做旧程度。

使用 ›
图片压缩

选择画质和输出格式,预览压缩前后的大小。

使用 ›
相关文章