【项目实战】格式化JSON数据

数据介绍

大家都知道，JSON（JavaScript Object Notation）是一种轻量级的数据交换格式，它基于JavaScript 编程语言的一个子集。尽管它起源于 JavaScript，但 JSON 已经成为了一个完全独立于语言的文本格式，被广泛采用和应用于多种编程语境中。

JSON由道格拉斯·克罗克福特在1999年设计并提出。它是一个简化版的数据传输格式，其设计初衷是为了使得不同的网络应用程序可以轻易地交换数据。随着时间的推移，JSON逐渐演变成了一种主流的数据格式，并被许多现代编程语言所支持。

JSON的语法建立在两种结构之上：键值对的集合（类似于 Python 中的字典或 Objective C 中的对象）以及有序值列表（类似于数组）。JSON 数据可以是一个简单的值、一个数组、一个对象或者一个对象和数组的组合。下面是这些数据结构的详细描述：

简单值: JSON中的简单值指的是字符串、数字、布尔值（true或false）和null。
数组 : 数组是值的有序集合，以方括号[]包围并以逗号,分隔。例如：[1, "apple", true]。
对象 : 对象是键值对的无序集合，以花括号{}包围并以逗号,分隔。键和值之间使用冒号:分隔，并且键必须是字符串。例如：{"name": "John", "age": 30}。

JSON数据格式具有以下特点：

可读性强: JSON数据以人类可读的纯文本格式组织，这使得它即使在不借助任何工具的情况下也易于理解和编辑。
易于解析生成: 几乎所有现代编程语言都提供了处理JSON数据的库或内置功能，使得从代码中生成JSON数据或解析JSON数据变得非常便捷。
跨语言兼容: 作为一种通用的数据格式，JSON没有绑定到特定的编程语言，这意味着在不同编程环境之间交换数据时，JSON是一个很好的选择。
数据描述能力强: JSON能够描述复杂的数据结构，包括嵌套的对象和数组，这使其成为表示层次化数据的理想选择。

JSON 与 XML 和 YAML 数据格式比较：

XML（Extensible Markup Language）是Web上数据交换的主要格式。然而，JSON 比 XML 更简洁，因为它不需要结束标签，数据更加紧凑。此外，JSON 直接映射到编程语言中的数据结构，如字典或哈希表，而XML则需要解析为这些数据结构。
YAML（Yet Another Markup Language）是另一种用于数据序列化的格式，它注重于人类的可读性和可写性。虽然YAML在某些情况下更易读写，但它的语法更复杂，有时可能会导致解析错误。相比之下，JSON的语法简单且不容易引起错误。

JSON（JavaScript Object Notation）是一种常用的数据交换格式，它以简洁、易读的方式存储和传输数据。在处理 JSON 数据时，数据格式化是一个重要的步骤，可以提高数据的可读性和可维护性。本文将介绍 JSON 数据格式化的方法，并提供两个在线工具网址，帮助您在处理 JSON 数据时进行格式化。

JSON 数据广泛应用于 Web 开发、移动应用开发、数据存储等领域。以下是一个示例 JSON 数据：

|---|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| 1 | {``"name"``: ``"John Doe"``,``"age"``: ``30``,``"email"``: ``"[email protected]"``,``"hobbies"``: [``"reading"``,``"gaming"``,``"traveling"``],``"address"``: {``"street"``: ``"123 Main Street"``,``"city"``:``"New York"``,``"state"``: ``"NY"``}} |

目标，格式化 JSON 如下：

|-------------------------------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| 1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 | { ``"name"``: ``"John Doe"``, ``"age"``: ``30``, ``"email"``: ``"[email protected]"``, ``"hobbies"``: [ ``"reading"``, ``"gaming"``, ``"traveling" ``], ``"address"``{ ``"street"``: ``"123 Main Street"``, ``"city"``: ``"New York"``, ``"state"``: ``"NY" ``} } |

那么，它可能会很难阅读和理解。这就是我们需要格式化 JSON 数据的原因。

各IDE脚本格式化

许多集成开发环境（IDE）如 Visual Studio Code，PyCharm 等都有内置的 JSON 格式化功能。你只需要将你的 JSON 数据粘贴到编辑器中，然后使用相关的格式化命令或快捷键即可。下面是一些常见的 IDE 和脚本语言的 JSON 格式化方法：

Visual Studio Code（VS Code）是一款流行的免费代码编辑器，支持多种编程语言并且通过插件系统提供丰富的功能扩展。对于 JSON 数据，VS Code 内置了直观的格式化工具。要使用这个工具，只需打开一个 JSON 文件，然后按下 Ctrl+Shift+I（Windows/Linux）或 Cmd+Shift+I（Mac）快捷键。编辑器会自动按照标准的缩进规则重新格式化整个文档，使数据结构一目了然。
对于 Java 开发者来说，IntelliJ IDEA 无疑是一款强大的 IDE。除了对 Java 的出色支持外，它也提供了处理 JSON 数据的功能。你可以打开一个 JSON 文件，然后使用 Code > Reformat Code 菜单项或者快捷键 Ctrl+Alt+L（Windows/Linux）/ Cmd+Alt+L（Mac）来快速格式化。IntelliJ IDEA 还会在编辑时提供实时的 JSON 验证和提示，帮助避免语法错误。
Sublime Text 是另一款广受欢迎的文本编辑器，以其速度和灵活性著称。虽然 Sublime Text 本身并不直接支持 JSON 格式化，但你可以通过安装插件来实现这一功能。例如，安装 Package Control 之后，你可以添加 JSONFormat 插件。通过 Edit > Line > Reindent 菜单项或者快捷键 Ctrl+Shift+R（Windows/Linux）/ Cmd+Shift+R（Mac），你可以很方便地对选定的 JSON 代码进行格式化。
PyCharm IDE 为开发者提供了一组快捷键来优化和加速开发流程，其中就包括用于代码格式化的快捷键。对于 JSON 数据，可以通过按下组合键 Ctrl+Alt+L 或者 Command+Option+L 来实现格式化。这种方法简单快捷，无需任何额外的配置或插件安装，是 PyCharm 内置功能的一部分。需要注意的是有时自定义的快捷键可能与 PyCharm 默认或其他插件的快捷键冲突。在这种情况下，需要调整快捷键设置，以避免操作上的混淆。

Python：使用 Python 的 json 模块可以轻松地格式化 JSON 数据。可以使用 json.dumps(data, indent=4) 方法将 JSON 对象转换为格式化后的字符串。

|-------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| 1 2 3 4 5 6 | import json data ``= {``"name"``: ``"John Doe"``,``"age"``: ``30``,``"email"``: ``"[email protected]"``,``"hobbies"``: [``"reading"``,``"gaming"``,``"traveling"``],``"address"``: {``"street"``: ``"123 Main Street"``,``"city"``:``"New York"``,``"state"``: ``"NY"``}} formatted_data ``= json.dumps(data, indent``=``4``) print``(formatted_data) |

JavaScript：在 JavaScript 中，可以使用 JSON.stringify(data, null, 2) 方法将 JSON 对象转换为格式化后的字符串，并指定缩进级别为 2。

|---------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| 1 2 3 4 | const data = {``"name"``: ``"John Doe"``,``"age"``: 30,``"email"``: ``"[email protected]"``,``"hobbies"``: [``"reading"``,``"gaming"``,``"traveling"``],``"address"``: {``"street"``: ``"123 Main Street"``,``"city"``:``"New York"``,``"state"``: ``"NY"``}}; const formattedData = JSON.stringify(data, ``null``, 2); console.log(formattedData); |

Node.js：在Node.js环境下工作，可以利用其强大的文件系统模块（fs）来读取和写入JSON数据，同时结合JSON.stringify来实现数据的格式化。以下是一个示例代码：

|----------------------------------------------------------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| 1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 | const fs = require(``'fs'``); // 读取原始 JSON 数据 fs.readFile(``'data.json'``, ``'utf8'``, (err, data) => { ``if (err) { ``console.error(err); ``return``; ``} ``// 解析并格式化 JSON 数据 ``let jsonData; ``try { ``jsonData = JSON.parse(data); ``} ``catch (error) { ``console.error(``"Error parsing JSON:"``, error); ``return``; ``} ``// 格式化 JSON 数据并写回文件 ``const formattedData = JSON.stringify(jsonData, ``null``, 4); ``fs.writeFile(``'formatted.json'``, formattedData, ``'utf8'``, err => { ``if (err) console.error(err); ``}); }); |

解释：首先使用fs.readFile异步地读取一个名为data.json的文件。读取完成后，我们尝试使用JSON.parse将文件内容解析为一个JavaScript对象。然后我们使用JSON.stringify将这个对象格式化为一个美观的JSON字符串，并指定缩进为4个空格。最后，我们使用fs.writeFile将格式化后的字符串写回到一个新的文件formatted.json中。

IDE 或者脚本格式化 JSON，虽然能实现效果，但是没有直接点击来的快，接下来介绍两个好用的在线工具网址。

在线工具网址

如果您不想安装 IDE 或编写脚本来格式化 JSON 数据，可以使用在线工具进行 JSON 数据格式化。以下是两个提供 JSON 数据格式化功能的在线工具网址：

SO JSON 在线工具（https://www.sojson.com）：SO JSON 在线工具是另一个提供 JSON 数据格式化功能的网站。它支持 JSON 数据的解析、格式化、压缩、转义、视图和编辑等功能。

JSONS 在线工具（http://www.jsons.cn）：JSONS 是一个提供多种 JSON 相关工具的网站，其中包括 JSON 数据的在线解析、格式化、校验、压缩和转义等功能。

这个在线工具不仅可以格式化 JSON ，也可以格式化其他数据，如 HTML、SQL等，最好的功能是可以进行文本比较，在代码进行迁移对比差异时经常用到。示例如下，不一致的部分会直接标红色。

你只需要在这些网站上输入或粘贴你的 JSON 数据，它们就会自动为你格式化。