JavaScript 中怎么在 JSON 转换中使用自定义对象的 toJSON 方法

浅辰同学_2434

浅辰同学_2434

2026-08-12

547人浏览

原创

json.stringify() 会自动调用对象的 tojson() 方法并用其返回值参与序列化;该方法可定义在对象自身或原型链上,返回任意类型值(undefined 在对象中被忽略、数组中转为 null),用于控制序列化输出格式。

javascript 中怎么在 json 转换中使用自定义对象的 tojson 方法

JavaScript 中,当使用 JSON.stringify() 序列化一个对象时,如果该对象定义了 toJSON() 方法,引擎会自动调用它,并用其返回值代替原对象参与序列化过程。这是标准规范支持的机制,无需额外配置。

toJSON 方法的基本行为

toJSON() 是一个约定方法(非强制接口),只要对象自身或其原型链上有这个方法,且是可调用函数,JSON.stringify() 就会在处理该对象时优先调用它,然后将返回值继续递归序列化。

  • 返回值可以是任意类型(包括 null、基本类型、普通对象、数组等)
  • 若返回 undefined,该属性会被忽略(在对象中)或转为 null(在数组中)
  • toJSON() 不影响对象本身的结构或行为,仅作用于 JSON 序列化环节

在自定义类中定义 toJSON

常见做法是在类的原型或实例上添加 toJSON 方法,控制对外暴露的数据格式:

Feishu calendar sync, local ics to json data for AI agent
Feishu calendar sync, local ics to json data for AI agent

将ICS日历文件转为JSON格式,用于飞书日历导入导出及数据集成。

下载
class User {
  constructor(name, email, password) {
    this.name = name;
    this.email = email;
    this.password = password;
  }

  toJSON() {
    // 过滤敏感字段,只保留需要序列化的属性
    return {
      name: this.name,
      email: this.email
      // password 被排除
    };
  }
}

const user = new User("Alice", "alice@example.com", "secret123");
console.log(JSON.stringify(user));
// → {"name":"Alice","email":"alice@example.com"}

toJSON 的调用时机与嵌套处理

toJSON() 会在任何层级被触发——无论是顶层对象,还是作为属性值、数组元素、嵌套子对象出现:

  • 如果对象 A 的某个属性值是对象 B,而 B 有 toJSON(),则 B 的该方法会被调用
  • 数组中包含自定义对象,也会逐个触发其 toJSON()
  • 即使 toJSON() 返回另一个带 toJSON() 的对象,也会继续递归调用

例如:

const obj = {
  id: 1,
  data: new User("Bob", "bob@test.com", "xxx"),
  tags: [new User("TagUser", "t@x.com", "y")]
};

console.log(JSON.stringify(obj));
// → {"id":1,"data":{"name":"Bob","email":"bob@test.com"},"tags":[{"name":"TagUser","email":"t@x.com"}]}

注意事项与常见陷阱

实际使用中需注意几点:

  • toJSON() 必须是**自有属性或原型上的方法**;通过 Object.defineProperty 设置时要确保 enumerable: true(默认为 false,会导致不生效)
  • 不能用箭头函数定义 toJSON(会丢失 this 绑定)
  • 避免在 toJSON() 中修改原始对象状态(比如删除属性、重置字段),这会影响后续逻辑
  • 如果返回值本身又含 toJSON 方法(如返回另一个自定义实例),会继续触发,需防止无限递归

Java免费学习笔记:立即使用
解锁 Java 大师之旅:从入门到精通的终极指南

相关文章

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

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

下载

相关标签:

javascript java js json

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

相关专题

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

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

2023.06.20

4486

5

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

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

2023.07.04

1129

3

js四舍五入
js四舍五入

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

2023.07.04

4404

6

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

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

2023.09.01

900

4

JavaScript转义字符
JavaScript转义字符

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

2023.09.04

1796

5

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

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

2023.09.04

3225

4

如何启用JavaScript
如何启用JavaScript

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

2023.09.12

4193

6

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

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

2023.09.20

2720

5

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

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

2023.09.20

868

7

热门下载

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

精品课程

更多
相关推荐
/
热门推荐
/
最新课程
WebStorm 官方调试文档
WebStorm 官方调试文档

共0课时 | 0人学习

React 教程
React 教程

共58课时 | 12.1万人学习

TypeScript 教程
TypeScript 教程

共19课时 | 6.6万人学习