动态表单

有时候手动编写和维护表单所需工作量和时间会过大。特别是在需要编写大量表单时。表单都很相似,而且随着业务和监管需求的迅速变化,表单也要随之变化,这样维护的成本过高。

基于业务对象模型的元数据,动态创建表单可能会更划算。

在此烹饪宝典中,我们会展示如何利用formGroup来动态渲染一个简单的表单,包括各种控件类型和验证规则。 这个起点很简陋,但可以在这个基础上添加丰富多彩的问卷问题、更优美的渲染以及更卓越的用户体验。

在本例中,我们使用动态表单,为正在找工作的英雄们创建一个在线申请表。英雄管理局会不断修改申请流程,我们要在不修改应用代码的情况下,动态创建这些表单。

目录

Contents

参见live example / downloadable example

程序启动

让我们从创建一个名叫AppModuleNgModule开始。

这个烹饪书使用响应式表单

响应式表单属于另外一个叫做ReactiveFormsModuleNgModule,所以,为了使用响应式表单类的指令,我们得从@angular/forms库中引入ReactiveFormsModule模块。

我们在main.ts中启动AppModule

  1. import { BrowserModule } from '@angular/platform-browser';
  2. import { ReactiveFormsModule } from '@angular/forms';
  3. import { NgModule } from '@angular/core';
  4. import { AppComponent } from './app.component';
  5. import { DynamicFormComponent } from './dynamic-form.component';
  6. import { DynamicFormQuestionComponent } from './dynamic-form-question.component';
  7. @NgModule({
  8. imports: [ BrowserModule, ReactiveFormsModule ],
  9. declarations: [ AppComponent, DynamicFormComponent, DynamicFormQuestionComponent ],
  10. bootstrap: [ AppComponent ]
  11. })
  12. export class AppModule {
  13. constructor() {
  14. }
  15. }

问卷问题模型

第一步是定义一个对象模型,用来描述所有表单功能需要的场景。英雄的申请流程涉及到一个包含很多问卷问题的表单。问卷问题是最基础的对象模型。

下面是我们建立的最基础的问卷问题基类,名叫QuestionBase

src/app/question-base.ts

  1. export class QuestionBase<T>{
  2. value: T;
  3. key: string;
  4. label: string;
  5. required: boolean;
  6. order: number;
  7. controlType: string;
  8. constructor(options: {
  9. value?: T,
  10. key?: string,
  11. label?: string,
  12. required?: boolean,
  13. order?: number,
  14. controlType?: string
  15. } = {}) {
  16. this.value = options.value;
  17. this.key = options.key || '';
  18. this.label = options.label || '';
  19. this.required = !!options.required;
  20. this.order = options.order === undefined ? 1 : options.order;
  21. this.controlType = options.controlType || '';
  22. }
  23. }

在这个基础上,我们派生出两个新类TextboxQuestionDropdownQuestion,分别代表文本框和下拉框。这么做的初衷是,表单能动态绑定到特定的问卷问题类型,并动态渲染出合适的控件。

TextboxQuestion可以通过type属性来支持多种HTML5元素类型,比如文本、邮件、网址等。

src/app/question-textbox.ts

import { QuestionBase } from './question-base';

export class TextboxQuestion extends QuestionBase<string> {
  controlType = 'textbox';
  type: string;

  constructor(options: {} = {}) {
    super(options);
    this.type = options['type'] || '';
  }
}

DropdownQuestion表示一个带可选项列表的选择框。

src/app/question-dropdown.ts

import { QuestionBase } from './question-base';

export class DropdownQuestion extends QuestionBase<string> {
  controlType = 'dropdown';
  options: {key: string, value: string}[] = [];

  constructor(options: {} = {}) {
    super(options);
    this.options = options['options'] || [];
  }
}

接下来,我们定义了QuestionControlService,一个可以把问卷问题转换为FormGroup的服务。 简而言之,这个FormGroup使用问卷模型的元数据,并允许我们设置默认值和验证规则。

src/app/question-control.service.ts

import { Injectable }   from '@angular/core';
import { FormControl, FormGroup, Validators } from '@angular/forms';

import { QuestionBase } from './question-base';

@Injectable()
export class QuestionControlService {
  constructor() { }

  toFormGroup(questions: QuestionBase<any>[] ) {
    let group: any = {};

    questions.forEach(question => {
      group[question.key] = question.required ? new FormControl(question.value || '', Validators.required)
                                              : new FormControl(question.value || '');
    });
    return new FormGroup(group);
  }
}

问卷表单组件

现在我们已经有一个定义好的完整模型了,接着就可以开始创建一个展现动态表单的组件。

DynamicFormComponent是表单的主要容器和入口点。

  1. <div>
  2. <form (ngSubmit)="onSubmit()" [formGroup]="form">
  3. <div *ngFor="let question of questions" class="form-row">
  4. <df-question [question]="question" [form]="form"></df-question>
  5. </div>
  6. <div class="form-row">
  7. <button type="submit" [disabled]="!form.valid">Save</button>
  8. </div>
  9. </form>
  10. <div *ngIf="payLoad" class="form-row">
  11. <strong>Saved the following values</strong><br>{{payLoad}}
  12. </div>
  13. </div>

它代表了问卷问题列表,每个问题都被绑定到一个<df-question>组件元素。 <df-question>标签匹配到的是组件DynamicFormQuestionComponent,该组件的职责是根据各个问卷问题对象的值来动态渲染表单控件。

  1. <div [formGroup]="form">
  2. <label [attr.for]="question.key">{{question.label}}</label>
  3. <div [ngSwitch]="question.controlType">
  4. <input *ngSwitchCase="'textbox'" [formControlName]="question.key"
  5. [id]="question.key" [type]="question.type">
  6. <select [id]="question.key" *ngSwitchCase="'dropdown'" [formControlName]="question.key">
  7. <option *ngFor="let opt of question.options" [value]="opt.key">{{opt.value}}</option>
  8. </select>
  9. </div>
  10. <div class="errorMessage" *ngIf="!isValid">{{question.label}} is required</div>
  11. </div>

请注意,这个组件能代表模型里的任何问题类型。目前,还只有两种问题类型,但可以添加更多类型。可以用ngSwitch决定显示哪种类型的问题。

在这两个组件中,我们依赖Angular的formGroup来把模板HTML和底层控件对象连接起来,该对象从问卷问题模型里获取渲染和验证规则。

formControlNameformGroup是在ReactiveFormsModule中定义的指令。我们之所以能在模板中使用它们,是因为我们往AppModule中导入了ReactiveFormsModule

问卷数据

DynamicForm期望得到一个问题列表,该列表被绑定到@Input() questions属性。

QuestionService会返回为工作申请表定义的那组问题列表。在真实的应用程序环境中,我们会从数据库里获得这些问题列表。

关键是,我们完全根据QuestionService返回的对象来控制英雄的工作申请表。 要维护这份问卷,只要非常简单的添加、更新和删除questions数组中的对象就可以了。

src/app/question.service.ts

  1. import { Injectable } from '@angular/core';
  2. import { DropdownQuestion } from './question-dropdown';
  3. import { QuestionBase } from './question-base';
  4. import { TextboxQuestion } from './question-textbox';
  5. @Injectable()
  6. export class QuestionService {
  7. // Todo: get from a remote source of question metadata
  8. // Todo: make asynchronous
  9. getQuestions() {
  10. let questions: QuestionBase<any>[] = [
  11. new DropdownQuestion({
  12. key: 'brave',
  13. label: 'Bravery Rating',
  14. options: [
  15. {key: 'solid', value: 'Solid'},
  16. {key: 'great', value: 'Great'},
  17. {key: 'good', value: 'Good'},
  18. {key: 'unproven', value: 'Unproven'}
  19. ],
  20. order: 3
  21. }),
  22. new TextboxQuestion({
  23. key: 'firstName',
  24. label: 'First name',
  25. value: 'Bombasto',
  26. required: true,
  27. order: 1
  28. }),
  29. new TextboxQuestion({
  30. key: 'emailAddress',
  31. label: 'Email',
  32. type: 'email',
  33. order: 2
  34. })
  35. ];
  36. return questions.sort((a, b) => a.order - b.order);
  37. }
  38. }

最后,在AppComponent里显示出表单。

app.component.ts

  1. import { Component } from '@angular/core';
  2. import { QuestionService } from './question.service';
  3. @Component({
  4. selector: 'my-app',
  5. template: `
  6. <div>
  7. <h2>Job Application for Heroes</h2>
  8. <dynamic-form [questions]="questions"></dynamic-form>
  9. </div>
  10. `,
  11. providers: [QuestionService]
  12. })
  13. export class AppComponent {
  14. questions: any[];
  15. constructor(service: QuestionService) {
  16. this.questions = service.getQuestions();
  17. }
  18. }

动态模板

在这个例子中,虽然我们是在为英雄的工作申请表建模,但是除了QuestionService返回的那些对象外,没有其它任何地方是与英雄有关的。

这点非常重要,因为只要与问卷对象模型兼容,就可以在任何类型的调查问卷中复用这些组件。 这里的关键是用到元数据的动态数据绑定来渲染表单,对问卷问题没有任何硬性的假设。除控件的元数据外,还可以动态添加验证规则。

表单验证通过之前,保存按钮是禁用的。验证通过后,就可以点击保存按钮,程序会把当前值渲染成JSON显示出来。 这表明任何用户输入都被传到了数据模型里。至于如何储存和提取数据则是另一话题了。

完整的表单是这样的:

Dynamic-Form

回到顶部