JSON 模式字符串或 null - Javascript

在 JavaScript 中，JSON 是一种常见的数据格式，它可以用来表示对象、数组、字符串、布尔值等等。JSON 模式字符串是一种描述 JSON 数据结构的字符串格式，它可以用来验证和描述 JSON 数据。

JSON 模式字符串的语法

JSON 模式字符串的语法可以使用几种不同的关键字和表达式，如下所示：

基本关键字

• type：用来定义一个 JSON 属性的数据类型；
• enum：用来限定一个 JSON 属性的取值范围；
• default：用来定义一个 JSON 属性的默认值；
• required：用来指定一个 JSON 属性是否为必须的；
• description：用来定义一个 JSON 属性的描述信息。

组合关键字

• oneOf：用来指定一个 JSON 属性只能取多个备选值中的一个；
• anyOf：用来指定一个 JSON 属性只需要满足多个备选值之一即可；
• allOf：用来指定一个 JSON 属性需要满足多个条件；
• not：用来指定一个 JSON 属性不能满足某个条件。

字符串表达式

• pattern：用来指定一个 JSON 属性所包含的字符串必须满足的正则表达式。

数字表达式

• multipleOf：用来指定一个 JSON 属性必须是某个数字的倍数；
• maximum：用来指定一个 JSON 属性的最大值；
• minimum：用来指定一个 JSON 属性的最小值；
• exclusiveMaximum：用来指定一个 JSON 属性是否小于或等于最大值；
• exclusiveMinimum：用来指定一个 JSON 属性是否大于或等于最小值。

数组表达式

• items：用来定义一个 JSON 数组中每个元素的数据结构；
• maxItems：用来指定一个 JSON 数组的最大长度；
• minItems：用来指定一个 JSON 数组的最小长度；
• uniqueItems：用来指定一个 JSON 数组中的元素是否必须唯一。

对象表达式

• properties：用来定义一个 JSON 对象中每个属性的数据结构；
• additionalProperties：用来指定是否允许 JSON 对象包含未在 properties 中定义的属性；
• maxProperties：用来指定一个 JSON 对象的最大属性数量；
• minProperties：用来指定一个 JSON 对象的最小属性数量；
• dependencies：用来指定一个 JSON 属性需要满足哪些条件，才能同时存在。

如何使用 JSON 模式字符串

在 JavaScript 中，可以通过调用 JSON.parse() 方法将一个 JSON 字符串解析成一个 JavaScript 对象。如果将一个 JSON 模式字符串作为第二个参数传给 JSON.parse() 方法，那么解析出来的对象将会被验证是否符合这个模式字符串。

const jsonData = '{"name": "Alice", "age": 20, "isStudent": true}';
const jsonSchema = {
  type: 'object',
  required: ['age', 'name'],
  properties: {
    name: { type: 'string' },
    age: { type: 'number', minimum: 0 },
    isStudent: { type: 'boolean', default: false }
  }
};
const parsedData = JSON.parse(jsonData, jsonSchema);
console.log(parsedData); // Output: { name: 'Alice', age: 20, isStudent: true }

如果解析出来的对象不符合这个模式字符串，那么 JSON.parse() 方法将会抛出一个错误。

try {
  JSON.parse('{"name": "Bob", "age": -5}', {
    type: 'object',
    required: ['age', 'name'],
    properties: {
      name: { type: 'string' },
      age: { type: 'number', minimum: 0 },
      isStudent: { type: 'boolean', default: false }
    }
  });
} catch (error) {
  console.error(error.message); // Output: "Property 'age' must be greater than or equal to 0."
}

在使用 JSON 模式字符串时，可以使用许多不同的关键字和表达式来描述 JSON 对象的结构和约束。这些关键字和表达式可以帮助开发者更好地理解和描述 JSON 数据，从而提高程序的可读性和可维护性。