# 生命周期钩子

当 Angular 实例化组件类并渲染组件视图及其子视图时,组件实例的生命周期就开始了。生命周期一直伴随着变更检测,Angular 会检查数据绑定属性何时发生变化,并按需更新视图和组件实例。当 Angular 销毁组件实例并从 DOM 中移除它渲染的模板时,生命周期就结束了。当 Angular 在执行过程中创建、更新和销毁实例时,指令就有了类似的生命周期。

你的应用可以使用生命周期钩子方法来触发组件或指令生命周期中的关键事件,以初始化新实例,需要时启动变更检测,在变更检测过程中响应更新,并在删除实例之前进行清理。

# 前提条件

在使用生命周期钩子之前,你应该对这些内容有一个基本的了解:

  • TypeScript 编程

  • Angular 应用设计基础,就像 Angular 的基本概念 中所讲的那样

# 响应生命周期事件

可以通过实现一个或多个 Angular core库中定义的生命周期钩子接口来响应组件或指令生命周期中的事件。这些钩子让你有机会在适当的时候对组件或指令实例进行操作,比如 Angular 创建、更新或销毁这个实例时。

每个接口都有唯一的一个钩子方法,它们的名字是由接口名再加上 ng前缀构成的。比如,OnInit接口的钩子方法叫做 ngOnInit()。如果你在组件或指令类中实现了这个方法,Angular 就会在首次检查完组件或指令的输入属性后,紧接着调用它。

peek-a-boo.directive.ts (excerpt)

@Directive({selector: '[appPeekABoo]'})
export class PeekABooDirective implements OnInit {
  constructor(private logger: LoggerService) { }

  // implement OnInit's `ngOnInit` method
  ngOnInit() {
    this.logIt('OnInit');
  }

  logIt(msg: string) {
    this.logger.log(`#${nextId++} ${msg}`);
  }
}

你不必实现所有生命周期钩子,只要实现你需要的那些就可以了。

# 生命周期的顺序

当你的应用通过调用构造函数来实例化一个组件或指令时,Angular 就会调用那个在该实例生命周期的适当位置实现了的那些钩子方法。

Angular 会按以下顺序执行钩子方法。可以用它来执行以下类型的操作。

钩子方法 Hook method 用途 Purpose 时机 Timing
ngOnChanges() 当 Angular 设置或重新设置数据绑定的输入属性时响应。该方法接受当前和上一属性值的 SimpleChanges 对象 注意: 这发生得比较频繁,所以你在这里执行的任何操作都会显著影响性能。 欲知详情,参阅本文档的使用变更检测钩子。 如果组件绑定过输入属性,那么在 ngOnInit() 之前以及所绑定的一个或多个输入属性的值发生变化时都会调用。 注意: 如果你的组件没有输入属性,或者你使用它时没有提供任何输入属性,那么框架就不会调用 ngOnChanges()。
ngOnInit() 在 Angular 第一次显示数据绑定和设置指令/组件的输入属性之后,初始化指令/组件。欲知详情,参阅本文档中的初始化组件或指令。 在第一轮 ngOnChanges() 完成之后调用,只调用一次。而且即使没有调用过 ngOnChanges(),也仍然会调用 ngOnInit()(比如当模板中没有绑定任何输入属性时)。
ngDoCheck() 检测,并在发生 Angular 无法或不愿意自己检测的变化时作出反应。欲知详情和范例,参阅本文档中的自定义变更检测。 紧跟在每次执行变更检测时的 ngOnChanges() 和 首次执行变更检测时的 ngOnInit() 后调用。
ngAfterContentInit() 当 Angular 把外部内容投影进组件视图或指令所在的视图之后调用。 欲知详情和范例,参阅本文档中的响应内容中的变更。 第一次 ngDoCheck() 之后调用,只调用一次。
ngAfterContentChecked() 每当 Angular 检查完被投影到组件或指令中的内容之后调用。 欲知详情和范例,参阅本文档中的响应被投影内容的变更。 ngAfterContentInit() 和每次 ngDoCheck() 之后调用。
ngAfterViewInit() 当 Angular 初始化完组件视图及其子视图或包含该指令的视图之后调用。 欲知详情和范例,参阅本文档中的响应视图变更。 第一次 ngAfterContentChecked() 之后调用,只调用一次。
ngAfterViewChecked() 每当 Angular 做完组件视图和子视图或包含该指令的视图的变更检测之后调用。 ngAfterViewInit() 和每次 ngAfterContentChecked() 之后调用。
ngOnDestroy() 每当 Angular 每次销毁指令/组件之前调用并清扫。在这儿反订阅可观察对象和分离事件处理器,以防内存泄漏。欲知详情,参阅本文档中的在实例销毁时进行清理。 在 Angular 销毁指令或组件之前立即调用。

# 生命周期范例

现场演练 / 下载范例 通过在受控于根组件 AppComponent的一些组件上进行的一系列练习,演示了生命周期钩子的运作方式。 每一个例子中,父组件都扮演了子组件测试台的角色,以展示出一个或多个生命周期钩子方法。

下表列出了这些练习及其简介。范例代码也用来阐明后续各节的一些特定任务。

组件 Component 详情 Details
Peek-a-boo 展示每个生命周期钩子,每个钩子方法都会在屏幕上显示一条日志。
Spy 展示了如何在自定义指令中使用生命周期钩子。SpyDirective 实现了 ngOnInit() 和 ngOnDestroy() 钩子,并且使用它们来观察和汇报一个元素何时进入或离开当前视图。
OnChanges 演示了每当组件的输入属性之一发生变化时,Angular 如何调用 ngOnChanges() 钩子。并且演示了如何解释传给钩子方法的 changes 对象。
DoCheck 实现了一个 ngDoCheck() 方法,通过它可以自定义变更检测逻辑。监视该钩子把哪些变更记录到了日志中,观察 Angular 以什么频度调用这个钩子。
AfterView 显示 Angular 中的视图所指的是什么。演示了 ngAfterViewInit() 和 ngAfterViewChecked() 钩子。
AfterContent 展示如何把外部内容投影进组件中,以及如何区分“投影进来的内容”和“组件的子视图”。演示了 ngAfterContentInit() 和 ngAfterContentChecked() 钩子。
Counter 演示了一个组件和一个指令的组合,它们各自有自己的钩子。

# 初始化组件或指令

使用 ngOnInit()方法执行以下初始化任务。

初始化任务 Initialization tasks 详情 Details
在构造函数外部执行复杂的初始化Perform complex initializations outside of the constructor 组件的构造应该既便宜又安全。比如,你不应该在组件构造函数中获取数据。当在测试中创建组件时或者决定显示它之前,你不应该担心新组件会尝试联系远程服务器。 ngOnInit() 是组件获取初始数据的好地方。比如,英雄之旅教程。
在 Angular 设置好输入属性之后设置组件Set up the component after Angular sets the input properties 构造函数应该只把初始局部变量设置为简单的值。 请记住,只有在构造完成之后才会设置指令的数据绑定输入属性。如果要根据这些属性对指令进行初始化,请在运行 ngOnInit() 时设置它们。 ngOnChanges() 方法是你能访问这些属性的第一次机会。Angular 会在调用 ngOnInit() 之前调用 ngOnChanges(),而且之后还会调用多次。但它只调用一次 ngOnInit()。

# 在实例销毁时进行清理

把清理逻辑放进 ngOnDestroy()中,这个逻辑就必然会在 Angular 销毁该指令之前运行。

这里是释放资源的地方,这些资源不会自动被垃圾回收。如果你不这样做,就存在内存泄漏的风险。

  • 取消订阅可观察对象和 DOM 事件。

  • 停止 interval 计时器。

  • 反注册该指令在全局或应用服务中注册过的所有回调。

ngOnDestroy()方法也可以用来通知应用程序的其它部分,该组件即将消失。

# 一般性例子

下面的例子展示了各个生命周期事件的调用顺序和相对频率,以及如何在组件和指令中单独使用或同时使用这些钩子。

# 所有生命周期事件的顺序和频率

为了展示 Angular 如何以预期的顺序调用钩子,PeekABooComponent演示了一个组件中的所有钩子。

实际上,你很少会(几乎永远不会)像这个演示中一样实现所有这些接口。

下列快照反映了用户单击 Create...按钮,然后单击 Destroy...按钮后的日志状态。

Peek-a-boo 日志信息的日志和所规定的钩子调用顺序是一致的:

钩子顺序 Hook order 日志信息 Log message
1 OnChanges
2 OnInit
3 DoCheck
4 AfterContentInit
5 AfterContentChecked
6 AfterViewInit
7 AfterViewChecked
8 DoCheck
9 AfterContentChecked
10 AfterViewChecked
11 OnDestroy

注意,该日志确认了在创建期间那些输入属性(这里是 name属性)没有被赋值。这些输入属性要等到 onInit()中才可用,以便做进一步的初始化。

如果用户点击Update Hero按钮,就会看到另一个 OnChanges和至少两组 DoCheckAfterContentCheckedAfterViewChecked钩子。注意,这三种钩子被触发了很多次,所以让它们的逻辑尽可能保持精简是非常重要的!。

# 使用指令来监视 DOM

这个 Spy例子演示了如何在指令和组件中使用钩子方法。SpyDirective实现了两个钩子 ngOnInit()ngOnDestroy(),以便发现被监视的元素什么时候位于当前视图中。

这个模板将 SpyDirective应用到由父组件 SpyComponent管理的 ngFor内的 <div>中。

该例子不执行任何初始化或清理工作。它只是通过记录指令本身的实例化时间和销毁时间来跟踪元素在视图中的出现和消失。

像这样的间谍指令可以深入了解你无法直接修改的 DOM 对象。你无法触及内置 <div>的实现,也无法修改第三方组件。但你有了一个选项来用指令监视这些元素。

这个指令定义了 ngOnInit()ngOnDestroy()钩子,它通过一个注入进来的 LoggerService把消息记录到父组件中去。

src/app/spy.directive.ts

let nextId = 1;

// Spy on any element to which it is applied.
// Usage: <div appSpy>...</div>
@Directive({selector: '[appSpy]'})
export class SpyDirective implements OnInit, OnDestroy {
  private id = nextId++;

  constructor(private logger: LoggerService) { }

  ngOnInit() {
    this.logger.log(`Spy #${this.id} onInit`);
  }

  ngOnDestroy() {
    this.logger.log(`Spy #${this.id} onDestroy`);
  }
}

你可以把这个侦探指令写到任何内置元素或组件元素上,以观察它何时被初始化和销毁。 下面是把它附加到用来重复显示英雄数据的这个 &lt;p&gt;上。

src/app/spy.component.html

<p *ngFor="let hero of heroes" appSpy>
  {{hero}}
</p>

每个“侦探”的创建和销毁都可以标出英雄所在的那个 &lt;p&gt;元素的出现和消失。 添加一个英雄就会产生一个新的英雄 &lt;p&gt;元素。侦探的 ngOnInit()记录下了这个事件。

Reset按钮清除了这个 heroes列表。 Angular 从 DOM 中移除了所有英雄的 &lt;p&gt;元素,并且同时销毁了附加在这些 &lt;p&gt;元素上的侦探指令。 侦探的 ngOnDestroy()方法汇报了它自己的临终时刻。

# 同时使用组件和指令的钩子

在这个例子中,CounterComponent使用了 ngOnChanges()方法,以便在每次父组件递增其输入属性 counter时记录一次变更。

这个例子将前例中的 SpyDirective用于 CounterComponent的日志,以便监视这些日志条目的创建和销毁。

# 使用变更检测钩子

一旦检测到该组件或指令的输入属性发生了变化,Angular 就会调用它的 ngOnChanges()方法。这个 onChanges范例通过监控 OnChanges()钩子演示了这一点。

on-changes.component.ts (excerpt)

ngOnChanges(changes: SimpleChanges) {
  for (const propName in changes) {
    const chng = changes[propName];
    const cur  = JSON.stringify(chng.currentValue);
    const prev = JSON.stringify(chng.previousValue);
    this.changeLog.push(`${propName}: currentValue = ${cur}, previousValue = ${prev}`);
  }
}

ngOnChanges()方法获取了一个对象,它把每个发生变化的属性名都映射到了一个SimpleChange对象,该对象中有属性的当前值和前一个值。这个钩子会在这些发生了变化的属性上进行迭代,并记录它们。

这个例子中的 OnChangesComponent组件有两个输入属性:heropower

src/app/on-changes.component.ts

@Input() hero!: Hero;
@Input() power = '';

宿主 OnChangesParentComponent绑定了它们,就像这样。

The host OnChangesParentComponentbinds to them as follows.

src/app/on-changes-parent.component.html

<on-changes [hero]="hero" [power]="power"></on-changes>

下面是此例子中的当用户做出更改时的操作演示。

Here's the sample in action as the user makes changes.

OnChanges 日志条目把 power属性的变化显示为字符串。但请注意,ngOnChanges()方法不会捕获对 hero.name更改。这是因为只有当输入属性的值发生变化时,Angular 才会调用该钩子。在这种情况下,hero是输入属性,hero属性的值是对 hero 对象的引用。当它自己的 name属性的值发生变化时,对象引用并没有改变。

# 响应视图的变更

当 Angular 在变更检测期间遍历视图树时,需要确保子组件中的某个变更不会尝试更改其父组件中的属性。因为单向数据流的工作原理就是这样的,这样的更改将无法正常渲染。

如果你需要做一个与预期数据流反方向的修改,就必须触发一个新的变更检测周期,以允许渲染这种变更。这些例子说明了如何安全地做出这些改变。

AfterView例子展示了 AfterViewInit()AfterViewChecked()钩子,Angular 会在每次创建了组件的子视图后调用它们。

下面是一个子视图,它用来把英雄的名字显示在一个 &lt;input&gt;中:

ChildViewComponent

@Component({
  selector: 'app-child-view',
  template: `
    <label for="hero-name">Hero name: </label>
    <input type="text" id="hero-name" [(ngModel)]="hero">
  `
})
export class ChildViewComponent {
  hero = 'Magneta';
}

AfterViewComponent把这个子视图显示在它的模板中:

AfterViewComponent (template)

template: `
  <div>child view begins</div>
    <app-child-view></app-child-view>
  <div>child view ends</div>
`

下列钩子基于子视图中的每一次数据变更采取行动,它只能通过带@ViewChild装饰器的属性来访问子视图。

AfterViewComponent (class excerpts)

export class AfterViewComponent implements  AfterViewChecked, AfterViewInit {
  private prevHero = '';

  // Query for a VIEW child of type `ChildViewComponent`
  @ViewChild(ChildViewComponent) viewChild!: ChildViewComponent;

  ngAfterViewInit() {
    // viewChild is set after the view has been initialized
    this.logIt('AfterViewInit');
    this.doSomething();
  }

  ngAfterViewChecked() {
    // viewChild is updated after the view has been checked
    if (this.prevHero === this.viewChild.hero) {
      this.logIt('AfterViewChecked (no change)');
    } else {
      this.prevHero = this.viewChild.hero;
      this.logIt('AfterViewChecked');
      this.doSomething();
    }
  }
  // ...
}
# 在更新视图之前等待

在这个例子中,当英雄名字超过 10 个字符时,doSomething()方法会更新屏幕,但在更新 comment之前会等一个节拍(tick)。

AfterViewComponent (doSomething)

// This surrogate for real business logic sets the `comment`
private doSomething() {
  const c = this.viewChild.hero.length > 10 ? "That's a long name" : '';
  if (c !== this.comment) {
    // Wait a tick because the component's view has already been checked
    this.logger.tick_then(() => this.comment = c);
  }
}

在组件的视图合成完之后,就会触发 AfterViewInit()AfterViewChecked()钩子。如果你修改了这段代码,让这个钩子立即修改该组件的数据绑定属性 comment,你就会发现 Angular 抛出一个错误。

LoggerService.tick_then()语句把日志的更新工作推迟了一个浏览器 JavaScript 周期,也就触发了一个新的变更检测周期。

# 编写精简的钩子方法来避免性能问题

当你运行 AfterView范例时,请注意当没有发生任何需要注意的变化时,Angular 仍然会频繁的调用 AfterViewChecked()。要非常小心你放到这些方法中的逻辑或计算量。

AfterView

# 响应被投影内容的变更

内容投影是从组件外部导入 HTML 内容,并把它插入在组件模板中指定位置上的一种途径。可以在目标中通过查找下列结构来认出内容投影。

  • 元素标签中间的 HTML

  • 组件模板中的 &lt;ng-content&gt;标签

AngularJS 的开发者把这种技术叫做 transclusion。

这个 AfterContent例子探索了 AfterContentInit()AfterContentChecked()钩子。Angular 会在把外部内容投影进该组件时调用它们。

对比前面的 AfterView例子考虑这个变化。 这次不再通过模板来把子视图包含进来,而是改为从 AfterContentComponent的父组件中导入它。下面是父组件的模板:

AfterContentParentComponent (template excerpt)


<after-content>
  <app-child></app-child>
</after-content>

注意,&lt;app-child&gt;标签被包含在 &lt;after-content&gt;标签中。永远不要在组件标签的内部放任何内容 —— 除非你想把这些内容投影进这个组件中。

现在来看该组件的模板。

AfterContentComponent (template)


template: `
  <div>projected content begins</div>
    <ng-content></ng-content>
  <div>projected content ends</div>
`

&lt;ng-content&gt;标签是外来内容的占位符。它告诉 Angular 在哪里插入这些外来内容。在这里,被投影进去的内容就是来自父组件的 &lt;app-child&gt;标签。

Projected Content

# 使用 AfterContent 钩子

AfterContent钩子和 AfterView相似。关键的不同点是子组件的类型不同。

  • AfterView钩子所关心的是 ViewChildren,这些子组件的元素标签会出现在该组件的模板里面

  • AfterContent钩子所关心的是 ContentChildren,这些子组件被 Angular 投影进该组件中

下列 AfterContent钩子基于子级内容中值的变化而采取相应的行动,它只能通过带有@ContentChild装饰器的属性来查询到“子级内容”。

AfterContentComponent (class excerpts)

export class AfterContentComponent implements AfterContentChecked, AfterContentInit {
  private prevHero = '';
  comment = '';

  // Query for a CONTENT child of type `ChildComponent`
  @ContentChild(ChildComponent) contentChild!: ChildComponent;

  ngAfterContentInit() {
    // contentChild is set after the content has been initialized
    this.logIt('AfterContentInit');
    this.doSomething();
  }

  ngAfterContentChecked() {
    // contentChild is updated after the content has been checked
    if (this.prevHero === this.contentChild.hero) {
      this.logIt('AfterContentChecked (no change)');
    } else {
      this.prevHero = this.contentChild.hero;
      this.logIt('AfterContentChecked');
      this.doSomething();
    }
  }
  // ...
}

不需要等待内容更新No need to wait for content updates该组件的 doSomething()方法会立即更新该组件的数据绑定属性 comment。而无需延迟更新以确保正确渲染。

Angular 在调用 AfterView钩子之前,就已调用完所有的 AfterContent钩子。在完成该组件视图的合成之前,Angular 就已经完成了所投影内容的合成工作。AfterContent...AfterView...钩子之间有一个小的时间窗,允许你修改宿主视图。

# 自定义变更检测逻辑

要监控 ngOnChanges()无法捕获的变更,你可以实现自己的变更检查逻辑,比如 DoCheck的例子。这个例子展示了你如何使用 ngDoCheck()钩子来检测和处理 Angular 自己没有捕捉到的变化。

DoCheck范例使用下面的 ngDoCheck()钩子扩展了 OnChanges范例:

DoCheckComponent (ngDoCheck)

ngDoCheck() {

  if (this.hero.name !== this.oldHeroName) {
    this.changeDetected = true;
    this.changeLog.push(`DoCheck: Hero name changed to "${this.hero.name}" from "${this.oldHeroName}"`);
    this.oldHeroName = this.hero.name;
  }

  if (this.power !== this.oldPower) {
    this.changeDetected = true;
    this.changeLog.push(`DoCheck: Power changed to "${this.power}" from "${this.oldPower}"`);
    this.oldPower = this.power;
  }

  if (this.changeDetected) {
      this.noChangeCount = 0;
  } else {
      // log that hook was called when there was no relevant change.
      const count = this.noChangeCount += 1;
      const noChangeMsg = `DoCheck called ${count}x when no change to hero or power`;
      if (count === 1) {
        // add new "no change" message
        this.changeLog.push(noChangeMsg);
      } else {
        // update last "no change" message
        this.changeLog[this.changeLog.length - 1] = noChangeMsg;
      }
  }

  this.changeDetected = false;
}

这段代码会检查某些感兴趣的值,捕获并把它们当前的状态和之前的进行比较。当 heropower没有实质性变化时,它就会在日志中写一条特殊的信息,这样你就能看到 DoCheck()被调用的频率。其结果很有启发性。

DoCheck 虽然 ngDoCheck()钩子可以检测出英雄的 name何时发生了变化,但却非常昂贵。无论变化发生在何处,每个变化检测周期都会以很大的频率调用这个钩子。在用户可以执行任何操作之前,本例中已经调用了二十多次。

这些初始化检查大部分都是由 Angular 首次在页面的其它地方渲染不相关的数据触发的。只要把光标移动到另一个 &lt;input&gt;就会触发一次调用。其中的少数调用揭示了相关数据的实际变化情况。如果使用这个钩子,那么你的实现必须非常轻量级,否则会损害用户体验。

Last Updated: 5/16/2023, 7:35:10 PM