angular2 响应式表单

2017-12-28

angular2

要使用响应式表单，我们必须先导入ReactiveFormsModule模块。

@NgModule({
  imports: [
    ReactiveFormsModule,    //<==
    CommonModule
  ],
  ...
})

用FormControl控制表单元素

login-form.component.html

<div>
  <label>Name:</label>
  <input type="text" [formControl]="name">
</div>
<div>
  <label>Password:</label>
  <input type="password" [formControl]="password">
</div>
<button type="submit" (click)="onSubmit()">Submit</button>

login-form.component.ts

import { FormControl } from '@angular/forms';
import { Component } from '@angular/core';

@Component({
  selector: 'app-login-form',
  templateUrl: './login-form.component.html',
  styleUrls: ['./login-form.component.css']
})
export class LoginFormComponent {
  name:FormControl = new FormControl('jack');
  password:FormControl = new FormControl();

  onSubmit() {
    console.log(this.name.value, this.password.value);
  }
}

几点说明：

formControl是一个指令，它接收一个FormControl的实例，来管理表单元素。
构造FormControl的实例时，第一个参数是表单元素的初始值，也可传入一个对象{value:'jack', disabled:true}，里面可以包含表单元素的状态，如是否禁用等。
在提交时，可以通过this.name.value获取表单元素的值。

有时候我们需要在元素值改变时做一些事情，可以订阅valueChanges。

this.name.valueChanges.subscribe(() => {
   // do something...
   console.log(this.name);
});

给FormControl添加验证器

password.validator.ts

export const PasswordValidator = (password?:RegExp): ValidatorFn => {
    return (control:AbstractControl): {[key: string]: any}  => {
        let error = null;
        if (password && !password.test(control.value)) {
            error = {
                password:control.value
            }
        }
        return error;
    }
}

login-form.component.html

<div>
  <label>Password:</label>
  <input type="password" [formControl]="password">
  <div [style.color]="'red'" *ngIf="password.invalid && (password.touched || password.dirty)">
    <p *ngIf="password.errors.required">password can not be empty!</p>
    <p *ngIf="password.errors.password">password is illegal!</p>
  </div>
</div>

login-form.component.ts

password:FormControl = new FormControl('', [Validators.required, PasswordValidator()]);

FormControl的第二个参数可以传入一个ValidatorFn对象或者一个包含ValidatorFn对象的数组。
angular2内置的验证器可以通过Validators取到，如；Validators.required。
自定义的验证器只需引用我们在模板驱动型表单中构造的验证器工厂函数(PasswordValidator)生成一个ValidatorFn对象的实例即可。
FormControl上包含了表单的验证信息，在模板中可以直接使用它。这里可看到，之前我们在模版驱动型表单中通过模板引用变量#password="ngModel"引用的ngModel实际就是一个FormControl实例。

给FormControl添加异步验证器

name.validator.ts

const userList = [
    'jack',
    'mary',
    'jimi',
    'tom'
];

export const checkNameValidator = () => {
    return (control:AbstractControl) => new Promise(
        (resolve, reject) => {
            setTimeout(() => {
                if (userList.indexOf(control.value) >= 0) {
                    resolve({
                        'checkName':control.value
                    });
                } else {
                    resolve(null);
                }
            }, 2000)
        }
    );
}

login-form.component.html

<label>Name:</label>
  <input type="text" [formControl]="name">
  <div [style.color]="'red'" *ngIf="name.invalid && (name.touched || name.dirty)">
    <p *ngIf="name.errors.required">Name can not be empty!</p>
    <p *ngIf="name.errors.checkName">Name is exist!</p>
  </div>

login-form.component.ts

name:FormControl = new FormControl('jack', Validators.required, checkNameValidator());

FormControl的第三个参数可以传入一个AsyncValidatorFn对象或者一个包含AsyncValidatorFn对象的数组。
异步验证器只需引用我们在模板驱动型表单中构造的验证器工厂函数(checkNameValidator)生成一个AsyncValidatorFn对象的实例即可。

用FormGroup将表单元素组合起来

当表单变得复杂时，组件中的FormControl对象会很多，我们可以用FormGroup对其进行统一管理。 login-form.component.html

<div [formGroup]="info">
  <div>
    <label>Name:</label>
    <input type="text" formControlName="name">
    <div [style.color]="'red'" *ngIf="info.get('name').invalid && (info.get('name').touched || info.get('name').dirty)">
      <p *ngIf="info.get('name').errors.required">Name can not be empty!</p>
      <p *ngIf="info.get('name').errors.checkName">Name is exist!</p>
    </div>
  </div>
  <div>
    <label>Password:</label>
    <input type="password" formControlName="password">
    <div [style.color]="'red'" *ngIf="info.get('password').invalid && (info.get('password').touched || info.get('password').dirty)">
      <p *ngIf="info.get('password').errors.required">password can not be empty!</p>
      <p *ngIf="info.get('password').errors.password">password is illegal!</p>
    </div>
  </div>
  <button type="submit" (click)="onSubmit()">Submit</button>
</div>

login-form.component.ts

import { checkNameValidator } from '../validators/name.validator';
import { PasswordValidator } from '../validators/password.validator';
import { FormControl, FormGroup, Validator, Validators } from '@angular/forms';
import { Component } from '@angular/core';

@Component({
  selector: 'app-login-form',
  templateUrl: './login-form.component.html',
  styleUrls: ['./login-form.component.css']
})
export class LoginFormComponent {
  info:FormGroup = new FormGroup({
    name:new FormControl('jack', Validators.required, checkNameValidator()),
    password:new FormControl('', [Validators.required, PasswordValidator()])
  });

  onSubmit() {
    console.log(this.info.value);
  }
}

构造FormGroup需传入一个包含有FormControl实例的对象。
在模板中可以通过[formGroup]="info"指令，管理一个表单组。
在包含有formGroup指令的元素的子节点上，可以使用formControlName="name"代替[formControl]="name"来控制表单元素，formControlName指令只能在formGroup指令内部使用。
在FormGroup上可以通过info.get('name')获取FormControl实例。
在FormGroup上可以通过this.info.value获取表单组的值。
在FormGroup上可以通过this.info.setValue(newValue)或this.info.patchValue(newValue)设置FormGroup的值，setValue是修改整个FormGroup的值，传入的值必须包含全部的属性，缺少任意一个属性控制台会报错，用patchValue时，可修改部分属性的值。
FormGroup内部可以嵌套FormGroup，如Name可能又包含firstName和lastName，此时我们可以构造嵌套的FormGroup。

<div formGroupName="name">
    <input type="text" formControlName="first">
    <input type="text" formControlName="last">
</div>
info:FormGroup = new FormGroup({
    name: new FormGroup({
      first:new FormControl(),
      last:new FormControl()
    })
});

用FormBuilder简化FormGroup的构造

login-form.component.ts

import { checkNameValidator } from '../validators/name.validator';
import { PasswordValidator } from '../validators/password.validator';
import { FormBuilder, FormControl, FormGroup, Validator, Validators } from '@angular/forms';
import { Component } from '@angular/core';

@Component({
  selector: 'app-login-form',
  templateUrl: './login-form.component.html',
  styleUrls: ['./login-form.component.css']
})
export class LoginFormComponent {
  info:FormGroup;

  constructor(private fb:FormBuilder){
    this.createForm();
  }

  createForm() {
    this.info = this.fb.group({
      name: ['jack', Validators.required, checkNameValidator()],
      password: ['', [Validators.required, PasswordValidator()]]
    });
  }

  onSubmit() {
    console.log(this.info.value);
  }
}

我们需要先在构造函数中注入FormBuilder, 最好新建一个方法来初始化表单，这里我们在createForm方法中初始化表单。
借助FormBuilder我们可以通过参数来构建表单组，参数的结构与使用new基本一致，就不需要重复的写new FormGroup(...)、new FormControl(...)了。

用FormArray处理动态表单

有时候我们可能需要动态表单，如一个用户可能有多个地址，FormArray可以帮助我们处理这种需求。 address.component.html

<div [formGroup]="info">
  <div>
    <div>Address</div>
    <div><button (click)="addAddress()">Add</button></div>
    <div *ngFor="let address of info.get('address').controls;let index=index">
      <p>
        Provience:<input [formControl]="address.get('provience')">
        City:<input [formControl]="address.get('city')">
        <button (click)="removeAddress(index)">Remove</button>
      </p>
    </div>
  </div>
</div>
<button (click)="getInfo()">Get Info</button>

address.component.ts

import { FormArray, FormBuilder, FormControl, FormGroup } from '@angular/forms';
import { Component, OnInit } from '@angular/core';

@Component({
  selector: 'app-address',
  templateUrl: './address.component.html',
  styleUrls: ['./address.component.css']
})
export class AddressComponent{
  address:FormArray;
  info:FormGroup;

  constructor(private fb:FormBuilder) {
    this.createForm();
  }

  /**
   * 初始化表单
   */
  createForm() {
    this.address = this.fb.array([]);
    this.info = this.fb.group({
      address:this.address
    });
  }

  /**
   * 添加地址
   */
  addAddress() {
    this.address.push(new FormGroup({
      provience:new FormControl(),
      city:new FormControl()
    }));
  }

  /**
   * 移除地址
   * @param index 
   */
  removeAddress(index) {
    this.address.removeAt(index);
  }

  /**
   * 获取表单值
   */
  getInfo() {
    console.log(this.info.value);
  }
}

几点说明：

构造FormArray时需传入一个数组，数组里面可以包含FormControl，FormGroup，FormArray。
可以通过push(...)方法往FormArray中添加值。
可以通过removeAt(index)移除FormArray中指定位置的值。
这里是借助FormBuilder.array来构建FormArray，同样我们也可以使用new FormArray([...])来构建表单。

构建 form-error 组件来简化验证信息的展示

从上图可以看到表单里的错误信息的展示结构基本类似，我们需要通过info.get('name')获取到FormControl的实例，然后把FormControl上的验证信息来展示到页面上。当验证项较多时，书写修改都变得很繁琐。我们可以考虑将错误信息的展示提取成一个组件。假设组件需要两个参数：

control是一个FormControl实例，我们可以通过他获取表单元素的有效性和详细的错误信息。
errors是一个数组，包含每一个验证项的名称以及对应的提示信息。格式如下：

[
    {
        name: 'required',
        msg: 'Name can not be empty!',
    },
    {
        name: 'checkName',
        msg: 'Name is exist!'
    }
    ],

组件代码：

form-error.component.html

<div [style.color]="'red'" *ngIf="control.invalid && (control.touched || control.dirty)">
    <div *ngFor="let error of errors">
        <p *ngIf="control.errors[error.name]"></p>
    </div>
</div>

form-error.component.ts

import { FormControl } from '@angular/forms';
import { Component, Input, OnInit } from '@angular/core';

@Component({
  selector: 'app-form-error',
  templateUrl: './form-error.component.html',
  styleUrls: ['./form-error.component.css']
})
export class FormErrorComponent{

  // 表单元素的FormControl实例
  @Input()
  control:FormControl;

  // 包含错误信息的数组
  @Input()
  errors:any [];
}

使用form-error组件简化后的模板 login-form.component.html

<div [formGroup]="info">
  <div>
    <label>Name:</label>
    <input type="text" formControlName="name">
    <app-form-error [control]="info.get('name')" [errors]="errors.name"></app-form-error>
  </div>
  <div>
    <label>Password:</label>
    <input type="password" formControlName="password">
    <app-form-error [control]="info.get('password')" [errors]="errors.password"></app-form-error>
  </div>
  <button type="submit" (click)="onSubmit()">Submit</button>
  <button type="button" (click)="setInfo()">SetInfo</button>
</div>

login-form.component.ts

createForm() {
    this.info = this.fb.group({
      name: ['jack', Validators.required, checkNameValidator()],
      password: ['', [Validators.required, PasswordValidator()]]
    });

    this.errors = {
      name: [{
        name: 'required',
        msg: 'Name can not be empty!',
      },{
        name: 'checkName',
        msg: 'Name is exist!'
      }],
      password: [
        {
          name: 'required',
          msg: 'Password can not be empty!'
        },
        {
          name: 'password',
          msg: 'Password is illegal!'
        }
      ]
    }
  }

构建 `form-widget` 组件来整合每一个表单项

观察使用form-error组件整合后的表单，我们可以看到每一个表单项的结构也是基本类似的，我们需要一个表单控件(Input, Select..)和一个form-error组件。我们可以考虑通过构建一个通用的表单控件组件来循环输出每一个表单元素，这样我们的模板将会进一步精简。构建form-widget组件，我们依赖一些数据：

需要一个FormControl对象，来帮助我们控制表单元素，这可以通过FormGroup的get(...)方法拿到。
需要一个表示组件类型变量，如：text,password,checkbox,radio,select等等，用它来确定表单元素的模板。
由于form-error组件是form-widget组件的子组件，我们也需要能得到errors参数。

组件代码：

form-widget.component.html

<div [ngSwitch]="options.type">
  <div>
    :
  </div>
  <div *ngSwitchCase="'text'">
    <input type="text" [formControl]="control">
  </div>
  <div *ngSwitchCase="'password'">
      <input type="password" [formControl]="control">
  </div>
  <app-form-error [control]="control" [errors]="options.errors"></app-form-error>
</div>

form-widget.component.ts

import { FormControl } from '@angular/forms';
import { Component, Input } from '@angular/core';

@Component({
  selector: 'app-form-widget',
  templateUrl: './form-widget.component.html',
  styleUrls: ['./form-widget.component.css']
})
export class FormWidgetComponent {
  /**
   * 表单控制项
   */
  @Input()
  control;

  /**
   * 组件配置项
   * {
   *    name: '...' // 配置项名称
   *    type: '...' // 表单类型
   *    errors: '...' // 错误提示信息
   * }
   */
  @Input()
  options:{};
}

我们把LoginComponent的配置项调整成如下格式：

login-form.component.ts

  /**
   * 创建表单
   */
  createForm() {
    this.info = this.fb.group({
      name: ['jack', Validators.required, checkNameValidator()],
      password: ['', [Validators.required, PasswordValidator()]]
    });

    this.options = [
      {
        name: 'name',       // 表单控制项的名字，便于我们从formGroup上找到formControl
        type: 'text',       // 表单控制项的类型
        errors: [{          // 错误提示信息
          name: 'required',
          msg: 'Name can not be empty!',
        },{
          name: 'checkName',
          msg: 'Name is exist!'
        }]
      },
      {
        name: 'password',
        type: 'password',
        errors:  [
          {
            name: 'required',
            msg: 'Password can not be empty!'
          },
          {
            name: 'password',
            msg: 'Password is illegal!'
          }
        ]
      }
    ];
  }

login-form.component.html

<div [formGroup]="info">
  <app-form-widget *ngFor="let item of options" [control]="info.get(item.name)" [options]="item"></app-form-widget>
  <button type="submit" (click)="onSubmit()">Submit</button>
  <button type="button" (click)="setInfo()">SetInfo</button>
</div>

这里我们给form-widget组件设置了两个输入参数control和options, options上面包含了控件名称（name）,控件类型（type）,控件错误提示信息（errors）等属性。在模板中我们通过*ngSwitch指令来处理不同的控件类型。

上面调整后的模板已经简化了很多了，接下来我们考虑这样一个问题：现在我们的模板只支持input和password两种类型，怎么样让它支持更多类型呢？

在form-widget组件中，我们使用了ngSwitch指令和ngSwitchCase指令，根据配置项的type值来处理不同的控件类型，对于一些简单的控件，如：select, checkbox, radio等等，我们只需要添加几个ngSwitchCase匹配项就好了，这里很好的完成了我们的需求，但是有几个弊端：

我们难免会有一些复杂的控件，全部加到form-widget组件模板中会使模板变得臃肿。
每次扩展类型，我们都需要修改form-widget组件模板，这是很繁琐的一件事，多人合作开发时也很容易造成冲突。

我们能不能将每一种类型的控件都提取成组件，扩展控件时只需写好组件，form-widget组件根据配置项里的控件类型动态加载组件呢？是可以的，动态加载组件的详细的介绍可以参考angular2文档，Angular 4.x 动态创建组件。

控件代码：

控件基类

widget.base.component.ts

import { Component, Input } from '@angular/core';

@Component({
    selector: 'form-widget-base',
    template: ''
})
export class FormWidgetBaseComponent{
    @Input()
    controls;

    @Input()
    options;
}

密码控件

input.password.component.ts

import { FormWidgetBaseComponent } from '../base/widget.base.component';
import { Component, Input } from '@angular/core';

@Component({
    selector: 'form-widget-password',
    template: `<div *ngIf="control && options">
                    <label>:</label>
                    <input type="password" [formControl]="control">
                </div>`
})
export class FormWidgetPassword extends FormWidgetBaseComponent{
    
}

文本控件

input.text.component.ts

import { FormWidgetBaseComponent } from '../base/widget.base.component';
import { Component, Input } from '@angular/core';

@Component({
    selector: 'form-widget-text',
    template: `<div *ngIf="control && options">
                    <label>:</label>
                    <input type="text" [formControl]="control">
                </div>`
})
export class FormWidgetText extends FormWidgetBaseComponent{

}

form-widget.component.ts

import { FormWidgetPassword } from './widgets/password/input.password.component';
import { FormWidgetText } from './widgets/text/input.text.component';
import { FormErrorComponent } from '../form-error/form-error.component';
import { FormControl } from '@angular/forms';
import { Component, ComponentFactoryResolver, Input, ViewChild, ViewContainerRef } from '@angular/core';


@Component({
  selector: 'app-form-widget',
  templateUrl: './form-widget.component.html',
  styleUrls: ['./form-widget.component.css'],
  entryComponents: [FormWidgetText,FormWidgetPassword,FormErrorComponent]
})
export class FormWidgetComponent {
  /**
   * 表单控制项
   */
  @Input()
  control;

  /**
   * 组件配置项
   * {
   *    name: '...' // 配置项名称
   *    type: '...' // 表单类型
   *    errors: '...' // 错误提示信息
   * }
   */
  @Input()
  options:{};

  /**
   * 组件视图容器
   */
  @ViewChild('widget', {read: ViewContainerRef})
  widget;

  /**
   * 表单控件组件的引用
   */
  controlRef;
  
  /**
   * 错误组件的引用
   */
  errorsRef;

  constructor(private componentFactoryResolver: ComponentFactoryResolver) {
  }

  ngAfterViewInit() {
    setTimeout(() => {
      this.loadComponent();
    }, 0);
  }

  loadComponent() {
    // 加载表单控件
    const controlComponentFactory = this.componentFactoryResolver.resolveComponentFactory(this.options['type']);
    this.controlRef = this.widget.createComponent(controlComponentFactory);
    this.controlRef.instance.control = this.control;
    this.controlRef.instance.options = this.options;
    // 加载错误组件
    const errorsComponentFactory = this.componentFactoryResolver.resolveComponentFactory(FormErrorComponent);
    this.errorsRef = this.widget.createComponent(errorsComponentFactory);
    this.errorsRef.instance.control = this.control;
    this.errorsRef.instance.errors = this.options['errors'];
  }

}

form-widget.component.html

<ng-template #widget></ng-template>

几点说明

在定义控件时，我们首先定义了一个FormWidgetBaseComponent基组件，里面包含了基础的配置项，我们可以使用组件继承来扩展不同的类型，在扩展的组件中就不需要重复定义配置项了，对于一些简单的模板，我们只需要继该组件，然后设置模板即可。关于组件的继承可参考angular2文档，Angular 2 Component Inheritance。
之前配置项中的type是text,password等值。采用动态加载组件的方法，我们需要将type类型改为我们所定义的组件，如：FormWidgetText，FormWidgetPassword等等。
扩展组件的时候，我们只需要实现好组件，然后将其加入到entryComponents即可。

构建dynamic-form组件，通过配置项生成FormGroup，简化表单构建

将构建FormGroup的参数整合进配置项里能让我们根据一个配置项就能构建好表单，进一步简化表单的构建。

我们需要一个转换函数，我们将它定义到一个服务里。 form.service.ts

import { FormBuilder } from '@angular/forms';
import { Injectable } from '@angular/core';

@Injectable()
export class FormService {
    constructor(private fb:FormBuilder) {

    }
    
    /**
     * 根据配置项生成FormGroup
     * @param options 
     */
    transform(options:any []) {
        const group = {};
        options.forEach((option) => {
            if (option.controlType === 'group') {
                group[option.name] = this.transform(option.control);
            } else if (option.controlType === 'array') {
                group[option.name] = this.fb.array(option.control);
            } else {
                group[option.name] = option.control;
            }
        });
        return this.fb.group(group);
    }
}

组件代码：

dynamic-form.component.ts

import { FormService } from '../services/form.service';
import { FormGroup } from '@angular/forms';
import { Component, EventEmitter, Input, OnInit, Output } from '@angular/core';

@Component({
  selector: 'app-dynamic-form',
  templateUrl: './dynamic-form.component.html',
  styleUrls: ['./dynamic-form.component.css']
})
export class DynamicFormComponent {
  group:FormGroup;

  @Input()
  options:any [];

  @Output()
  submitEvent:EventEmitter<any> = new EventEmitter<any>();

  constructor(private formService:FormService) {
    
  }

  ngOnInit() {
    this.group = this.formService.transform(this.options);
  }

  onSubmit() {
    this.submitEvent.emit(this.group.value);
  }
}

dynamic-form.component.html

<div [formGroup]="group">
  <app-form-widget *ngFor="let item of options" [control]="group.get(item.name)" [options]="item"></app-form-widget>
  <button type="submit" (click)="onSubmit()">Submit</button>
</div>

<app-dynamic-form [options]="options" (submitEvent)="onSubmit($event)"></app-dynamic-form>

login-form.component.ts

/**
   * 创建表单
   */
  createForm() {

    // 表单配置项
    this.options = [
      {
        name: 'name',               // 表单控制项的名字，便于我们从formGroup上找到formControl
        control: ['jack', Validators.required, checkNameValidator()], // 表单配置项的构建参数
        type: FormWidgetText,       // 表单控制项的类型
        errors: [{                  // 错误提示信息
          name: 'required',
          msg: 'Name can not be empty!',
        },{
          name: 'checkName',
          msg: 'Name is exist!'
        }]
      },
      ...
    ];
  }

在dynamic-form组件里我们通过Output暴露了一个提交事件的接口，如有需要可以通过这个方法暴露更多接口。自此我们的组件已经基本完成了，我们可以通过一个配置项很快捷的构建表单了。

小结

借助响应式表单，我们能将使用代码实现表单初始化，表单验证，获取表单值等等操作。我们可以用FormControl控制单个表单元素，用FormGroup将表单元素分组，用FormArray处理需要动态添加的表单。在模板中我们只需要展示表单和验证信息即可，从而实现模板和业务逻辑的分离。
通过FormBuilder，我们可以使用配置项来简化响应式表单的构造。
对于结构类似的表单，我们可以考虑构建动态表单组件，来避免重复的劳动，提升开发效率。

 angular2 模板驱动型表单

mao ji

angular2 响应式表单

用FormControl控制表单元素

给FormControl添加验证器

给FormControl添加异步验证器

用FormGroup将表单元素组合起来

用FormBuilder简化FormGroup的构造

用FormArray处理动态表单

构建 form-error 组件来简化验证信息的展示

构建 `form-widget` 组件来整合每一个表单项

使用动态加载组件让form-widget支持更多的控件类型

控件基类

密码控件

文本控件

更新后的form-widget组件

几点说明

构建dynamic-form组件，通过配置项生成FormGroup，简化表单构建

小结

angular2 响应式表单

用FormControl控制表单元素

给FormControl添加验证器

给FormControl添加异步验证器

用FormGroup将表单元素组合起来

用FormBuilder简化FormGroup的构造

用FormArray处理动态表单

构建 form-error 组件来简化验证信息的展示

构建 form-widget 组件来整合每一个表单项

使用动态加载组件让form-widget支持更多的控件类型

控件基类

密码控件

文本控件

更新后的form-widget组件

几点说明

构建dynamic-form组件，通过配置项生成FormGroup，简化表单构建

小结

构建 `form-widget` 组件来整合每一个表单项