JSON.stringify()
是一个 JSON 对象的方法,用于将一个 JavaScript 值转换为一个 JSON 字符串。
语法
JSON.stringify(value[, replacer[, space]])
参数
-
value
:必需,要转换成 JSON 字符串的值。 -
replacer
:可选,用于转换结果的函数或数组。如果是函数,则在转换过程中,被转换的值会传递给这个函数,并最终返回转换结果。如果是数组,则只有包含在这个数组中的属性名才会被转换到 JSON 字符串中。 -
space
:可选,用于美化输出的字符串。可以是一个字符串,用于指定缩进的空白字符,也可以是一个正整数,表示缩进的空格数。
返回值
一个表示给定值的 JSON 字符串。
示例
// 将一个 JavaScript 对象转换为 JSON 字符串 const obj = { name: "John", age: 30, city: "New York" }; const jsonStr = JSON.stringify(obj); console.log(jsonStr); // 输出:{"name":"John","age":30,"city":"New York"} // 将一个数组转换为 JSON 字符串 const arr = [1, 2, 3, 4, 5]; const jsonArr = JSON.stringify(arr); console.log(jsonArr); // 输出:[1,2,3,4,5] // 使用 replacer 函数过滤转换的属性 const obj2 = { name: "John", age: 30, city: "New York" }; const jsonStr2 = JSON.stringify(obj2, ["name", "age"]); console.log(jsonStr2); // 输出:{"name":"John","age":30} // 使用 replacer 函数修改转换的属性 const obj3 = { name: "John", age: 30, city: "New York" }; const jsonStr3 = JSON.stringify(obj3, (key, value) => { if (key === "name") { return value.toUpperCase(); } return value; }); console.log(jsonStr3); // 输出:{"name":"JOHN","age":30,"city":"New York"} // 使用 space 参数美化输出 const obj4 = { name: "John", age: 30, city: "New York" }; const jsonStr4 = JSON.stringify(obj4, null, 2); console.log(jsonStr4); // 输出: // { // "name": "John", // "age": 30, // "city": "New York" // }
注意事项
-
转换过程中,
undefined
、function
和symbol
类型的属性会被自动忽略。 -
如果一个属性值为
NaN
、Infinity
或-Infinity
,则会被转换成null
。 -
如果
replacer
是一个数组,但数组中的元素不是字符串,则会被忽略。 -
JSON.stringify()
方法不会转换对象的原型链上的属性。 -
如果对象中存在循环引用,则会抛出
TypeError
。 -
在转换过程中,对于非法的 JSON 值(例如
Infinity
、-Infinity
和NaN
),会将其转换成null
。 -
自定义对象的属性值如果含有函数(方法),则在转换为 JSON 字符串时会被忽略。
-
对象的属性名如果为非字符串类型,会被自动转换为字符串。
-
转换一个 JavaScript 值时,可以通过在该值上添加
toJSON()
方法,来自定义值的转换过程。