JSON 格式化工具

使用这个简单的工具格式化和美化你的 JSON

原始 JSON 输入*

格式化后的 JSON 输出

格式化后的 JSON 将出现在这里...

JSON 格式化器

介绍

JSON（JavaScript 对象表示法）是一种轻量级的数据交换格式，已成为 Web 应用程序中数据交换的标准。尽管它简单，但当 JSON 数据被压缩或缺乏适当格式时，可能会变得难以阅读。此工具帮助您将原始、未格式化的 JSON 字符串转换为结构良好、缩进格式，使其更易于阅读和分析。

JSON 格式化（也称为“美化打印”）通过添加一致的缩进、换行和空格，使 JSON 数据的层次结构在视觉上显而易见。这在处理复杂嵌套对象或大型数据集时尤其有价值，因为在这些情况下，元素之间的关系可能会变得难以辨别。

我们的 JSON 格式化工具提供了一个简单的界面，可以通过适当的缩进和结构来美化您的 JSON 数据，使其对人类更具可读性，同时保持其对机器的有效性。

JSON 语法和结构

JSON 基于两种主要结构：

对象：由大括号 {} 包围的名称/值对集合。每个名称后面跟着一个冒号 :，对之间用逗号 , 分隔。

   {"name": "John", "age": 30, "city": "New York"}

数组：由方括号 [] 包围的有序值列表。值之间用逗号 , 分隔。

   ["apple", "banana", "cherry"]

JSON 值可以是：

字符串（用双引号括起来）：“Hello World”
数字：42 或 3.14159
布尔值：true 或 false
Null：null
对象：{"key": "value"}
数组：[1, 2, 3]

有效的 JSON 必须遵循以下语法规则：

名称必须是用双引号括起来的字符串
值必须是有效的 JSON 数据类型之一
不允许有尾随逗号
不允许有注释
不允许有函数或方法

常见的语法错误包括：

缺少或不匹配的括号/大括号
属性名称缺少引号
使用单引号而不是双引号
包含尾随逗号
使用未定义的值

JSON 格式化的工作原理

JSON 格式化通过以下方式将紧凑的、压缩的 JSON 转换为更可读的形式：

解析：首先解析 JSON 字符串以确保其有效，并创建数据结构的内存表示。
缩进：每个嵌套级别的对象和数组缩进（通常为 2 或 4 个空格），以在视觉上表示层次结构。
换行：在每个属性或数组元素后添加新行以提高可读性。
空格：在冒号和逗号周围添加一致的空格。

例如，这个压缩的 JSON：

{"name":"John Doe","age":30,"address":{"street":"123 Main St","city":"Anytown","state":"CA"},"hobbies":["reading","hiking","photography"]}

变成这个格式化的 JSON：

{
  "name": "John Doe",
  "age": 30,
  "address": {
    "street": "123 Main St",
    "city": "Anytown",
    "state": "CA"
  },
  "hobbies": [
    "reading",
    "hiking",
    "photography"
  ]
}

我们的格式化工具使用每级 2 个空格的标准缩进，这是开发社区中的常见约定，并在紧凑性和可读性之间提供了良好的平衡。

JSON 验证

JSON 格式化的一个关键方面是验证。在 JSON 可以格式化之前，它必须根据 JSON 规范在语法上是有效的。常见的验证错误包括：

语法错误：
- 未加引号的属性名称
- 缺少或多余的逗号
- 结构不当嵌套
- 未关闭的字符串、对象或数组
数据类型错误：
- 使用 JavaScript 特定值，如 undefined 或 NaN
- 包含函数或方法
- 使用字符串表示法的精确数值

当您遇到无效 JSON 时，错误消息可以帮助识别问题。大多数 JSON 解析器会指示解析失败的位置，这可以帮助定位问题。我们的工具提供清晰的错误消息，以帮助您识别和修复 JSON 数据中的问题。

用例

JSON 格式化在许多场景中都很有价值：

API 开发和测试

在处理 RESTful API 时，格式化 JSON 使得：

检查响应负载更容易
调试请求主体
文档 API 示例
验证数据结构是否符合预期

配置管理

许多现代应用程序使用 JSON 作为配置：

应用程序设置文件
环境配置
构建和部署规范
基础设施即代码模板（例如 AWS CloudFormation、Terraform）

数据分析和可视化

格式化 JSON 在以下情况下有帮助：

探索数据集
为可视化准备数据
理解数据模式
识别结构化数据中的模式

调试和故障排除

适当格式化的 JSON 在以下情况下至关重要：

调试 Web 应用程序
检查 localStorage 或 sessionStorage
分析网络响应
排查数据集成问题

教育目的

清晰的 JSON 格式化对于：

教授数据结构
演示嵌套关系
解释 API 概念
阐明数据建模原则

替代方案

虽然我们的基于 Web 的 JSON 格式化工具对于快速格式化任务很方便，但在不同场景中还有几种替代方案：

浏览器开发者工具

现代浏览器包括 JSON 格式化功能：

Chrome 和 Edge DevTools 会在网络选项卡中自动格式化 JSON 响应
Firefox 的 JSON 查看器提供交互式树视图
浏览器扩展程序如 JSONView 可以直接在浏览器中格式化 JSON

代码编辑器和 IDE

大多数开发环境提供 JSON 格式化：

Visual Studio Code 具有内置的 JSON 格式化（Alt+Shift+F）
JetBrains IDE（WebStorm、IntelliJ）包含强大的 JSON 工具
Sublime Text 和 Atom 通过插件支持 JSON 格式化

命令行工具

对于终端用户或自动化：

jq 是一个强大且灵活的命令行 JSON 处理器
json_pp 在许多 Unix 系统上预装
python -m json.tool 使用 Python 提供快速格式化

编程方法

在应用程序中格式化 JSON：

// JavaScript
const formatted = JSON.stringify(jsonObject, null, 2);

# Python
import json
formatted = json.dumps(json_object, indent=2)

// Java with Gson
Gson gson = new GsonBuilder().setPrettyPrinting().create();
String formatted = gson.toJson(jsonObject);

# Ruby
require 'json'
formatted = JSON.pretty_generate(json_object)

// PHP
$formatted = json_encode($jsonObject, JSON_PRETTY_PRINT);

历史

JSON 是由道格拉斯·克罗克福德在 2000 年代初创建的，作为 XML 的轻量级替代方案。该格式源自 JavaScript 对象字面量语法，但旨在独立于语言。2006 年，JSON 在 RFC 4627 中正式规范，并迅速因其简单性和与 JavaScript 的兼容性而获得广泛应用。

在 JSON 出现之前，XML 是数据交换的主导格式，但其冗长和复杂性使其在许多应用中变得笨重。JSON 提供了一种更简洁的语法，更易于人类和机器阅读和编写。它还完美契合 JavaScript 的对象模型，使其成为 Web 应用程序的自然选择。

随着 AJAX 和 RESTful API 在 2000 年代中期的兴起，JSON 的采用加速了。到 2010 年代，它已成为 Web API、配置文件和 NoSQL 数据库（如 MongoDB 和 CouchDB）中数据交换的事实标准。

如今，几乎所有编程语言都支持 JSON，并在无数 Web 应用中使用。它的简单性、灵活性和通用支持使其成为现代计算中最重要的数据格式之一。

代码示例

以下是如何在各种编程语言中格式化 JSON 的示例：

// JavaScript JSON 格式化
function formatJSON(jsonString) {
  try {
    const parsedData = JSON.parse(jsonString);
    return JSON.stringify(parsedData, null, 2);
  } catch (error) {
    return `错误：${error.message}`;
  }
}

// 示例用法
const rawJSON = '{"name":"John","age":30,"city":"New York"}';
console.log(formatJSON(rawJSON));

# Python JSON 格式化
import json

def format_json(json_string):
    try:
        parsed_data = json.loads(json_string)
        return json.dumps(parsed_data, indent=2)
    except json.JSONDecodeError as e:
        return f"错误：{str(e)}"

# 示例用法
raw_json = '{"name":"John","age":30,"city":"New York"}'
print(format_json(raw_json))

// Java JSON 格式化使用 Gson
import com.google.gson.Gson;
import com.google.gson.GsonBuilder;
import com.google.gson.JsonSyntaxException;

public class JSONFormatter {
    public static String formatJSON(String jsonString) {
        try {
            Gson gson = new GsonBuilder().setPrettyPrinting().create();
            Object parsedJson = gson.fromJson(jsonString, Object.class);
            return gson.toJson(parsedJson);
        } catch (JsonSyntaxException e) {
            return "错误：" + e.getMessage();
        }
    }
    
    public static void main(String[] args) {
        String rawJSON = "{\"name\":\"John\",\"age\":30,\"city\":\"New York\"}";
        System.out.println(formatJSON(rawJSON));
    }
}

// PHP JSON 格式化
function formatJSON($jsonString) {
    $result = json_decode($jsonString);
    if (json_last_error() !== JSON_ERROR_NONE) {
        return "错误：" . json_last_error_msg();
    }
    return json_encode($result, JSON_PRETTY_PRINT);
}

// 示例用法
$rawJSON = '{"name":"John","age":30,"city":"New York"}';
echo formatJSON($rawJSON);

# Ruby JSON 格式化
require 'json'

def format_json(json_string)
  begin
    parsed_data = JSON.parse(json_string)
    return JSON.pretty_generate(parsed_data)
  rescue JSON::ParserError => e
    return "错误：#{e.message}"
  end
end

# 示例用法
raw_json = '{"name":"John","age":30,"city":"New York"}'
puts format_json(raw_json)

// C# JSON 格式化使用 Newtonsoft.Json
using Newtonsoft.Json;
using System;

class JSONFormatter
{
    public static string FormatJSON(string jsonString)
    {
        try
        {
            object parsedJson = JsonConvert.DeserializeObject(jsonString);
            return JsonConvert.SerializeObject(parsedJson, Formatting.Indented);
        }
        catch (JsonException e)
        {
            return $"错误：{e.Message}";
        }
    }
    
    static void Main()
    {
        string rawJSON = "{\"name\":\"John\",\"age\":30,\"city\":\"New York\"}";
        Console.WriteLine(FormatJSON(rawJSON));
    }
}

// Go JSON 格式化
package main

import (
    "encoding/json"
    "fmt"
)

func formatJSON(jsonString string) string {
    var parsedData interface{}
    err := json.Unmarshal([]byte(jsonString), &parsedData)
    if err != nil {
        return fmt.Sprintf("错误：%s", err.Error())
    }
    
    formattedBytes, err := json.MarshalIndent(parsedData, "", "  ")
    if err != nil {
        return fmt.Sprintf("错误：%s", err.Error())
    }
    
    return string(formattedBytes)
}

func main() {
    rawJSON := `{"name":"John","age":30,"city":"New York"}`
    fmt.Println(formatJSON(rawJSON))
}

边缘案例和注意事项

在处理 JSON 格式化时，请注意以下潜在挑战：

大型 JSON 文件

非常大的 JSON 文件（几兆字节或更多）可能会在基于浏览器的格式化器中造成性能问题。在这种情况下：

考虑使用命令行工具如 jq
将 JSON 拆分为较小的块
使用流式解析器进行处理，而不将整个文件加载到内存中

深度嵌套结构

极其嵌套的 JSON（超过 10-20 层）即使在格式化后也可能变得难以导航。在这些情况下：

考虑在可能的情况下扁平化结构
使用可折叠的 JSON 查看器
提取并处理 JSON 的特定部分

特殊字符和 Unicode

JSON 支持 Unicode，但某些格式化器可能对某些字符存在问题：

确保您的格式化器正确处理表情符号和其他 Unicode 字符
对控制字符和转义序列保持谨慎
验证格式化输出是否保留所有原始字符

数字精度

JSON 并未指定数字的精度，这可能导致非常大的整数或浮点值出现问题：

请注意某些 JavaScript 实现可能会在超过 53 位的整数上丢失精度
考虑使用字符串表示法来确保数值的精确性
如果应用程序需要高精度，请测试极端值

空对象和数组

有效的 JSON 包括空对象 {} 和数组 []，应正确格式化：

空对象应显示为 {}
空数组应显示为 []
嵌套的空结构应保持适当的缩进

参考文献

JSON.org - 官方 JSON 规范网站
RFC 8259 - JSON 数据交换格式
MDN Web 文档：JSON - 关于 JavaScript 中 JSON 的全面文档
JSON Lint - 一个流行的在线 JSON 验证器
jq - 一个轻量级且灵活的命令行 JSON 处理器