Angular 4.x 自定义验证指令
表单是几乎每一个 Web 应用程序的一部分。虽然 Angular 为咱们提供了几个内置 validators (验证器)，但在实际工做中为了知足项目需求，咱们常常须要为应用添加一些自定义验证功能。接下来咱们将着重介绍，如何自定义 validator 指令。html
Built-in Validators
Angular 提供了一些内置的 validators，咱们能够在 Template-Driven 或 Reactive 表单中使用它们。若是你对 Template-Driven 和 Reactive 表单还不了解的话，能够参考 Angular 4.x Forms 系列中 Template Driven Forms 和 Reactive Forms 这两篇文章。typescript
在写本文时，Angular 支持的内建 validators 以下：json
required - 设置表单控件值是非空的bootstrap
email - 设置表单控件值的格式是 emailsegmentfault
minlength - 设置表单控件值的最小长度app
maxlength - 设置表单控件值的最大长度ide
pattern - 设置表单控件的值需匹配 pattern 对应的模式函数
在使用内建 validators 以前，咱们须要根据使用的表单类型 (Template-Driven 或 Reactive)，导入相应的模块，对于 Template-Driven 表单，咱们须要导入 FormsModule。具体示例以下：ui
import { NgModule } from '@angular/core';
import { BrowserModule } from '@angular/platform-browser';
import { FormsModule } from '@angular/forms';
@NgModule({
imports: [BrowserModule, FormsModule], // we add FormsModule here
declarations: [AppComponent],
bootstrap: [AppComponent]
})
export class AppModule {}
一旦导入了 FormsModule 模块，咱们就能够在应用中使用该模块提供的全部指令：this
<form novalidate>
<input type="text" name="name" ngModel required>
<input type="text" name="street" ngModel minlength="3">
<input type="text" name="city" ngModel maxlength="10">
<input type="text" name="zip" ngModel pattern="[A-Za-z]{5}">
</form>
而对于 Reactive 表单，咱们就须要导入 ReactiveFormsModule 模块：
import { ReactiveFormsModule } from '@angular/forms';
@NgModule({
imports: [BrowserModule, ReactiveFormsModule],
...
})
export class AppModule {}
能够直接使用 FormControl 和 FormGroup API 建立表单：
@Component()
class Cmp {
form: FormGroup;
ngOnInit() {
this.form = new FormGroup({
name: new FormControl('', Validators.required)),
street: new FormControl('', Validators.minLength(3)),
city: new FormControl('', Validators.maxLength(10)),
zip: new FormControl('', Validators.pattern('[A-Za-z]{5}'))
});
}
}
也能够利用 FormBuilder 提供的 API，采用更便捷的方式建立表单：
@Component()
class Cmp {
constructor(private fb: FormBuilder) {}
ngOnInit() {
this.form = this.fb.group({
name: ['', Validators.required],
street: ['', Validators.minLength(3)],
city: ['', Validators.maxLength(10)],
zip: ['', Validators.pattern('[A-Za-z]{5}')]
});
}
}
须要注意的是，咱们还须要使用 [formGroup] 指令将表单模型与 DOM 中的表单对象关联起来，具体以下：
<form novalidate [formGroup]="form"> ... </form>
接下来咱们来介绍一下如何自定义 validator 指令。
Building a custom validator directive
在实际开发前，咱们先来介绍一下具体需求：咱们有一个新增用户的表单页面，里面包含 4 个输入框，分为用于保存用户输入的 username、email、password、confirmPassword 信息。具体的 UI 效果图以下：
Setup (基础设置)
1.定义 user 接口
export interface User {
username: string; // 必填，5-8个字符
email: string; // 必填，有效的email格式
password: string; // 必填，值要与confirmPassword值同样
confirmPassword: string; // 必填，值要与password值同样
}
2.导入 ReactiveFormsModule
app.module.ts
import { NgModule, CUSTOM_ELEMENTS_SCHEMA } from '@angular/core';
import { BrowserModule } from '@angular/platform-browser';
import { ReactiveFormsModule } from '@angular/forms';
import { AppComponent } from './app.component';
@NgModule({
imports: [BrowserModule, ReactiveFormsModule],
declarations: [AppComponent],
bootstrap: [AppComponent]
})
export class AppModule { }
3.初始化 AppComponent
app.component.html
<div>
<h3>Add User</h3>
<form novalidate (ngSubmit)="saveUser()" [formGroup]="user">
<div>
<label for="">Username</label>
<input type="text" formControlName="username">
<div class="error" *ngIf="user.get('username').invalid &&
user.get('username').touched">
Username is required (minimum 5 characters, maximum 8 characters).
</div>
<!--<pre *ngIf="user.get('username').errors" class="margin-20">
{{ user.get('username').errors | json }}</pre>-->
</div>
<div>
<label for="">Email</label>
<input type="email" formControlName="email">
<div class="error" *ngIf="user.get('email').invalid && user.get('email').touched">
Email is required and format should be <i>24065****@qq.com</i>.
</div>
<!--<pre *ngIf="user.get('email').errors" class="margin-20">
{{ user.get('email').errors | json }}</pre>-->
</div>
<div>
<label for="">Password</label>
<input type="password" formControlName="password">
<div class="error" *ngIf="user.get('password').invalid &&
user.get('password').touched">
Password is required
</div>
<!--<pre *ngIf="user.get('password').errors" class="margin-20">
{{ user.get('password').errors | json }}</pre>-->
</div>
<div>
<label for="">Retype password</label>
<input type="password" formControlName="confirmPassword" validateEqual="password">
<div class="error" *ngIf="user.get('confirmPassword').invalid &&
user.get('confirmPassword').touched">
Password mismatch
</div>
<!--<pre *ngIf="user.get('confirmPassword').errors" class="margin-20">
{{ user.get('confirmPassword').errors | json }}</pre>-->
</div>
<button type="submit" class="btn-default" [disabled]="user.invalid">Submit</button>
</form>
</div>
app.component.ts
import { Component, OnInit } from '@angular/core';
import { FormGroup, FormBuilder, Validators } from '@angular/forms';
export interface User {
username: string; // 必填，5-8个字符
email: string; // 必填，有效的email格式
password: string; // 必填，值要与confirmPassword值同样
confirmPassword: string; // 必填，值要与password值同样
}
@Component({
moduleId: module.id,
selector: 'exe-app',
templateUrl: 'app.component.html',
styles: [`
.error {
border: 1px dashed red;
color: red;
padding: 4px;
}
.btn-default {
border: 1px solid;
background-color: #3845e2;
color: #fff;
}
.btn-default:disabled {
background-color: #aaa;
}
`]
})
export class AppComponent implements OnInit {
public user: FormGroup;
constructor(public fb: FormBuilder) { }
ngOnInit() {
this.user = this.fb.group({
username: ['', [Validators.required, Validators.minLength(5),
Validators.maxLength(8)]],
email: ['', [Validators.required, Validators.email]],
password: ['', [Validators.required]],
confirmPassword: ['', [Validators.required]]
});
}
saveUser(): void {
}
}
Custom confirm password validator
接下来咱们来实现自定义 equal-validator 指令：
equal-validator.directive.ts
import { Directive, forwardRef, Attribute } from '@angular/core';
import { Validator, AbstractControl, NG_VALIDATORS } from '@angular/forms';
@Directive({
selector: '[validateEqual][formControlName],[validateEqual][formControl],
[validateEqual][ngModel]',
providers: [
{ provide: NG_VALIDATORS, useExisting: forwardRef(() => EqualValidator),
multi: true }
]
})
export class EqualValidator implements Validator {
constructor(@Attribute('validateEqual') public validateEqual: string) { }
validate(c: AbstractControl): { [key: string]: any } {
// self value (e.g. retype password)
let v = c.value; // 获取应用该指令，控件上的值
// control value (e.g. password)
let e = c.root.get(this.validateEqual); // 获取进行值比对的控件
// value not equal
if (e && v !== e.value)
return {
validateEqual: false
}
return null;
}
}
上面的代码很长，咱们来分解一下。
Directive declaration
@Directive({
selector: '[validateEqual][formControlName],[validateEqual]
[formControl],[validateEqual][ngModel]',
providers: [
{ provide: NG_VALIDATORS, useExisting: forwardRef(() => EqualValidator),
multi: true }
]
})
首先，咱们使用 @Directive 装饰器来定义指令。而后咱们设置该指令的 Metadata 信息：
selector - 定义指令在 HTML 代码中匹配的方式
providers - 注册EqualValidator
其中 forwardRef 的做用，请参考 - Angular 2 Forward Reference
Class defintion
export class EqualValidator implements Validator {
constructor(@Attribute('validateEqual') public validateEqual: string) {}
validate(c: AbstractControl): { [key: string]: any } {}
}
咱们的 EqualValidator 类必须实现 Validator 接口：
export interface Validator {
validate(c: AbstractControl): ValidationErrors|null;
registerOnValidatorChange?(fn: () => void): void;
}
该接口要求定义一个 validate() 方法，所以咱们的 `EqualValidator 类中就须要实现 Validator 接口中定义的 validate 方法。此外在构造函数中，咱们经过 @Attribute('validateEqual') 装饰器来获取 validateEqual 属性上设置的值。
Validate implementation
validate(c: AbstractControl): { [key: string]: any } {
// self value (e.g. retype password)
let v = c.value; // 获取应用该指令，控件上的值
// control value (e.g. password)
let e = c.root.get(this.validateEqual); // 获取进行值比对的控件
// value not equal
if (e && v !== e.value)
return { // 若不相等，返回验证失败信息
validateEqual: false
}
return null;
}
Use custom validator
要在咱们的表单中使用自定义验证器，咱们须要将其导入到咱们的应用程序模块中。
import { NgModule, CUSTOM_ELEMENTS_SCHEMA } from '@angular/core';
import { BrowserModule } from '@angular/platform-browser';
import { ReactiveFormsModule } from '@angular/forms';
import { EqualValidator } from './equal-validator.directive';
import { AppComponent } from './app.component';
@NgModule({
imports: [BrowserModule, ReactiveFormsModule],
declarations: [AppComponent, EqualValidator],
bootstrap: [AppComponent]
})
export class AppModule { }
以上代码成功运行后，咱们来验证一下刚实现的功能：
友情提示：演示须要先把密码框的类型设置为text
步骤一
步骤二
看起来一切很顺利，但请继续看下图：
什么状况，password 输入框的值已经变成 12345 了，还能验证经过。为何会出现这个问题呢？由于咱们的只在 confirmPassword 输入框中应用 validateEqual 指令。因此 password 输入框的值发生变化时，是不会触发验证的。接下来咱们来看一下如何修复这个问题。
Solution
咱们将重用咱们的 validateEqual 验证器并添加一个 reverse 属性 。
<div>
<label for="">Password</label>
<input type="text" formControlName="password" validateEqual="confirmPassword"
reverse="true">
<div class="error" *ngIf="user.get('password').invalid &&
user.get('password').touched">
Password is required
</div>
<!--<pre *ngIf="user.get('password').errors" class="margin-20">
{{ user.get('password').errors | json }}</pre>-->
</div>
<div>
<label for="">Retype password</label>
<input type="text" formControlName="confirmPassword" validateEqual="password">
<div class="error" *ngIf="user.get('confirmPassword').invalid &&
user.get('confirmPassword').touched">
Password mismatch
</div>
<!--<pre *ngIf="user.get('confirmPassword').errors" class="margin-20">
{{ user.get('confirmPassword').errors | json }}</pre>-->
</div>
若未设置
reverse属性或属性值为 false，实现的功能跟前面的同样。若
reverse的值设置为 true，咱们仍然会执行相同的验证，但错误信息不是添加到当前控件，而是添加到目标控件上。
在上面的示例中，咱们设置 password 输入框的 reverse 属性为 true，即 reverse="true"。当 password 输入框的值与 confirmPassword 输入框的值不相等时，咱们将把错误信息添加到 confirmPassword 控件上。具体实现以下：
equal-validator.directive.ts
import { Directive, forwardRef, Attribute } from '@angular/core';
import { Validator, AbstractControl, NG_VALIDATORS } from '@angular/forms';
@Directive({
selector: '[validateEqual][formControlName],[validateEqual][formControl],
[validateEqual][ngModel]',
providers: [
{ provide: NG_VALIDATORS, useExisting: forwardRef(() => EqualValidator),
multi: true }
]
})
export class EqualValidator implements Validator {
constructor(@Attribute('validateEqual') public validateEqual: string,
@Attribute('reverse') public reverse: string) { }
private get isReverse() {
if (!this.reverse) return false;
return this.reverse === 'true';
}
validate(c: AbstractControl): { [key: string]: any } {
// self value
let v = c.value;
// control vlaue
let e = c.root.get(this.validateEqual);
// value not equal
// 未设置reverse的值或值为false
if (e && v !== e.value && !this.isReverse) {
return {
validateEqual: false
}
}
// value equal and reverse
// 若值相等且reverse的值为true，则删除validateEqual异常信息
if (e && v === e.value && this.isReverse) {
delete e.errors['validateEqual'];
if (!Object.keys(e.errors).length) e.setErrors(null);
}
// value not equal and reverse
// 若值不相等且reverse的值为true，则把异常信息添加到比对的目标控件上
if (e && v !== e.value && this.isReverse) {
e.setErrors({ validateEqual: false });
}
return null;
}
}
以上代码运行后，成功解决了咱们的问题。其实解决该问题还有其它的方案，咱们能够基于 password 和 confirmPassword 来建立 FormGroup 对象，而后添加自定义验证来实现上述的功能。详细的信息，请参考 - Angular 4.x 基于AbstractControl自定义表单验证。