一聚教程网:一个值得你收藏的教程网站

最新下载

热门教程

怎样通过 Reflect.ownKeys() 获取包含 Symbol 在内的对象所有类型自有属性标识键名

时间:2026-06-28 09:48:57 编辑:袖梨 来源:一聚教程网

Reflect.ownKeys() 返回对象自有属性的全部键(字符串和Symbol),按创建顺序排列,不区分可枚举性,等价于Object.getOwnPropertyNames()与Object.getOwnPropertySymbols()并集。

Reflect.ownKeys() 确实能拿到 Symbol 键,但得确保 Symbol 是“自有”的

它不会漏掉 Symbol 类型的键,前提是这些 Symbol 是直接定义在目标对象上、而非继承来的。比如 obj[Symbol('a')] = 1 会进结果,但 Object.prototype[Symbol.toStringTag] 不会——因为那是原型链上的。

常见错误是误以为 Reflect.ownKeys() 会返回所有 Symbol(包括全局注册的或内置的),其实它只管“自有 + 可枚举/不可枚举 + 字符串/Symbol”,和 Object.getOwnPropertyNames() + Object.getOwnPropertySymbols() 的并集等价。

  • Reflect.ownKeys() 返回的是 Array<string | symbol>,顺序是:先字符串键(按创建顺序),再 Symbol 键(也按创建顺序)
  • 如果对象有 Symbol.for('x')Symbol('x') 两个不同 Symbol,它们都会被列出,互不影响
  • 注意:WeakMapWeakSet 等无法遍历内部键,Reflect.ownKeys() 对它们抛 TypeError

对比 Object.keys() / Object.getOwnPropertyNames() 容易踩的坑

Object.keys() 只返回可枚举的字符串键;Object.getOwnPropertyNames() 返回所有自有字符串键(含不可枚举),但完全忽略 Symbol;只有 Reflect.ownKeys()Object.getOwnPropertyNames() + Object.getOwnPropertySymbols() 组合才能覆盖全量。

典型翻车场景:你用 for...inObject.keys() 遍历配置对象,结果漏掉了 obj[Symbol.metadata] = {...} 这种元数据键,后续序列化或深拷贝就丢信息。

  • 别用 Object.keys(obj).concat(Object.getOwnPropertySymbols(obj)) ——类型不一致(前者是 string[],后者是 symbol[]),合并后数组元素类型变成 (string | symbol)[],TypeScript 会报错,运行时虽可行但不干净
  • 直接用 Reflect.ownKeys(obj) 最省心,语义明确,且返回值类型就是 (string | symbol)[]
  • 如果要过滤出纯 Symbol 键,用 Reflect.ownKeys(obj).filter(k => typeof k === 'symbol')

Symbol 键不可枚举,但 Reflect.ownKeys() 不care枚举性

这是关键点:Reflect.ownKeys() 不区分可枚举/不可枚举,它只认“是否为自有属性”。所以即使你用 Object.defineProperty(obj, 'hidden', { value: 1, enumerable: false }) 加了不可枚举字符串键,或者用 obj[Symbol.iterator] = function*(){} 加了不可枚举 Symbol 键,它全收。

这也意味着:不能靠 Reflect.ownKeys() 判断某个键是否“应该被 JSON.stringify() 包含”——因为 JSON.stringify() 只处理可枚举的字符串键,对 Symbol 和不可枚举键一律无视。

  • Reflect.ownKeys() 是反射层面的“物理存在性”探测,不是运行时行为控制工具
  • 想模拟 JSON.stringify() 行为?得手动筛:Reflect.ownKeys(obj).filter(k => typeof k === 'string' && obj.propertyIsEnumerable(k))
  • 给 Symbol 键设 enumerable: false 没意义——Symbol 键天生不可枚举,propertyIsEnumerable() 对任何 Symbol 键都返回 false

实际用法示例:安全地遍历并克隆含 Symbol 的对象

很多库(比如 Vue 的响应式标记、class 装饰器元数据)依赖 Symbol 属性,直接 Object.assign({}, obj) 或展开运算符会丢失它们。

const source = {  a: 1,  b: 2};source[Symbol.for('meta')] = { version: 2 };source[Symbol('id')] = 'xyz';const clone = {};Reflect.ownKeys(source).forEach(key => {  clone[key] = source[key];});// clone 现在有 a、b、Symbol.for('meta')、Symbol('id') 四个键

注意:这样浅拷贝没问题,但如果 Symbol 键对应的是复杂对象,且你希望深拷贝,就得额外判断 typeof key === 'symbol' 并递归处理值——这点常被忽略。

真正麻烦的是那些带 [[DefineOwnProperty]] 陷阱的对象(比如 Proxy),Reflect.ownKeys() 返回的键可能和实际可访问的不一致,此时需结合 Reflect.getOwnPropertyDescriptor() 进一步验证。

热门栏目