轻松修复和验证 JSON：深入指南

了解 JSON 结构

JSON（JavaScript 对象表示法）是一种轻量级数据交换格式，易于人类阅读和编写，也易于机器解析和生成。它由两个基本结构组成：

1. 对象：用大括号 {} 括起来的键/值对的集合。

   • 示例：{ "name": "John", "age": 30 }

2. 数组：用方括号 [] 括起来的有序值集合。

   • 示例：[“苹果”、“香蕉”、“樱桃”]

常见 JSON 错误

在开始修复和验证 JSON 之前，让我们首先了解 JSON 可能遇到的常见问题：

1. 缺少或多余的逗号：数组或对象末尾的尾随逗号或缺少逗号可能会导致无效的 JSON。

   • 无效的 JSON: { "name": "John", "age": 30, }
   • 正确的 JSON: { "name": "John", "age": 30 }

2. 不带引号的键：JSON 键必须始终用双引号 (") 括起来。

   • 无效的 JSON: { name: "John" }
   • 正确的 JSON: { "name": "John" }

3. 不正确的数据类型：确保正确使用数据类型。例如，字符串应该加引号，数字应该不加引号。

   • 无效的 JSON: { "age": "30" } （年龄被引用，但它应该是一个数字）
   • 正确的 JSON: { "age": 30 }

4. 括号不匹配：始终确保大括号 {} 和方括号 [] 正确匹配。

   • 无效的 JSON: { "name": "John", "age": 30
   • 正确的 JSON: { "name": "John", "age": 30 }

5. 无效字符：JSON 字符串只能包含某些字符。例如，反斜杠 () 必须在字符串中转义。

   • 无效的 JSON: { "quote": "这是一个反斜杠 \" }
   • 正确的 JSON: { "quote": "这是一个反斜杠 \\" }

如何修复 JSON

要修复无效的 JSON，您可以按照以下步骤操作：

1. 手动修复 JSON

如果您有一小段无效的 JSON，最简单的方法可能是手动修复它。这是一个简单的方法：

• 第 1 步：识别并纠正语法错误（例如缺少逗号、括号或引号）。
• 第 2 步：确保所有键都用双引号括起来，并且值的类型正确（字符串、数字、布尔值、数组、对象、null）。
• 第 3 步：使用 JSON 验证器（更多内容见下文）来确认您的 JSON 结构正确。

2. 使用在线工具修复 JSON

有几个在线工具可以帮助您自动修复或格式化 JSON：

• JSONLint (https://onlinejsonformatter.com) – 它检查 JSON 的语法并突出显示错误。它还可以将杂乱的 JSON 格式化为可读的结构。
• JSON 格式化程序和验证器 (https://jsonformatter.curiousconcept.com/) – 该工具帮助格式化 JSON 并提供错误描述。
• JSON Prettifier – 它可以帮助清理并使 JSON 更具可读性。

这些工具通常会突出显示语法问题并提供错误消息，可以引导您准确找到问题所在，从而更容易修复。

3. 使用支持 JSON 的代码编辑器

许多代码编辑器（例如 Visual Studio Code、Sublime Text 或 Atom）提供特定于 JSON 的功能，例如：

• 语法突出显示：颜色和格式可帮助您直观地看到不匹配的括号或引号。
• Linting：ESLint 或 TSLint 等工具可以帮助标记 JSON 文件中的问题。
• 自动格式化：VSCode 等编辑器具有内置格式化程序，可以自动修复 JSON 缩进并删除无关的空格。

VS Code 中的示例：

1. 打开您的 JSON 文件。
2. 单击 Shift Alt F 自动格式化并修复常见的间距问题。
3. 使用像 Prettier 这样的扩展来进一步格式化 JSON。

4. 使用编程语言修复 JSON

如果您有大型数据集，使用编程语言（例如 Python、JavaScript 或 Go）可能会更有效。例如，在 Python 中，您可以使用 json 模块来验证和修复 JSON：

import json

# Read the JSON string from a file or input
input_json = '{"name": "John", "age": 30,}'

# Try to load and fix the JSON
try:
    parsed_json = json.loads(input_json)  # This will raise an error if the JSON is invalid
except json.JSONDecodeError as e:
    print(f"Invalid JSON: {e}")

# Correcting it manually or programmatically and revalidating

在 JavaScript 中，您可以使用 JSON.parse() 检查 JSON 是否有效，然后修改它：

const inputJson = '{"name": "John", "age": 30,}';

try {
    const parsedJson = JSON.parse(inputJson); // Throws error if invalid
    console.log('Valid JSON:', parsedJson);
} catch (error) {
    console.log('Invalid JSON:', error.message);
}

验证 JSON

JSON 验证涉及检查 JSON 字符串的结构和格式是否正确。这可以通过多种方式完成：

1. 使用 JSON 验证器

网上有几个免费的 JSON 验证工具：

• JSONLint：将 JSON 粘贴到框中，然后单击“验证 JSON”。它将显示您的 JSON 是否有效或突出显示无效的地方。
• JSON Formatter & Validator：该工具不仅可以验证，还可以以可读的方式格式化 JSON。

2. 使用编程语言进行验证

大多数编程语言都有用于验证 JSON 的内置函数或库：

• Python：

import json

# Read the JSON string from a file or input
input_json = '{"name": "John", "age": 30,}'

# Try to load and fix the JSON
try:
    parsed_json = json.loads(input_json)  # This will raise an error if the JSON is invalid
except json.JSONDecodeError as e:
    print(f"Invalid JSON: {e}")

# Correcting it manually or programmatically and revalidating

• JavaScript：

const inputJson = '{"name": "John", "age": 30,}';

try {
    const parsedJson = JSON.parse(inputJson); // Throws error if invalid
    console.log('Valid JSON:', parsedJson);
} catch (error) {
    console.log('Invalid JSON:', error.message);
}

• 去：

  import json

  try:
      json_object = json.loads('{"name": "John", "age": 30}')
      print("Valid JSON")
  except ValueError as e:
      print("Invalid JSON", e)

3. 使用 JSON 模式验证

对于更复杂的 JSON 结构，您可以根据预定义的 JSON 架构 验证 JSON。 JSON 架构是定义 JSON 文档的结构、所需属性和数据类型的蓝图。

• JSON 架构 就像一个合约，定义了有效的 JSON 应该是什么样子。
• JavaScript 或 Python jsonschema 库中的 AJV（另一个 JSON 架构验证器）等工具可以帮助您根据架构验证 JSON 数据。

示例 JSON 架构:

  try {
      JSON.parse('{"name": "John", "age": 30}');
      console.log("Valid JSON");
  } catch (e) {
      console.log("Invalid JSON");
  }

使用 Schema 在 Python 中验证 JSON:

  import (
      "encoding/json"
      "fmt"
  )

  func main() {
      var jsonData = `{"name": "John", "age": 30}`
      var obj map[string]interface{}

      err := json.Unmarshal([]byte(jsonData), &obj)
      if err != nil {
          fmt.Println("Invalid JSON:", err)
      } else {
          fmt.Println("Valid JSON")
      }
  }

自动 JSON 验证

对于持续集成、自动化测试或生产环境，您可能希望使用构建工具或 CI 管道（如 GitHub Actions、Jenkins 等）自动进行 JSON 验证。

• 您可以使用 JSONLint、prettier 等工具，或使用编程语言编写自定义验证脚本并将其集成到您的工作流程中。

结论

修复和验证 JSON 对于开发人员来说是一项关键技能，尤其是在使用 API、配置文件或系统之间的数据交换时。无论您使用小型 JSON 对象还是大型数据集，了解常见陷阱、使用在线工具、编程语言或 JSON 架构验证都可以显着提高 JSON 数据的可靠性和正确性。

通过使用正确的工具，例如在线验证器、具有内置功能的代码编辑器，甚至使用脚本自动化该过程，您可以确保您的 JSON 格式化程序 既有效又易于使用.

以上是轻松修复和验证 JSON：深入指南的详细内容。更多信息请关注PHP中文网其他相关文章！