Angular ElementRef简介及其使用

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 中支持的类和方法][1] 这篇文章。通过 elementref 我们就可以封装不同平台下视图层中的 native 元素 (在浏览器环境中，native 元素通常是指 dom 元素)，最后借助于 angular 提供的强大的依赖注入特性，我们就可以轻松地访问到 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 的应用

我们先来介绍一下整体需求，我们想在页面成功渲染后，获取页面中的 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?][2] 这个演讲的示例。

问题解决了，但感觉不是很优雅 ？有没有更好的方案，答案是肯定的。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 框架内部已经为我们提供了解决方案，它为我们提供了内置的装饰器，如 @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, 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 实例提供的 api 优雅地设置了 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;
}

以上就是本文的全部内容，希望对大家的学习有所帮助，也希望大家多多支持。