JavaScript class需手动实现toJSON()方法以支持JSON.stringify()序列化,该方法返回纯数据对象,可处理Date、RegExp等特殊类型并忽略私有字段和函数。

JavaScript 的 class 本身不支持自动序列化,因为 JSON.stringify() 只处理纯数据:它会跳过函数、undefined、Symbol、私有字段(#field),也无法保留原型或特殊类型(如 Date、RegExp、Map)。要让 class 实例能被正确转成 JSON 字符串,核心是手动实现一个 toJSON() 方法。
toJSON() 方法的作用机制
JSON.stringify() 在遇到对象时,会先检查该对象是否有 toJSON() 方法。如果有,就调用它,并用其返回值代替原对象参与后续序列化——这个过程完全绕过默认的属性遍历逻辑。
- 该方法必须是实例方法(定义在 class 原型上或构造函数内),不能是静态方法
- 返回值应为 plain object、数组、字符串、数字、布尔值或
null,确保能被 JSON 安全表示 - 它不负责反序列化,只控制“输出什么”,反序列化需另写逻辑(如静态
fromJSON())
如何编写可靠的 toJSON() 方法
重点是只暴露可持久化的公共状态,同时对特殊值做标准化转换:
- 显式列出需要保留的字段,避免意外包含方法或临时属性
- 将
Date转为toISOString(),RegExp转为{ source, flags }对象 - 对嵌套 class 实例,递归调用其
toJSON()(前提是它们也实现了) - 忽略私有字段(
#id)、箭头函数、绑定方法等无法还原的成员
示例:
class Task {
constructor(title, due, tags = []) {
this.title = title;
this.due = new Date(due);
this.tags = tags;
this.#id = Math.random(); // 私有字段,不序列化
}
toJSON() {
return {
title: this.title,
due: this.due.toISOString(),
tags: this.tags
};
}
}
分析 Java Spring Boot 后端 Controller 代码,自动生成 Markdown 格式的接口文档。当用户说“生成 Java 接口文档”、“生成 API 文档”、“从 Spring 代码生成文档”时触发。
JSON.stringify(new Task('Buy milk', '2026-10-15')) → {"title":"Buy milk","due":"2026-10-15T00:00:00.000Z","tags":[]}
配合 replacer 参数做额外过滤(可选)
如果不想改 class,也可用 JSON.stringify(obj, replacer) 控制字段级行为:
- 传入数组(如
['title', 'due'])只保留指定键 - 传入函数可动态处理每个键值对,比如统一格式化日期或剔除空数组
但这种方式不封装在 class 内,复用性弱,且无法处理私有字段或类型转换逻辑——推荐优先使用 toJSON()。
注意边界情况
即使写了 toJSON(),仍需警惕这些常见问题:
- 循环引用:若对象图中存在 A→B→A,
toJSON()本身不解决,需在方法内提前检测并断开(例如用 WeakMap 记录已访问实例) - Map / Set:原生不可序列化,应在
toJSON()中转为普通对象或数组,如Object.fromEntries(map)或[...set] - 继承链:子类需重写
toJSON()显式合并父类字段,否则可能丢失状态
Java免费学习笔记:立即使用
解锁 Java 大师之旅:从入门到精通的终极指南










