在JavaScript中获取不可枚举属性与Symbol属性的核心方案详解。深入分析for...in与Object.keys的限制,演示Object.getOwnPropertyNames、Object.getOwnPropertySymbols与Reflect.ownKeys的使用方法、执行排序机制及跨原型链追溯技巧。
JS怎么获取对象的不可枚举属性及Symbol属性
时间:2026-11-18
浏览:477
文章目录
在 JavaScript 中,常规的 Object.keys() 和 for...in 循环均只能访问可枚举的字符串键,无法触达不可枚举属性与 Symbol 属性。要准确获取这两类属性,需要根据目标类型选用原生反射接口:获取不可枚举字符串属性使用 Object.getOwnPropertyNames(),获取 Symbol 属性使用 Object.getOwnPropertySymbols();若需一次性完整获取对象自有的全部属性(无论是否枚举、无论是字符串还是 Symbol),最直接且现代的标准方案是调用 Reflect.ownKeys()。
一、常规遍历方法的局限与属性分类
JavaScript 对象的属性特征由内部属性描述符(Property Descriptor)决定。其中 enumerable(可枚举性)决定了属性是否会在日常遍历中暴露出来。此外,ES6 引入了 Symbol 作为一种新的原始数据类型,作为属性键时具备独特的隔离性。
当开发者使用常规语法读取对象属性时,JavaScript 引擎实施了严格的过滤机制:
for...in循环:遍历对象自身以及原型链上所有可枚举的字符串属性,会自动跳过不可枚举属性和全部 Symbol 属性。Object.keys()/Object.values()/Object.entries():仅返回对象自身且可枚举的字符串键,完全忽略不可枚举属性与 Symbol 属性。JSON.stringify():序列化对象时不仅会忽略不可枚举属性,还会彻底忽略所有以 Symbol 为键的属性。
因此,当需要编写深拷贝、序列化工具、对象校验器、调试审查工具或元编程框架时,必须采用专用的反射 API。
二、如何获取对象的不可枚举属性
不可枚举属性通常由 Object.defineProperty() 或 Object.defineProperties() 明确声明(当未指定 enumerable 时默认为 false),内置对象的许多原生方法(例如 Array.prototype.push 或 Object.prototype.toString)也是不可枚举的。
1. 使用 Object.getOwnPropertyNames()
Object.getOwnPropertyNames(obj) 返回一个数组,包含指定对象自身的所有字符串属性名,包括不可枚举属性,但不包含 Symbol 属性。
// 构造测试对象:包含可枚举与不可枚举属性
const user = {};
// 默认普通赋值,enumerable 为 true
user.name = "张三";
// 使用 defineProperty 定义不可枚举属性
Object.defineProperty(user, "_idCard", {
value: "110101199003072345",
writable: false,
enumerable: false, // 不可枚举
configurable: true
});
// 尝试常规读取与 getOwnPropertyNames 读取
console.log("Object.keys(user):", Object.keys(user));
console.log("Object.getOwnPropertyNames(user):", Object.getOwnPropertyNames(user));
Object.keys(user): [ 'name' ]
Object.getOwnPropertyNames(user): [ 'name', '_idCard' ]
2. 精确提取“仅不可枚举”的字符串属性
Object.getOwnPropertyNames() 返回的是“所有”自有字符串属性(既有可枚举的,也有不可枚举的)。如果业务需求是仅提取出不可枚举的那一部分,可以配合 Object.prototype.propertyIsEnumerable() 或属性描述符进行二次过滤:
function getOnlyNonEnumerableKeys(obj) {
return Object.getOwnPropertyNames(obj).filter(key => {
return !Object.prototype.propertyIsEnumerable.call(obj, key);
});
}
console.log("纯不可枚举属性:", getOnlyNonEnumerableKeys(user));
纯不可枚举属性: [ '_idCard' ]
Object.prototype.propertyIsEnumerable.call(obj, key) 能够防御目标对象通过 Object.create(null) 创建或自身覆盖了同名方法导致的报错。
三、如何获取对象的 Symbol 属性
Symbol 作为 ES6 引入的唯一标识符,其作为属性键时无论是否可枚举,都会被 Object.getOwnPropertyNames() 完全忽略。针对 Symbol 属性,JavaScript 提供了专用反射函数。
1. 使用 Object.getOwnPropertySymbols()
Object.getOwnPropertySymbols(obj) 返回一个由对象自身所有 Symbol 属性键组成的数组。无论该 Symbol 属性的 enumerable 被设为 true 还是 false,都会完整包含在此数组中。
const symPublic = Symbol("publicToken");
const symInternal = Symbol("internalSecret");
const session = {
title: "AdminSession",
[symPublic]: "PUB-9981"
};
// 显式定义一个不可枚举的 Symbol 属性
Object.defineProperty(session, symInternal, {
value: "SEC-SECRET-HASH-8832",
enumerable: false,
writable: false
});
// 获取 Symbol 键
const symbolKeys = Object.getOwnPropertySymbols(session);
console.log("获取到的 Symbol 属性数量:", symbolKeys.length);
symbolKeys.forEach(sym => {
console.log(sym.toString(), "=", session[sym]);
});
获取到的 Symbol 属性数量: 2
Symbol(publicToken) = PUB-9981
Symbol(internalSecret) = SEC-SECRET-HASH-8832
四、一网打尽:Reflect.ownKeys 的综合应用
在实际工程中,很多场景(如对象深克隆、序列化、元数据注入、代理代理器等)需要一次性获取对象自有的全部属性,而不愿手动将字符串属性与 Symbol 属性拼装合并。此时,Reflect.ownKeys() 是最推荐的标准解决方案。
1. Reflect.ownKeys 的基本用法
Reflect.ownKeys(target) 在底层等价于 Object.getOwnPropertyNames(target).concat(Object.getOwnPropertySymbols(target))。它接受一个目标对象,返回由该对象自身全部属性键构成的数组。
const mixedObj = {
normalProp: "常规值"
};
const symKey = Symbol("flag");
mixedObj[symKey] = true;
Object.defineProperty(mixedObj, "nonEnumProp", {
value: "隐藏配置",
enumerable: false
});
// 一行代码获取所有键
const allKeys = Reflect.ownKeys(mixedObj);
console.log("Reflect.ownKeys 结果:", allKeys);
Reflect.ownKeys 结果: [ 'normalProp', 'nonEnumProp', Symbol(flag) ]
2. 底层键序规则 (Key Ordering Specification)
根据 ECMAScript 规范定义,Reflect.ownKeys 以及底层抽象操作 [[OwnPropertyKeys]] 的返回数组有着严格确定的排序保证:
- 非负整数索引键:符合 32 位无符号整数字符串键(例如
"0","1","2"),一律按升序数值顺序排列。 - 常规字符串键:其他字符串属性(包括不可枚举属性),按插入时间先后顺序排列。
- Symbol 键:所有 Symbol 属性键排在所有字符串键之后,同样按插入时间先后顺序排列。
五、进阶场景:跨原型链追溯不可枚举与 Symbol 属性
无论是 Object.getOwnPropertyNames()、Object.getOwnPropertySymbols() 还是 Reflect.ownKeys(),从名称中的 OwnProperty 就可以看出,它们仅针对对象自身的属性生效,不会自动向上遍历原型链。
如果一个不可枚举方法或 Symbol 标识挂载在原型对象上(例如类的原型方法),单纯调用上述方法是找不到该属性的。此时,必须通过 Object.getPrototypeOf() 沿着原型链迭代追溯。
跨原型链获取全部属性的通用实现
下面是一个工业级的属性探查函数,它能够沿着原型链逐层向上搜集所有的字符串属性与 Symbol 属性,并支持设置是否包含顶层 Object.prototype:
/**
* 递归获取对象及其原型链上的所有属性键(包含不可枚举与 Symbol)
* @param {object} target 目标对象
* @param {boolean} includeObjectPrototype 是否包含 Object.prototype 上的原生方法
* @returns {Array<string|symbol>} 去重后的所有属性键
*/
function getAllPropertiesAlongChain(target, includeObjectPrototype = false) {
if (target === null || target === undefined) {
return [];
}
const keysSet = new Set();
let currentObj = target;
while (currentObj !== null) {
// 如果不希望混入 Object.prototype 自带的大量方法(如 hasOwnProperty、toString),在此跳过
if (!includeObjectPrototype && currentObj === Object.prototype) {
break;
}
// 提取当前层级的所有自有键(无论枚举与否,无论字符串或 Symbol)
const ownKeys = Reflect.ownKeys(currentObj);
ownKeys.forEach(k => keysSet.add(k));
// 沿原型链向上步进
currentObj = Object.getPrototypeOf(currentObj);
}
return Array.from(keysSet);
}
// 验证类继承场景
class Base {
constructor() {
this.baseField = "baseValue";
}
baseMethod() {} // ES6 class 原型方法默认即为不可枚举
}
const symChild = Symbol("childTag");
class Child extends Base {
constructor() {
super();
this[symChild] = "childSecret";
}
childMethod() {}
}
const instance = new Child();
const chainKeys = getAllPropertiesAlongChain(instance);
console.log("实例全链路属性集合:", chainKeys);
实例全链路属性集合: [ 'baseField', Symbol(childTag), 'constructor', 'childMethod', 'baseMethod' ]
六、全方案对照与选型参考
为了方便日常开发快速选型,下表汇总了各常用 API 在处理不可枚举属性、Symbol 键以及原型链遍历时的具体能力:
| 提取方法 | 可枚举字符串 | 不可枚举字符串 | 可枚举 Symbol | 不可枚举 Symbol | 作用范围 |
|---|---|---|---|---|---|
Object.keys() |
支持 | 不支持 | 不支持 | 不支持 | 仅自身 |
for...in |
支持 | 不支持 | 不支持 | 不支持 | 自身 + 原型链 |
Object.getOwnPropertyNames() |
支持 | 支持 | 不支持 | 不支持 | 仅自身 |
Object.getOwnPropertySymbols() |
不支持 | 不支持 | 支持 | 支持 | 仅自身 |
Reflect.ownKeys() |
支持 | 支持 | 支持 | 支持 | 仅自身 |
七、实践中的注意事项与常见陷阱
-
慎用 JSON.stringify 复制对象:
JSON.stringify会静默丢弃所有的不可枚举属性和 Symbol 属性。若需要完整克隆对象,应结合Reflect.ownKeys与Object.getOwnPropertyDescriptor构建深拷贝逻辑。 -
原型方法不可枚举特性:在 ES6 类(
class)语法中,类体内部声明的实例方法在编译后挂载于原型上,且其描述符的enumerable默认均为false。这也是常规Object.keys()无法获取类方法的原因。 -
获取属性的具体描述符:当使用上述方法取得属性键名后,若需要了解其读写状态、Getter/Setter 或枚举性,应通过
Object.getOwnPropertyDescriptor(obj, propKey)读取其完整元数据。
实用工具推荐
绿化、压缩、噪点和虚拟水印,自由调节做旧程度。
选择画质和输出格式,预览压缩前后的大小。