Developer Tools

掌握 JSON 格式化与验证

为什么完美格式化的 JSON 至关重要,哪怕只是最后一个逗号,以及如何发现常见的结构性错误。

5分钟阅读

Code editor showing JSON

Javascript Object Notation(JSON) 是现代 API 和数据传输领域无可争议的王者。然而,正因为它极为严格,一个多余的逗号就可能导致整个生产端点崩溃。

在本指南中,我们将介绍 JSON 格式化的黄金法则。

JSON 的语法规则

与普通的 Javascript 对象不同,JSON 以严苛著称,毫无容错空间。一旦违反这些规则,解析器就会抛出 SyntaxError

  1. 键名必须用双引号括起来'name': 'John' 是无效的,必须写成 "name": "John"
  2. 不允许尾随逗号:数组或对象的最后一项后面不能留有逗号。
  3. 不支持函数或 undefined:JSON 只能存储字符串、数字、布尔值、数组、对象和 null

有效与无效的 JSON

让我们来看看严格的 JSON 解析器对我们有哪些要求。

{
  "user": {
    "id": 1042,
    "isActive": true,
    "roles": ["admin", "editor"],
    "preferences": null
  }
}

如果我们像在 JS 脚本中那样随意地书写同一个对象:

// This is INVALID JSON (but valid Javascript)
{
  user: {
    id: 1042,
    isActive: true, // trailing comma
  }
}

为什么验证如此重要

在连接微服务时,传递无效的 JSON 意味着接收方服务器会因 JSON.parse() 灾难性地失败而抛出严重的 500 错误。在将 JSON 添加到应用程序之前,请务必对其进行检查和格式化。

使用自动格式化工具来验证您的 API 载荷是否安全且结构合理!

准备好测试您的数据了吗?立即前往我们的 JSON Formatter & Validator,即刻美化您的原始字符串!