neal-parameter v1.0.0

数据校验模块

这是什么

• 是 GitHub 上 paramete` 的中文学抄版本，

我为什么要做这件事

• 是在学习 eggjs 时了解到数据校验的 egg版本，其中讲到使用了 parameter , 但是因为种种原因都不符合本人的使用习惯 ,主要是新手学习要学的东西太多,耐心有限,就想要看到一个中文提示,使自己的注意力更多的在业务逻辑上.所以就有改下源码提示的行为
• 作为一个 IT 新人我知道自己水平有限, 也知道很多新人和我一样能力有限, 互联网精神嘛,分享是快乐的.
• 另外国内装逼犯,优越狗太多, 本人声明一下仅接受指教不接受 PUA。
• 本人不对后续更新，持续维护，使用后果做任何形式的承诺。但如果要求合理我是非常乐意更新的, 因为我自己也在用.

我做了什么

1. 删除了原框架的 options.translate 选项, 因为不需要适配其他语言.
2. 我将其中的提醒修改为中文
3. 使用 Promise 进行了一个封装
   1. 有错误返回错误, 无错误就无返回值. 这样非常合适仅作为一个数据校验存在

安装

1. 通过 NPM 安装

$ npm install neal-parameter --save

2. 直接下载
   1. 将 index.js , middleware 和 validate.js 引入项目即可
      1. 或者直接使用 validate.js 自己封装

使用方法

1. 创建一个校验文件

   1. //  示例: 更新邮箱
      module.exports = {
        user_id: {
          type: "string",
          trim: true,
          message: "user_id 不符合规则",
        },
        email: {
          type: "email",
          trim: true,
          message: "邮箱验不符合规则",
        },
        captcha: {
          type: "string",
          trim: true,
          format: /^[A-Za-z0-9]{4}$/,
          message: "验证码不符合要求",
        },
        codeType: {
          type: "string",
          trim: true,
          format: /^changeNumber$/,
          message: "验证码类型不符合要求",
        },
      };

2. 在 Eggjs 中使用

   app/extend/context.ts

   const n_rule = require('neal-parameter');
   module.exports = {
     rule: n_rule,
   };

   app/service/user.ts

const rule = require('neal-parameter');
// 更新用户邮箱
public async updateEmail(data: any) {
  const { ctx } = this;
  try {
    // 校验数据
    await ctx.rule.validateDataFormat(require("../validate/user/updateEmail.js"), data);
  }
  catch (error) {
    // 验证错误直接通过抛出
    throw error;
  }
}

3. 在node.js 使用
   1. 引入
   2. 调用

配置简单说明

• 更多信息可以查看 demo 下文件示范

API

/**
   * > 严格数据格式校验 : 不能添加规则文件中没有的字段
   * @param {string|url} rule : 规则对象||规则文件>require(路径+文件名)
   * @param {object} data : 需要校验的数据
   * @returns 错误原因, 正确无返回值
   */
validateDataFormat(rule, data)
/**
   * > 数据格式校验 : 可以添加规则文件中没有的字段,没有添加的字段不做校验
   * @param {string|url} rule : 规则对象||规则文件>require(路径+文件名)
   * @param {object} data : 需要校验的数据
   * @returns 错误原因, 正确无返回值
   */
validateDataFormatSimpleMode(rule, data) {

补充

• 我觉得我大概说明白了, 因为我也不知道在说什么了. 就这样吧

原 API

Parameter Class

• constructor([options]) -创建实力时,可设置可选项
  • options.validateRoot - 接受布尔值;
    • 传入的校验数据是否必须是一个对象, 默认: false
  • options.convert - 接受布尔值;
    • 将原始参数转换为特定类型，默认为 false。
  • options.widelyUndefined - 接受布尔值;
    • 将空字符串(''), NaN, Null 转换为undefined，这个选项可以让rule.required 更加强大，默认为false。这可能会改变原来的输入参数。
• validate(rule, value) - 暴露使用的方法
  • 验证 value 符合 rule。 如果违反规则，则返回错误数组。
• addRule(type, check) - 添加自定义规则
  • type - 规则类型，必填，必须是字符串类型。
  • check - 校验程序。 可以是 function 或 RegExp

__Note:当”选项。convert ' enabled，所有内置规则检查原始输入参数并将其转换为规则的默认' convertType '(定义如下)，你也可以在每个规则定义中通过' convertType '选项为特定规则启用该特性

例子

var Parameter = require('parameter');

var parameter = new Parameter({
  validateRoot: true, //限制被验证值必须是一个对象
});

var data = {
  name: 'foo',
  age: 24,
  gender: 'male'
};

var rule = {
  name: 'string',
  age: 'int',
  gender: ['male', 'female', 'unknown']
};

var errors = parameter.validate(rule, data);

复杂例子

规则

通用规则

• type - 属性的类型，每种类型都有自己的验证规则.
• convertType - 将输入参数转换为特定类型，支持int、number、string和boolean，还支持自定义转换方法的函数
• required - 必填项，默认是 true。如果某个字段是可选项需要主动设置为：false
• default - 属性的默认值，如果该属性被手动设置为：required: false 此参数的值，将作为默认值。
  • 这可能会更改原始输入参数。
• widelyUndefined - 覆盖 选项 options.widelyUndefined

注意：您可以将 require 和 type 以符号? 结尾，例如：int? 或 string? 来指定类型和非必需。

type：可选值

int

type 是 int，有两个可选规则

• max - 最大值: 值必须小于或等于 max 设置的值, value <= max.
• min - 最小值: 值必须大于或等于 min 设置的值, , value >= min.

默认 convertType 是 int

注意：默认的 convertType 只会在 options.convert 在参数的构造函数中设置为 true 时起作用。

integer

int的别名

number

type 是 number，有两个可选规则， 同int

• max - 最大值: 值必须小于或等于 max 设置的值, value <= max.
• min - 最小值: 值必须大于或等于 min 设置的值, , value >= min.

默认 convertType 是 number.

date

date 类型要匹配 YYYY-MM-DD 类型的日期字符串

默认 convertType 是 string。

dateTime

dateTime 类型要匹配 YYYY-MM-DD HH:mm:ss 类型的日期字符串。

默认 convertType 是 string。

datetime

dateTime的别名

id

'id'类型要与/^\d+$/类型日期字符串匹配。

默认 convertType 是 string。

boolean

匹配 boolean 类型值。

默认 convertType 是 boolean。

bool

boolean的别名

string

类型为“string”，有四条可选规则

• allowEmpty(alias to empty) - 允许空字符串，默认为false。 如果 required 设置为 false，默认情况下 allowEmpty 将设置为 true。
• format -用于检查字符串格式的RegExp（正则表达式）.
• max - 字符串的最大长度
• min - 字符串的最小长度
• trim - 检查前修剪字符串前后的空格，默认为false。

默认 convertType 是 string。

email

要匹配的email类型[RFC 5322] 电子邮件地址。

• allowEmpty -允许空字符串，默认为false。

默认 convertType 是 string。

password

password 类型要匹配 /^$/ 类型的字符串

• compare - Compare field to check equal, default null, not check.
• max - 密码的最大长度
• min - 密码的最小长度，默认为6

默认 convertType 是 string。

url

url 类型要匹配 web url.

默认 convertType 是 string。

enum

type为' enum '，则需要一个附加规则

• values - 值是数组，' value '必须为其中之一。此规则是必填项

object

type 是 object，则有一个可选规则：

• rule - 验证对象属性的对象

array

type 是 array，则有四个可选规则

• itemType - 可声明数组中每个 item 的类型
• rule - 验证数组项的对象。 仅适用于itemType
• max - 数组的最大长度
• min - 数组的最小长度

简写的

示例：type:int

• 'int' => {type: 'int', required: true}
• 'int?' => {type: 'int', required: false }
• 'integer' => {type: 'integer', required: true}
• 'number' => {type: 'number', required: true}
• 'date' => {type: 'date', required: true}
• 'dateTime' => {type: 'dateTime', required: true}
• 'id' => {type: 'id', required: true}
• 'boolean' => {type: 'boolean', required: true}
• 'bool' => {type: 'bool', required: true}
• 'string' => {type: 'string', required: true, allowEmpty: false}
• 'string?' => {type: 'string', required: false, allowEmpty: true}
• 'email' => {type: 'email', required: true, allowEmpty: false, format: EMAIL_RE}
• 'password' => {type: 'password', required: true, allowEmpty: false, format: PASSWORD_RE, min: 6}
• 'object' => {type: 'object', required: true}
• 'array' => {type: 'array', required: true}
• [1, 2] => {type: 'enum', values: [1, 2]}
• /\d+/ => {type: 'string', required: true, allowEmpty: false, format: /\d+/}

错误 示例

code: 遗漏字段

{
  code: 'missing_field',
  field: 'name',
  message: 'required'
}

code: invalid

{
  code: 'invalid',
  field: 'age',
  message: 'should be an integer'
}

提供校验文件

1. /n_box/validate/validateDir 目录下写入校验文件
2. 在使用时写入文件名(不包含扩展名), 文件自动到 指定目录搜寻规则文件

/*
 ^ 提供图片上传是数据校验
 文件名: image.js
*/

module.exports = {
  user_id: {
    type: 'string',
    trim: true,
    message: '用户 ID 不能为空'
  },
  type: {
    type: 'enum',
    values: ['position', 'home_item'],
    message: '值类型必须二选一'
  },
  home_item: {
    required: false,
    type: 'enum',
    values: ['Renew', 'recommend','share','download','help'],
  },
  position: {
    required: false,
    type: 'enum',
    values: ['home_carousel', 'QRcode','advert_carousel','personal_cover'],
  }
}

使用

const n_validate = require('../n_box/validate')
// 校验数据, 没有错误则得到 null
const isError = n_validate.validateDataFormat('image', urlObj.fields)
if (isError) throw new Error(`字段: ${isError[0].field}, 错误信息: ${isError[0].message}`);

提供方法2个

//  本模块不是异步模式
const n_validate = require('./validate.js')

module.exports = {
  /**
   * > 数据格式校验 : 不能添加规则文件中没有的字段
   * @参数1 : 规则文件名
   * @参数2 : 需要校验的数据
   * @返回: 错误原因, 正确无返回值
   */
  validateDataFormat(rule, data) {
    return n_validate.validateDataFormat(rule, data)
  },
  /**
   * > 数据格式校验 : 可以添加规则文件中没有的字段,没有添加的字段不做校验
   * @参数1 : 规则文件名
   * @参数2 : 需要校验的数据
   * @返回: 错误原因, 正确无返回值
   */
   validateDataFormatSimpleMode(rule, data) {
    return n_validate.validateDataFormatSimpleMode(rule, data)
  }
}