JSON.stringify()

作者likuolei

JSON.stringify() 中文讲解

JSON.stringify() 是 JavaScript（包括 Node.js）内置的函数，用于将 JavaScript 值（对象、数组等）转换为 JSON 格式的字符串。以下是对 JSON.stringify() 的详细中文讲解，涵盖其定义、用法、参数、注意事项、常见场景以及与 Node.js 和 MongoDB 的结合，力求简洁清晰。

1. 什么是 JSON.stringify()？

  • 定义：JSON.stringify() 是 JavaScript 全局对象 JSON 的方法，用于将 JavaScript 值（对象、数组、字符串、数字、布尔值或 null）序列化为符合 JSON 语法的字符串。
  • 用途：常用于将数据发送到 API、保存到文件、存储到 MongoDB，或生成可读的 JSON 字符串。
  • 基本语法：
  JSON.stringify(value[, replacer[, space]])
  • value：要序列化的 JavaScript 值（通常是对象或数组）。
  • replacer：可选，函数或数组，用于过滤或转换值。
  • space：可选，控制输出格式的缩进（数字或字符串）。

2. JSON.stringify() 的用法

2.1 基本示例

将 JavaScript 对象转换为 JSON 字符串：

const obj = {
  name: "张三",
  age: 25,
  hobbies: ["读书", "旅行"]
};
const jsonString = JSON.stringify(obj);
console.log(jsonString);
// 输出：{"name":"张三","age":25,"hobbies":["读书","旅行"]}
  • 输入：JavaScript 对象。
  • 输出：紧凑的 JSON 字符串。

2.2 格式化输出

使用 space 参数添加缩进，使输出更易读：

const obj = {
  name: "李四",
  address: { city: "北京", zip: "100000" }
};
const jsonString = JSON.stringify(obj, null, 2); // 2 表示缩进 2 个空格
console.log(jsonString);
/* 输出：
{
  "name": "李四",
  "address": {
    "city": "北京",
    "zip": "100000"
  }
}
*/
  • space 参数：
  • 数字：指定缩进空格数（如 2 或 4）。
  • 字符串：用作缩进字符（如 "\t"）。

2.3 使用 replacer 参数

replacer 可以是函数或数组，用于控制序列化的值。

  • replacer 函数：对每个键值对进行处理：
  const obj = {
    name: "王五",
    age: 28,
    birth: new Date("2025-07-28")
  };
  const jsonString = JSON.stringify(obj, (key, value) => {
    if (key === "birth") {
      return value.toISOString(); // 将 Date 转为 ISO 字符串
    }
    return value;
  }, 2);
  console.log(jsonString);
  /* 输出：
  {
    "name": "王五",
    "age": 28,
    "birth": "2025-07-28T00:00:00.000Z"
  }
  */
  • replacer 数组：指定要序列化的属性：
  const obj = { name: "赵六", age: 22, email: "zhao@example.com" };
  const jsonString = JSON.stringify(obj, ["name", "age"], 2);
  console.log(jsonString);
  /* 输出：
  {
    "name": "赵六",
    "age": 22
  }
  */

3. JSON.stringify() 的特点

  • 严格符合 JSON 格式：输出的字符串符合 JSON 语法，支持字符串、数字、布尔值、null、对象和数组。
  • 不支持的类型：以下 JavaScript 类型会被特殊处理：
  • undefined、函数、Symbol：直接忽略（对象属性）或转为 null（数组元素）。
  • Date：转为 ISO 字符串（如 "2025-07-28T00:00:00.000Z"）。
  • 循环引用：抛出 TypeError。
  • 格式化支持：通过 space 参数生成易读的 JSON 字符串。
  • 性能：序列化速度快，适合小型到中型数据。

4. 在 Node.js 中使用 JSON.stringify()

在 Node.js 中，JSON.stringify() 是内置方法，常用于生成 API 响应、保存 JSON 文件或准备 MongoDB 数据。

4.1 生成 API 响应

将数据序列化为 JSON 字符串并返回：

const http = require('http');

const server = http.createServer((req, res) => {
  const data = {
    status: "success",
    user: { name: "张三", age: 25 }
  };
  res.writeHead(200, { 'Content-Type': 'application/json' });
  res.end(JSON.stringify(data));
});
server.listen(3000, () => console.log('Server running on port 3000'));
  • 说明：API 响应通常需要 JSON 字符串，JSON.stringify() 将对象转为字符串。

4.2 保存 JSON 文件

将对象序列化为 JSON 字符串并写入文件：

const fs = require('fs');

const data = {
  name: "李四",
  hobbies: ["读书", "旅行"],
  scores: [95, 88]
};
const jsonString = JSON.stringify(data, null, 2);
fs.writeFileSync('output.json', jsonString);
console.log('文件保存成功');
  • output.json 内容：
  {
    "name": "李四",
    "hobbies": [
      "读书",
      "旅行"
    ],
    "scores": [
      95,
      88
    ]
  }

5. JSON.stringify() 与 MongoDB

在 Node.js 连接 MongoDB 时，JSON.stringify() 可用于调试或将数据序列化为 JSON 格式。MongoDB 驱动直接操作 JavaScript 对象，但有时需要将查询结果转为 JSON 字符串（如日志记录或 API 返回）。

示例：查询 MongoDB 并序列化结果

const { MongoClient } = require('mongodb');
const uri = 'mongodb://localhost:27017/myDatabase';
const client = new MongoClient(uri);

async function run() {
  try {
    await client.connect();
    const db = client.db('myDatabase');
    const collection = db.collection('users');

    // 插入数据
    await collection.insertOne({
      name: "赵六",
      age: 22,
      hobbies: ["编程", "旅行"]
    });

    // 查询并序列化
    const result = await collection.findOne({ name: "赵六" });
    const jsonString = JSON.stringify(result, null, 2);
    console.log('查询结果：', jsonString);
  } catch (error) {
    console.error('操作失败：', error.message);
  } finally {
    await client.close();
  }
}
run();
  • 输出：
  {
    "_id": "someObjectId",
    "name": "赵六",
    "age": 22,
    "hobbies": [
      "编程",
      "旅行"
    ]
  }
  • 说明：MongoDB 的 _id 字段（ObjectId 类型）会被 JSON.stringify() 自动转为字符串。

6. 常见问题与注意事项

  1. 不支持的类型：
  • undefined、函数、Symbol 会被忽略或转为 null： const obj = { name: "王五", func: function() {}, undef: undefined }; console.log(JSON.stringify(obj)); // 输出：{"name":"王五"}
  • 数组中的 undefined 和函数转为 null：
    javascript const arr = [1, undefined, function() {}]; console.log(JSON.stringify(arr)); // 输出：[1,null,null]
  1. 循环引用：
  • 如果对象包含循环引用，JSON.stringify() 会抛出 TypeError。
  • 示例： const obj = {}; obj.self = obj; JSON.stringify(obj); // 抛出错误：TypeError: Converting circular structure to JSON
  • 解决方法：手动移除循环引用，或使用第三方库（如 flatted）。
  1. 性能考虑：
  • 序列化大型对象可能耗时，建议分块处理或使用流式序列化（如 JSONStream 模块）。
  • 示例：
    bash npm install jsonstream
  1. 调试技巧：
  • 使用 JSON.stringify(obj, null, 2) 格式化输出，便于检查复杂数据。
  • 在线工具（如 JSON Formatter）可验证生成的 JSON 字符串。

7. JSON.stringify() vs JSON.parse()

方法功能输入输出
JSON.stringify()将 JavaScript 值转为 JSON 字符串JavaScript 对象/数组JSON 字符串
JSON.parse()将 JSON 字符串解析为 JavaScript 值JSON 字符串JavaScript 对象/数组

示例：

const obj = { name: "张三", age: 25 };
const jsonString = JSON.stringify(obj); // 转为 JSON 字符串
const parsedObj = JSON.parse(jsonString); // 解析回对象
console.log(parsedObj.name); // 输出：张三

8. 总结

  • JSON.stringify()：将 JavaScript 值序列化为 JSON 字符串，简单高效，广泛用于 Node.js 和 MongoDB 开发。
  • 特点：支持格式化输出（space）、自定义转换（replacer），但不支持 undefined、函数等类型。
  • 使用场景：生成 API 响应、保存 JSON 文件、调试 MongoDB 数据。
  • 注意事项：处理循环引用、特殊类型时需小心，建议用 space 参数提高可读性。

如果你有具体问题（如复杂对象序列化、MongoDB 数据处理，或性能优化），请告诉我，我会提供更详细的代码或指导！

const obj = {
  name: "张三",
  age: 25,
  hobbies: ["读书", "旅行"],
  birth: new Date("2025-07-28")
};

// 基本序列化
const jsonString = JSON.stringify(obj);
console.log("基本序列化:", jsonString);

// 格式化输出
const formattedJson = JSON.stringify(obj, null, 2);
console.log("格式化输出:", formattedJson);

// 使用 replacer 函数
const jsonWithDate = JSON.stringify(obj, (key, value) => {
  if (key === "birth") {
    return value.toISOString();
  }
  return value;
}, 2);
console.log("处理日期:", jsonWithDate);

// 使用 replacer 数组
const filteredJson = JSON.stringify(obj, ["name", "age"], 2);
console.log("过滤属性:", filteredJson);

类似文章

发表回复

您的邮箱地址不会被公开。 必填项已用 * 标注