如何通过 自定义 toJSON 方法 精准控制对象在序列化时的输出格式

大墨姑娘_2276

大墨姑娘_2276

2026-05-07

725人浏览

原创

json.stringify() 遇到对象时优先调用其 tojson() 方法(若存在),用其返回值参与序列化;tojson 必须返回可序列化值,可实现字段过滤、重命名、格式转换及嵌套递归控制。

如何通过 自定义 tojson 方法 精准控制对象在序列化时的输出格式

在 JavaScript 中,JSON.stringify() 遇到对象时会默认调用其 toJSON() 方法(如果存在),并用该方法的返回值参与序列化。通过自定义 toJSON,你可以完全决定这个对象“对外呈现”的结构,而不是暴露原始属性或内部状态。

toJSON 方法的基本规则

toJSON 是一个普通函数,必须返回一个可被 JSON 序列化的值(即:字符串、数字、布尔值、null、数组、或另一个拥有 toJSON 的对象)。它不会改变原对象,只影响序列化结果。

  • 函数名必须严格为 toJSON(大小写敏感)
  • 它会在 JSON.stringify() 内部自动触发,无需手动调用
  • 如果返回 undefined,该字段会被忽略(整个键值对不出现)
  • 如果返回其他不可序列化类型(如 DateFunctionundefined),会报错或被转为 null(取决于上下文)

按需过滤与重命名字段

常见场景是隐藏敏感字段(如 _idpasswordHash)或统一输出格式(如把 createdAt 转为 ISO 字符串)。

例如:

jm-jsjkxyjs02-pzl-803
jm-jsjkxyjs02-pzl-803

查询全球任意城市的实时天气和未来天气预报

下载
const user = {
  id: 123,
  _internalId: 'abc-456',
  name: 'Alice',
  passwordHash: 'sha256...',
  createdAt: new Date('2023-01-01'),

  toJSON() {
    return {
      userId: this.id,
      fullName: this.name,
      registeredAt: this.createdAt.toISOString()
      // _internalId 和 passwordHash 被主动排除
    };
  }
};

JSON.stringify(user);
// → {"userId":123,"fullName":"Alice","registeredAt":"2023-01-01T00:00:00.000Z"}

支持嵌套对象与递归控制

toJSON 不仅适用于顶层对象,也适用于任意嵌套层级的对象。只要子对象定义了 toJSON,它就会被递归调用。

  • 适合封装业务模型类(如 UserOrder
  • 避免在每个 JSON.stringify() 调用前手动映射
  • 保持数据结构与序列化逻辑解耦

示例中,若 user.profile 也是一个带 toJSON 的对象,它会自动按自己的规则输出,无需外层干预。

配合 class 使用更清晰

使用 ES6 class 定义模型时,toJSON 更易维护和复用:

class Product {
  constructor(id, title, price, stock) {
    this.id = id;
    this.title = title;
    this.price = price;
    this.stock = stock;
    this._updatedAt = new Date();
  }

  toJSON() {
    return {
      productId: this.id,
      name: this.title,
      price: Number(this.price.toFixed(2)),
      inStock: this.stock > 0,
      lastUpdated: this._updatedAt.toISOString()
    };
  }
}

const p = new Product(789, 'Wireless Mouse', 29.99, 42);
JSON.stringify(p);
// → {"productId":789,"name":"Wireless Mouse","price":29.99,"inStock":true,"lastUpdated":"..."}

这样既保证实例行为一致,又让 API 响应格式稳定可控。

相关文章

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

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

下载

相关标签:

js json

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

相关专题

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

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

2023.06.20

4106

5

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

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

2023.07.04

1049

3

js四舍五入
js四舍五入

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

2023.07.04

3984

6

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

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

2023.09.01

820

4

JavaScript转义字符
JavaScript转义字符

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

2023.09.04

1716

5

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

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

2023.09.04

3005

4

如何启用JavaScript
如何启用JavaScript

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

2023.09.12

3913

6

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

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

2023.09.20

2480

5

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

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

2023.09.20

828

7

热门下载

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

精品课程

更多
相关推荐
/
热门推荐
/
最新课程
WEB前端教程【HTML5+CSS3+JS】
WEB前端教程【HTML5+CSS3+JS】

共101课时 | 20.5万人学习

JS进阶与BootStrap学习
JS进阶与BootStrap学习

共39课时 | 4.7万人学习