JSON 是什么?常见错误及修复方法

一份通俗易懂的 JSON 指南:它的结构、最容易出错的语法规则,以及快速定位并修复错误的方法。

开发 阅读约 6 分钟

只要用过 API、配置文件或数据导出,你一定见过 JSON。它看起来很简单,但一个放错位置的逗号就足以让整个文件失效,并弹出难以理解的报错信息。

本文将带你了解 JSON 是什么、支持哪些值类型、必须记住的语法规则,通过前后对比示例看懂最常见的错误,并学会在几秒钟内校验、格式化和压缩数据。

立即校验并格式化你的 JSON 粘贴 JSON 即可查找错误、格式化或压缩。一切在浏览器中完成,不会上传任何内容。 打开 JSON 格式化工具

JSON 是什么?

JSON(JavaScript Object Notation)是一种轻量级的文本格式,用来存储和交换数据。数据以“键和值”成对的方式组织,例如 {"name": "Ana", "age": 30}。它既方便人阅读,也方便程序解析。

虽然 JSON 起源于 JavaScript,但它与编程语言无关。它是 Web API 在服务器和应用之间传输数据的标准方式,也广泛用于配置文件、日志和数据导出。

六种值类型

JSON 中的每个值都属于以下六种类型之一:

  • 字符串(string):双引号包裹的文本,例如 "你好"。
  • 数字(number):整数或小数,例如 42 或 3.14,不加引号。
  • 布尔值(boolean):true 或 false,小写且不加引号。
  • 空值(null):单词 null,表示“没有值”。
  • 数组(array):方括号内的有序列表,例如 [1, 2, 3]。
  • 对象(object):花括号内的键值对集合,例如 {"city": "Beijing"}。键必须是字符串。

数组和对象中可以再包含数组和对象,因此可以描述任意层级的数据。

必须记住的语法规则

JSON 比 JavaScript 严格得多,大多数错误都源于违反下面这些规则:

  • 字符串和键必须使用双引号,不允许单引号。
  • 不能有多余的末尾逗号:数组或对象的最后一项后面不能跟逗号。
  • 不能有注释:// 和 /* */ 都无效。
  • 只有六种值类型:undefined、NaN、Infinity 和函数都不合法。
  • 键值对之间用逗号分隔,键和值之间用冒号分隔。
  • 每个左括号都必须有对应的右括号。

最常见的错误及修复方法

以下五种错误造成了绝大多数“JSON 无效”的报错:

  • 末尾多余逗号。错误:{"a": 1, "b": 2,}。正确:{"a": 1, "b": 2}。删除最后一项后面的逗号。
  • 使用单引号。错误:{'name': 'Ana'}。正确:{"name": "Ana"}。把所有单引号换成双引号。
  • 键没有加引号。错误:{name: "Ana"}。正确:{"name": "Ana"}。每个键都要用双引号包起来。
  • 缺少括号。错误:{"items": [1, 2, 3}。正确:{"items": [1, 2, 3]}。打开的每个数组和对象都要关闭。
  • 引号转义错误。错误:{"text": "他说 "hi""}。正确:{"text": "他说 \"hi\""}。字符串内部的双引号必须用反斜杠转义,反斜杠本身也一样,要写成 \\。

还要留意从文字处理软件粘贴来的“弯引号”:它们看起来像引号,但在 JSON 中是无效的。

如何看懂 JSON 报错信息

大多数解析器会告诉你它在哪里“迷路”了,例如 "Unexpected token } in JSON at position 25" 或 "Expected double-quoted property name at line 3 column 5"。position 表示从开头数起的字符位置,而行和列则指出确切位置。

真正的错误往往出现在报告位置的稍前面。出现意外的右花括号,通常说明它前面多了一个逗号;出现意外的数据结束,通常说明少了右括号。请检查报错的那一行以及它的上一行。

如何校验、格式化和压缩 JSON

  1. 打开免费的 JSON 格式化工具。它完全在浏览器中运行,你的数据不会离开你的设备。
  2. 粘贴你的 JSON。如果无效,工具会显示出错的行和列,方便你修改。
  3. 使用格式化(美化)添加缩进,让内容更易读;或使用压缩去掉空格,在发送前减小体积。
  4. 复制结果。如果你修改了文件,想确切看到哪里不同,可以用文本对比工具比较两个版本。

JSON、XML 与 YAML 的区别

XML 更冗长,有开始和结束标签,但支持属性,在老系统中仍然常见。YAML 对人更友好并支持注释,因此常用于配置文件,不过缩进规则容易写错。

JSON 介于两者之间:简洁、无歧义,几乎所有语言都支持,因此是 API 的默认选择。它的主要缺点是不支持注释。

实用小技巧

  • 发送 JSON 或把它保存到配置文件之前,一定先校验。
  • 使用支持 JSON 语法高亮的编辑器,引号或括号不匹配会立刻显示出来。
  • 能用代码生成 JSON 时就不要手写,库会正确转义字符。
  • 如果 URL 参数中包含 JSON,先用 URL 编码工具编码,避免特殊字符破坏请求。
  • 不要把密码或令牌粘贴到会上传数据的在线工具中,优先选择在本地运行的工具。

总结

掌握规则后,JSON 其实很简单:六种值类型、双引号、没有末尾逗号、没有注释。出错时,先看报错的行和列,检查它前面的位置,再让校验工具完成繁重的工作。花几秒钟使用格式化工具,就能节省大量调试时间。

常见问题

JSON 用来做什么?

它用于在应用之间交换数据,尤其是 Web API,也用于在文件中保存设置和结构化数据。几乎所有编程语言都能读写 JSON。

JSON 可以写注释吗?

不可以。标准 JSON 不允许注释。如果需要备注,可以添加一个普通字段(例如 "comment"),或者在配置文件中改用 YAML 之类的格式。

为什么我的 JSON 提示 unexpected token?

解析器遇到了不该出现的字符,通常是末尾多余的逗号、单引号、没加引号的键或缺失的括号。请检查报错的位置以及它上一行。

格式化和压缩 JSON 有什么区别?

格式化会添加换行和缩进,方便阅读;压缩则删除所有不必要的空格,让文件更小。数据本身完全相同。

使用在线 JSON 格式化工具安全吗?

如果工具在浏览器中运行且不会把内容发送到服务器,就是安全的。我们的 JSON 格式化工具完全在你的设备本地处理数据。

本文提到的免费工具

继续阅读

全部文章