JSON.stringify()的坑及实现
题目来源:GitHub 手写题集合 刷题
总结:文章概要分为三个部分,JSON.stringify 踩的坑 + 循环引用问题 + 手写 JSON.stringify
一、JSON.stringify
踩的坑
前后端约定,前端传递的参数格式为 [{key, value},...]
,但是 JSON.stringify
处理数据的时候,有一个原则:
undefined
、任意的函数
以及symbol值
出现在 非数组对象 的属性值中时 在序列化过程中会被忽略(在数组中遇到会被转换成null
)
在浏览器中尝试输出如下,的确会将值为 undefined 的对象属性值忽略
后端解析输入参数的时候,JSON.parse 拿到的第二个 key 是没有对应的 value 值的
解决方案1、新引入一个对象
// 在 JSON.stringify 前将参数中的 undefined 替换成 空字符串 ''
let newInfo = info.map((it) => {
const value = typeof it.value === 'undefined' ? '' : it.value;
return {...it, value}
})
解决方案2、利用 JSON.stringify
第二个参数
// 判断到序列化的 value 为 undefined,返回空字符串即可
JSON.stringify(info, (key, value) => typeof value === 'undefined' ? '' : value);
二、重学一遍 JSON.stringify
MDN 描述:JSON.stringify()
方法将一个 JavaScript
对象或值 转换为 JSON 字符串,如果指定了一个 replacer
函数,则可以选择性地替换值,或者指定的 replacer 是数组,则可选择性地仅包含数组指定的属性。
JSON.stringify(value[, replacer [, space]])
// replacer[可选]
/**
* 如果该参数是一个函数,则在序列化过程中,被序列化的值的每个属性都会经过该函数的转换和处理
* 如果该参数是一个数组,则只有包含在这个数组中的属性名才会被序列化到最终的 JSON 字符串中
* 如果该参数为 null 或者未提供,则对象所有的属性都会被序列化
*/
// space[可选] - 指定缩进用的空白字符串,用于美化输出
/**
* 如果参数为 数字,它代表有多少的空格;上限为 10。该值若小于 1,则意味着没有空格;
* 如果该参数为字符串(当字符串长度超过 10 个字母,取其前 10 个字母),该字符串将被作为空格;
* 如果该参数没有提供(或者为 null),将没有空格
*/
异常:
- 当在循环引用时会抛出异常
TypeError
(“cyclic object value”)(循环对象值) - 当尝试去转换
BigInt
类型的值会抛出TypeError
(“BigInt value can’t be serialized in JSON”)(BigInt 值不能 JSON 序列化).
转换规则:
-
转换值如果有 toJSON() 方法,该方法定义什么值将被序列化
- 可以给转换值自定义序列化方法
-
非数组对象的属性 不能保证以特定的顺序出现 在序列化后的字符串中。
-
布尔值、数字、字符串的包装对象在序列化过程中会自动转换成对应的原始值。
-
console.log(JSON.stringify([new Number(30), new String("Alice"), new Boolean(true)])) // '[1, "Alice", true]'
-
-
undefined
、任意的函数以及 symbol 值,在序列化过程中会被忽略(出现在非数组对象的属性值中时)或者被 转换成null
(出现在数组中时)。函数、undefined 被 单独转换时,会返回 undefined,如JSON.stringify(function(){})
orJSON.stringify(undefined)
- 案例如上一小节的 bug 问题
-
对包含循环引用的对象(对象之间相互引用,形成无限循环)执行此方法,会抛出错误。
-
所有 以 symbol 为属性键的属性都会被完全忽略掉,即便
replacer
参数中强制指定包含了它们。 -
Date 日期调用了 toJSON() 将其转换为了 string 字符串(同 Date.toISOString()),因此会被当做字符串处理。
-
NaN 和 Infinity 格式的数值及 null 都会被当做 null
-
JSON.stringify({name: NaN, sex: Infinity, partner: null}) // '{"name":null,"sex":null,"partner":null}'
-
-
其他类型的对象,包括 Map/Set/WeakMap/WeakSet,仅会序列化可枚举的属性
三、手写 JSON.stringify
这里实现没有第二、第三个函数的版本,主要就是上述异常和转换规则的实现
const jsonstringify = (data) => {
// 确认一个对象是否存在循环引用
const isCyclic = (obj) => {
// 使用Set数据类型来存储已经检测过的对象
let stackSet = new Set()
let detected = false
const detect = (obj) => {
// 不是对象类型的话,可以直接跳过
if (obj && typeof obj != 'object') {
return
}
// 当要检查的对象已经存在于stackSet中时,表示存在循环引用
if (stackSet.has(obj)) {
return detected = true
}
// 将当前 obj 存入 stackSet
stackSet.add(obj)
for (let key in obj) {
// 对obj下的属性进行挨个检测
if (obj.hasOwnProperty(key)) {
detect(obj[key])
}
}
// 平级检测完成之后,将当前对象删除,防止误判
stackSet.delete(obj)
}
detect(obj);
return detected;
}
// 特性七:对包含循环引用的对象(对象之间相互引用,形成无限循环)执行此方法,会抛出错误。
if (isCyclic(data)) {
throw new TypeError('Converting circular structure to JSON')
}
// 特性九:当尝试去转换 BigInt 类型的值会抛出错误
if (typeof data === 'bigint') {
throw new TypeError('Do not know how to serialize a BigInt')
}
const type = typeof data;
const commonKeys1 = ['undefined', 'function', 'symbol']
const getType = (s) => {
return Object.prototype.toString.call(s).replace(/\[object (.*?)\]/, '$1').toLowerCase()
}
// 非对象
if (type !== 'object' || data === null) {
let result = data
// 特性四:NaN 和 Infinity 格式的数值及 null 都会被当做 null。
if ([NaN, Infinity, null].includes(data)) {
result = 'null'
// 特性一:`undefined`、`任意的函数`以及`symbol值`被`单独转换`时,会返回 undefined
} else if (commonKeys1.includes(type)) {
// 直接得到undefined,并不是一个字符串'undefined'
return undefined
} else if (type === 'string') {
result = '"' + data + '"'
}
return String(result)
} else if (type === 'object') {
// 特性五:转换值如果有 toJSON() 方法,该方法定义什么值将被序列化
// 特性六:Date 日期调用了 toJSON() 将其转换为了 string 字符串(同Date.toISOString()),因此会被当做字符串处理。
if (typeof data.toJSON === 'function') {
return jsonstringify(data.toJSON())
} else if (Array.isArray(data)) {
let result = data.map((it) => {
// 特性一:`undefined`、`任意的函数`以及`symbol值`出现在`数组`中时会被转换成 `null`
return commonKeys1.includes(typeof it) ? 'null' : jsonstringify(it)
})
return `[${result}]`.replace(/'/g, '"')
} else {
// 特性二:布尔值、数字、字符串的包装对象在序列化过程中会自动转换成对应的原始值。
if (['boolean', 'number'].includes(getType(data))) {
return String(data)
} else if (getType(data) === 'string') {
return '"' + data + '"'
} else {
let result = []
// 特性八:其他类型的对象,包括 Map/Set/WeakMap/WeakSet,仅会序列化可枚举的属性
Object.keys(data).forEach((key) => {
// 特性三:所有以symbol为属性键的属性都会被完全忽略掉,即便 replacer 参数中强制指定包含了它们。
if (typeof key !== 'symbol') {
const value = data[key]
// 特性一:`undefined`、`任意的函数`以及`symbol值`,出现在`非数组对象`的属性值中时在序列化过程中会被忽略
if (!commonKeys1.includes(typeof value)) {
result.push(`"${key}":${jsonstringify(value)}`)
}
}
})
return `{${result}}`.replace(/'/, '"')
}
}
}
}