JS获取对象所有键名的方法

在 JavaScript 中，获取对象的所有键名是常见的需求，但并非所有方法都能满足。`Object.keys()` 最为常用，但它仅返回可枚举的字符串键。要获取 Symbol 键，需使用 `Object.getOwnPropertySymbols()`；要获取不可枚举的字符串键，则需使用 `Object.getOwnPropertyNames()`。而 `Reflect.ownKeys()` 则能获取所有键，包括字符串和 Symbol，无论是否可枚举。`Object.keys()` 的局限性源于其设计，旨在区分公开属性与内部属性。遍历键名时，需注意这些方法仅返回自身属性，不包括原型链上的属性，且混合使用数字字符串和普通字符串键时，顺序可能不确定。频繁获取大对象键名可能影响性能，Proxy 对象的键名获取则受 ownKeys 陷阱控制。选择合适的方法，取决于你的具体需求，是从仅获取公开属性到全面内省对象结构。

获取对象所有键名最常用的是Object.keys()，但它只返回可枚举的字符串键；2. 要获取Symbol键需用Object.getOwnPropertySymbols()；3. 要获取不可枚举的字符串键需用Object.getOwnPropertyNames()；4. 要获取所有键（包括字符串、Symbol、可枚举和不可枚举）应使用Reflect.ownKeys()；5. Object.keys()取不到所有键是因为其设计仅包含可枚举字符串键，这是为了区分公开属性与内部或私有属性；6. 遍历键名时需注意：这些方法仅返回自身属性不包括原型链上的属性，若需遍历继承属性应使用for...in配合hasOwnProperty判断；7. 属性枚举顺序在现代规范中已明确，但混合数字字符串和普通字符串键时仍可能产生意外顺序；8. 对大对象频繁获取键名可能影响性能，应避免在循环中重复调用；9. Proxy对象的键名获取受ownKeys陷阱控制，返回结果取决于代理逻辑而非目标对象实际键名，因此需特别注意其行为。这些方法的选择取决于具体需求，从仅获取公开属性到全面内省对象结构不等。

在JavaScript中，获取一个对象的所有键名最常用且直接的方式是使用Object.keys()。它会返回一个数组，包含对象自身所有可枚举的字符串键名。但如果你需要获取Symbol类型的键名，或者那些不可枚举的字符串键名，就需要用到其他更专门的方法了。理解这些方法的区别，对于编写健壮的代码至关重要。

解决方案

要获取对象的键名，根据你的具体需求，有几种不同的方法：

• Object.keys(obj)：这是最常用的，它返回一个由给定对象自身可枚举的字符串键名组成的数组。它会忽略Symbol类型的键和不可枚举的字符串键。
• Object.getOwnPropertyNames(obj)：这个方法返回一个数组，包含对象自身所有字符串键名（包括可枚举和不可枚举的），但同样会忽略Symbol类型的键。
• Object.getOwnPropertySymbols(obj)：顾名思义，它返回一个数组，包含对象自身所有Symbol类型的键。
• Reflect.ownKeys(obj)：这是一个更现代、更全面的方法。它返回一个数组，包含对象自身所有键名，无论是字符串键还是Symbol键，也无论它们是否可枚举。这在需要对对象进行全面内省时非常有用。

以下是一个示例，展示了这些方法的不同之处：

const myObject = {
  name: '张三',
  age: 30,
  [Symbol('id')]: 'A101', // 一个Symbol类型的键
};

// 定义一个不可枚举的属性
Object.defineProperty(myObject, 'secretKey', {
  value: 'hidden_value',
  enumerable: false // 设置为不可枚举
});

console.log('Object.keys():', Object.keys(myObject));
// 输出: [ 'name', 'age' ]

console.log('Object.getOwnPropertyNames():', Object.getOwnPropertyNames(myObject));
// 输出: [ 'name', 'age', 'secretKey' ]

console.log('Object.getOwnPropertySymbols():', Object.getOwnPropertySymbols(myObject));
// 输出: [ Symbol(id) ]

console.log('Reflect.ownKeys():', Reflect.ownKeys(myObject));
// 输出: [ 'name', 'age', 'secretKey', Symbol(id) ]

从上面的输出可以看出，根据你想要获取的键名类型（字符串、Symbol、可枚举、不可枚举），你需要选择最合适的方法。

为什么 Object.keys() 有时候取不到所有键？

说实话，这其实不是 Object.keys() 的“缺陷”，而是它设计上的一个特点。Object.keys() 的初衷就是为了获取那些“公开的”、“可枚举的”字符串属性。想象一下，如果你有一个对象，里面有些属性是内部使用的，或者是一些只有通过特定API才能访问的Symbol属性，你肯定不希望它们在常规的遍历或序列化（比如JSON.stringify，它也只处理可枚举属性）时被暴露出来。

所以，当 Object.keys() “漏掉”了某些键时，它通常是刻意为之的：

• Symbol 键： Symbol 是一种独一无二的值，常用于创建对象的私有属性或避免命名冲突。它们本身就不是为了被常规遍历机制发现而设计的。如果你想获取它们，那显然是有一种更明确的意图，因此需要调用 Object.getOwnPropertySymbols()。
• 不可枚举的字符串键： 通过 Object.defineProperty() 定义的属性，可以显式地将 enumerable 设置为 false。这在很多框架或库中很常见，用来存放一些内部状态或方法，不希望它们出现在 for...in 循环或 Object.keys() 的结果中。比如，一个对象的 length 属性可能就是不可枚举的，你通常不会想在遍历对象时也把它当成一个普通键来处理。

这种区分，在我看来，让JavaScript的对象属性管理更加灵活和精细。它强制你思考，你到底想“看”到对象的哪些部分。

如何获取对象的 Symbol 类型键名和不可枚举键名？

要获取对象的Symbol类型键名和不可枚举的字符串键名，你需要更“深入”地探查对象。

• 获取 Symbol 类型键名： 就像前面提到的，Object.getOwnPropertySymbols(obj) 是专门用来解决这个问题的。它会返回一个数组，里面包含了对象自身所有直接定义的Symbol属性。这对于那些利用Symbol作为唯一标识符或内部状态的场景特别有用。比如，你可能在设计一个插件系统时，用Symbol来注册和查找插件的特定钩子函数，这时候就需要这个方法来遍历这些“隐形”的键。

• 获取不可枚举的字符串键名： Object.getOwnPropertyNames(obj) 是你的朋友。这个方法会返回一个数组，包含了对象自身所有字符串类型的属性名，无论是可枚举的还是不可枚举的。所以，如果你想拿到一个对象所有“自己”的字符串属性，包括那些“藏起来”的，Object.getOwnPropertyNames() 就能帮你办到。

• 一次性获取所有类型、所有枚举性的键名： 如果你真的想一网打尽，把对象自身的字符串键（无论可枚举与否）和Symbol键都拿出来，那么 Reflect.ownKeys(obj) 是最简洁、最现代的方式。Reflect 是ES6引入的一个内置对象，提供了一些与JavaScript运行时内部操作对应的方法，Reflect.ownKeys 就是其中之一。它提供了一种统一的方式来获取对象的所有自有属性键，这在进行元编程或需要对对象结构进行全面分析时非常方便。

选择哪种方法，完全取决于你当前的需求。是只想看“表面”的公开属性？还是想深入了解所有细节？

遍历对象键名时，有哪些需要注意的“坑”？

在JavaScript中处理对象键名，确实有一些细节值得注意，不然可能一不小心就踩坑里了：

• 原型链上的属性： Object.keys()、Object.getOwnPropertyNames()、Object.getOwnPropertySymbols() 和 Reflect.ownKeys() 这些方法都只会返回对象“自身”的属性，它们不会去原型链上查找继承的属性。如果你希望遍历到原型链上的可枚举属性，那就得用 for...in 循环。但使用 for...in 时，务必记住用 hasOwnProperty() 方法进行判断，比如 for (const key in obj) { if (obj.hasOwnProperty(key)) { /* ... */ } }。不然，你可能会意外地遍历到对象从其原型继承来的属性，这在很多情况下并不是你想要的。

• 属性顺序的不确定性（历史遗留与现代规范）： 过去，JavaScript对象属性的顺序并没有严格的规范，不同的引擎可能会有不同的表现。虽然现代ES规范（ES2015及以后）对属性的枚举顺序做了明确规定，例如，整数索引属性会按升序排列，字符串属性会按插入顺序排列，Symbol属性也会按插入顺序排列。但如果你处理的是老旧代码，或者在特定场景下依赖绝对的插入顺序，还是得留心。尤其是在混合使用数字字符串（如"1", "2"）和普通字符串（如"name"）作为键时，它们的排列顺序可能会出乎你的意料。

• 性能考量： 对于非常庞大、拥有成千上万个属性的对象，频繁地调用 Object.keys() 或其他类似的枚举方法，可能会带来一定的性能开销。因为这些操作都需要遍历对象的内部属性列表。在大多数日常应用中这并不是问题，但在高性能要求的场景，比如在循环中反复对同一个大对象执行键名获取操作，就可能需要考虑优化策略了。通常，避免在紧密循环中重复执行这类操作是一个好的实践。

• Proxy 对象的行为： 如果你正在处理一个 Proxy 对象，那么所有关于属性键名的获取操作（包括 Object.keys()、Object.getOwnPropertyNames() 等）都会被 Proxy 的 ownKeys 陷阱（trap）所拦截。这意味着最终返回的键名列表将完全取决于 Proxy 的实现逻辑，而不是底层目标对象的真实键名。这在进行元编程或构建抽象层时非常强大，但也意味着你不能简单地假设你会得到原始对象的键名。理解 Proxy 的工作机制，在遇到这类问题时能帮你快速定位问题。

本篇关于《JS获取对象所有键名的方法》的介绍就到此结束啦，但是学无止境，想要了解学习更多关于文章的相关知识，请关注golang学习网公众号！