Angular 2 ElementRef

Angular 2 的口號是 - "一套框架，多種平臺。同時適用手機與桌面(One framework.Mobile & desktop.)"，即 Angular 2 是支持開發跨平臺的應用，比如：Web應用、移動Web應用、原生移動應用和原生桌面應用等。

為了能夠支持跨平臺，Angular 2 通過抽象層封裝了不同平臺的差異，統一了 API 接口。如定義了抽象類 Renderer 、抽象類 RootRenderer 等。此外還定義了以下引用類型：ElementRef、TemplateRef、ViewRef 、ComponentRef 和 ViewContainerRef 等。下面我們就來分析一下 ElementRef 類：

ElementRef 的作用

在應用層直接操作 DOM，就會造成應用層與渲染層之間強耦合，導致我們的應用無法運行在不同環境，如 web worker 中，因為在 web worker 環境中，是不能直接操作 DOM。有興趣的讀者，可以閱讀一下 Web Workers 中支持的類和方法 這篇文章。通過 ElementRef 我們就可以封裝不同平臺下視圖層中的 native 元素 (在瀏覽器環境中，native 元素通常是指 DOM 元素)，最后借助于 Angular 2 提供的強大的依賴注入特性，我們就可以輕松地訪問到 native 元素。

ElementRef 的定義

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

ElementRef 的應用

我們先來介紹一下整體需求，我們想在頁面成功渲染后，獲取頁面中的 div 元素，并改變該  div  元素的背景顏色。接下來我們來一步步，實現這個需求。

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

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

@Component({  
    selector: 'my-app', 
    template: `
        <h2>Welcome to Angular World</h2>
        <div>Hello {{ name }}</div>  `
})
export class AppComponent {  
    name: string = 'Semlinker';  
    constructor(private elementRef: ElementRef) {   
       let divEle = this.elementRef.nativeElement.querySelector('div');
       console.dir(divEle);
}}

運行上面代碼，在控制臺中沒有出現異常，但是輸出的結果卻是 null 。什么情況 ？ 沒有拋出異常，我們可以推斷  this.elementRef.nativeElement 這個對象是存在，但卻找不到它的子元素，那應該是在調用構造函數的時候，my-app 元素下的子元素還未創建。那怎么解決這個問題呢 ？沉思中… ，不是有 setTimeout 么，我們在稍微改造一下：

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

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

問題解決了，但感覺不是很優雅 ？有沒有更好的方案，答案是肯定的。Angular 2 不是有提供組件生命周期的鉤子，我們可以選擇一個合適的時機，然后獲取我們想要的 div 元素。

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

@Component({  
    selector: 'my-app',  
    template: `
        <h2>Welcome to Angular World</h2>
        <div>Hello {{ name }}</div>  `
})
export class AppComponent {  
 name: string = 'Semlinker';  
    
 // 在構造函數中 this.elementRef = elementRef 是可選的，編譯時會自動賦值  
 // function AppComponent(elementRef) { this.elementRef = elementRef; }  
 constructor(private elementRef: ElementRef) { }   
    
 ngAfterViewInit() { // 模板中的元素已創建完成    
   console.dir(this.elementRef.nativeElement.querySelector('div'));   
   
 // let greetDiv: HTMLElement = this.elementRef.nativeElement.querySelector('div');     
 // greetDiv.style.backgroundColor = 'red'; 
}}

運行一下上面的代碼，我們看到了意料中的 div 元素。我們直接選用 ngAfterViewInit 這個鉤子，不要問我為什么，因為它看得最順眼咯。不過我們后面也會有專門的文章，詳細分析一下 Angular 2 組件的生命周期。成功取到 div 元素，就剩下的事情就好辦了，直接通過 style 對象設置元素的背景顏色。

功能雖然已經實現了，但還有優化的空間么？在 Angular 2 Decorators part - 2 文章中我們有談到 Angular 2 內置的屬性裝飾器，如 @ContentChild、 @ContentChildren、@ViewChild、@ViewChildren 等。相信讀者看完后，已經猜到我們的優化方案了。具體示例如下：

import { Component, ElementRef, ViewChild, AfterViewInit } from '@angular/core';

@Component({ 
   selector: 'my-app',  
   template: `<h2>Welcome to Angular World</h2>    
       <div #greet>Hello {{ name }}</div>  `
})
export class AppComponent {  
   name: string = 'Semlinker'; 
    
   @ViewChild('greet')  greetDiv: ElementRef;  
   ngAfterViewInit() {    
       this.greetDiv.nativeElement.style.backgroundColor  = 'red'; 
   }
}

是不是感覺瞬間高大上了，不過先等等，上面的代碼是不是還有進一步的優化空間呢 ？我們看到設置 div 元素的背景，我們是默認應用的運行環境在是瀏覽器中。前面已經介紹了，我們要盡量減少應用層與渲染層之間強耦合關系，從而讓我們應用能夠靈活地運行在不同環境。最后我們來看一下，最終優化后的代碼：

import { Component, ElementRef, ViewChild, AfterViewInit,
 Renderer } from '@angular/core';
 
@Component({  
    selector: 'my-app',  
    template: `
        <h2>Welcome to Angular World</h2>
        <div #greet>Hello {{ name }}</div> `
})
export class AppComponent {  
    name: string = 'Semlinker'; 
    
    @ViewChild('greet')  greetDiv: ElementRef;  
    
    constructor(private elementRef: ElementRef, private renderer: Renderer) { }  
    
    ngAfterViewInit() {    
    // this.greetDiv.nativeElement.style.backgroundColor  = 'red';    
      this.renderer.setElementStyle(this.greetDiv.nativeElement, 
        'backgroundColor', 'red');  
    }
}

最后我們通過 renderer 對象提供的 API 優雅地設置了 div 元素的背景顏色。

我有話說

1.Render API 還有哪些常用的方法 ？

export abstract class Renderer {  
// 創建元素  abstract createElement(parentElement: any, name: string, 
    debugInfo?: RenderDebugInfo): any;   
     
// 創建文本元素  abstract createText(parentElement: any, value: string,
    debugInfo?: RenderDebugInfo): any;     
    
// 設置文本  abstract setText(renderNode: any, text: string): void;     

// 設置元素Property  abstract setElementProperty(renderElement: any,
     propertyName: string, propertyValue: any): void;      
     
// 設置元素Attribute  abstract setElementAttribute(renderElement: any, 
    attributeName: string, attributeValue: string): void;    
    
// 設置元素的Class  abstract setElementClass(renderElement: any, 
    className: string,    isAdd: boolean): void;        
    
// 設置元素的樣式  abstract setElementStyle(renderElement: any, 
    styleName: string, styleValue: string): void; 
}

總結

本文主要介紹了 ElementRef 的作用和定義，然后通過一個簡單的示例，展示了如何一步步優化已有的功能，希望對初學者能有所啟發。