JSON 格式化教程

JSON 语法规则与最佳实践

什么是 JSON

JSON (JavaScript Object Notation) 是一种轻量级的数据交换格式,易于人类阅读和编写,也易于机器解析和生成。它基于 JavaScript 对象字面量的一个子集,但独立于语言,许多编程语言都支持 JSON 数据的处理。

基本语法规则

{
    "键": "值",
    "数字": 123,
    "布尔值": true,
    "数组": [1, 2, 3],
    "对象": { "嵌套键": "嵌套值" },
    "空值": null
}
  • 数据以键值对形式存在:键必须是字符串,用双引号包裹
  • 字符串必须用双引号:JSON 中只能使用双引号,不能使用单引号
  • 对象用大括号表示:{ "name": "张三", "age": 25 }
  • 数组用方括号表示:[1, 2, 3] 或 ["苹果", "香蕉", "橙子"]
  • 最后一项不能有逗号:数组和对象的最后一个元素后面不能加逗号
  • 数值不能有前导零:如 0.5 合法,但 05 不合法
  • 不能使用 undefined:JSON 值只能是 JSON 规范支持的数据类型

JSON 数据类型

类型 示例 说明
String "Hello" 字符串必须用双引号
Number 42, 3.14 数字不能有前导零
Boolean true, false 布尔值是小写
Array [1, 2, 3] 有序列表,可嵌套
Object {"key": "value"} 键值对集合
null null 空值是小写 null

最佳实践

  • 使用缩进提高可读性:格式化后的 JSON 更容易阅读和维护
  • 键命名保持一致:建议使用 camelCase 或 snake_case 统一风格
  • 合理嵌套深度:避免过深的嵌套,必要时考虑拆分数据结构
  • 数据类型要正确:字符串用字符串,数字用数字,不要用字符串表示数字
  • 处理大数字精度:JavaScript 中大数字可能丢失精度,需要注意
  • 注意特殊字符转义:字符串中的特殊字符需要正确转义,如 "C:\\Windows"

常见错误

错误 [1, 2, 3,] 最后一项多了逗号
错误 {'name': '张三'} 使用了单引号
错误 {name: "张三"} 键没有用双引号
错误 { "value": undefined } 使用了 undefined

使用工具

使用 format.cool 的 JSON 格式化工具,你可以:

  • 格式化:将压缩的 JSON 美化缩进
  • 压缩:去除缩进和换行,减小数据体积
  • 校验:检查 JSON 语法是否正确
  • 语法高亮:不同类型数据用不同颜色显示