Angular 4 ElementRef

47

Angular 的口号是 - "一套框架,多种平台。同时适用手机与桌面 (One framework.Mobile & desktop.)",即 Angular 是支持开发跨平台的应用,比如:Web 应用、移动 Web 应用、原生移动应用和原生桌面应用等。

为了能够支持跨平台,Angular 通过抽象层封装了不同平台的差异,统一了 API 接口。如定义了抽象类 Renderer 、抽象类 RootRenderer 等。此外还定义了以下引用类型:ElementRef、TemplateRef、ViewRef 、ComponentRef 和 ViewContainerRef 等。下面我们就来分析一下 ElementRef 类:

ElementRef的作用

在应用层直接操作 DOM,就会造成应用层与渲染层之间强耦合,导致我们的应用无法运行在不同环境,如 web worker 中,因为在 web worker 环境中,是不能直接操作 DOM。有兴趣的读者,可以阅读一下 Web Workers 中支持的类和方法 这篇文章。通过 ElementRef 我们就可以封装不同平台下视图层中的 native 元素 (在浏览器环境中,native 元素通常是指 DOM 元素),最后借助于 Angular 提供的强大的依赖注入特性,我们就可以轻松地访问到 native 元素。

ElementRef的定义

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

ElementRef的应用

我们先来介绍一下整体需求,我们想在页面成功渲染后,获取页面中的 div 元素,并改变该 div 元素的背景颜色。接下来我们来一步步,实现这个需求。

首先我们要先获取 div 元素,在文中 "ElementRef 的作用" 部分,我们已经提到可以利用 Angular 提供的强大的依赖注入特性,获取封装后的 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);
  }
}

运行上面代码,在控制台中没有出现异常,但是输出的结果却是 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 不是有提供组件生命周期的钩子,我们可以选择一个合适的时机,然后获取我们想要的 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';

  // 在构造函数中 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 组件的生命周期。成功取到 div 元素,就剩下的事情就好办了,直接通过 style 对象设置元素的背景颜色。

功能虽然已经实现了,但还有优化的空间么?在 Angular 2 Decorators part - 2 文章中我们有谈到 Angular 内置的属性装饰器,如 @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';
  }
}

是不是感觉瞬间高大上了,不过先等等,上面的代码是不是还有进一步的优化空间呢 ?我们看到设置 div 元素的背景,我们是默认应用的运行环境在是浏览器中。前面已经介绍了,我们要尽量减少应用层与渲染层之间强耦合关系,从而让我们应用能够灵活地运行在不同环境。最后我们来看一下,最终优化后的代码:

import { Component, ElementRef, ViewChild, AfterViewInit, Renderer } 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: Renderer) { }

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

最后我们通过 renderer 对象提供的 API 优雅地设置了 div 元素的背景颜色。

我有话说

1.Renderer 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;    
}

需要注意的是在 Angular 4.x+ 版本,我们使用 Renderer2 替代 Renderer (Angular V2)。

2.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;
}

总结

本文主要介绍了 ElementRef 的作用和定义,然后通过一个简单的示例,展示了如何一步步优化已有的功能,希望对初学者能有所启发。


如果觉得我的文章对你有用,请随意赞赏
已赞赏

你可能感兴趣的

25 条评论
smile · 2018年08月23日

ngAfterViewInit 这个钩子 是dom 渲染后才出发的 而构造函数 比 ngOinit还早 这个时候 操作dom 肯定是不能的 所以 settimeout 下 可以去看下angular的生命周期

+1 回复

小豆子的牛儿 · 2017年05月11日

https://angular.cn/docs/ts/la...
官方上写的renderer被弃用了。。。。。。。是要使用renderer2了么

回复

semlinker 作者 · 2017年05月11日

是的,4.x要用Renderer2

回复

0

大神,请教下,怎么获取滚动条的高度,

味道在旅途 · 2017年12月13日
雨落 · 2017年05月31日

是向前兼容的吗?

回复

0

是的,内部有做适配哈

semlinker 作者 · 2017年05月31日
慢慢磨成针 · 2017年06月22日

这个真的牛逼,解答了我很多问题

回复

0

呵呵,如果有看不懂的地方,可以提出来哈

semlinker 作者 · 2017年06月22日
想象高原 · 2017年06月25日

很好,有收获!

回复

qzuser · 2017年06月30日

为什么我用了ngAfterViewInit,打印出来还是null呢

回复

0

估计是你使用的姿势不对哈

semlinker 作者 · 2017年06月30日
0

我也遇到这个问题 ....angular6用Renderer2 ,用了ngAfterViewInit,打印出来还是ERROR TypeError: "this.greet is undefined" .....

skandinavia · 2018年07月15日
sulishibaobei · 2017年07月06日

请问renderer和renderer2 用法上有啥区别吗

回复

0
fuchao2012 · 2017年07月28日
0

API改了名字.... 刚刚用了一下

石镇斌 · 2017年08月02日
fuchao2012 · 2017年07月26日

标题改为angular 4 , renderer换成renderer2 吧,从目录过来的

回复

0
semlinker 作者 · 2017年07月26日
0

文章稍微做了更新,谢谢反馈。

semlinker 作者 · 2017年07月26日
道者三 · 2017年09月18日

请问下,如果我要获取到模板的dom结构怎么办,因为第三方必须要dom结构的,所以传入ElementRef就没效果,

回复

0

this.elementRef.nativeElement.innerHTML

semlinker 作者 · 2017年09月18日
happy007 · 2017年10月15日

为什么添加个 setTimeout 就能成功获取到想要的 div 元素呢?

技术博客最好不要买关子啊,我刚好不知道。。。。

虽然大概和react的componentDidMount()类似的东西吧

回复

0

要了解constructor和组件生命周期的关系,constructor就在实例化组件过程中调用并只做创建组件DOM、注入所有必要的依赖,完成输入绑定,注意这里的dom是类似root的根元素(应该可以理解类似react的虚拟dom),并非视图层可操控的dom元素

heiying · 2018年01月05日
Hermion · 2018年09月01日

为什么我的ngAfterViewInit是在constructor之后才调用的,这个时候画面的渲染还没有完成,画面是的ngOnChanges之后才被调出来的

回复

双木枯荣 · 2月27日

angular6,直接用ViewChild('greet'),获取不到ElementRef的。
需要 ViewChild('greet',{read: ElementRef})

回复

马良 · 3月27日

不错的文章

回复

载入中...