使用教程

JSON 格式化完全指南:从入门到避坑

工具箱团队 · · 阅读 12,007

JSON 是前后端交互的通用语言,但生产环境中的 JSON 往往经过压缩,挤在一行里难以阅读。无论是调试接口、排查数据问题,还是阅读配置文件,格式化都是每个开发者每天都会用到的基础操作。本文从原理讲起,带你彻底掌握 JSON 格式化的方方面面。

什么是 JSON 格式化

JSON(JavaScript Object Notation)是一种轻量级的数据交换格式,易于人阅读和编写,也易于机器解析和生成。格式化(Pretty Print)指的是在完全不改变数据内容的前提下,通过缩进、换行与对齐,让层级结构一目了然。

一段未经格式化的 JSON 可能是这样的:所有字段挤在一行,嵌套稍深就完全无法阅读。而格式化之后,每个字段独占一行,缩进清晰地表达了层级关系。

{
  "code": 200,
  "message": "success"
}

为什么需要格式化

接口返回的 JSON 通常经过压缩以节省带宽,日志系统中的 JSON 也常常是一行一条。当数据结构复杂、字段众多时,直接阅读几乎是不可能的。

常见语法错误与避坑

三类错误最为常见:对象或数组末尾多余的逗号、误用单引号代替双引号、括号未正确闭合。好的格式化工具会在校验时直接指出错误所在的行号与原因。