js JSON.stringify()方法详解|极客笔记

js JSON.stringify()方法详解

简介

在现代的Web开发中，经常需要在客户端和服务器端之间传输数据。而JSON（JavaScript Object Notation）已成为一种常用的数据交换格式，它具有简洁明了、易于阅读和编写的特点。

在JavaScript中，我们可以使用JSON.stringify()方法将JavaScript对象转换为JSON字符串，以便于传输和存储。本文将详细介绍 JSON.stringify() 方法的基本用法、参数和返回值，并提供一些示例代码。

基本用法

JSON.stringify() 方法用于将JavaScript对象转换为JSON字符串的表示形式。该方法接收三个参数：value、replacer 和 space。其中，value 参数是指要进行转换的 JavaScript 对象或值。

下面是一个基本的使用示例：

const obj = { name: 'John', age: 25 };
const objJson = JSON.stringify(obj);

console.log(objJson);
// Output: {"name":"John","age":25}

在这个示例中，我们定义了一个包含姓名和年龄的对象 obj，然后使用 JSON.stringify() 方法将其转换为JSON字符串，并将其赋值给变量 objJson。最后，使用 console.log() 方法打印出转换后的JSON字符串。

参数说明

replacer 参数

replacer 是一个可选参数，用来指定在将对象转换为JSON字符串时需要进行替换的属性。它可以是一个函数，也可以是一个数组。

如果 replacer 是一个函数，它将会被调用来为每个属性值进行转换。函数接收两个参数：key 和 value。其中 key 是指当前属性的键名，value 是指当前属性的值。我们可以在函数中根据需要对属性值进行修改。

const obj = { name: 'John', age: 25 };
const replacer = (key, value) => {
    if (key === 'age') {
        return value + 5;
    }
    return value;
};
const objJson = JSON.stringify(obj, replacer);

console.log(objJson);
// Output: {"name":"John","age":30}

如果 replacer 是一个数组，它将被用于选择要转换的属性。只有包含在 replacer 数组中的属性才会被转换为JSON字符串。数组元素可以是字符串或者数字，它们分别表示对象属性的名称或者下标位置。

const obj = { name: 'John', age: 25, address: '123 Street' };
const replacer = ['name', 0];
const objJson = JSON.stringify(obj, replacer);

console.log(objJson);
// Output: {"name":"John", "0":"J"}

space 参数

space 是一个可选参数，用于美化生成的JSON字符串。它可以是一个表示缩进空格数的正整数，也可以是一个表示缩进使用的字符串。

如果 space 是一个正整数，则表示每一级缩进使用相应数量的空格。比如，space 设置为 4，表示每一级缩进使用 4 个空格。

const obj = { name: 'John', age: 25 };
const space = 4;
const objJson = JSON.stringify(obj, null, space);

console.log(objJson);
// Output:
// {
//     "name": "John",
//     "age": 25
// }

如果 space 是一个字符串，表示该字符串将被用作缩进字符。比如， space 设置为 '\t'，表示使用制表符进行缩进。

const obj = { name: 'John', age: 25 };
const space = '\t';
const objJson = JSON.stringify(obj, null, space);

console.log(objJson);
// Output:
// {
//     "name": "John",
//     "age": 25
// }

undefined 的转换

默认情况下，JSON.stringify() 方法会忽略 JavaScript 对象中的 undefined 属性。例如：

const obj = { name: 'John', age: undefined };
const objJson = JSON.stringify(obj);

console.log(objJson);
// Output: {"name":"John"}

如果想要自定义 undefined 的转换行为，replacer 参数可以实现。下面是一个示例：

const obj = { name: 'John', age: undefined };
const replacer = (key, value) => {
    if (typeof value === 'undefined') {
        return null;
    }
    return value;
};
const objJson = JSON.stringify(obj, replacer);

console.log(objJson);
// Output: {"name":"John","age":null}

返回值

JSON.stringify() 方法返回一个JSON字符串，包含已转换的对象或值。如果传递给方法的对象无法转换为有效的JSON格式（比如包含循环引用），则会抛出异常。

示例代码

下面是一些示例代码，演示了 JSON.stringify() 方法的更多用法：

数组转换

const arr = [1, "test", { key: "value" }];
const arrJson = JSON.stringify(arr);

console.log(arrJson);
// Output: [1,"test",{"key":"value"}]

对象转换

const obj = { name: 'John', age: 25, address: { city: 'New York', country: 'USA' } };
const objJson = JSON.stringify(obj);

console.log(objJson);
// Output: {"name":"John","age":25,"address":{"city":"New York","country":"USA"}}

转义特殊字符

const str = 'This is a "quoted" string.';
const strJson = JSON.stringify(str);

console.log(strJson);
// Output: "This is a \"quoted\" string."

空格缩进

const obj = { name: 'John', age: 25 };
const space = 2;
const objJson = JSON.stringify(obj, null, space);

console.log(objJson);
// Output:
// {
//   "name": "John",
//   "age": 25
// }