如何在JSON中进行数据验证？

修改于 2023-07-26 03:38:53

212

词条归属：JSON

在JSON中进行数据验证可以使用JSON Schema。JSON Schema是一种用于描述JSON数据结构的语言，它可以描述JSON对象、数组和基本类型之间的关系，并提供了一套规范来验证JSON数据的完整性和正确性。

以下是一个简单的JSON Schema示例：

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "type": "object",
  "properties": {
    "name": {
      "type": "string"
    },
    "age": {
      "type": "integer",
      "minimum": 18,
      "maximum": 100
    },
    "address": {
      "type": "object",
      "properties": {
        "street": {
          "type": "string"
        },
        "city": {
          "type": "string"
        },
        "state": {
          "type": "string",
          "enum": ["NY", "CA", "TX"]
        },
        "zipcode": {
          "type": "string",
          "pattern": "^[0-9]{5}(?:-[0-9]{4})?$"
        }
      },
      "required": ["street", "city", "state", "zipcode"]
    },
    "phone_numbers": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "type": {
            "type": "string",
            "enum": ["home", "work", "cell"]
          },
          "number": {
            "type": "string",
            "pattern": "^[0-9]{3}-[0-9]{3}-[0-9]{4}$"
          }
        },
        "required": ["type", "number"]
      }
    }
  },
  "required": ["name", "age", "address", "phone_numbers"]
}

在上面的示例中，JSON Schema描述了一个包含"name"、"age"、"address"和"phone_numbers"四个属性的对象，"name"为字符串类型，"age"为整数类型且取值范围为18到100之间，"address"为包含"street"、"city"、"state"和"zipcode"四个属性的对象，其中"state"必须为"NY"、"CA"或"TX"中的一个，"zipcode"必须符合美国邮政编码的格式。"phone_numbers"为一个数组，其中每个元素都是包含"type"和"number"两个属性的对象，"type"必须为"home"、"work"或"cell"中的一个，"number"必须符合电话号码的格式。

可以使用以下方法来验证JSON数据是否符合JSON Schema：

在JavaScript中使用AJV库：

var Ajv = require('ajv');
var ajv = new Ajv();
var validate = ajv.compile(schema);
var valid = validate(data);
if (!valid) console.log(validate.errors);

在Python中使用jsonschema库：

import jsonschema

jsonschema.validate(instance=data, schema=schema)

在Java中使用json-schema-validator库：

import com.github.fge.jsonschema.core.exceptions.ProcessingException;
import com.github.fge.jsonschema.core.report.ProcessingReport;
import com.github.fge.jsonschema.main.JsonSchema;
import com.github.fge.jsonschema.main.JsonSchemaFactory;
import com.google.gson.Gson;
import com.google.gson.JsonElement;
import com.google.gson.JsonParser;

JsonParser parser = new JsonParser();
JsonElement

使用JSON Schema来验证接口数据