如何利用 Symbol 实现类中的“半私有”属性防止外部意外访问

梦丽君_5365

梦丽君_5365

2026-04-07

397人浏览

原创

symbol作为属性键能防普通遍历,因其唯一不可枚举,不出现于for...in、object.keys()等常规遍历中,仅object.getownpropertysymbols()可获取,属“半私有”而非真正私有。

如何利用 symbol 实现类中的“半私有”属性防止外部意外访问

Symbol 作为属性键为什么能防普通遍历

因为 Symbol 创建的值是唯一且不可被枚举的——它不会出现在 for...in、Object.keys()、JSON.stringify() 中,连 Object.getOwnPropertyNames() 都拿不到它,只有 Object.getOwnPropertySymbols() 能显式提取。这使得用 Symbol 命名的属性天然“隐身”于常规访问路径之外。

但注意:它不是真正的私有,Reflect.ownKeys() 和 Object.getOwnPropertySymbols() 仍能发现它,所以只是“半私有”,目标是防止误用,而非对抗恶意探测。

  • Symbol 属性不会被解构赋值直接获取:const { secret } = instance 拿不到 secret(除非你显式写 [secretSym])
  • 类方法内部可自由使用 this[secretSym],和普通属性无异
  • 多个 Symbol() 调用即使描述相同,也互不相等:Symbol('foo') !== Symbol('foo')

在 class 中定义和使用 Symbol 属性的正确姿势

必须把 Symbol 定义在类外部或静态块中,避免每次实例化都新建一个——否则每个实例的 Symbol 键都不一样,无法统一访问逻辑,也失去“约定标识”的意义。

const _id = Symbol('id');
const _token = Symbol('token');
<p>class User {
constructor(id, token) {
this[_id] = id;
this[_token] = token;
}</p><p>getId() {
return this[_id];
}</p><p>// 外部调用 this.id 或 this.token 会是 undefined
}
</p>
  • 不要在构造函数里写 const _id = Symbol(),那会导致每个实例用不同 key,无法复用逻辑
  • 推荐用 const _xxx = Symbol('xxx') 方式命名,便于调试时识别用途(DevTools 会显示描述字符串)
  • 如果需要跨模块共享 Symbol,可用 Symbol.for('key'),但要小心全局命名冲突

和 # 私有字段(Private Fields)的关键区别在哪

#field 是真私有:语法级限制,外部访问直接报错 Uncaught SyntaxError: Private field '#field' must be declared in an enclosing class;而 Symbol 属性是运行时“藏起来”,访问 instance[_sym] 完全合法,只是没人会这么写。

  • # 字段不能被 in、hasOwnProperty、Reflect.ownKeys 检测到;Symbol 属性可以被 Reflect.ownKeys 和 Object.getOwnPropertySymbols 拿到
  • # 不支持计算属性,this[#key] 无效;Symbol 可以用 this[symKey] 动态访问
  • 兼容性:# 在 Node.js ≥ 12 / Chrome ≥ 74+;Symbol 在 IE11 以外基本全覆盖
  • 如果你需要子类继承并访问该字段,Symbol 更合适;# 字段完全不可继承、不可反射

容易忽略的调试与序列化陷阱

开发时容易以为 “没看到属性就是不存在”,结果在 console.log(instance) 里看不到 Symbol 属性就误判逻辑错误;或者想用 JSON.stringify(instance) 序列化时发现字段丢了,却没意识到这是设计使然。

  • 调试时可用 console.log(Object.getOwnPropertySymbols(instance)) 查看有哪些 Symbol 键
  • 若需序列化 Symbol 属性,得手动处理:JSON.stringify({ ...instance, [_id]: instance[_id] })
  • Vue / React 的响应式系统默认不追踪 Symbol 属性(如 Vue 3 的 reactive()),需额外用 shallowRef 或 markRaw 配合
  • 单元测试中检查 Symbol 属性要用 expect(instance[_sym]).toBe(...),别依赖 toMatchObject ——它只看可枚举属性

真正难的不是加个 Symbol,而是团队是否对这种“约定式隐藏”形成共识,以及后续所有序列化、调试、测试环节是否都记得绕过这个盲区。

PHP速学视频免费教程(入门到精通)
PHP速学视频免费教程(入门到精通)

PHP怎么学习?PHP怎么入门?PHP在哪学?PHP怎么学才快?不用担心,这里为大家提供了PHP速学教程(入门到精通),有需要的小伙伴保存下载就能学习啦!

下载

相关标签:

本站声明:本文内容由网友自发贡献,版权归原作者所有,本站不承担相应法律责任。如您发现有涉嫌抄袭侵权的内容,请联系admin@php.cn

相关专题

更多
js获取数组长度的方法
js获取数组长度的方法

在js中,可以利用array对象的length属性来获取数组长度,该属性可设置或返回数组中元素的数目,只需要使用“array.length”语句即可返回表示数组对象的元素个数的数值,也就是长度值。php中文网还提供JavaScript数组的相关下载、相关课程等内容,供大家免费下载使用。

2023.06.20

4586

5

js刷新当前页面
js刷新当前页面

js刷新当前页面的方法:1、reload方法,该方法强迫浏览器刷新当前页面,语法为“location.reload([bForceGet]) ”;2、replace方法,该方法通过指定URL替换当前缓存在历史里(客户端)的项目,因此当使用replace方法之后,不能通过“前进”和“后退”来访问已经被替换的URL,语法为“location.replace(URL) ”。php中文网为大家带来了js刷新当前页面的相关知识、以及相关文章等内容

2023.07.04

1149

3

js四舍五入
js四舍五入

js四舍五入的方法:1、tofixed方法,可把 Number 四舍五入为指定小数位数的数字;2、round() 方法,可把一个数字舍入为最接近的整数。php中文网为大家带来了js四舍五入的相关知识、以及相关文章等内容

2023.07.04

4524

6

js删除节点的方法
js删除节点的方法

js删除节点的方法有:1、removeChild()方法,用于从父节点中移除指定的子节点,它需要两个参数,第一个参数是要删除的子节点,第二个参数是父节点;2、parentNode.removeChild()方法,可以直接通过父节点调用来删除子节点;3、remove()方法,可以直接删除节点,而无需指定父节点;4、innerHTML属性,用于删除节点的内容。

2023.09.01

900

4

JavaScript转义字符
JavaScript转义字符

JavaScript中的转义字符是反斜杠和引号,可以在字符串中表示特殊字符或改变字符的含义。本专题为大家提供转义字符相关的文章、下载、课程内容,供大家免费下载体验。

2023.09.04

1816

5

js生成随机数的方法
js生成随机数的方法

js生成随机数的方法有:1、使用random函数生成0-1之间的随机数;2、使用random函数和特定范围来生成随机整数;3、使用random函数和round函数生成0-99之间的随机整数;4、使用random函数和其他函数生成更复杂的随机数;5、使用random函数和其他函数生成范围内的随机小数;6、使用random函数和其他函数生成范围内的随机整数或小数。

2023.09.04

3285

4

如何启用JavaScript
如何启用JavaScript

JavaScript启用方法有内联脚本、内部脚本、外部脚本和异步加载。详细介绍:1、内联脚本是将JavaScript代码直接嵌入到HTML标签中;2、内部脚本是将JavaScript代码放置在HTML文件的`<script>`标签中;3、外部脚本是将JavaScript代码放置在一个独立的文件;4、外部脚本是将JavaScript代码放置在一个独立的文件。

2023.09.12

4273

6

Js中Symbol类详解
Js中Symbol类详解

javascript中的Symbol数据类型是一种基本数据类型,用于表示独一无二的值。Symbol的特点:1、独一无二,每个Symbol值都是唯一的,不会与其他任何值相等;2、不可变性,Symbol值一旦创建,就不能修改或者重新赋值;3、隐藏性,Symbol值不会被隐式转换为其他类型;4、无法枚举,Symbol值作为对象的属性名时,默认是不可枚举的。

2023.09.20

2780

5

java访问控制修饰符介绍
java访问控制修饰符介绍

java访问控制修饰符有四种,分别是public、protected、private、默认访问修饰符。详细介绍:1、public,public是最宽松的访问控制修饰符,被修饰的类、方法和变量可以被任何其他类访问,当一个类、方法或变量被声明为public时,它们可以在任何地方被访问,无论是同一个包中的类还是不同包中的类;2、protected修饰符等等。

2023.09.20

888

7

热门下载

更多
网站特效
/
网站源码
/
网站素材
/
前端模板

精品课程

更多
热门推荐
/
最新课程
phpStudy极速入门视频教程
phpStudy极速入门视频教程

共6课时 | 54.6万人学习

独孤九贱(4)_PHP视频教程
独孤九贱(4)_PHP视频教程

共89课时 | 133.4万人学习