angular4自定义表单控件[(ngModel)]的实现

Angular文档中描述到这里，就中止了。刚好我要定制一个模拟radio的组件，只能如文档所说，依葫芦画瓢实现 ControlValueAccessor。

ControlValueAccessor接口

简而言之，实现了这个接口的组件，就可以使用 Angular forms API，比如[(ngModel)] 。

interface ControlValueAccessor { 
 writeValue(obj: any): void
 registerOnChange(fn: any): void
 registerOnTouched(fn: any): void
 setDisabledState(isDisabled: boolean)?: void
}

实现ControlValueAccessor步骤

模仿primeng中的自定义radio组件，写了一个简单的自定义radio组件。

完整demo代码如下：

import { NgModule, Component, Input, Output, ElementRef, OnInit, EventEmitter, forwardRef, ViewChild, ChangeDetectorRef } from '@angular/core';
import { CommonModule } from '@angular/common';
import { NG_VALUE_ACCESSOR, ControlValueAccessor } from '@angular/forms';

const RADIO_VALUE_ACCESSOR: any = {
 provide: NG_VALUE_ACCESSOR,
 useExisting: forwardRef(() => PRadioComponent),
 multi: true
};

@Component({
 selector: 'app-p-radio',
 template: `
 <div class="p-radio">
 <label class="radio-label" (click)="select()" *ngIf="label">
 <div class="name" [class.checked-name]="rb.checked">{{label}}</div>
 </label>
 <div class="helper-hidden-accessible">
 <input #rb type="radio" [attr.name]="name" [attr.value]="value" [checked]="checked">
 </div>
 <div class="radio-md" (click)="handleClick()">
 <div class="radio-icon " [class.radio-checked]="rb.checked">
 <div class="radio-inner"></div>
 </div>
 </div>
 </div>
 `,
 styleUrls: ['./p-radio.component.scss'],
 providers: [RADIO_VALUE_ACCESSOR]
})
export class PRadioComponent implements ControlValueAccessor {

 @Input() name: string;
 @Input() label: string;
 @Input() value: string;
 checked: boolean;

 @ViewChild('rb') inputViewChild: ElementRef;
 @Output() pRadioChange: EventEmitter<any> = new EventEmitter();
 onModelChange: Function = () => { };

 constructor(
 private cd: ChangeDetectorRef
 ) { }

 // model view -> view value
 writeValue(value: any): void {
 if (value) {
 this.checked = (value === this.value);
 if (this.inputViewChild.nativeElement) {
 this.inputViewChild.nativeElement.checked = this.checked;
 }
 this.cd.markForCheck();
 }
 }

 // view value ->model value
 registerOnChange(fn: Function): void {
 this.onModelChange = fn;
 }

 registerOnTouched(fn: Function): void { }

 handleClick() {
 this.select();
 }

 select() {
 this.inputViewChild.nativeElement.checked = !this.inputViewChild.nativeElement.checked;
 this.checked = !this.checked;
 if (this.checked) {
 this.onModelChange(this.value); // 同步view value 和 model value
 } else {
 this.onModelChange(null);
 }
 this.pRadioChange.emit(null);
 }

}

@NgModule({
 imports: [CommonModule],
 exports: [PRadioComponent],
 declarations: [PRadioComponent]
})

export class RadioButtonModule { }

方法何时被调用？

writeValue(obj: any): void

API中提到 (model -> view) 时，writeValue() 会被调用。
model value 和 view value分别指什么？
举个调用PRadioComponent的例子：

代码如下:<app-p-radio [value]="'1'" [label]="'text1'" [(ngModel)]="checkedValue"></app-p-radio>

这里checkedValue属性就是model value，view value 为PRadioComponent内部的某个属性（PRadioComponent中定义为this.value）。

当model view（checkedValue）发生改变时，PRadioComponent中的writeValue(obj: any)就会被调用，参数为当前model value（checkedValue）的值，在函数中将参数值赋给内部的view value，从而实现(model -> view)。接受到model value的值后，改变PRadioComponent的UI显示。

registerOnChange(fn: any): void

这个方法的作用是同步 view value 和 model value (view -> model)，

 registerOnChange(fn: Function): void {
 this.onModelChange = fn;
 }

调用this.onModelChange()时候，将view value当作参数传入此方法中，即完成了同步，此例子中this.onModelChange(this.value);。

上面两种方法是相对的：

registerOnTouched(fn: any): void

setDisabledState(isDisabled: boolean)?: void

目的只为在控件中简单的使用[(ngModel)]，所以这两个方法没有用到。registerOnTouched(fn: any)必须实现，所以定义了一个空函数。

实际效果

初始值为'a'，点击改变view value，在Angury调试工具中看到值改为'b'。然后在调试工具中将checkedValue改为'a'，视图发生了改变。可见，完成了数据的双向绑定。