使用 AJV

在使用 AJV 之前，需要了解什么是 JSON Schema。

JSON Schema 简介

JSON Schema 是一种用于描述 JSON 数据格式的规范，它定义了数据的结构和约束条件。

AJV 概述

AJV 是一个高效的 JSON Schema 校验库，广泛应用于各种前端和后端项目中。

安装和引入 AJV

首先，需要安装 AJV：

npm install ajv

然后在项目中引入并初始化 AJV：

import Ajv from 'ajv';
const optiOns= {}; // 配置项
const ajv = new Ajv(options); // 在某些情况下，需要使用 new Ajv.default()
// 执行校验
const isValid = ajv.validate(schema, data);
if (!isValid) {
  throw new Error(ajv.errorsText());
}

JSON Schema 默认支持以下六种基本数据类型：string、number、object、array、boolean 和 null。

通过 AJV 的扩展插件，如 ajv-keywords，可以支持更多的数据类型。

基本类型示例

以下是一个简单的 JSON Schema 示例，用于校验一个对象的结构：

const schema = {
  type: 'object',
  properties: {
    get: {
      type: 'object',
      properties: {
        url: { type: 'string' },
        method: { type: 'string' },
      },
      required: ['url'],
    },
  },
};
const data = {
  get: {
    url: 'http://localhost:8080/get',
  },
};

处理重复代码块

为了避免重复定义相同的校验规则，可以使用 $ref 关键字引用已定义的规则：

const schema = {
  type: 'object',
  properties: {
    get: {
      $id: '#getType',
      type: 'object',
      properties: {
        url: { type: 'string' },
        method: { type: 'string' },
      },
      required: ['url'],
    },
    put: { $ref: '#getType' },
    delete: { $ref: '#getType' },
  },
};

处理不支持的格式

JSON Schema 不支持 Javascript 中的一些复杂数据类型，如 function 和 date。可以通过引入 ajv-keywords 来扩展支持这些类型：

import Ajv from 'ajv';
import AjvKeywords from 'ajv-keywords';
const ajv = new Ajv();
AjvKeywords(ajv, ['typeof', 'instanceof']);
const schema = {
  type: 'object',
  properties: {
    get: {
      type: 'object',
      properties: {
        url: { type: 'string' },
        method: { type: 'string' },
      },
      required: ['url'],
    },
    getMethod: { instanceof: 'Function' },
    list: { instanceof: ['Function', 'Array'] },
  },
};
const data = {
  get: {
    url: 'http://localhost:8080/get',
  },
  getMethod() {},
  list: [],
};

通过上述方法，可以有效地对 JSON 数据进行校验，确保数据的有效性和一致性，从而提高开发效率和代码质量。

参考链接

• 简书
• AJV 中文文档