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

JavaScript 2019-01-07

引言

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

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

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

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

一、Angular是如何校验？

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

required maxlength="11">

required">手机号必填

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

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

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

requiredValidator),multi: true }] }) export class requiredValidator {}

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

ngModel 我把它简化了一下：

) {}

get validator(): ValidatorFn|null {
// 各种校验并返回结果
}
}

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

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

二、编写一个校验器

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

定义Directive

UserMobileDirective),multi: true }] }) export class UserMobileDirective {}

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

类

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

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

required maxlength="11">

required">手机号必填

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

三、异步校验器

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

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

UserAsyncDirective),multi: true }] }) export class UserAsyncDirective implements Validator { validate(c: AbstractControl): Observable { 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() 做为结尾，原因每一次校验，对于结果而言只允许一个。