首页
/ 异步验证工具——async-validate

异步验证工具——async-validate

2025-05-17 05:11:06作者:田桥桑Industrious

1. 项目介绍

async-validate 是一个异步类型验证库,适用于Node.js和浏览器环境。它具有最小的依赖关系,并使用插件架构,这意味着你只需要包含你想要验证的类型插件,并且可以轻松创建自己的验证插件。async-validate 提供了灵活的验证规则定义方式,支持对象、数组、函数等多种形式,并且可以通过插件扩展其功能。

2. 项目快速启动

首先,确保你已经安装了Node.js环境。接下来,通过以下步骤快速启动async-validate

// 安装 async-validate
npm i async-validate

// 创建一个验证规则描述符
var descriptor = {
  type: 'object',
  fields: {
    name: {
      type: 'string',
      required: true
    }
  }
};

// 创建一个验证器实例
var schema = new Schema(descriptor);

// 定义要验证的数据
var source = {};

// 进行验证
schema.validate(source, function (err, res) {
  if (err) throw err;
  if (res) {
    // 验证失败,res.errors 包含所有错误
    console.dir(res.errors);
  } else {
    // 验证通过
  }
});

3. 应用案例和最佳实践

验证用户输入

在Web应用中,经常需要验证用户输入的数据。以下是一个验证用户名和邮箱的例子。

var descriptor = {
  type: 'object',
  fields: {
    username: {
      type: 'string',
      required: true,
      min: 3,
      max: 20
    },
    email: {
      type: 'string',
      required: true,
      regexp: /^[a-zA-Z0-9._%+-]+@[a-zA-Z0-9.-]+\.[a-zA-Z]{2,}$/
    }
  }
};

// 使用同样的方式创建Schema实例并验证数据

创建自定义验证规则

你可以通过内置的rule函数创建自定义验证规则。

var descriptor = {
  type: 'object',
  fields: {
    age: {
      type: 'integer',
      rule: function (cb) {
        if (this.value < 0 || this.value > 120) {
          this.raise('年龄必须在0到120之间');
        }
        cb();
      }
    }
  }
};

4. 典型生态项目

async-validate的生态中,有一些项目可以与async-validate配合使用,以增强验证功能:

  • async-validate-plugin-email: 用于验证邮箱地址的插件。
  • async-validate-plugin-password: 用于验证密码复杂度的插件。
  • async-validate-plugin-date: 用于验证日期格式的插件。

这些插件可以通过npm安装,并在创建Schema实例时通过plugin方法加载。

登录后查看全文
热门项目推荐