Angular在模板驱动表单中自定义校验器的方法


Posted in Javascript onAugust 09, 2017

引言

模板驱动表单相比较响应式表单可以少更少的代码做同样的事情,可也损失了自由度与更易测试,当然很多人并不在乎啦。

所以我相信很多人在编写Angular不自由自主去更倾向于模板驱动表单的写法。

表单最核心的是校验体验,在Angular中简直就是发挥到了极致,比如:required、min、max、pattern 等,这些原本是HTML DOM元素中的表述,而Angular默认实现了一整套的校验指令,比如:required 对应 RequiredValidator。

然后很多时候我们需要一些特殊的校验,比如:数据比较、远程校验等。那在模板驱动表单风格中我们要如何优雅的实现这样一个校验器呢?

一、Angular是如何校验?

一般在编写一个手机文本框可能是这样:

<input [(ngModel)]="user.mobile" #mobile="ngModel" autocomplete="off" type="tel" class="form-control" name="mobile" required maxlength="11">
<div *ngIf="mobile.errors">
  <p *ngIf="mobile.errors.required">手机号必填</p>
  <p *ngIf="mobile.errors.pattern">手机号格式不正确</p>
</div>

以上几行很友好的实现从必填项、格式进行校验,而这一切都是依靠 [(ngModel)] 统一采集,得以只需要利用一个模板引用变量访问到每个校验指令的错误信息。

1、[(ngModel)] 到底做了什么?

在解析这个问题前需要先了解一下 RequiredValidator 是如何定义的。

@Directive({
 providers: [{
   provide: NG_VALIDATORS,
   useExisting: forwardRef(() => RequiredValidator),
   multi: true
  }]
})
export class RequiredValidator {}

只看最核心向 NG_VALIDATORS 标识符注册一个 RequiredValidator 指令。这样就可以使 ngModel 指令中注入 NG_VALIDATORS 后就能得到这个指令对象。

ngModel 我把它简化了一下:

export class NgModel extends NgControl {
  constructor(@Inject(NG_VALIDATORS) validators: Array<Validator|ValidatorFn>) {}
  
  get validator(): ValidatorFn|null {
    // 各种校验并返回结果
  }
}

有关更多ng_model.ts可以深入阅读源代码。

Angular会在每一次表单值变更时,对所有的表单中已经安装的校验器进行一次遍历。

二、编写一个校验器

诚如 required 校验器一样,依然是把自定义校验器挂到 NG_VALIDATORS 当中。假如我们希望手机文本框只能输入 159 开头的一个校验器。

定义Directive

@Directive({
  selector: '[user-mobile]',
  exportAs: 'userMobile',
  providers: [{
    provide: NG_VALIDATORS,
    useExisting: forwardRef(() => UserMobileDirective),
    multi: true
  }]
})
export class UserMobileDirective {}

一个非常普通的指令定义方法,只是多了一个将 UserMobileDirective 注册到 NG_VALIDATORS 标识符当中而已。别问我为什么,一种约定。

export class UserMobileDirective implements Validator {
  validate(c: AbstractControl): { [key: string]: any; } {
    let value: string = c.value || '';
    if (!value.startsWith('159')) {
      return {
        mobile: {
          msg: '手机号必须是159开头',
          actualValue: value
        }
      };
    }
    return null;
  }
}

只需要实现 Validator 接口的 validate 方法即可。

从 c 中获取DOM值,当遇到非 159 开头时,返回一个用于表述消息的对象即可,否则返回一个 null。这个对象会被统一采集在 ngModel.errors 对象下面。故而,只需要在DOM元素加上 user-mobile 指令即可。

<input user-mobile [(ngModel)]="user.mobile" #mobile="ngModel" autocomplete="off" type="tel" class="form-control" name="mobile" id="mobile" required maxlength="11">
<div *ngIf="mobile.errors">
  <p *ngIf="mobile.errors.required">手机号必填</p>
  <p *ngIf="mobile.errors.mobile">{{mobile.errors.mobile.msg}}</p>
</div>

接口还包括一个 registerOnValidatorChange 可选方法,当某些其它外部属性的变更时,允许重新手动触发校验。

三、异步校验器

如果说用户手机校验器需要检查手机是否为黑名单的情况下,正常黑名单数据都存在远程当中。这样情况下需要发送HTTP请求,而这一过程就是异步。

Angular针对这类异步校验有独立的另一个标识符,即:NG_ASYNC_VALIDATORS,而其它代码都是相通的。

@Directive({
  selector: '[user-async]',
  exportAs: 'userAsync',
  providers: [{
    provide: NG_ASYNC_VALIDATORS,
    useExisting: forwardRef(() => UserAsyncDirective),
    multi: true
  }]
})
export class UserAsyncDirective implements Validator {
  validate(c: AbstractControl): Observable<any> {
    return c.valueChanges
        // 去抖
        .debounceTime(300)
        // 抑制重复值
        .distinctUntilChanged()
        // 1、可以使用flatMap进行远程校验
        // .flatMap(value => value)
        // 2、本地模拟判断
        .map((value: string) => {
          if ([ '15900000001', '15900000002' ].includes(value)) {
            return {
              mobile: {
                msg: '手机号为黑名',
                actualValue: value
              }
            }
          }
          return null;
        })
        .first();    
  }
}

除了 NG_ASYNC_VALIDATORS 核心的结构完全没有变动。

而对于 validate 方法返回的是一个 Observable 类型,利用对 valueChanges 的订阅可以制作一些像去抖动作。

而最后必须使用 first() 做为结尾,原因每一次校验,对于结果而言只允许一个。

结论

本章介绍的是如何对模板驱动表单创建自定义校验器,它相比较响应式表单自定义校验器略为复杂一些。但是实际运用中,我们不应该只为某个构建表单风格做一种自定义校验器,应该二者是共存的。

比如上面 159 开头的示例。更合理的编写方式应该是将校验逻辑独立:

export class MyValidators {
  static checkMobile(value: string): ValidationErrors|null {
    return !value.startsWith('159') ? { mobile: { msg: '手机号必须是159开头' } } : null;
  }
}
// 校验器类
export class UserMobileDirective implements Validator {
  validate(c: AbstractControl): { [key: string]: any; } {
    let value: string = c.value || '';
    return MyValidators.checkMobile(value);
  }
}

这样,同一个校验器,不管是模板驱动表单还是响应式表单,都能是通用的。

总结

以上所述是小编给大家介绍的Angular在模板驱动表单中自定义校验器的方法,希望对大家有所帮助,如果大家有任何疑问请给我留言,小编会及时回复大家的。在此也非常感谢大家对三水点靠木网站的支持!

Javascript 相关文章推荐
一些常用的JS功能函数代码
Jun 23 Javascript
Prototype源码浅析 String部分(三)之HTML字符串处理
Jan 15 Javascript
javascript验证上传文件的类型限制必须为某些格式
Nov 14 Javascript
js中this的用法实例分析
Jan 10 Javascript
整理AngularJS中的一些常用指令
Jun 16 Javascript
JavaScript提高性能知识点汇总
Jan 15 Javascript
JavaScript中的boolean布尔值使用学习及相关技巧讲解
May 26 Javascript
AngularJs ng-repeat 嵌套如何获取外层$index
Sep 21 Javascript
老生常谈js中的MVC
Jul 25 Javascript
从setTimeout看js函数执行过程
Dec 19 Javascript
Vue.js图片预览插件使用详解
Aug 27 Javascript
JS使用Dijkstra算法求解最短路径
Jan 17 Javascript
浅谈react+es6+webpack的基础配置
Aug 09 #Javascript
js中less常用的方法小结
Aug 09 #Javascript
利用JS做网页特效_大图轮播(实例讲解)
Aug 09 #Javascript
基于Vue实例对象的数据选项
Aug 09 #Javascript
react-native之ART绘图方法详解
Aug 08 #Javascript
jQuery Easyui Treegrid实现显示checkbox功能
Aug 08 #jQuery
jQuery EasyUI的TreeGrid查询功能实现方法
Aug 08 #jQuery
You might like
php中用数组的方法设置cookies
2011/04/21 PHP
php文件缓存类汇总
2014/11/21 PHP
YII分模块加载路由的实现方法
2018/10/01 PHP
Javascript实例教程(19) 使用HoTMetal(6)
2006/12/23 Javascript
jquery 上下滚动广告
2009/06/17 Javascript
Javascript string 扩展库代码
2010/04/09 Javascript
详解Node.Js如何处理post数据
2016/09/19 Javascript
js es6系列教程 - 基于new.target属性与es5改造es6的类语法
2017/09/02 Javascript
Angular.js实现获取验证码倒计时60秒按钮的简单方法
2017/10/18 Javascript
ES6解构赋值实例详解
2017/10/31 Javascript
使用jQuery如何写一个含验证码的登录界面
2019/05/13 jQuery
微信小程序indexOf的替换方法(推荐)
2020/01/14 Javascript
JS箭头函数和常规函数之间的区别实例分析【 5 个区别】
2020/05/27 Javascript
Vue3 实现双盒子定位Overlay的示例
2020/12/22 Vue.js
详解python的数字类型变量与其方法
2016/11/20 Python
python常用知识梳理(必看篇)
2017/03/23 Python
python正则表达式及使用正则表达式的例子
2018/01/22 Python
Python输出各行命令详解
2018/02/01 Python
python读取视频流提取视频帧的两种方法
2020/10/22 Python
Django中自定义查询对象的具体使用
2019/10/13 Python
基于python plotly交互式图表大全
2019/12/07 Python
使用Python操作ArangoDB的方法步骤
2020/02/02 Python
python ETL工具 pyetl
2020/06/07 Python
python 实现数据库中数据添加、查询与更新的示例代码
2020/12/07 Python
详解CSS3弹性伸缩盒
2020/09/21 HTML / CSS
大学毕业生个人自荐信范文
2014/01/08 职场文书
餐饮加盟计划书
2014/01/10 职场文书
中专自我鉴定
2014/02/05 职场文书
化学专业自荐信
2014/05/28 职场文书
大学生自我评价200字(4篇)
2014/09/17 职场文书
副校长个人对照检查材料思想汇报
2014/10/04 职场文书
委托书的样本
2015/01/28 职场文书
广播稿:校园广播稿范文
2019/04/17 职场文书
Pytorch中TensorBoard及torchsummary的使用详解
2021/05/12 Python
MySQL 聚合函数排序
2021/07/16 MySQL
Python学习之异常中的finally使用详解
2022/03/16 Python