json怎么校验完整

JSON怎么校验完整：从基础语法到深度结构验证的全面指南

JSON（JavaScript Object Notation）作为一种轻量级的数据交换格式，因其简洁性和易读性被广泛应用于前后端数据交互、配置文件存储等场景，JSON数据的“完整”性并非显而易见，一个看似合法的JSON字符串，可能在数据结构、业务逻辑或类型层面存在缺陷，导致后续处理出错，对JSON进行“完整”校验至关重要，本文将系统阐述如何从不同维度校验JSON的完整性，确保数据的质量和可靠性。

JSON完整性校验的维度

要全面校验JSON的完整性,我们需要从以下几个层面入手：

1. 语法合法性校验：这是最基本的校验，确保JSON字符串符合JSON规范的标准语法。
2. 结构完整性校验：在语法合法的基础上，校验JSON数据的结构是否符合预期的模式（Schema），例如必填字段是否存在、字段的数据类型是否正确、数组长度是否在允许范围内等。
3. 业务逻辑完整性校验：更进一步的校验，确保数据在业务逻辑上是合理的，例如日期是否在有效范围内、数值是否符合业务规则、关联数据是否存在等。

语法合法性校验——JSON完整性的基石

语法合法性是JSON完整性的前提,如果JSON字符串本身不符合语法规范，那么后续的结构和业务校验都无从谈起。

校验方法：

1. 编程语言内置解析器：大多数编程语言都提供了JSON解析库，这些库在尝试解析JSON字符串时会自动进行语法校验，如果语法不正确，会抛出异常。

   • JavaScript (Node.js / 浏览器)：使用 JSON.parse()。

     try {
         const jsonObj = JSON.parse('{"name": "张三", "age": 30}'); // 合法
         console.log("JSON语法合法");
     } catch (error) {
         console.error("JSON语法错误:", error.message);
     }
     try {
         const jsonObj = JSON.parse('{name: "张三", age: 30}'); // 非法，属性名需双引号
         console.log("JSON语法合法");
     } catch (error) {
         console.error("JSON语法错误:", error.message); // 输出：JSON语法错误: Unexpected token n in JSON at position 1
     }

   • Python：使用 json.loads()。

     import json
     json_str = '{"name": "李四", "age": 25}'
     try:
         json_obj = json.loads(json_str)
         print("JSON语法合法")
     except json.JSONDecodeError as e:
         print(f"JSON语法错误: {e}")
     json_str_invalid = "{'name': '王五', 'age': 40}" # 单引号非法
     try:
         json_obj = json.loads(json_str_invalid)
         print("JSON语法合法")
     except json.JSONDecodeError as e:
         print(f"JSON语法错误: {e}") # 输出：JSON语法错误: Expecting property name enclosed in double quotes: line 1 column 2 (char 1)

   • Java：使用 JSONObject 或 Gson 等库。

     import org.json.JSONObject;
     public class JsonSyntaxCheck {
         public static void main(String[] args) {
             String jsonStr = "{\"name\": \"赵六\", \"age\": 35}";
             try {
                 JSONObject jsonObj = new JSONObject(jsonStr);
                 System.out.println("JSON语法合法");
             } catch (Exception e) {
                 System.out.println("JSON语法错误: " + e.getMessage());
             }
         }
     }

2. 在线JSON校验工具：有许多在线JSON校验器（如 JSONLint, JSONValidator 等），可以直接将JSON字符串粘贴进去，工具会快速反馈语法错误。

语法校验要点：

• 对象（Object）必须以 开始，以 结束，键名必须是双引号括起来的字符串。
• 数组（Array）必须以 [ 开始，以 ] 结束。
• 键值对之间用逗号 分隔。
• 字符串（String）必须用双引号 括起来。
• 数值（Number）可以是整数或浮点数，不能有前导零（除非是0本身）。
• 布尔值（Boolean）必须是 true 或 false（全小写）。
• null 值必须是 null（全小写）。
• 注意转义字符的正确使用。

结构完整性校验——确保JSON符合预期模式

当JSON语法合法后,我们还需要校验其结构是否符合我们的预期，一个用户信息对象，我们期望它必须包含 id 和 name 字段，age 字段应该是整数，emails 字段应该是一个字符串数组，这时，JSON Schema 就是一个非常强大的工具。

JSON Schema 是什么？ JSON Schema 是一个基于JSON的格式，用于定义JSON数据结构的规范，它可以描述JSON对象的结构、数据类型、约束条件等，并用于校验JSON数据是否符合该规范。

如何使用JSON Schema校验？

1. 定义JSON Schema：我们需要编写一个描述我们期望JSON结构的Schema文件。

   • 示例：用户信息Schema

     {
       "$schema": "http://json-schema.org/draft-07/schema#",
       "title": "用户信息",
       "description": "一个标准的用户信息JSON对象",
       "type": "object",
       "required": ["id", "name", "email"],
       "properties": {
         "id": {
           "type": "integer",
           "description": "用户唯一标识"
         },
         "name": {
           "type": "string",
           "minLength": 1,
           "maxLength": 50,
           "description": "用户姓名"
         },
         "email": {
           "type": "string",
           "format": "email",
           "description": "用户邮箱"
         },
         "age": {
           "type": "integer",
           "minimum": 0,
           "maximum": 150,
           "description": "用户年龄（可选）"
         },
         "phones": {
           "type": "array",
           "items": {
             "type": "string",
             "pattern": "^1[3-9]\\d{9}$" // 简单的手机号正则
           },
           "description": "用户手机号列表（可选）"
         },
         "is_active": {
           "type": "boolean",
           "default": true,
           "description": "用户是否激活（可选）"
         }
       }
     }

2. 使用校验库进行校验：

   • JavaScript (使用 ajv 库)

     const Ajv = require("ajv");
     const ajv = new Ajv();
     const userSchema = {
       // 上面的userSchema JSON内容
     };
     const validate = ajv.compile(userSchema);
     const validUser = {
       "id": 1,
       "name": "张三",
       "email": "zhangsan@example.com",
       "age": 30,
       "phones": ["13800138000"]
     };
     const invalidUser1 = {
       "name": "李四",
       "email": "lisi@example.com"
       // 缺少必需的 "id"
     };
     const invalidUser2 = {
       "id": "abc", // id应为整数
       "name": "王五",
       "email": "wangwu@example.com"
     };
     console.log(validUser, "校验结果:", validate(validUser)); // true
     console.log(invalidUser1, "校验结果:", validate(invalidUser1)); // false, 输出：id is a required property
     console.log(invalidUser2, "校验结果:", validate(invalidUser2)); // false, 输出：id should be integer

   • Python (使用 jsonschema 库)

     from jsonschema import validate, ValidationError
     user_schema = {
         # 上面的userSchema JSON内容
     }
     valid_user = {
         "id": 1,
         "name": "张三",
         "email": "zhangsan@example.com",
         "age": 30,
         "phones": ["13800138000"]
     }
     invalid_user1 = {
         "name": "李四",
         "email": "lisi@example.com"
     }
     try:
         validate(instance=valid_user, schema=user_schema)
         print("valid_user 校验通过")
     except ValidationError as e:
         print(f"valid_user 校验失败: {e.message}")
     try:
         validate(instance=invalid_user1, schema=user_schema)
         print("invalid_user1 校验通过")
     except ValidationError as e:
         print(f"invalid_user1 校验失败: {e.message}") # �输出：'id' is a required property

JSON Schema 常用关键字：