Angular開發實務（七）： 跨平台操作DOM及渲染器Renderer2

在《Angular開發實踐（六）：服務端渲染》這篇文章的最後，我們也提到了在服務端渲染中需要牢記的幾件事件，其中就包括不要使用window、 document、 navigator等瀏覽器特有的類型以及直接操作DOM元素。

這樣就引出了 Angular 主要特性之一：橫跨所有平台。透過適當的方法，使用 Angular 建構的應用，可重複使用在多種不同平台的應用上 —— Web、行動 Web、行動應用、原生應用程式和桌面原生應用程式。

為了能夠支援跨平台，Angular 透過抽象層封裝了不同平台的差異。例如定義了抽象類別 Renderer2 、抽象類別 RootRenderer 等。另外也定義了以下參考類型：ElementRef、TemplateRef、ViewRef 、ComponentRef 和 ViewContainerRef 等。透過 模板變數、@ViewChild 等方法取得DOM元素。

為了示範，先定義一個元件DemoComponent：

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

@Component({
    template: `
        <p id="demop" #demop>this is p!</p>
        p的id：{{demop.id}} <!-- p的id：demop -->
    `
})
export class DemoComponent implements AfterViewInit {
    @ViewChild(&#39;demop&#39;) demop: ElementRef; // @ViewChild通过模板变量名获取

    constructor(private renderer: Renderer2) {
    }

    ngAfterViewInit() {
        console.log(&#39;p的id：&#39; + this.demop.nativeElement.id); // p的id：demop
        this.renderer.setStyle(this.demop.nativeElement, &#39;background-color&#39;, &#39;red&#39;); // 通过Renderer2设置p的css样式background-color
    }
}

取得元件中的p

在Angular應用程式中不應該透過原生API 或jQuery 直接取得DOM元素：

let element1 = document.getElementById("demop"); // jQuery获取: $('#demop')

而是應該透過Angular提供的方法來取得DOM元素：

模板變數

<p id="demop" #demop>this is p!</p>
p的id：{{demop.id}} <!-- p的id：demop -->

在元件模板中，我們在p 上定義了#demop 的模板變量，那麼demop 就等於該p 的DOM 對象，因此我們可以透過demop.id 直接取得p 的id。

@ViewChild

@ViewChild('demop') demop: ElementRef; // @ViewChild通过模板变量名获取

ngAfterViewInit() {
    console.log('p的id：' + this.demop.nativeElement.id); // p的id：demop
}

在元件類別中，我們透過@ViewChild 取得到包裝有p 的DOM 物件的ElementRef 對象，ElementRef 定義如下：

class ElementRef<T> {
  constructor(nativeElement: T)
  nativeElement: T
}

因此我們可以在ngAfterViewInit 中透過this.demop.nativeElement 取得到該p 的DOM 對象，然後取得元素的id。

操作元件中的p

在上面透過幾種方式取得到p 的DOM 對象，那麼我們要如果對它進行操作呢（設定樣式、屬性、插入子元素等） ？透過原始API 或 jQuery 肯定是不允許的了。

這樣我們就引出Angular抽象類別 Renderer2 來設定元素樣式、屬性、插入子元素等操作。

Renderer2 的定義如下：

class Renderer2 {
    get data: {...}
    destroyNode: ((node: any) => void) | null
    destroy(): void
    createElement(name: string, namespace?: string | null): any // 创建元素
    createComment(value: string): any // 创建注释元素
    createText(value: string): any // 创建文本元素
    appendChild(parent: any, newChild: any): void // 添加子元素（在最后）
    insertBefore(parent: any, newChild: any, refChild: any): void // 添加子元素（在最前）
    removeChild(parent: any, oldChild: any): void // 移除子元素
    selectRootElement(selectorOrNode: string | any): any // 获取根元素
    parentNode(node: any): any // 获取父元素
    nextSibling(node: any): any // 获取下一个兄弟元素
    setAttribute(el: any, name: string, value: string, namespace?: string | null): void // 设置属性
    removeAttribute(el: any, name: string, namespace?: string | null): void // 移除属性
    addClass(el: any, name: string): void // 添加样式类
    removeClass(el: any, name: string): void // 移除样式类
    setStyle(el: any, style: string, value: any, flags?: RendererStyleFlags2): void // 设置样式
    removeStyle(el: any, style: string, flags?: RendererStyleFlags2): void // 移除样式
    setProperty(el: any, name: string, value: any): void // 设置DOM对象属性，不同于元素属性
    setValue(node: any, value: string): void // 设置元素值
    listen(target: 'window' | 'document' | 'body' | any, eventName: string, callback: (event: any) => boolean | void): () => void // 注册事件
}

因此，我們要改變 p 的背景色，就可以這樣做：

ngAfterViewInit() {
    this.renderer.setStyle(this.demop.nativeElement, 'background-color', 'red'); // 通过Renderer2设置p的css样式background-color
}

                               

在《Angular開發實踐（六）：服務端渲染》這篇文章的最後，我們也提到了在服務端渲染中需要牢記的幾件事件，其中就包括不要使用window、 document、 navigator等瀏覽器特有的類型以及直接操作DOM元素。

這樣就引出了 Angular 主要特性之一：橫跨所有平台。透過適當的方法，使用 Angular 建構的應用，可重複使用在多種不同平台的應用上 —— Web、行動 Web、行動應用、原生應用程式和桌面原生應用程式。

為了能夠支援跨平台，Angular 透過抽象層封裝了不同平台的差異。例如定義了抽象類別 Renderer2 、抽象類別 RootRenderer 等。另外也定義了以下參考類型：ElementRef、TemplateRef、ViewRef 、ComponentRef 和 ViewContainerRef 等。透過 模板變數、@ViewChild 等方法取得DOM元素。

為了示範，先定義一個元件DemoComponent：

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

@Component({
    template: `
        <p id="demop" #demop>this is p!</p>
        p的id：{{demop.id}} <!-- p的id：demop -->
    `
})
export class DemoComponent implements AfterViewInit {
    @ViewChild(&#39;demop&#39;) demop: ElementRef; // @ViewChild通过模板变量名获取

    constructor(private renderer: Renderer2) {
    }

    ngAfterViewInit() {
        console.log(&#39;p的id：&#39; + this.demop.nativeElement.id); // p的id：demop
        this.renderer.setStyle(this.demop.nativeElement, &#39;background-color&#39;, &#39;red&#39;); // 通过Renderer2设置p的css样式background-color
    }
}

取得元件中的p

在Angular應用程式中不應該透過原生API 或jQuery 直接取得DOM元素：

let element1 = document.getElementById("demop"); // jQuery获取: $('#demop')

而是應該透過Angular提供的方法來取得DOM元素：

模板變數

<p id="demop" #demop>this is p!</p>
p的id：{{demop.id}} <!-- p的id：demop -->

在元件模板中，我們在p 上定義了#demop 的模板變量，那麼demop 就等於該p 的DOM 對象，因此我們可以透過demop.id 直接取得p 的id。

@ViewChild

@ViewChild('demop') demop: ElementRef; // @ViewChild通过模板变量名获取

ngAfterViewInit() {
    console.log('p的id：' + this.demop.nativeElement.id); // p的id：demop
}

在元件類別中，我們透過@ViewChild 取得到包裝有p 的DOM 物件的ElementRef 對象，ElementRef 定義如下：

class ElementRef<T> {
  constructor(nativeElement: T)
  nativeElement: T
}

因此我們可以在ngAfterViewInit 中透過this.demop.nativeElement 取得到該p 的DOM 對象，然後取得元素的id。

操作元件中的p

在上面透過幾種方式取得到p 的DOM 對象，那麼我們要如果對它進行操作呢（設定樣式、屬性、插入子元素等） ？透過原始API 或 jQuery 肯定是不允許的了。

這樣我們就引出Angular抽象類別 Renderer2 來設定元素樣式、屬性、插入子元素等操作。

Renderer2 的定義如下：

class Renderer2 {
    get data: {...}
    destroyNode: ((node: any) => void) | null
    destroy(): void
    createElement(name: string, namespace?: string | null): any // 创建元素
    createComment(value: string): any // 创建注释元素
    createText(value: string): any // 创建文本元素
    appendChild(parent: any, newChild: any): void // 添加子元素（在最后）
    insertBefore(parent: any, newChild: any, refChild: any): void // 添加子元素（在最前）
    removeChild(parent: any, oldChild: any): void // 移除子元素
    selectRootElement(selectorOrNode: string | any): any // 获取根元素
    parentNode(node: any): any // 获取父元素
    nextSibling(node: any): any // 获取下一个兄弟元素
    setAttribute(el: any, name: string, value: string, namespace?: string | null): void // 设置属性
    removeAttribute(el: any, name: string, namespace?: string | null): void // 移除属性
    addClass(el: any, name: string): void // 添加样式类
    removeClass(el: any, name: string): void // 移除样式类
    setStyle(el: any, style: string, value: any, flags?: RendererStyleFlags2): void // 设置样式
    removeStyle(el: any, style: string, flags?: RendererStyleFlags2): void // 移除样式
    setProperty(el: any, name: string, value: any): void // 设置DOM对象属性，不同于元素属性
    setValue(node: any, value: string): void // 设置元素值
    listen(target: 'window' | 'document' | 'body' | any, eventName: string, callback: (event: any) => boolean | void): () => void // 注册事件
}

因此，我們想要改變p 的背景色，就可以這樣做：

ngAfterViewInit() {
    this.renderer.setStyle(this.demop.nativeElement, 'background-color', 'red'); // 通过Renderer2设置p的css样式background-color
}

##相關建議：

Angular開發實務（五）：深入解析變更監控#

Angular開發實踐（六）：服務端渲染

Angular開發實踐（一）：環境準備與框架建構

#

以上是Angular開發實務（七）： 跨平台操作DOM及渲染器Renderer2的詳細內容。更多資訊請關注PHP中文網其他相關文章！