閱讀 Angular 6/RxJS 最新教程，請訪問前端修仙之路

如果你嘗試在 Angular 中編寫可重複使用的元件，則可能會接觸到內容投射的概念。然後你發現了 <ng-content>，並找到了一些關於它的文章，進而實現了所需的功能。

接下來我們來通過一個簡單的示例，一步步介紹 <ng-content> 所涉及的內容。

Simple example

在本文中我們使用一個示例，來演示不同的方式實現內容投影。由於許多問題與Angular 中的元件生命週期相關，因此我們的主要元件將顯示一個計數器，用於展示它已被例項化的次數：

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

let instances = 0;

@Component({
  selector: 'counter',
  template: '<h1>{{this.id}}</h1>'
})
class Counter {
  id: number;
  
  constructor() {
    this.id = ++instances;
  }
}
 

上面示例中我們定義了 Counter 元件，元件類中的 id 屬性用於顯示本元件被例項化的次數。接著我們繼續定義一個 Wrapper 元件：

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

@Component({
  selector: 'wrapper',
  template: `
    <div class="box">
      <ng-content></ng-content>
    </div>
  `
})
class Wrapper {}

現在我們來驗證一下效果：

<wrapper>
  <counter></counter>
  <counter></counter>
  <counter></counter>
</wrapper>
 

Targeted projection

有時你希望將包裝器的不同子項投影到模板的不同部分。為了處理這個問題，<ng-content> 支援一個 select 屬性，可以讓你在特定的地方投射具體的內容。該屬性支援 CSS 選擇器（my-element，.my-class，[my-attribute]，...）來匹配你想要的內容。如果 ng-content 上沒有設定 select 屬性，它將接收全部內容，或接收不匹配任何其他 ng-content 元素的內容。長話短說：

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

@Component({
  selector: 'wrapper',
  template: `
  <div class="box red">
    <ng-content></ng-content>
  </div>
  <div class="box blue">
    <ng-content select="counter"></ng-content>
  </div>
  `,
  styles: [`
    .red {background: red;}
    .blue {background: blue;}
  `]
})
export class Wrapper { }
 

上面示例中，我們引入了 select 屬性，來選擇投射的內容：

<wrapper>
  <span>This is not a counter</span>
  <counter></counter>
</wrapper>

上述程式碼成功執行後，counter 元件被正確投影到第二個藍色框中，而 span 元素最終會在全部紅色框中。請注意，目標 ng-content 會優先於 catch-all，即使它在模板中的位置靠後。

ngProjectAs

有時你的內部元件會被隱藏在另一個更大的元件中。有時你只需要將其包裝在額外的容器中即可應用 ngIf 或 ngSwitch。無論什麼原因，通常情況下，你的內部元件不是包裝器的直接子節點。為了演示上述情況，我們將 Counter 元件包裝在一個 <ng-container> 中，看看我們的目標投影會發生什麼：

<wrapper>
  <ng-container>
    <counter></counter>
  </ng-container>
</wrapper>

現在我們的 couter 元件會被投影到第一個紅色框中。因為 ng-container 容器不再匹配 select="counter"。為了解決這個問題，我們必須使用 ngProjectAs 屬性，它可以應用於任何元素上。具體如下：

<wrapper>
  <ng-container ngProjectAs="counter">
    <counter></counter>
  </ng-container>
</wrapper>

通過設定 ngProjectAs 屬性，終於讓我們的 counter 元件重回藍色框的懷抱了。

Time to poke and prod

我們從一個簡單的實驗開始：將兩個 <ng-content> 塊放在我們的模板中，沒有選擇器。會出現什麼情況？

頁面中會顯示一個或兩個框，如果我們包含兩個框，它們的內容是顯示 1 和 1 或 1 和 2？

<div class="box red">
    <ng-content></ng-content>
</div>
<div class="box blue">
    <ng-content></ng-content>
</div>

答案是我們在最後一個 <ng-content> 中得到一個計數器，另一個是空的！在我們嘗試解釋為什麼之前，讓我們再來驗證一個問題，即在 ng-content 指令的外層容器中新增 ngIf 指令：

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

@Component({
  selector: 'wrapper',
  template: `
    <button (click)="show = !show">
      {{ show ? 'Hide' : 'Show' }}
    </button>
    <div class="box" *ngIf="show">
      <ng-content></ng-content>
    </div>
  `
})
class Wrapper {
  show = true;
}

乍一看，似乎正常執行。但是如果你通過按鈕進行切換操作，你會注意到計數器的值不會增加。這意味著我們的計數器元件只被例項化了一次 - 從未被銷燬和重新建立。難道這是 ngIf 指令產生的問題，讓我們測試一下 ngFor 指令，看看是否有同樣的問題：

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

@Component({
  selector: 'wrapper',
  template: `
    <div class="box" *ngFor="let item of items">
      <ng-content></ng-content>
    </div>
  `
})
class Wrapper {
  items = [0, 0, 0];
}

以上程式碼執行後與我們使用多個 <ng-content> 的效果是一樣的，只會顯示一個計數器！為什麼不按照我們的預期執行？

The explanation

<ng-content> 不會 "產生" 內容，它只是投影現有的內容。你可以認為它等價於 node.appendChild(el) 或 jQuery 中的 $(node).append(el) 方法：使用這些方法，節點不被克隆，它被簡單地移動到它的新位置。因此，投影內容的生命週期將被繫結到它被宣告的地方，而不是顯示在地方。

這種行為有兩個原因：期望一致性和效能。什麼 "期望的一致性" 意味著作為開發人員，可以基於應用程式的程式碼，猜測其行為。假設我寫了以下程式碼：

<div class="my-wrapper">
  <counter></counter>
</div>

很顯然計數器將被例項化一次，但現在假如我們使用第三方庫的元件：

<third-party-wrapper>
  <counter></counter>
</third-party-wrapper>

如果第三方庫能夠控制 counter 元件的生命週期，我將無法知道它被例項化了多少次。其中唯一方法就是檢視第三方庫的程式碼，瞭解它們的內部處理邏輯。將元件的生命週期被繫結到我們的應用程式元件而不是包裝器的意義是，開發者可以掌控計數器只被例項化一次，而不用瞭解第三方庫的內部程式碼。

效能的原因更為重要。因為 ng-content 只是移動元素，所以可以在編譯時完成，而不是在執行時，這大大減少了實際應用程式的工作量。

The solution

為了讓包裝器能夠控制其子元素的例項化，我們可以通過兩種方式完成：在我們的內容周圍使用 <ng-template> 元素，或者使用帶有 "*" 語法的結構指令。為簡單起見，我們將在示例中使用 <ng-template> 語法，我們的新應用程式如下所示：

<wrapper>
  <ng-template>
    <counter></counter>
  </ng-template>
</wrapper>

包裝器不再使用 <ng-content>，因為它接收到一個模板。我們需要使用 @ContentChild 訪問模板，並使用ngTemplateOutlet 來顯示它：

@Component({
  selector: 'wrapper',
  template: `
    <button (click)="show = !show">
      {{ show ? 'Hide' : 'Show' }}
    </button>
    <div class="box" *ngIf="show">
      <ng-container [ngTemplateOutlet]="template"></ng-container>
    </div>
  `
})
class Wrapper {
  show = true;
  @ContentChild(TemplateRef) template: TemplateRef;
}

現在我們的 counter 元件，每當我們隱藏並重新顯示時都正確遞增！讓我們再驗證一下 *ngFor 指令：

@Component({
  selector: 'wrapper',
  template: `
    <div class="box" *ngFor="let item of items">
      <ng-container [ngTemplateOutlet]="template"></ng-container>
    </div>
  `
})
class Wrapper {
  items = [0, 0, 0];
  @ContentChild(TemplateRef) template: TemplateRef;
}

上面程式碼成功執行後，每個盒子中有一個計數器，顯示 1，2 和 3，這正是我們之前預期的結果。