ElementRef簡(jiǎn)介

2018-08-28 10:27 更新

查看新版Angular ElementRef 簡(jiǎn)介

Angular 的口號(hào)是:

一套框架,多種平臺(tái)。同時(shí)適用手機(jī)與桌面(One framework.Mobile & desktop.)

即 Angular 是支持開(kāi)發(fā)跨平臺(tái)的應(yīng)用,比如:Web應(yīng)用、移動(dòng)Web應(yīng)用、原生移動(dòng)應(yīng)用和原生桌面應(yīng)用等。

為了能夠支持跨平臺(tái),Angular 通過(guò)抽象層封裝了不同平臺(tái)的差異,統(tǒng)一了 API 接口。如定義了抽象類 Renderer2、抽象類 RendererFactory2 等。此外還定義了以下抽象類:

  • ElementRef
  • TemplateRef
  • ViewRef
  • ComponentRef
  • ViewContainerRef

接下來(lái)我們正式來(lái)介紹本文的主角 - ElementRef

ElementRef

ElementRef 的作用

在應(yīng)用層直接操作 DOM,就會(huì)造成應(yīng)用層與渲染層之間強(qiáng)耦合,導(dǎo)致我們的應(yīng)用無(wú)法運(yùn)行在不同環(huán)境,如 web worker 中,因?yàn)樵?Web Worker 環(huán)境中,是不能直接操作 DOM。有興趣的讀者,可以閱讀一下 Web Workers 中支持的類和方法 這篇文章。通過(guò) ElementRef 我們就可以封裝不同平臺(tái)下視圖層中的 native 元素 (在瀏覽器環(huán)境中,native 元素通常是指 DOM 元素),最后借助于 Angular 提供的強(qiáng)大的依賴注入特性,我們就可以輕松地訪問(wèn)到 native 元素。

ElementRef 的定義

  1. export class ElementRef {
  2. public nativeElement: any;
  3. constructor(nativeElement: any) { this.nativeElement = nativeElement; }
  4. }

ElementRef 的應(yīng)用

我們先來(lái)介紹一下整體需求,我們想在頁(yè)面成功渲染后,獲取頁(yè)面中的 div 元素,并改變?cè)? div 元素的背景顏色。接下來(lái)我們來(lái)一步步,實(shí)現(xiàn)這個(gè)需求。

首先我們要先獲取 div 元素,在文中 "ElementRef 的作用" 部分,我們已經(jīng)提到可以利用 Angular 提供的強(qiáng)大的依賴注入特性,獲取封裝后的 native 元素。在瀏覽器中 native 元素就是 DOM 元素,我們只要先獲取 myapp元素,然后利用 querySelector API 就能獲取頁(yè)面中 div元素。具體代碼如下:

  1. import { Component, ElementRef } from '@angular/core';
  2. @Component({
  3. selector: 'my-app',
  4. template: `
  5. <h1>Welcome to Angular World</h1>
  6. <div>Hello {{ name }}</div>
  7. `,
  8. })
  9. export class AppComponent {
  10. name: string = 'Semlinker';
  11. constructor(private elementRef: ElementRef) {
  12. let divEle = this.elementRef.nativeElement.querySelector('div');
  13. console.dir(divEle);
  14. }
  15. }

運(yùn)行上面代碼,在控制臺(tái)中沒(méi)有出現(xiàn)異常,但是輸出的結(jié)果卻是 null 。什么情況 ? 沒(méi)有拋出異常,我們可以推斷 this.elementRef.nativeElement 這個(gè)對(duì)象是存在,但卻找不到它的子元素,那應(yīng)該是在調(diào)用構(gòu)造函數(shù)的時(shí)候,my-app 元素下的子元素還未創(chuàng)建。那怎么解決這個(gè)問(wèn)題呢 ?沉思中… ,不是有 setTimeout 么,我們?cè)谏晕⒏脑煲幌拢?/p>

  1. constructor(private elementRef: ElementRef) {
  2. setTimeout(() => { // 此處需要使用箭頭函數(shù)哈,你懂的...
  3. let divEle = this.elementRef.nativeElement.querySelector('div');
  4. console.dir(divEle);
  5. }, 0);
  6. }

更新一下代碼,此時(shí)控制臺(tái)成功輸出了 div 。為什么添加個(gè) setTimeout 就能成功獲取到想要的 div 元素呢?此處就不展開(kāi)了,有興趣的讀者可以參考 - What the heck is the event loop anyway? 這個(gè)演講的示例。

問(wèn)題解決了,但感覺(jué)不是很優(yōu)雅 ?有沒(méi)有更好的方案,答案是肯定的。Angular 不是有提供組件生命周期的鉤子,我們可以選擇一個(gè)合適的時(shí)機(jī),然后獲取我們想要的 div 元素。

  1. import { Component, ElementRef, AfterViewInit } from '@angular/core';
  2. @Component({
  3. selector: 'my-app',
  4. template: `
  5. <h1>Welcome to Angular World</h1>
  6. <div>Hello {{ name }}</div>
  7. `,
  8. })
  9. export class AppComponent {
  10. name: string = 'Semlinker';
  11. // 在構(gòu)造函數(shù)中 this.elementRef = elementRef 是可選的,編譯時(shí)會(huì)自動(dòng)賦值
  12. // function AppComponent(elementRef) { this.elementRef = elementRef; }
  13. constructor(private elementRef: ElementRef) { }
  14. ngAfterViewInit() { // 模板中的元素已創(chuàng)建完成
  15. console.dir(this.elementRef.nativeElement.querySelector('div'));
  16. // let greetDiv: HTMLElement = this.elementRef.nativeElement.querySelector('div');
  17. // greetDiv.style.backgroundColor = 'red';
  18. }
  19. }

運(yùn)行一下上面的代碼,我們看到了意料中的 div 元素。我們直接選用 ngAfterViewInit 這個(gè)鉤子,不要問(wèn)我為什么,因?yàn)樗吹米铐樠劭?。不過(guò)我們后面也會(huì)有專門的文章,詳細(xì)分析一下 Angular 2 組件的生命周期。成功取到 div 元素,就剩下的事情就好辦了,直接通過(guò) style 對(duì)象設(shè)置元素的背景顏色。

功能雖然已經(jīng)實(shí)現(xiàn)了,但還有優(yōu)化的空間么?在 Angular 2 Decorators part - 2 文章中我們有談到 Angular 內(nèi)置的屬性裝飾器,如 @ContentChild、 @ContentChildren、@ViewChild、@ViewChildren 等。相信讀者看完后,已經(jīng)猜到我們的優(yōu)化方案了。具體示例如下:

  1. import { Component, ElementRef, ViewChild, AfterViewInit } from '@angular/core';
  2. @Component({
  3. selector: 'my-app',
  4. template: `
  5. <h1>Welcome to Angular World</h1>
  6. <div #greet>Hello {{ name }}</div>
  7. `,
  8. })
  9. export class AppComponent {
  10. name: string = 'Semlinker';
  11. @ViewChild('greet')
  12. greetDiv: ElementRef;
  13. ngAfterViewInit() {
  14. this.greetDiv.nativeElement.style.backgroundColor = 'red';
  15. }
  16. }

是不是感覺(jué)瞬間高大上了,不過(guò)先等等,上面的代碼是不是還有進(jìn)一步的優(yōu)化空間呢 ?我們看到設(shè)置 div 元素的背景,我們是默認(rèn)應(yīng)用的運(yùn)行環(huán)境在是瀏覽器中。前面已經(jīng)介紹了,我們要盡量減少應(yīng)用層與渲染層之間強(qiáng)耦合關(guān)系,從而讓我們應(yīng)用能夠靈活地運(yùn)行在不同環(huán)境。最后我們來(lái)看一下,最終優(yōu)化后的代碼:

  1. import { Component, ElementRef, ViewChild, AfterViewInit, Renderer2 } from '@angular/core';
  2. @Component({
  3. selector: 'app-root',
  4. template: `
  5. <h1>Welcome to Angular World</h1>
  6. <div #greet>Hello {{ name }}</div>
  7. `,
  8. })
  9. export class AppComponent {
  10. name: string = 'Semlinker';
  11. @ViewChild('greet')
  12. greetDiv: ElementRef;
  13. constructor(private elementRef: ElementRef, private renderer: Renderer2) { }
  14. ngAfterViewInit() {
  15. this.renderer.setStyle(this.greetDiv.nativeElement, 'backgroundColor', 'red');
  16. }
  17. }

最后我們通過(guò) renderer 對(duì)象提供的 API 優(yōu)雅地設(shè)置了 div 元素的背景顏色。

我有話說(shuō)

Renderer2 API 還有哪些常用的方法 ?

  1. // packages/core/src/render/api.ts
  2. export abstract class Renderer2 {
  3. // 創(chuàng)建元素
  4. abstract createElement(name: string, namespace?: string|null): any;
  5. // 創(chuàng)建文本元素
  6. abstract createText(value: string): any;
  7. // 創(chuàng)建Comment元素
  8. abstract createComment(value: string): any;
  9. // 設(shè)置元素Property屬性
  10. abstract setProperty(el: any, name: string, value: any): void;
  11. // 設(shè)置元素Attribute屬性
  12. abstract setAttribute(el: any, name: string, value: string,
  13. namespace?: string|null): void;
  14. // 設(shè)置元素Class類
  15. abstract addClass(el: any, name: string): void;
  16. // 設(shè)置元素的樣式
  17. abstract setStyle(el: any, style: string, value: any,
  18. flags?: RendererStyleFlags2): void;
  19. }
以上內(nèi)容是否對(duì)您有幫助:
在線筆記
App下載
App下載

掃描二維碼

下載編程獅App

公眾號(hào)
微信公眾號(hào)

編程獅公眾號(hào)