Angular 2 中的 ViewChildren 和 ContentChildren

原文地址:http://blog.mgechev.com/2016/01/23/angular2-viewchildren-contentchildren-difference-viewproviders/

在这篇文章中,我将解释在Angular 2中view children和content children之间的区别,我们将看看如何从父组件来访问这两种不同的children,除了这些内容,我们也将提到在@Component

装饰器中提供的属性providersviewProviders之间的区别。

你可以在我的github找到这篇文章的源代码,所以让我们开始吧!

组合基元(Composing primitives)

首先,让我们弄清Angular2组件(Component)和指令(Directive)概念之间的关系。组合模式是一个典型的设计模式用来开发用户界面。它使我们能够组成不同的基元,并以相同的方式对待它们。在函数式编程的世界中,我们可以组合函数。 例如:

map ((*2).(+1)) [1, 2, 3]
-- [4,6,8]

上面是Haskell的代码,我们组合函数(*2)和(+1),以便后面的列表中每个项目n被共同操作,操作顺序为n -> + 1 -> * 2。

UI中的组成

那么,在用户界面,实际上相当类似的,我们可以将各个组件当做函数,这些函数可以被组合在一起,作为结果,我们得到更多复杂的功能。

[图片上传中...(image-223ec9-1512525371154-2)]

在上图中,我们有2个元素

  • Directive - 一个独立的持有一些逻辑的元素,但不包含任何结构。
  • Component - 一个元素,它指定了Directive元素,并拥有其他指令实例的列表(这也可能是Component,因为Component继承Direcitve)。

这意味着,使用上述的抽象概念,我们可以构建以下形式的结构:

[图片上传中...(image-bbfffa-1512525371154-1)]

Angular 2中组件的组合

现在,为了更具体地说明,让我们切换到Angular 2的上下文。

// ...
@Component({
  selector: 'todo-app',
  providers: [TodoList],
  directives: [TodoCmp, TodoInputCmp],
  template: `
    <section>
      Add todo:
      <todo-input (onTodo)="addTodo($event)"></todo-input>
    </section>
    <section>
      <h4 *ngIf="todos.getAll().length">Todo list</h4>
      <todo *ngFor="var todo of todos.getAll()" [todo]="todo">
      </todo>
    </section>
    <ng-content select="footer"></ng-content>
  `
})
class TodoAppCmp {
  constructor(private todos: TodoList) {}
  addTodo(todo) {
    this.todos.add(todo);
  }
}
// ...

是的,这将是“另一个MV* todo应用”。上面我们定义了一个组件selector是todo-app,它有一些内联模板,定义了一组指令,它或它的任何子组件可以使用。

我们可以以下列方式使用组件:

<todo-app></todo-app>

这基本上是一个XML,因为在<todo-app></todo-app>之间我们可以添加一些内容:

<todo-app>
  <footer>
    Yet another todo app!
  </footer>
</todo-app>

ng-content

让我们先回到todo-app组件的定义,请注意模板的最后一行元素<ng-content select="footer"></ng-content>,ng-content`会替换和``之间内容到模板内,select属性的值是一个CSS选择器,这使得我们可以选择我们想要投射的内容,例如在上面的例子中,footer将在所渲染的todo组件的底部被注入。

我们也可以不是用select属性,在这种情况下,我们将投射<todo-app></todo-app>之间的所有内容。

这里的实现很有很多组件,我们在这里并不不需要关心它们是怎么样实现,所以在这里忽略它们,应用的最终结果将是如下:

[图片上传中...(image-b2e0d0-1512525371154-0)]

ViewChildren和ContentChildren

是的,它是那么的简单,现在,我们已经准备好来定义什么是view children和content children的概念。

  • 在组件的模板中定义的内容,它是组件的一部分,被称为view children
  • 在host元素<opening></closing>标签中的被称为content children

这意味着,在todo-app中的todo-inputtodo是view children,而footer(如果它被定义为Angular 2组件或指令)为content child。

访问 View 和 Content Children

现在到了有趣的部分!让我们看看我们如何能够访问和操作这两种类型的Children!

不同方式访问View Children

Angular 2 在

angular2/core包中提供了下列属性装饰器:@ViewChildren,

@ViewChild,

@ContentChildren

@ContentChild

我们可以通过以下方式:

import {ViewChild, ViewChildren, Component...} from 'angular2/core';

// ...

@Component({
  selector: 'todo-app',
  providers: [TodoList],
  directives: [TodoCmp, TodoInputCmp],
  template: `...`
})
class TodoAppCmp {
  @ViewChild(TodoInputCmp)
  inputComponent: TodoInputCmp
  @ViewChildren(TodoCmp)
  todoComponents: QueryList<TodoCmp>;

  constructor(private todos: TodoList) {}
  ngAfterViewInit() {
    // available here
  }
}

// ...

上面例子显示我们如何使用@ViewChildren@ViewChild,基本上,我们可以装饰一个属性,这样它会来查询视图中的某个元素,在上面例子中,使用@ViewChild查询TodoInputCmp子组件和使用@ViewChildren查询TodoCmp,我们使用不同的装饰器,是因为我们只有一个input,所以我们用@ViewChild来获取它,而我们有多个todo项,所以我们需要使用@ViewChildren

另外要注意的是的inputComponent和todoComponents的属性类型,第一个属性的类型是TodoInputCmp,如果Angular在组件控制器实例中还未发现该子组件或者引用,则它的值为空。另一方面,我们有多个TodoCmp实例,并可以从视图中动态的添加或移除,所以todoComponents属性的类型是QueryList<TodoCmp>,我们可以认为QueryList作为一个观察的集合,一旦项目被添加或删除它可以发出事件。

由于Angular的DOM编译todo-app组件在它的子组件inputComponent实例化和todosComponent实例化之前,所以在todo-app初始化时inputComponenttodoComponents不会被设置,它们的值要在ngAfterViewInit生命周期钩子被触发后才被设置。

访问Content Children

几乎是相同的规则来访问content children,但是,也有一些轻微的差别。为了更好地说明它们,让我们一起来看看它的使用:

@Component({
  selector: 'footer',
  template: '<ng-content></ng-content>'
})
class Footer {}

@Component(...)
class TodoAppCmp {...}

@Component({
  selector: 'app',
  styles: [
    'todo-app { margin-top: 20px; margin-left: 20px; }'
  ],
  template: `
    <content>
      <todo-app>
        <footer>
          <small>Yet another todo app!</small>
        </footer>
      </todo-app>
    </content>
  `,
  directives: [TodoAppCmp, NgModel, Footer]
})
export class AppCmp {}

在上面的代码段,我们定义了两个组件Footer和AppCmp,Footer可视化其host元素标签内的所有内容(<footer>content to be projected</footer>)。
另一方面,AppCmp使用TodoAppCmp的标签来传递Footer,鉴于我们上面的术语,Footer是Content Child,我们可以以下列方式访问:

// ...
@Component(...)
class TodoAppCmp {
  @ContentChild(Footer)
  footer: Footer;
  ngAfterContentInit() {
    // this.footer is now with value set
  }
}
// ...

我们从上面可以看到,View Children和Content Children的区别是装饰器的名字和生命周期不同,为了获取所有的Children,我们使用@ContentChildren(如果只要获取一个,可以使用ContentChild),Children会在ngAfterContentInit之后被设置

viewProviders vs providers

好吧!我们差不多讲完了,最后让我们来看下providers和viewProviders之间的区别,如果你还不熟悉Angular 2的依赖注入,可以看下该文章Angular 2中的依赖注入

让我们来看下TodoAppCmp

class TodoList {
  private todos: Todo[] = [];
  add(todo: Todo) {}
  remove(todo: Todo) {}
  set(todo: Todo, index: number) {}
  get(index: number) {}
  getAll() {}
}

@Component({
  // ...
  viewProviders: [TodoList],
  directives: [TodoCmp, TodoInputCmp],
  // ...
})
class TodoAppCmp {
  constructor(private todos: TodoList) {}
  // ...
}

@Component

我们设置了viewProviders属性,是一个数组,里面有一个元素TodoList服务,TodoList服务保存了所有todo项。

我们在TodoAppCmp构造函数中注入了TodoList服务,但我们也可以在TodoAppCmp视图中使用的其他指令(或组件)中注入该服务,这意味着下列组件可以使用TodoList:

  • TodoList
  • TodoCmp
  • TodoInputCmp

但是,如果我们尝试在footer组件的构造函数中注入该服务,我们会得到以下运行时错误:

EXCEPTION: No provider for TodoList! (Footer -> TodoList)

这意味着在viewProviders声明的只允许组件的模板内的组件使用。

如果我们想让Footer组件使用TodoList服务,可以将TodoList声明在providers属性中。

何时使用viewProviders

为什么要使用viewProviders?如果这些provider无法被content children访问到?假设你现在在开发第三方库,它内部使用一些服务,这些服务是库私有API的一部分,你不想让它们能被外部访问到,如果这些私有的内容注册在providers里用户可以通过content children来访问到这些私有的内容,但是如果你使用viewProviders,该providers将无法从外部访问

©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 212,080评论 6 493
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 90,422评论 3 385
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 157,630评论 0 348
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 56,554评论 1 284
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 65,662评论 6 386
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 49,856评论 1 290
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 39,014评论 3 408
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 37,752评论 0 268
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 44,212评论 1 303
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 36,541评论 2 327
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 38,687评论 1 341
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 34,347评论 4 331
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 39,973评论 3 315
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 30,777评论 0 21
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 32,006评论 1 266
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 46,406评论 2 360
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 43,576评论 2 349

推荐阅读更多精彩内容