詳解Angular Forms中自定義ngModel綁定值的方式
在 Angular 應(yīng)用中,我們有兩種方式來(lái)實(shí)現(xiàn)表單綁定——“模板驅(qū)動(dòng)表單”與“響應(yīng)式表單”。這兩種方式通常能夠很好的處理大部分的情況,但是對(duì)于一些特殊的表單控件,例如 input[type=datetime] 、 input[type=file] ,我們需要重寫(xiě)默認(rèn)的表單綁定方式,讓我們綁定的變量不再僅僅只是一個(gè)字符串,而是一個(gè) Date 或者 File 對(duì)象。為了達(dá)成這一目的,我們需要自定義表單控件的 ControlValueAccessor 。
ControlValueAccessor 接口是 Angular Forms API 與 DOM 之間的橋梁,通過(guò)提供不同的 ControlValueAccessor ,我們就可以使用統(tǒng)一的 Angular Forms API 來(lái)操作不同的 HTML 表單元素。
在我們使用 ngModel 或者 formControl 的時(shí)候,這兩個(gè) Directive 會(huì)向 Angular 的依賴(lài)注入容器申請(qǐng)實(shí)現(xiàn)了 ControlValueAccessor 接口的對(duì)象,這是一種典型的面向接口編程的設(shè)計(jì)。例如,如果我們需要為 input[type=file] 提供一個(gè)用來(lái)綁定 File 對(duì)象的 ControlValueAccessor ,只需要在依賴(lài)注入容器中提供一個(gè) FileControlValueAccessor 的實(shí)現(xiàn)就可以了。不過(guò),我們并不想覆蓋其他類(lèi)型 input 元素的 ControlValueAccessor ,因?yàn)槟菢涌隙〞?huì)對(duì)已有代碼造成大范圍的破壞。所以在這里,我們需要使用 Angular 的分層注入能力——在 ElementInjector 中提供 FileControlValueAccessor 。關(guān)于 ElementInjector 更多的內(nèi)容,請(qǐng)看這里 a-curios-case-of-the-host-decorator-and-element-injectors-in-angular 。
下面演示的兩個(gè) Directive 您都可以在這里查看 在線演示 。
首先讓我們來(lái)創(chuàng)建一個(gè) Directive,這個(gè)指令將會(huì)選中 input[type=file][appInputFile] 元素,這樣我們就可以有選擇的為文件選擇器的 ElementInjector 定義新的 Provider。
@Directive({
selector: 'input[type=file][inputFile]', // <1>
providers: [
{
provide: NG_VALUE_ACCESSOR, // <2>
useExisting: forwardRef(() => InputFileDirective), // <3>
multi: true // <4>
}
]
})
export class InputFileDirective implements ControlValueAccessor, OnInit, OnDestroy {
// 當(dāng)文件選擇器選擇的文件發(fā)生改變時(shí)調(diào)用的回調(diào)函數(shù)
onChange: (any) => any;
// 當(dāng)文件選擇器選擇的被操作后調(diào)用的回調(diào)函數(shù)
onTouched: () => any;
// 監(jiān)聽(tīng)宿主元素的 change 事件
@HostListener('change', ['$event.target.files']) onElChange = (files: FileList) => {
this.onChange(files);
};
// 監(jiān)聽(tīng)宿主元素的 blur 事件
@HostListener('blur', []) onElTouched = () => {
this.onTouched();
};
constructor(private el: ElementRef<HTMLInputElement>) { // <5>
}
ngOnInit(): void {
this.el.nativeElement.addEventListener('change', this.listener);
}
// 來(lái)自 ControlValueAccessor 接口,用來(lái)設(shè)置元素的值
writeValue(obj: any): void {
this.el.nativeElement.value = obj;
}
// 來(lái)自 ControlValueAccessor 接口,用來(lái)將一個(gè)函數(shù)注冊(cè)為 onChange 回調(diào)函數(shù)
registerOnChange(fn: any): void {
this.onChange = fn;
}
// 來(lái)自 ControlValueAccessor 接口,用來(lái)將一個(gè)函數(shù)注冊(cè)為 onTouched 回調(diào)函數(shù)
registerOnTouched(fn: any): void {
this.onTouched = fn;
}
// 來(lái)自 ControlValueAccessor 接口,設(shè)置表單元素是否啟用
setDisabledState?(isDisabled: boolean): void {
this.el.nativeElement.disabled = isDisabled;
}
}
上面的代碼片段中你可以看到有幾處類(lèi)似 // <1> 的注釋?zhuān)@是我用來(lái)在下面的文章中引用該行代碼的標(biāo)記,語(yǔ)法借鑒自 ASCIIDoc
- 通過(guò)定義一個(gè)復(fù)合的選擇器,我們可以有選擇的對(duì)
input[type=file]重寫(xiě)ControlValueAccessor ControlValueAccessor的注入 token 是一個(gè)常量 ——NG_VALUE_ACCESSOR- 由于 Directive 的定義在這行代碼的下面,所以需要使用
forwardRef來(lái)引用這個(gè)依賴(lài)的實(shí)現(xiàn)。 - 這里需要將 multiple 設(shè)置為 true,因?yàn)?Angular 默認(rèn)的
ControlValueAccessor就是提供了多個(gè)實(shí)現(xiàn)的。在解析依賴(lài)的時(shí)候,Angular 會(huì)優(yōu)先選擇我們自定義的實(shí)現(xiàn)。 - 為了代碼更加簡(jiǎn)單,我在這里選擇了不利于服務(wù)端渲染的
ElementRef.nativeElement來(lái)讀取原生 HTML 元素的屬性,如果你對(duì)服務(wù)端渲染有需求,你應(yīng)該使用Renderer2來(lái)讀寫(xiě)元素的屬性。
有了這個(gè) Directive,我們就可以在 Angular Forms 中綁定 File 對(duì)象了:
<input type="file" [(ngModel)]="foo.files" inputFile />
Date 類(lèi)型的數(shù)據(jù)也是日常開(kāi)發(fā)中比較頭疼的一個(gè)地方,因?yàn)樵?JSON 中, Date 類(lèi)型往往會(huì)被序列化為字符串,而在前端代碼中,我們又需要將其反序列化為 Date 對(duì)象,最終在頁(yè)面上展示的時(shí)候,我們又需要按照產(chǎn)品需求再將其序列化為制定格式的字符串?,F(xiàn)在,有了 ControlValueAccessor 的幫助,我們就可以實(shí)現(xiàn)讓 input[type=datetime] 與 Date 對(duì)象進(jìn)行雙向綁定的功能,同時(shí)還能夠定制 Date 對(duì)象在輸入框中的顯示格式。
@Directive({
// tslint:disable-next-line:directive-selector
selector: 'input[type=datetime][valueAsDate]',
providers: [
{
provide: NG_VALUE_ACCESSOR,
useExisting: forwardRef(() => DateValueDirective),
multi: true
}
]
})
export class DateValueDirective implements ControlValueAccessor {
/**
* See https://date-fns.org/v2.0.0-alpha.25/docs/format
* 自定義日期展示格式
* @type {string}
* @memberof DateValueDirective
*/
// tslint:disable-next-line:no-input-rename
@Input('valueAsDate') format: string;
private dateValue: Date;
@HostListener('input', ['$event.target.value']) onChange = (_: any) => { };
@HostListener('blur', []) onTouched = () => { };
get element() { return this.elementRef.nativeElement; }
constructor(
private elementRef: ElementRef,
private renderer: Renderer2 // <1>
) { }
parseDate(str: string) {
return parseDate(str, this.format, new Date(), { awareOfUnicodeTokens: true });
}
formatDate(date: Date) {
return formatDate(date, this.format, { awareOfUnicodeTokens: true });
}
/**
* 設(shè)置組件的值的時(shí)候,先把新的值存到一個(gè)成員變量中,然后再把新的值格式化為 string
*/
writeValue(date: Date): void {
this.dateValue = date;
this.renderer.setProperty(this.element, 'value', this.formatDate(date));
}
/**
* 在 input 元素值發(fā)生變化的時(shí)候,先嘗試把變化后的值轉(zhuǎn)換成 Date 對(duì)象
* 如果轉(zhuǎn)換失敗,那么依然使用之前的值
* 否則,將新的值傳遞給回調(diào)函數(shù)
*/
registerOnChange(fn: any): void {
const onChange = (value: string) => {
const date = this.parseDate(value);
if (isValidDate(date)) {
this.dateValue = date;
fn(date);
} else {
fn(this.dateValue);
}
};
this.onChange = onChange;
}
registerOnTouched(fn: any): void {
this.onTouched = fn;
}
setDisabledState?(isDisabled: boolean): void {
this.renderer.setProperty(this.element, 'disabled', isDisabled);
}
}
這里演示了使用 Renderer2 來(lái)讀寫(xiě)元素屬性的操作
整個(gè)指令的內(nèi)容仍然非常簡(jiǎn)單,但是卻能夠?yàn)槲覀兊娜粘i_(kāi)發(fā)帶來(lái)不小的便利,使用了這個(gè)指令后,我們就可以非常容易的為 Date 對(duì)象進(jìn)行雙向綁定。
<input type="datetime" valueAsDate="M/d/yyyy h:mm:ss a" [(ngModel)]="foo.date">
以上就是本文的全部?jī)?nèi)容,希望對(duì)大家的學(xué)習(xí)有所幫助,也希望大家多多支持腳本之家。
- angular4自定義表單控件[(ngModel)]的實(shí)現(xiàn)
- Angularjs之ngModel中的值驗(yàn)證綁定方法
- 解決angular2在雙向數(shù)據(jù)綁定時(shí)[(ngModel)]無(wú)法使用的問(wèn)題
- Angular 2 ngForm中的ngModel、[ngModel]和[(ngModel)]的寫(xiě)法
- 淺談Angular中ngModel的$render
- AngularJS實(shí)踐之使用NgModelController進(jìn)行數(shù)據(jù)綁定
- AngularJS ngModel實(shí)現(xiàn)指令與輸入直接的數(shù)據(jù)通信
相關(guān)文章
深究AngularJS——ng-checked(回寫(xiě):帶真實(shí)案例代碼)
本篇文章主要介紹了深究AngularJS——ng-checked(回寫(xiě):帶真實(shí)案例代碼),具有一定的參考價(jià)值,感興趣的小伙伴們可以參考一下2017-06-06
AngularJS1.X學(xué)習(xí)筆記2-數(shù)據(jù)綁定詳解
本篇文章主要介紹了AngularJS1.X學(xué)習(xí)筆記2-數(shù)據(jù)綁定詳解,具有一定的參考價(jià)值,有興趣的可以了解一下。2017-04-04
Angular?Ngrx?Store應(yīng)用程序狀態(tài)典型示例詳解
這篇文章主要為大家介紹了Angular?Ngrx?Store應(yīng)用程序狀態(tài)典型示例詳解,有需要的朋友可以借鑒參考下,希望能夠有所幫助,祝大家多多進(jìn)步,早日升職加薪2023-07-07
AngularJS入門(mén)教程中SQL實(shí)例詳解
本文主要介紹 AngularJS SQL,這里給大家整理了相關(guān)資料,并提供了實(shí)例代碼,有需要的小伙伴可以參考下2016-07-07
AngularJS基礎(chǔ) ng-focus 指令簡(jiǎn)單示例
本文主要介紹AngularJS ng-focus 指令,這里整理了ng-focus的一些基礎(chǔ)資料,并附一個(gè)實(shí)例代碼,有需要的小伙伴參考下2016-08-08
AngularJS常見(jiàn)過(guò)濾器用法實(shí)例總結(jié)
這篇文章主要介紹了AngularJS常見(jiàn)過(guò)濾器用法,結(jié)合實(shí)例形式總結(jié)分析了AngularJS大小寫(xiě)過(guò)濾器、貨幣過(guò)濾器、日期過(guò)濾器、limitTo過(guò)濾器、orderBy過(guò)濾器及自定義過(guò)濾器使用方法,需要的朋友可以參考下2017-07-07
AngularJS 2.0入門(mén)權(quán)威指南
這篇文章主要介紹了AngularJS 2.0入門(mén)權(quán)威指南的相關(guān)資料,非常不錯(cuò),具有參考借鑒價(jià)值,需要的朋友可以參考下2016-10-10
AngularJS中的指令實(shí)踐開(kāi)發(fā)指南(二)
這篇文章主要介紹了AngularJS中的指令實(shí)踐指南(二)的相關(guān)資料,需要的朋友可以參考下2016-03-03

