我這個(gè)人，寫(xiě)文章或者說(shuō)心得，不喜歡直接抄官網(wǎng)上面的東西，實(shí)在是沒(méi)啥意思。我還是喜歡用我的大白話來(lái)寫(xiě)文章。今天這個(gè)關(guān)于模板輸入變量的這個(gè)我今天啃官網(wǎng)啃了許久，總算是初步的了解了是啥東西。【相關(guān)教程推薦：《angular教程》】

那么模板輸入變量到底是什么

我想研究這玩意的起因在于之前我使用ng-zorro的時(shí)候，用到了它的分頁(yè)組件Pagination（官網(wǎng)鏈接）。這其中有一個(gè)自定義上一頁(yè)下一頁(yè)模板的功能。代碼的話如下：

@Component({   selector: 'nz-demo-pagination-item-render',   template: `     <nz-pagination [nzPageIndex]="1" [nzTotal]="500" [nzItemRender]="renderItemTemplate"></nz-pagination>     <ng-template #renderItemTemplate let-type let-page="page">       <ng-container [ngSwitch]="type">         <a *ngSwitchCase="'page'">{{ page }}</a>         <a *ngSwitchCase="'prev'">Previous</a>         <a *ngSwitchCase="'next'">Next</a>         <a *ngSwitchCase="'prev_5'"><<</a>         <a *ngSwitchCase="'next_5'">>></a>       </ng-container>     </ng-template>   ` }) export class NzDemoPaginationItemRenderComponent {}

看完這個(gè)之后我就很是疑惑，這個(gè)let是啥，為啥let-跟上一個(gè)變量之后就有值了呢？然后我就開(kāi)始在官網(wǎng)中找這個(gè)let是什么東西。最終，我在主要概念-指令-結(jié)構(gòu)性指令的微語(yǔ)法一節(jié)找到了關(guān)于let的說(shuō)明。官網(wǎng)描述：微語(yǔ)法。

在下面還有一段簡(jiǎn)短的說(shuō)明：

模板輸入變量（Template input variable）

模板輸入變量是這樣一種變量，你可以在單個(gè)實(shí)例的模板中引用它的值。 這個(gè)例子中有好幾個(gè)模板輸入變量：hero、i 和 odd。 它們都是用 let 作為前導(dǎo)關(guān)鍵字。

……

你使用 let 關(guān)鍵字（如 let hero）在模板中聲明一個(gè)模板輸入變量。 這個(gè)變量的范圍被限制在所重復(fù)模板的單一實(shí)例上。 事實(shí)上，你可以在其它結(jié)構(gòu)型指令中使用同樣的變量名。

……

官網(wǎng)還是一如既往的不說(shuō)人話，短短幾句話就給你介紹完了，也不告訴你這玩意怎么用，也不告訴你let聲明的變量的值到底是從哪里來(lái)的。我越看越氣，得，官網(wǎng)你不說(shuō)，我自己找。

先說(shuō)一個(gè)粗略的結(jié)論：let聲明的變量是這個(gè)template模板的上下文對(duì)象中的變量。不然為啥叫模板輸入變量呢。在*ngFor內(nèi)幕這小節(jié)中，我們了解到了其內(nèi)幕，結(jié)構(gòu)性指令其實(shí)就是將宿主元素包裹在一個(gè)<ng-template></ng-template>中，然后在這個(gè)模板上將*ngFor中的表達(dá)式解析成一個(gè)個(gè)的let模板輸入變量和這個(gè)指令需要傳入的值。由于模板中代碼并不會(huì)直接被渲染成視圖，所以一定需要某種方法來(lái)使模板變成視圖。我們的結(jié)構(gòu)性指令就是干這個(gè)事的，就是將我們的模板變成視圖。

*ngFor的官方示例代碼如下：

//解析前的模板 <div *ngFor="let hero of heroes; let i=index; let odd=odd; trackBy: trackById" [class.odd]="odd">   ({{i}}) {{hero.name}} </div> //angular解析后的模板 <ng-template ngFor let-hero [ngForOf]="heroes" let-i="index" let-odd="odd" [ngForTrackBy]="trackById">   <div [class.odd]="odd">({{i}}) {{hero.name}}</div> </ng-template>

• 在此提示一下，所謂的宿主元素就是指令所在的那個(gè)元素，像上面的例子中，div就是*ngFor指令的宿主元素。
• trackBy這個(gè)類似于vue和react中的key?？梢越o模板一個(gè)標(biāo)識(shí)，使其重新渲染的時(shí)候性能開(kāi)銷(xiāo)降低一些。

然后我們?cè)倏垂倬W(wǎng)說(shuō)的：

• let-i 和 let-odd 變量是通過(guò) let i=index 和 let odd=odd 來(lái)定義的。 Angular 把它們?cè)O(shè)置為上下文對(duì)象中的 index 和 odd 屬性的當(dāng)前值。
• 這里并沒(méi)有指定 let-hero 的上下文屬性。它的來(lái)源是隱式的。 Angular 將 let-hero 設(shè)置為此上下文中 $implicit 屬性的值， 它是由 NgFor 用當(dāng)前迭代中的英雄初始化的。

看完這段描述，我們可以得知：angular為這個(gè)模板設(shè)置了上下文對(duì)象。但是我們看不到這個(gè)過(guò)程，因?yàn)檫@是在ngFor的源碼內(nèi)部實(shí)現(xiàn)的。并且這個(gè)上下文對(duì)象具備index和odd屬性，并且包含一個(gè)$implicit（implicit：含蓄的；不直接言明的）的屬性。那么我們推斷這個(gè)上下文對(duì)象至少有以下幾個(gè)屬性：

{     $implicit:null,     index:null,     odd:null, }

那么我們聲明let變量的本質(zhì)其實(shí)就是聲明一個(gè)變量獲取上下文對(duì)象中的同名屬性的值。let-hero不進(jìn)行任何賦值的話，hero默認(rèn)等于$implicit的值。無(wú)論是有多少個(gè)let-a，let-b，let-c還是let-me。聲明的這個(gè)變量的值都等于$implicit的值。而我們進(jìn)行賦值過(guò)的，比如let-i = "index"，i的值就等于這個(gè)上下文對(duì)象中的index屬性對(duì)應(yīng)的值。

上下文對(duì)象是如何設(shè)置的

當(dāng)我們知道這個(gè)上下文對(duì)象是什么了，就該想這個(gè)上下文對(duì)象是怎么設(shè)置的了。

在結(jié)構(gòu)性指令這一節(jié)當(dāng)中，我們跟著官方示例做了一遍這個(gè)自定義結(jié)構(gòu)性指令（如果還沒(méi)有做的話，建議先跟著做一遍）。在UnlessDirective這個(gè)指令中，其構(gòu)造器constructor聲明了兩個(gè)可注入的變量，分別是TemplateRef和ViewContainerRef。官網(wǎng)給的解釋我覺(jué)得太過(guò)晦澀難懂，我這里給出一下我自己的理解：TemplateRef代表的是宿主元素被包裹之后形成的模板的引用。而ViewContainerRef代表的是一個(gè)視圖容器的引用。那么問(wèn)題來(lái)了，這個(gè)視圖容器在哪兒呢？我們?cè)?code>constructor構(gòu)造器中打印一下ViewContainerRef。打印結(jié)果如圖：

然后我們點(diǎn)進(jìn)去這個(gè)comment元素。發(fā)現(xiàn)其就是一個(gè)注釋元素。如圖所示：

其實(shí)我也不是很確定這個(gè)視圖容器到底是不是這個(gè)注釋元素。但是毋庸置疑的是，視圖容器和宿主元素是兄弟關(guān)系，緊挨著宿主元素。我們可以使用ViewContainerRef中的createEmbeddedView() 方法（Embedded：嵌入式，內(nèi)嵌式），將templateRef模板引用傳入進(jìn)去，創(chuàng)建出來(lái)一個(gè)真實(shí)的視圖。由于這個(gè)視圖是被插入到視圖容器ViewContainerRef中了，所以又叫內(nèi)嵌視圖。那么這又和我們的上下文對(duì)象有什么關(guān)系呢？其實(shí)createEmbeddedView這個(gè)方法不止一個(gè)參數(shù)，其第二個(gè)參數(shù)就是給我們的模板設(shè)置上下文對(duì)象的。API的詳情介紹請(qǐng)看createEmbeddedView這個(gè)API的詳情。

就這樣。我們就可以將上下文對(duì)象塞入模板中了，這樣的話我們也可以直接使用let聲明變量的方法來(lái)使用這個(gè)上下文對(duì)象了。

自定義一個(gè)簡(jiǎn)單的類*ngFor指令——appRepeat

那么我們知道是如何設(shè)置的了，那么我們就來(lái)驗(yàn)證一下是否是對(duì)的。接下來(lái)，我們仿照ngfor的功能，自己寫(xiě)一個(gè)簡(jiǎn)單的渲染指令。

首先我們定義一個(gè)指令：RepeatDirective。代碼如下：

@Directive({   selector: '[appRepeat]', }) export class RepeatDirective {   constructor(     private templateRef: TemplateRef<any>,     private viewContainer: ViewContainerRef,   ) { }    @Input() set appRepeatOf(heroesList: string[]) {     heroesList.forEach((item, index, arr) => {       this.viewContainer.createEmbeddedView(this.templateRef, {         //當(dāng)前條目的默認(rèn)值         $implicit: item,         //可迭代對(duì)象的總數(shù)         count: arr.length,         //當(dāng)前條目的索引值         index: index,         //如果當(dāng)前條目在可迭代對(duì)象中的索引號(hào)為偶數(shù)則為 true。         even: index % 2 === 0,         //如果當(dāng)前條目在可迭代對(duì)象中的索引號(hào)為奇數(shù)則為 true。         odd: index % 2 === 1,       });     });   } }

然后我們將其導(dǎo)入NgModule中，這個(gè)過(guò)程就省略不寫(xiě)了。然后我們?cè)诮M件中使用一下這個(gè)指令：

@Component({   selector: 'app-structural-likeNgFor-demo',   template: `     <h2>原神1.5版本卡池角色</h2>     <h4>自定義ngFor（appRepeat）</h4>     <ul>       <li *appRepeat="let h of heroesList;let i = index;let even = even">         索引：{{i}} -- {{h}} -- 索引值是否是偶數(shù)：{{even.toString()}}       </li>     </ul>     <h4>真正的ngFor</h4>     <ul>       <li *ngFor="let h of heroesList;let i = index;let even = even">         索引：{{i}} -- {{h}} -- 索引值是否是偶數(shù)：{{even.toString()}}       </li>     </ul>   `, }) export class StructuralLikeNgForDemoComponent {   public heroesList: string[] = ['鐘離', '煙緋', '諾艾爾', '迪奧娜']; }

在這里需要注意的是指令中的appRepeatOf不是亂寫(xiě)的。在微語(yǔ)法的解析過(guò)程中let h of heroesList中的of首先首字母會(huì)變成大寫(xiě)的，變成Of。然后在給它加上這個(gè)指令的前綴，也就是appRepeat。組合起來(lái)就是appRepeatOf了。由它來(lái)接收一個(gè)可迭代的對(duì)象。

最后顯示的效果圖：

運(yùn)行結(jié)果的話和*ngFor沒(méi)有區(qū)別。但是功能肯定是欠缺的，如果有能力的小伙伴可以去閱讀*ngFor的源碼：*ngFor的源碼。

總結(jié)

通過(guò)這篇文章，我們知道了let-變量這個(gè)模板輸入變量是通過(guò)模板的上下文對(duì)象中定義并獲取值的。然后想要設(shè)置上下文對(duì)象的話需要通過(guò)createEmbeddedView方法的第二個(gè)參數(shù)來(lái)設(shè)置。

結(jié)語(yǔ)

但是我總覺(jué)得了解的還不夠透徹，我總覺(jué)得設(shè)置模板的上下文對(duì)象可能不只是createEmbeddedView這一種方法，但是我并沒(méi)有找到其他的方法。如果各位小伙伴有知道其他的方法可以留言告訴我。

參考資料：

這篇文章靈感來(lái)自：Angular 實(shí)現(xiàn)一個(gè)"repeat" 指令

轉(zhuǎn)載地址：https://juejin.cn/post/6956466729891561503