@supine/validator v11.0.2

验证器

• 安装

# npm
npm install @supine/validator
# yarn
yarn add @supine/validator

• 简单使用

import {ZlValidator} from '@supine/validator';

const validator = new ZlValidator();
    // 被验证的数据
    const data = {id: '100'};
    validator
      .setRule({id: 'in:100,2,3'}) // 设置校验规则
      .setTarget(data) // 设置被校验的数据
      .make();
    // 判断验证是否通过
    if (validator.fails()) {
      // 获取错误信息
      console.log(v.getMessages());
    }

• 支持的规则书写形式
  • 字符串数组

    // 相当于max||min 满足其中之一即可
    validator.setRule({id: ['max:30', 'min:10']})

  • 字符串

    // &意味着 两个条件必须同时满足
    validator.setRule({id: 'max:30&in:20,10'})

  • 函数

    function max(value, targetMap: TargetMap): boolean | string {/**/}
    validator.setRule({id: max})

  • 函数数组

    function max(value, targetMap: TargetMap): boolean | string {/**/}
    function min(value, targetMap: TargetMap): boolean | string {/**/}
    // 相当于max||min 满足其中之一即可
    validator.setRule({id: [max, min]})

  • 对象

    function max(value, targetMap: TargetMap): boolean | string {/**/}
    // 两个条件必须同时满足
    // in和max均为规则名称 max使用了自定义校验 将不会使用内置max校验规则
    // [10, 14, 15, 16] 为规则参数
    validator.setRule({id: {in: [10, 14, 15, 16], max}})

  • 对象数组

    function max(value, targetMap: TargetMap): boolean | string {/**/}
    // 数组组的对象中的所有规则必须同时满足
    // in和max均为规则名称 max使用了自定义校验 将不会使用内置max校验规则
    // [10, 14, 15, 16] 为规则参数
    validator.setRule({id: [{in: [10, 14, 15, 16], max}]})

• 批量验证

import {ZlValidator} from '@supine/validator';

const validator = new ZlValidator();
    // 被验证的数据
    const data = {id: '100'};
    validator
      .batch(true) // 将会对所有的规则都会进行校验 即便已经知道验证结果了
      .setRule({id: 'in:100,2,3&max:20&min:10'}) // 设置校验规则
      .setTarget(data) // 设置被校验的数据
      .make();
    // 判断验证是否通过
    if (validator.fails()) {
      // 获取错误信息
      console.log(v.getMessages());
    }

• 嵌套验证

import {ZlValidator} from '@supine/validator';

const validator = new ZlValidator();
    // 被验证的数据
    const data = {id: '100', child: {id: '300'}};
    validator
      .setRule({'child.id': 'in:100,2,3'}) // 设置校验规则
      .setTarget(data) // 设置被校验的数据
      .make();
    // 判断验证是否通过
    if (validator.fails()) {
      // 获取错误信息
      console.log(v.getMessages());
    }

• 自定义验证信息

import {ZlValidator} from '@supine/validator';

const validator = new ZlValidator();
    // 被验证的数据
    const data = {id: '100', child: {id: '300'}};
    validator
      .setRule({'child.id': 'in:100,2,3'}) // 设置校验规则
      .setTarget(data) // 设置被校验的数据
      .setMessage({'id.in': 'id 必须为100,2,3其中之一'})
      .make();
    // 判断验证是否通过
    if (validator.fails()) {
      // 获取错误信息
      console.log(v.getMessages());
    }

• 内置校验规则

• 单独使用内置规则

import {ZlValidatorRule} from '@supine/validator';

ZlValidatorRule.base64('hfk')

自定义验证规则

• 自定义规则

import {ZlValidator, DefaultMessage, Rule} from '@supine/validator';
export class XXValidatorRule {
  // 验证规则默认提示信息
  @DefaultMessage()
  defaultMessage(filedName: string, ruleName: string, params, value): string {
    if (!params) {
      params = [];
    }
    const typeMsg = {
      array: `${filedName} 必须是数组`,
      required: `${filedName} 字段是必须的`,
    };

    return typeMsg[ruleName];
  }

  /**
  * @param value 被验证的数据 不用担心是怎么传过来的 因为这个是验证器做的事
  * @param {string[]} rule 验证的规则 不用担心是怎么传过来的 因为这个是验证器做的事
  * @param {Map<string, any>} dataMap 解析后数据 可以根据属性名获取对应的数据
  * @returns {string} 返回值可以为string 或者 boolean 当为 string 时
  * 自动将返回值作为自定义错误信息提示 如果验证失败请返回失败原因(字符串) 如果验证通过 请返回空字符''
  * 当为 boolean 时 为true说明验证失败 为false说明验证通过
  * 方法名hello 为验证规则的名称  后面可以跟参数 比如 hello:otherField
  * 装饰器 @Rule() 告诉验证 该方法为验证规则  如果没有声明该装饰器的方法  将不会拓展该规则
  * 例子: 实现hello规则 当otherField的值为hello 该规则才通过 否则失败
  */
  @Rule()
  required(value, params, targetMap: TargetMap) {
    CheckParamNotException('required', params);
    return value === null || value === '' || (isArray(value) && !value.length) ||
      (isObject(value) && !Object.keys(value).length);
  }

  /**
   * 只允许为数组类型
   * @param value
   * @param params
   */
  @Rule()
  array(value, params, targetMap: TargetMap) {
    CheckParamNotException('array', params);
    return !Array.isArray(value);
  }
}

• 注册自定义规则

import {ZlValidator, ZlValidatorRule} from '@supine/validator';
import {XXValidatorRule} from './XXValidatorRule'
/**
 * ValidatorRule 内置的验证规则  如有需要可以加进来
 * XXValidatorRule 就是上面自定义的 规则
 */
@Validator({
  rules: [ZlValidatorRule, XXValidatorRule]
})
class XXValidator extends ZlValidator {
  
}