NgFor 指令

ngFor指令是通过使用可迭代的每个项作为模板的上下文来重复模板的一种方式。

  1. @Component({
  2. selector: 'app-root',
  3. template: `
  4. <app-for-example *ngFor="let episode of episodes" [episode]="episode">
  5. {{episode.title}}
  6. </app-for-example>
  7. `
  8. })
  9. export class AppComponent {
  10. episodes = [
  11. { title: 'Winter Is Coming', director: 'Tim Van Patten' },
  12. { title: 'The Kingsroad', director: 'Tim Van Patten' },
  13. { title: 'Lord Snow', director: 'Brian Kirk' },
  14. { title: 'Cripples, Bastards, and Broken Things', director: 'Brian Kirk' },
  15. { title: 'The Wolf and the Lion', director: 'Brian Kirk' },
  16. { title: 'A Golden Crown', director: 'Daniel Minahan' },
  17. { title: 'You Win or You Die', director: 'Daniel Minahan' },
  18. { title: 'The Pointy End', director: 'Daniel Minahan' }
  19. ];
  20. }

View Example

ngFor指令与我们看到的其他指令有不同的语法。 如果你熟悉for...of语句,你会注意到,他们几乎相同。 ngFor允许您指定要迭代的iterable对象,以及在范围内引用每个项的名称。 在我们的示例中,您可以看到该episode 可用于插值以及属性绑定。 该指令做一些额外的解析,所以当它扩展到模板形式,它看起来有点不同:

  1. @Component({
  2. selector: 'app',
  3. template: `
  4. <template ngFor [ngForOf]="episodes" let-episode>
  5. <app-for-example [episode]="episode">
  6. {{episode.title}}
  7. </app-for-example>
  8. </template>
  9. `
  10. })

View Example

请注意,模板元素上有一个奇怪的let-episode属性。 ngFor指令在其范围内提供一些变量作为上下文。 let-episode是一个上下文绑定,这里它接受迭代的每个项的值。

局部变量

NgFor还提供了可以被局部变量别名的其他值:

  • index - 当前项目的位置在从0开始的迭代中
  • first - 如果当前项是可迭代中的第一个项,则为true
  • last - 如果当前项是可迭代中的最后一个项,则为true
  • even - 如果当前索引为偶数,则为true
  • odd - 如果当前索引是奇数,则为true
  1. @Component({
  2. selector: 'app',
  3. template: `
  4. <for-example
  5. *ngFor="let episode of episodes; let i = index; let isOdd = odd"
  6. [episode]="episode"
  7. [ngClass]="{ odd: isOdd }">
  8. {{i+1}}. {{episode.title}}
  9. </for-example>
  10. <hr/>
  11. <h2>Desugared</h2>
  12. <template ngFor [ngForOf]="episodes" let-episode let-i="index" let-isOdd="odd">
  13. <for-example [episode]="episode" [ngClass]="{ odd: isOdd }">
  14. {{i+1}}. {{episode.title}}
  15. </for-example>
  16. </template>
  17. `
  18. })

View Example

trackBy

通常ngFor用于迭代具有唯一ID字段的对象列表。 在这种情况下,我们可以提供一个trackBy函数,帮助Angular跟踪列表中的项目,以便它可以检测哪些项目已添加或删除,并提高性能。

Angular 2将通过引用来尝试和跟踪对象,以确定应该创建和销毁哪些项目。 然而,如果你用一个新的对象源代替列表,也许是一个API请求的结果,我们可以通过告诉Angular 2如何跟踪事情来获得一些额外的性能。

例如,如果Add Episode按钮是要发出请求并返回新的剧集列表,我们可能不想销毁并重新创建列表中的每个项目。 如果剧集有唯一的ID,我们可以添加一个trackBy函数:

  1. @Component({
  2. selector: 'app-root',
  3. template: `
  4. <button
  5. (click)="addOtherEpisode()"
  6. [disabled]="otherEpisodes.length === 0">
  7. Add Episode
  8. </button>
  9. <app-for-example
  10. *ngFor="let episode of episodes;
  11. let i = index; let isOdd = odd;
  12. trackBy: trackById" [episode]="episode"
  13. [ngClass]="{ odd: isOdd }">
  14. {{episode.title}}
  15. </app-for-example>
  16. `
  17. })
  18. export class AppComponent {
  19. otherEpisodes = [
  20. { title: 'Two Swords', director: 'D. B. Weiss', id: 8 },
  21. { title: 'The Lion and the Rose', director: 'Alex Graves', id: 9 },
  22. { title: 'Breaker of Chains', director: 'Michelle MacLaren', id: 10 },
  23. { title: 'Oathkeeper', director: 'Michelle MacLaren', id: 11 }]
  24. episodes = [
  25. { title: 'Winter Is Coming', director: 'Tim Van Patten', id: 0 },
  26. { title: 'The Kingsroad', director: 'Tim Van Patten', id: 1 },
  27. { title: 'Lord Snow', director: 'Brian Kirk', id: 2 },
  28. { title: 'Cripples, Bastards, and Broken Things', director: 'Brian Kirk', id: 3 },
  29. { title: 'The Wolf and the Lion', director: 'Brian Kirk', id: 4 },
  30. { title: 'A Golden Crown', director: 'Daniel Minahan', id: 5 },
  31. { title: 'You Win or You Die', director: 'Daniel Minahan', id: 6 }
  32. { title: 'The Pointy End', director: 'Daniel Minahan', id: 7 }
  33. ];
  34. addOtherEpisode() {
  35. // We want to create a new object reference for sake of example
  36. let episodesCopy = JSON.parse(JSON.stringify(this.episodes))
  37. this.episodes=[...episodesCopy,this.otherEpisodes.pop()];
  38. }
  39. trackById(index: number, episode: any): number {
  40. return episode.id;
  41. }
  42. }

要了解这会如何影响ForExample组件,我们向它添加一些 console。

  1. export class ForExampleComponent {
  2. @Input() episode;
  3. ngOnInit() {
  4. console.log('component created', this.episode)
  5. }
  6. ngOnDestroy() {
  7. console.log('destroying component', this.episode)
  8. }
  9. }

View Example

当我们查看示例时,当我们点击Add Episode时,我们可以看到控制台输出,指示只有一个组件被创建 - 用于新添加到列表中的项目。

但是,如果我们从*ngFor中删除trackBy - 每次我们单击按钮,我们将看到组件中的项目被销毁和重新创建。

View Example Without trackBy