快捷導(dǎo)航

Angular ElementRef簡介及其使用

更新時(shí)間：2018年10月01日 11:29:09 作者：前端修仙之路

這篇文章主要介紹了Angular ElementRef簡介及其使用，小編覺得挺不錯(cuò)的，現(xiàn)在分享給大家，也給大家做個(gè)參考。一起跟隨小編過來看看吧

Angular 的口號是 - “一套框架，多種平臺。同時(shí)適用手機(jī)與桌面 (One framework.Mobile & desktop.)”，即 Angular 是支持開發(fā)跨平臺的應(yīng)用，比如：Web 應(yīng)用、移動(dòng) Web 應(yīng)用、原生移動(dòng)應(yīng)用和原生桌面應(yīng)用等。

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

下面我們就來分析一下 ElementRef 類：

ElementRef 的作用

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

ElementRef 的定義

// angular-master/packages/core/src/linker/element_ref.ts
export class ElementRef<T = any> {
 public nativeElement: T;
 constructor(nativeElement: T) { this.nativeElement = nativeElement; }
}

ElementRef 的應(yīng)用

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

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

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

@Component({
 selector: 'my-app',
 template: `
  <h1>Welcome to Angular World</h1>
  <div>Hello {{ name }}</div>
 `,
})
export class AppComponent {
 name: string = 'Semlinker';

 constructor(private elementRef: ElementRef) {
  let divEle = this.elementRef.nativeElement.querySelector('div');
  console.dir(divEle);
 }
}

運(yùn)行上面代碼，在控制臺中沒有出現(xiàn)異常，但是輸出的結(jié)果卻是 null 。什么情況？沒有拋出異常，我們可以推斷 this.elementRef.nativeElement 這個(gè)對象是存在，但卻找不到它的子元素，那應(yīng)該是在調(diào)用構(gòu)造函數(shù)的時(shí)候，my-app 元素下的子元素還未創(chuàng)建。

那怎么解決這個(gè)問題呢？沉思中… ，不是有 setTimeout 么，我們在稍微改造一下：

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

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

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

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

@Component({
 selector: 'my-app',
 template: `
  <h1>Welcome to Angular World</h1>
  <div>Hello {{ name }}</div>
 `,
})
export class AppComponent {

 name: string = 'Semlinker';

 // 在構(gòu)造函數(shù)中 this.elementRef = elementRef 是可選的，編譯時(shí)會自動(dòng)賦值
 // function AppComponent(elementRef) { this.elementRef = elementRef; }
 constructor(private elementRef: ElementRef) { } 

 ngAfterViewInit() { // 模板中的元素已創(chuàng)建完成
  console.dir(this.elementRef.nativeElement.querySelector('div'));
  // let greetDiv: HTMLElement = this.elementRef.nativeElement.querySelector('div'); 
  // greetDiv.style.backgroundColor = 'red';
 }
}

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

功能雖然已經(jīng)實(shí)現(xiàn)了，但還有優(yōu)化的空間么？當(dāng)然有咯！其實(shí)在 Angular 框架內(nèi)部已經(jīng)為我們提供了解決方案，它為我們提供了內(nèi)置的裝飾器，如 @ContentChild、 @ContentChildren、@ViewChild、@ViewChildren 等。

具體使用示例如下：

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

@Component({
 selector: 'my-app',
 template: `
  <h1>Welcome to Angular World</h1>
  <div #greet>Hello {{ name }}</div>
 `,
})
export class AppComponent {
 name: string = 'Semlinker';

 @ViewChild('greet')
 greetDiv: ElementRef;

 ngAfterViewInit() {
  this.greetDiv.nativeElement.style.backgroundColor = 'red';
 }
}

是不是感覺瞬間高大上了，不過先等等，上面的代碼是不是還有進(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)境。

最后我們來看一下，最終優(yōu)化后的代碼：

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

@Component({
 selector: 'my-app',
 template: `
  <h1>Welcome to Angular World</h1>
  <div #greet>Hello {{ name }}</div>
 `,
})
export class AppComponent {
 name: string = 'Semlinker';

 @ViewChild('greet')
 greetDiv: ElementRef;

 constructor(private elementRef: ElementRef, private renderer: Renderer2) { }

 ngAfterViewInit() {
  // this.greetDiv.nativeElement.style.backgroundColor = 'red';
  this.renderer.setStyle(this.greetDiv.nativeElement, 'backgroundColor', 'red');
 }
}

最后我們通過 Renderer2 實(shí)例提供的 API 優(yōu)雅地設(shè)置了 div 元素的背景顏色。

我有話說

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

export abstract class Renderer2 {
 abstract createElement(name: string, namespace?: string|null): any;
 abstract createComment(value: string): any;
 abstract createText(value: string): any;
 abstract setAttribute(el: any, name: string, value: string,
  namespace?: string|null): void;
 abstract removeAttribute(el: any, name: string, namespace?: string|null): void;
 abstract addClass(el: any, name: string): void;
 abstract removeClass(el: any, name: string): void;
 abstract setStyle(el: any, style: string, value: any, 
  flags?: RendererStyleFlags2): void;
 abstract removeStyle(el: any, style: string, flags?: RendererStyleFlags2): void;
 abstract setProperty(el: any, name: string, value: any): void;
 abstract setValue(node: any, value: string): void;
 abstract listen(
   target: 'window'|'document'|'body'|any, eventName: string,
   callback: (event: any) => boolean | void): () => void;
}

以上就是本文的全部內(nèi)容，希望對大家的學(xué)習(xí)有所幫助，也希望大家多多支持腳本之家。

您可能感興趣的文章: