从 AngularJS 升级

Angular这个名字专指现在和未来的Angular版本,而AngularJS专指Angular的所有v1.x版本。

有很多大型AngularJS应用。 在决定迁移到Angular之前,首先要深入思考业务案例。 在这些案例中,最重要的部分之一是时间和需要付出的努力。 本章描述用于把AngularJS应用高效迁移到Angular平台的内置工具,每次讲一点点。

有些应用可能比其它的升级起来简单,还有一些方法能让把这项工作变得更简单。 即使在正式开始升级过程之前,我们可以准备AngularJS的程序,让它向Angular看齐。 这些准备步骤几乎都是关于如何让代码更加松耦合、更有可维护性,以及用现代开发工具提高速度的。 这意味着,这种准备工作不仅能让最终的升级变得更简单,而且还能提升AngularJS程序的质量。

成功升级的关键之一是增量式的实现它,通过在同一个应用中一起运行这两个框架,并且逐个把AngularJS的组件迁移到Angular中。 这意味着可以在不必打断其它业务的前提下,升级更大、更复杂的应用程序,因为这项工作可以多人协作完成,在一段时间内逐渐铺开。 Angular upgrade模块的设计目标就是让你渐进、无缝的完成升级。

  1. 准备工作

    1. 遵循Angular风格指南

    2. 使用模块加载器

    3. 迁移到TypeScript

    4. 使用组件型指令

  2. 通过升级模块进行升级

    1. 升级模块是如何工作的

    2. 引导混合(hybrid)应用

    3. 从AngularJS的代码中使用Angular的组件

    4. 从Angular的代码中使用AngularJS的组件

    5. 把AngularJS的内容投影(project)进Angular组件中

    6. 把Angular的内容透传(transclude)到AngularJS的组件型指令中

    7. 让AngularJS提供的依赖可以被注入到Angular

    8. 让Angular提供的依赖可以被注入到AngularJS

    9. 在混合式应用中使用预编译

    10. 在Angular和AngularJS之间进行路由

  3. PhoneCat准备工作教程

    1. 切换到TypeScript

    2. 安装Angular

    3. 引导混合版PhoneCat

    4. 升级Phone服务

    5. 升级组件

    6. 对混合式应用进行AoT预编译

    7. 添加Angular路由器并引导

    8. 和AngularJS说再见

  4. 附录:升级PhoneCat测试

准备工作

AngularJS应用程序的组织方式有很多种。当我们想把它们升级到Angular的时候, 有些做起来会比其它的更容易些。即使在我们开始升级之前,也有一些关键的技术和模式可以让我们将来升级时更轻松。

遵循Angular风格指南

Angular风格指南收集了一些已证明能写出干净且可维护的AngularJS程序的模式与实践。 它包含了很多关于如何书写和组织Angular代码的有价值信息,同样重要的是,不应该采用的书写和组织Angular代码的方式。

Angular是一个基于AngularJS中最好的部分构思出来的版本。在这种意义上,它的目标和Angular风格指南是一样的: 保留AngularJS中好的部分,去掉坏的部分。当然,Angular还做了更多。 说这些的意思是:遵循这个风格指南可以让你写出更接近Angular程序的AngularJS程序

有一些特别的规则可以让使用Angular的upgrade模块进行增量升级变得更简单:

如果应用程序能用这种方式把每个特性分到一个独立目录中,它也就能每次迁移一个特性。 对于那些还没有这么做的程序,强烈建议把应用这条规则作为准备步骤。而且这也不仅仅对升级有价值, 它还是一个通用的规则,可以让你的程序更“坚实”。

使用模块加载器

当我们把应用代码分解成每个文件中放一个组件之后,我们通常会得到一个由大量相对较小的文件组成的项目结构。 这比组织成少量大文件要整洁得多,但如果你不得不通过<script>标签在HTML页面中加载所有这些文件,那就不好玩了。 尤其是当你不得不按正确的顺序维护这些标签时更是如此。 这就是为什么开始使用模块加载器是一个好主意了。

使用模块加载器,比如SystemJSWebpackBrowserify, 可以让我们在程序中使用TypeScript或ES2015语言内置的模块系统。 我们可以使用importexport特性来明确指定哪些代码应该以及将会被在程序的不同部分之间共享。 对于ES5程序来说,我们可以改用CommonJS风格的requiremodule.exports特性代替。 无是论哪种情况,模块加载器都会按正确的顺序加载程序中用到的所有代码。

当我们的应用程序投入生产环境时,模块加载器也会让把所有这些文件打成完整的产品包变得更容易。

迁移到TypeScript

Angular升级计划的一部分是引入TypeScript,即使在开始升级之前,引入TypeScript编译器也是有意义的。 这意味着等真正升级的时候需要学习和思考的东西更少。 它还意味着我们可以在AngularJS代码中开始使用TypeScript的特性。

因为TypeScript是ECMAScript 2015的一个超集,而ES2015又是ECMAScript 5的一个超集。 这意味着除了安装一个TypeScript编译器,并把文件名都从*.js改成*.ts之外,其实什么都不用做。 当然,如果仅仅这样做也没什么大用,也没什么令人兴奋之处。 下面这些额外步骤可以让我们精神抖擞起来:

使用组件型指令

在Angular中,组件是用来构建用户界面的主要元素。我们把UI中的不同部分定义成组件,然后通过在模板中使用这些组件最终合成为UI。

我们在AngularJS中也能这么做。那就是一种定义了自己的模板、控制器和输入/输出绑定的指令 —— 跟Angular中对组件的定义是一样的。 要迁移到Angular,通过组件型指令构建的应用程序会比直接用ng-controllerng-include和作用域继承等底层特性构建的要容易得多。

要与Angular兼容,AngularJS的组件型指令应该配置下列属性:

组件型指令还可能使用下列属性:

组件型指令不能使用下列属性:

AngularJS中一个完全向Angular架构对齐过的组件型指令是这样的:

  1. export function heroDetailDirective() {
  2. return {
  3. restrict: 'E',
  4. scope: {},
  5. bindToController: {
  6. hero: '=',
  7. deleted: '&'
  8. },
  9. template: `
  10. <h2>{{ctrl.hero.name}} details!</h2>
  11. <div><label>id: </label>{{ctrl.hero.id}}</div>
  12. <button ng-click="ctrl.onDelete()">Delete</button>
  13. `,
  14. controller: function() {
  15. this.onDelete = () => {
  16. this.deleted({hero: this.hero});
  17. };
  18. },
  19. controllerAs: 'ctrl'
  20. };
  21. }

AngularJS.5引入了组件API,它让像这样定义指令变得更简单了。 为组件型指令使用这个API是一个好主意,因为:

如果使用这个组件API进行快捷定义,那么上面看到的组件型指令就变成了这样:

  1. export const heroDetail = {
  2. bindings: {
  3. hero: '<',
  4. deleted: '&'
  5. },
  6. template: `
  7. <h2>{{$ctrl.hero.name}} details!</h2>
  8. <div><label>id: </label>{{$ctrl.hero.id}}</div>
  9. <button ng-click="$ctrl.onDelete()">Delete</button>
  10. `,
  11. controller: function() {
  12. this.onDelete = () => {
  13. this.deleted(this.hero);
  14. };
  15. }
  16. };
  17. import { Directive, ElementRef, Injector, Input, Output, EventEmitter } from '@angular/core';
  18. import { UpgradeComponent } from '@angular/upgrade/static';
  19. import { Hero } from '../hero';
  20. @Directive({
  21. selector: 'hero-detail'
  22. })
  23. export class HeroDetailDirective extends UpgradeComponent {
  24. @Input() hero: Hero;
  25. @Output() deleted: EventEmitter<Hero>;
  26. constructor(elementRef: ElementRef, injector: Injector) {
  27. super('heroDetail', elementRef, injector);
  28. }
  29. }

控制器的生命周期钩子$onInit()$onDestroy()$onChanges()是AngularJS.5引入的另一些便利特性。 它们都很接近于Angular中的等价物,所以,围绕它们组织组件生命周期的逻辑会更容易升级。

使用升级适配器进行升级

不管要升级什么,Angular中的upgrade模块都会是一个非常有用的工具 —— 除非是小到没功能的应用。 借助它,我们可以在同一个应用程序中混用并匹配AngularJS和2的组件,并让它们实现无缝的互操作。 这意味着我们不用必须一次性做完所有升级工作,因为在整个演进过程中,这两个框架可以很自然的和睦相处。

升级模块如何工作

upgrade模块提供的主要工具叫做UpgradeModule。这是一个服务,它可以引导并管理同时支持Angular和AngularJS的混合式应用程序。

当使用UpgradeModule时,我们实际做的是同时运行两个版本的Angular。所有Angular的代码运行在Angular框架中, 而AngularJS的代码运行在AngularJS框架中。所有这些都是真实的、全功能的框架版本。 没有进行任何仿真,所以我们可以期待同时存在这两个框架的所有特性和天生的行为。

所有这些事情的背后,本质上是一个框架中管理的组件和服务能和来自另一个中的进行互操作。 这发生在三个主要的领域:依赖注入、DOM和变更检测。

依赖注入

无论是在AngularJS中还是在Angular中,依赖注入都处于前沿和中心的位置,但在两个框架的工作原理上,却存在着一些关键的不同之处。

AngularJSAngular

依赖注入的令牌(Token)永远是字符串(译注:指服务名称)。

令牌可能有不同的类型。 通常是类,也可能是字符串。

只有一个注入器。即使在多模块的应用程序中,每样东西也都被装入一个巨大的命名空间中。

有一组树状多层注入器,有一个根注入器,每个组件也另外有一个注入器。

就算有这么多不同点,也并不妨碍我们在依赖注入时进行互操作。UpgradeModule解决了这些差异,并让它们无缝的对接:

The two injectors in a hybrid application

组件与DOM

在混合式应用中,我们能同时发现那些来自AngularJS和Angular中组件和指令的DOM。 这些组件通过它们各自框架中的输入和输出绑定来互相通讯,它们由UpgradeModule桥接在一起。 它们也能通过共享被注入的依赖彼此通讯,就像前面所说的那样。

要弄明白在一个混合式应用的DOM中发生了什么,有两点很关键:

  1. DOM中的每个元素都只能被两个框架之一拥有。另一个框架会忽略它。 如果一个元素被AngularJS拥有,Angular就会当它不存在。反之亦然。

  2. 应用的根节点总是来自AngularJS中的模板

所以,混合式应用总是像AngularJS程序那样启动,处理根模板的也是AngularJS. 然后,当这个应用的模板中使用到了Angular的组件时,Angular才开始参与。 这个组件的视图由Angular进行管理,而且它还可以使用一系列的Angular组件和指令。

更进一步说,我们可以按照需要,任意穿插使用这两个框架。 使用下面的两种方式之一,我们可以自由穿梭于这两个框架的边界:

  1. 通过使用来自另一个框架的组件:AngularJS的模板中用到了Angular的组件,或者Angular的模板中使用了AngularJS的组件。

  2. 通过透传(transclude)或投影(project)来自另一个框架的内容。UpgradeModule牵线搭桥,把AngularJS的透传概念和Angular的内容投影概念关联起来。

DOM element ownership in a hybrid application

当我们使用一个属于另一个框架的组件时,就会发生一个跨框架边界的切换。不过,这种切换只发生在该组件元素的子节点上。 考虑一个场景,我们从AngularJS中使用一个Angular组件,就像这样:

<a-component></a-component>

此时,<a-component>这个DOM元素仍然由AngularJS管理,因为它是在AngularJS的模板中定义的。 这也意味着你可以往它上面添加别的AngularJS指令,却不能添加Angular的指令。 只有在<a-component>组件的模板中才是Angular的天下。同样的规则也适用于在Angular中使用AngularJS组件型指令的情况。

变更检测

AngularJS中的变更检测全是关于scope.$apply()的。在每个事件发生之后,scope.$apply()就会被调用。 这或者由框架自动调用,或者在某些情况下由我们自己的代码手动调用。它是发生变更检测以及更新数据绑定的时间点。

在Angular中,事情有点不一样。虽然变更检测仍然会在每一个事件之后发生,却不再需要每次调用scope.$apply()了。 这是因为所有Angular代码都运行在一个叫做Angular zone的地方。 Angular总是知道什么时候代码执行完了,也就知道了它什么时候应该触发变更检测。代码本身并不需要调用scope.$apply()或其它类似的东西。

在这种混合式应用的案例中,UpgradeModule在AngularJS的方法和Angular的方法之间建立了桥梁。发生了什么呢?

Change detection in a hybrid application

在实践中,这意味着我们不用在自己的代码中调用$apply(),而不用管这段代码是在AngularJS还是Angular中。 UpgradeModule都替我们做了。我们仍然可以调用$apply(),也就是说我们不必从现有代码中移除此调用。 但是在混合式应用中,那些调用没有任何效果。

当我们降级一个Angular组件,然后把它用于AngularJS中时,组件的输入属性就会被AngularJS的变更检测体系监视起来。 当那些输入属性发生变化时,组件中相应的属性就会被设置。我们也能通过实现OnChanges 接口来挂钩到这些更改,就像它未被降级时一样。

相应的,当我们把AngularJS的组件升级给Angular使用时,在这个组件型指令的scope(或bindToController)中定义的所有绑定, 都将被挂钩到Angular的变更检测体系中。它们将和标准的Angular输入属性被同等对待,并当它们发生变化时设置回scope(或控制器)上。

通过Angular的NgModule来使用UpgradeModule

AngularJS还是Angular都有自己的模块概念,来帮你我们把应用组织成一些紧密相关的功能块。

它们在架构和实现的细节上有着显著的不同。 在AngularJS中,我们会把AngularJS的资源添加到angular.module属性上。 在Angular中,我们会创建一个或多个带有NgModule装饰器的类,这些装饰器用来在元数据中描述Angular资源。差异主要来自这里。

在混合式应用中,我们同时运行了两个版本的Angular。 这意味着我们至少需要AngularJS和Angular各提供一个模块。 当我们使用AngularJS的模块进行引导时,就得把Anuglar 2的模块传给UpgradeModule。我们来看看怎么做。

要了解Angular模块的更多信息,请参阅Angular模块页。

引导AngularJS+2的混合式应用程序

使用UpgradeModule升级应用的第一步总是把它引导成一个同时支持AngularJS和Angular的混合式应用。

纯粹的AngularJS应用可以用两种方式引导:在HTML页面中的某处使用ng-app指令,或者从JavaScript中调用 angular.bootstrap。 在Angular中,只有第二种方法是可行的,因为它没有ng-app指令。在混合式应用中也同样只能用第二种方法。 所以,在将AngularJS应用切换到混合模式之前,把它改为用JavaScript引导的方式是一个不错的起点。

比如说我们有个由ng-app驱动的引导过程,就像这个:

  1. <!DOCTYPE HTML>
  2. <html>
  3. <head>
  4. <base href="/">
  5. <script src="https://ajax.googleapis.com/ajax/libs/angularjs/1.5.3/angular.js"></script>
  6. <script src="app/ajs-ng-app/app.module.js"></script>
  7. </head>
  8. <body ng-app="heroApp" ng-strict-di>
  9. <div id="message" ng-controller="MainCtrl as mainCtrl">
  10. {{ mainCtrl.message }}
  11. </div>
  12. </body>
  13. </html>

我们可以从HTML中移除ng-appng-strict-di指令,改为从JavaScript中调用angular.bootstrap,它能达到同样效果:

angular.bootstrap(document.body, ['heroApp'], {strictDi: true});

现在,把Angular引入项目中。根据搭建本地开发环境中的指导,你可以有选择的从“快速起步”的Github仓库中拷贝素材进来。

接下来,创建一个app.module.ts文件,并添加下列NgModule类:

  1. import { NgModule } from '@angular/core';
  2. import { BrowserModule } from '@angular/platform-browser';
  3. import { UpgradeModule } from '@angular/upgrade/static';
  4. @NgModule({
  5. imports: [
  6. BrowserModule,
  7. UpgradeModule
  8. ]
  9. })
  10. export class AppModule {
  11. ngDoBootstrap() {}
  12. }

这个最小化的NgModule导入了BrowserModule,该模块是每个基于浏览器的Angular应用都必须具备的。

它还从@angular/upgrade/static导入了UpgradeModule,并添加了一个ngDoBootstrap空的覆盖方法,防止 Angular启动它自身。

现在我们使用platformBrowserDynamicbootstrapModule方法启动AppModule。 接着我们使用依赖注入来获取AppModule中的一个UpgradeModule实例, 并使用它来启动我们的AngularJS应用。 upgrade.bootstrap方法接受与angular.bootstrap相同的参数。

  1. import { platformBrowserDynamic } from '@angular/platform-browser-dynamic';
  2. platformBrowserDynamic().bootstrapModule(AppModule).then(platformRef => {
  3. const upgrade = platformRef.injector.get(UpgradeModule) as UpgradeModule;
  4. upgrade.bootstrap(document.body, ['heroApp'], {strictDi: true});
  5. });

我们还需要通过npm install @angular/upgrade --save命令安装@angular/upgrade包,并且为@angular/upgrade/static包添加一个映射关系:

systemjs.config.js (map)

'@angular/upgrade/static': 'npm:@angular/upgrade/bundles/upgrade-static.umd.js',

恭喜!我们就要开始运行AngularJS+2的混合式应用程序了!所有现存的AngularJS代码会像以前一样正常工作,但是我们现在也同样可以运行Angular代码了。

在AngularJS的代码中使用Angular的组件

Using an Angular component from AngularJS code

一旦我们开始运行混合式应用,我们就可以开始逐渐升级代码了。做这件事的一种更常见的模式就是在AngularJS的上下文中使用Angular的组件。 该组件可能是全新的,也可能是把原本AngularJS的组件用Angular重写而成的。

假设我们有一个简单的用来显示英雄信息的Angular组件:

hero-detail.component.ts

  1. import { Component } from '@angular/core';
  2. @Component({
  3. selector: 'hero-detail',
  4. template: `
  5. <h2>Windstorm details!</h2>
  6. <div><label>id: </label>1</div>
  7. `
  8. })
  9. export class HeroDetailComponent { }

如果我们想在AngularJS中使用这个组件,我们就得用downgradeComponent()方法把它降级。 如果我们这么做,就会得到一个AngularJS的指令,我们可以把它注册到AngularJS的模块中:

  1. import { HeroDetailComponent } from './hero-detail.component';
  2. /* . . . */
  3. import { downgradeComponent } from '@angular/upgrade/static';
  4. angular.module('heroApp', [])
  5. .directive(
  6. 'heroDetail',
  7. downgradeComponent({component: HeroDetailComponent}) as angular.IDirectiveFactory
  8. );

由于HeroDetailComponent是一个Angular组件,所以我们必须同时把它加入AppModuledeclarations字段中。

并且由于这个组件在AngularJS模块中使用,也是我们Angular应用的一个入口点,我们还需要 将它加入到Angular模块的entryComponents列表中。

  1. import { HeroDetailComponent } from './hero-detail.component';
  2. @NgModule({
  3. imports: [
  4. BrowserModule,
  5. UpgradeModule
  6. ],
  7. declarations: [
  8. HeroDetailComponent
  9. ],
  10. entryComponents: [
  11. HeroDetailComponent
  12. ]
  13. })
  14. export class AppModule {
  15. ngDoBootstrap() {}
  16. }

所有Angular组件、指令和管道都必须声明在NgModule中。

这里我们得到的是一个叫做heroDetail的AngularJS指令,我们可以像用其它指令一样把它用在AngularJS模板中。

<hero-detail></hero-detail>

注意,它在AngularJS中是一个名叫heroDetail的元素型指令(restrict: 'E')。 AngularJS的元素型指令是基于它的名字匹配的。 Angular组件中的selector元数据,在降级后的版本中会被忽略。

当然,大多数组件都不像这个这么简单。它们中很多都有输入属性和输出属性,来把它们连接到外部世界。 Angular的英雄详情组件带有像这样的输入属性与输出属性:

hero-detail.component.ts

  1. import { Component, EventEmitter, Input, Output } from '@angular/core';
  2. import { Hero } from '../hero';
  3. @Component({
  4. selector: 'hero-detail',
  5. template: `
  6. <h2>{{hero.name}} details!</h2>
  7. <div><label>id: </label>{{hero.id}}</div>
  8. <button (click)="onDelete()">Delete</button>
  9. `
  10. })
  11. export class HeroDetailComponent {
  12. @Input() hero: Hero;
  13. @Output() deleted = new EventEmitter<Hero>();
  14. onDelete() {
  15. this.deleted.emit(this.hero);
  16. }
  17. }

这些输入属性和输出属性的值来自于AngularJS的模板,而downgradeComponent()方法负责桥接它们:

  1. import { HeroDetailComponent } from './hero-detail.component';
  2. /* . . . */
  3. angular.module('heroApp', [])
  4. .controller('MainController', MainController)
  5. .directive('heroDetail', downgradeComponent({
  6. component: HeroDetailComponent,
  7. inputs: ['hero'],
  8. outputs: ['deleted']
  9. }) as angular.IDirectiveFactory);
  1. <div ng-controller="MainController as mainCtrl">
  2. <hero-detail [hero]="mainCtrl.hero"
  3. (deleted)="mainCtrl.onDelete($event)">
  4. </hero-detail>
  5. </div>

注意,虽然我们正在AngularJS的模板中,但却在使用Angular的属性(Attribute)语法来绑定到输入属性与输出属性。 这是降级的组件本身要求的。而表达式本身仍然是标准的AngularJS表达式。

在降级过的组件属性中使用中线命名法

为降级过的组件使用Angular的属性(Attribute)语法规则时有一个值得注意的例外。 它适用于由多个单词组成的输入或输出属性。在Angular中,我们要使用小驼峰命名法绑定这些属性:

[myHero]="hero"

但是从AngularJS的模板中使用它们时,我们得使用中线命名法:

[my-hero]="hero"

$event变量能被用在输出属性里,以访问这个事件所发出的对象。这个案例中它是Hero对象,因为this.deleted.emit()函数曾把它传了出来。

由于这是一个AngularJS模板,虽然它已经有了Angular中绑定的属性(Attribute),我们仍可以在这个元素上使用其它AngularJS指令。 例如,我们可以用ng-repeat简单的制作该组件的多份拷贝:

  1. <div ng-controller="MainController as mainCtrl">
  2. <hero-detail [hero]="hero"
  3. (deleted)="mainCtrl.onDelete($event)"
  4. ng-repeat="hero in mainCtrl.heroes">
  5. </hero-detail>
  6. </div>

从Angular代码中使用AngularJS组件型指令

Using an AngularJS component from Angular code

现在,我们已经能在Angular中写一个组件,并把它用于AngularJS代码中了。 当我们从低级组件开始移植,并往上走时,这非常有用。但在另外一些情况下,从相反的方向进行移植会更加方便: 从高级组件开始,然后往下走。这也同样能用UpgradeModule完成。 我们可以升级AngularJS组件型指令,然后从Angular中用它们。

不是所有种类的AngularJS指令都能升级。该指令必须是一个严格的组件型指令,具有上面的准备指南中描述的那些特征。 确保兼容性的最安全的方式是AngularJS.5中引入的组件API

可升级组件的简单例子是只有一个模板和一个控制器的指令:

hero-detail.component.ts

  1. export const heroDetail = {
  2. template: `
  3. <h2>Windstorm details!</h2>
  4. <div><label>id: </label>1</div>
  5. `,
  6. controller: function() {
  7. }
  8. };

我们可以使用UpgradeComponent方法来把这个组件升级到Angular。 具体方法是创建一个Angular指令,继承UpgradeComponent,在其构造函数中进行super调用, 这样我们就得到一个完全升级的AngularJS组件,并且可以Angular中使用。 剩下是工作就是把它加入到AppModuledeclarations数组。

hero-detail.component.ts

  1. import { Directive, ElementRef, Injector } from '@angular/core';
  2. import { UpgradeComponent } from '@angular/upgrade/static';
  3. @Directive({
  4. selector: 'hero-detail'
  5. })
  6. export class HeroDetailDirective extends UpgradeComponent {
  7. constructor(elementRef: ElementRef, injector: Injector) {
  8. super('heroDetail', elementRef, injector);
  9. }
  10. }

hero-detail.component.ts

  1. @NgModule({
  2. imports: [
  3. BrowserModule,
  4. UpgradeModule
  5. ],
  6. declarations: [
  7. HeroDetailDirective,
  8. /* . . . */
  9. ]
  10. })
  11. export class AppModule {
  12. ngDoBootstrap() {}
  13. }

升级后的组件是Angular的指令,而不是组件,因为Angular不知道AngularJS将在它下面创建元素。 Angular所知道的是升级后的组件只是一个指令(一个标签),Angular不需要关心组件本身及其子元素。

升级后的组件也可能有输入属性和输出属性,它们是在原AngularJS组件型指令的scope/controller绑定中定义的。 当我们从Angular模板中使用该组件时,我们要使用Angular模板语法来提供这些输入属性和输出属性,但要遵循下列规则:

绑定定义

模板语法

属性(Attribute)绑定

myAttribute: '@myAttribute'

<my-component myAttribute="value">

表达式绑定

myOutput: '&myOutput'

<my-component (myOutput)="action()">

单向绑定

myValue: '<myValue'

<my-component [myValue]="anExpression">

双向绑定

myValue: '=myValue'

用作输入:<my-component [myValue]="anExpression"> 或 用作双向绑定:<my-component [(myValue)]="anExpression"

举个例子,假设我们在AngularJS中有一个表示“英雄详情”的组件型指令,它带有一个输入属性和一个输出属性:

hero-detail.component.ts

  1. export const heroDetail = {
  2. bindings: {
  3. hero: '<',
  4. deleted: '&'
  5. },
  6. template: `
  7. <h2>{{$ctrl.hero.name}} details!</h2>
  8. <div><label>id: </label>{{$ctrl.hero.id}}</div>
  9. <button ng-click="$ctrl.onDelete()">Delete</button>
  10. `,
  11. controller: function() {
  12. this.onDelete = () => {
  13. this.deleted(this.hero);
  14. };
  15. }
  16. };

我们可以把这个组件升级到Angular,然后使用Angular的模板语法提供这个输入属性和输出属性:

hero-detail.component.ts

  1. import { Directive, ElementRef, Injector, Input, Output, EventEmitter } from '@angular/core';
  2. import { UpgradeComponent } from '@angular/upgrade/static';
  3. import { Hero } from '../hero';
  4. @Directive({
  5. selector: 'hero-detail'
  6. })
  7. export class HeroDetailDirective extends UpgradeComponent {
  8. @Input() hero: Hero;
  9. @Output() deleted: EventEmitter<Hero>;
  10. constructor(elementRef: ElementRef, injector: Injector) {
  11. super('heroDetail', elementRef, injector);
  12. }
  13. }

container.component.ts

  1. import { Component } from '@angular/core';
  2. import { Hero } from '../hero';
  3. @Component({
  4. selector: 'my-container',
  5. template: `
  6. <h1>Tour of Heroes</h1>
  7. <hero-detail [hero]="hero"
  8. (deleted)="heroDeleted($event)">
  9. </hero-detail>
  10. `
  11. })
  12. export class ContainerComponent {
  13. hero = new Hero(1, 'Windstorm');
  14. heroDeleted(hero: Hero) {
  15. hero.name = 'Ex-' + hero.name;
  16. }
  17. }

把AngularJS的内容投影到Angular组件中

Projecting AngularJS content into Angular

如果我们在AngularJS模板中使用降级后的Angular组件时,可能会需要把模板中的一些内容投影进那个组件。 这也是可能的,虽然在Angular中并没有透传(transclude)这样的东西,但它有一个非常相似的概念,叫做内容投影UpgradeModule也能让这两个特性实现互操作。

Angular的组件通过使用<ng-content>标签来支持内容投影。下面是这类组件的一个例子:

hero-detail.component.ts

  1. import { Component, Input } from '@angular/core';
  2. import { Hero } from '../hero';
  3. @Component({
  4. selector: 'hero-detail',
  5. template: `
  6. <h2>{{hero.name}}</h2>
  7. <div>
  8. <ng-content></ng-content>
  9. </div>
  10. `
  11. })
  12. export class HeroDetailComponent {
  13. @Input() hero: Hero;
  14. }

当从AngularJS中使用该组件时,我们可以为它提供内容。正如它们将在AngularJS中被透传一样, 它们也在Angular中被投影到了<ng-content>标签所在的位置:

  1. <div ng-controller="MainController as mainCtrl">
  2. <hero-detail [hero]="mainCtrl.hero">
  3. <!-- Everything here will get projected -->
  4. <p>{{mainCtrl.hero.description}}</p>
  5. </hero-detail>
  6. </div>

当AngularJS的内容被投影到Angular组件中时,它仍然留在“AngularJS王国”中,并被AngularJS框架管理着。

把Angular的内容透传进AngularJS的组件型指令

Projecting Angular content into AngularJS

就像我们能把AngularJS的内容投影进Angular组件一样,我们也能把Angular的内容透传进AngularJS的组件, 但不管怎样,我们都要使用它们升级过的版本。

如果一个AngularJS组件型指令支持透传,它就会在自己的模板中使用ng-transclude指令标记出透传到的位置:

hero-detail.component.ts

  1. export const heroDetail = {
  2. bindings: {
  3. hero: '='
  4. },
  5. template: `
  6. <h2>{{$ctrl.hero.name}}</h2>
  7. <div>
  8. <ng-transclude></ng-transclude>
  9. </div>
  10. `
  11. };

该指令还需要启用一个transclude: true选项。当用AngularJS.5中的组件API定义组件型指令时,该选项默认是开启的。

如果我们升级这个组件,并把它用在Angular中,我们就能把准备透传的内容放进这个组件的标签中。

container.component.ts

  1. import { Component } from '@angular/core';
  2. import { Hero } from '../hero';
  3. @Component({
  4. selector: 'my-container',
  5. template: `
  6. <hero-detail [hero]="hero">
  7. <!-- Everything here will get transcluded -->
  8. <p>{{hero.description}}</p>
  9. </hero-detail>
  10. `
  11. })
  12. export class ContainerComponent {
  13. hero = new Hero(1, 'Windstorm', 'Specific powers of controlling winds');
  14. }

让AngularJS中的依赖可被注入到Angular

当运行一个混合式应用时,我们可能会遇到这种情况:我们需要把某些AngularJS的依赖注入到Angular代码中。 这可能是因为某些业务逻辑仍然在AngularJS服务中,或者需要某些AngularJS的内置服务,比如$location$timeout

在这些情况下,把一个AngularJS提供商升级到Angular也是有可能的。这就让它将来有可能被注入到Angular代码中的某些地方。 比如,我们可能在AngularJS中有一个名叫HeroesService的服务:

heroes.service.ts

  1. import { Hero } from '../hero';
  2. export class HeroesService {
  3. get() {
  4. return [
  5. new Hero(1, 'Windstorm'),
  6. new Hero(2, 'Spiderman')
  7. ];
  8. }
  9. }

我们可以Angular的工厂提供商(factory provider)升级该服务, 它从AngularJS的$injector请求服务。Angular依赖的名称由你确定:

我们建议在一个独立的ajs-upgraded-providers.ts中声明这个工厂提供商,以便把它们都放在一起,这样便于引用、创建新的以及在升级完毕时删除它们。

我们还建议导出heroesServiceFactory函数,以便AOT编译器可以拿到它们。

ajs-upgraded-providers.ts

  1. import { HeroesService } from './heroes.service';
  2. export function heroesServiceFactory(i: any) {
  3. return i.get('heroes');
  4. }
  5. export const heroesServiceProvider = {
  6. provide: HeroesService,
  7. useFactory: heroesServiceFactory,
  8. deps: ['$injector']
  9. };

app.module.ts

  1. import { heroesServiceProvider } from './ajs-upgraded-providers';
  2. @NgModule({
  3. imports: [
  4. BrowserModule,
  5. UpgradeModule
  6. ],
  7. providers: [
  8. heroesServiceProvider
  9. ],
  10. /* . . . */
  11. })
  12. export class AppModule {
  13. ngDoBootstrap() {}
  14. }

然后我们可以一个字符串型令牌,把它注入到Angular中:

hero-detail.component.ts

  1. import { Component } from '@angular/core';
  2. import { HeroesService } from './heroes.service';
  3. import { Hero } from '../hero';
  4. @Component({
  5. selector: 'hero-detail',
  6. template: `
  7. <h2>{{hero.id}}: {{hero.name}}</h2>
  8. `
  9. })
  10. export class HeroDetailComponent {
  11. hero: Hero;
  12. constructor(heroes: HeroesService) {
  13. this.hero = heroes.get()[0];
  14. }
  15. }

在这个例子中,我们升级了服务类。当我们注入它时,我们可以使用TypeScript类型注解来获得这些额外的好处。 它没有影响该依赖的处理过程,同时还得到了启用静态类型检查的好处。 任何AngularJS中的服务、工厂和提供商都能被升级 —— 尽管这不是必须的。

让Angular的依赖能被注入到AngularJS中

除了能升级AngularJS依赖之外,我们还能降级Angular的依赖,以便我们能在AngularJS中使用它们。 当我们已经开始把服务移植到Angular或在Angular中创建新服务,但同时还有一些用AngularJS写成的组件时,这会非常有用。

例如,我们可能有一个Angular的Heroes服务:

heroes.ts

  1. import { Injectable } from '@angular/core';
  2. import { Hero } from '../hero';
  3. @Injectable()
  4. export class Heroes {
  5. get() {
  6. return [
  7. new Hero(1, 'Windstorm'),
  8. new Hero(2, 'Spiderman')
  9. ];
  10. }
  11. }

仿照Angular组件,我们通过把该提供商加入NgModuleproviders列表中来注册它。

app.module.ts

  1. import { Heroes } from './heroes';
  2. @NgModule({
  3. imports: [
  4. BrowserModule,
  5. UpgradeModule
  6. ],
  7. providers: [ Heroes ]
  8. })
  9. export class AppModule {
  10. ngDoBootstrap() {}
  11. }

现在,我们使用upgradeAdapter.downgradeNg2Provider()来把Angular的Heroes包装成AngularJS的工厂函数,并把这个工厂注册进AngularJS的模块中。 依赖在AngularJS中的名字你可以自己定:

app.module.ts

  1. import { downgradeInjectable } from '@angular/upgrade/static';
  2. angular.module('heroApp', [])
  3. .factory('heroes', downgradeInjectable(Heroes))
  4. .component('heroDetail', heroDetailComponent);

此后,该服务就能被注入到AngularJS代码中的任何地方了:

hero-detail.component.ts

  1. export const heroDetailComponent = {
  2. template: `
  3. <h2>{{$ctrl.hero.id}}: {{$ctrl.hero.name}}</h2>
  4. `,
  5. controller: ['heroes', function(heroes: Heroes) {
  6. this.hero = heroes.get()[0];
  7. }]
  8. };

在混合式应用中使用AOT编译

我们也可以其它Angular应用一样在混合式应用中发挥AOT编译的优势。 对混合式应用的设置过程和预编译章节中所讲的几乎完全一样,不同点在于index.htmlmain-aot.ts中。

我们的index.html仍然需要script标签来加载AngularJS的文件,因此我们使用AOT编译的index.html也需要加载那些文件。 复制它们的简单方案是把它们全都添加到copy-dist-files.js文件中。

我们还要使用UpgradeModule在启动了模块工厂之后引导一个混合式应用:

app/main-aot.ts

  1. import { platformBrowser } from '@angular/platform-browser';
  2. import { UpgradeModule } from '@angular/upgrade/static';
  3. import { AppModuleNgFactory } from '../aot/app/app.module.ngfactory';
  4. platformBrowser().bootstrapModuleFactory(AppModuleNgFactory).then(platformRef => {
  5. const upgrade = platformRef.injector.get(UpgradeModule) as UpgradeModule;
  6. upgrade.bootstrap(document.documentElement, ['phonecatApp']);
  7. });

这就是我们为获取Angular应用的AOT优势所要做的一切。

AOT元数据收集器不能检测到父类原型中的生命周期钩子方法,因此为了让升级后的组件正常工作,我们要在升级后的组件类中实现生命周期钩子, 并且把它们转发给UpgradeComponent的父类。

在Angular和AngularJS之间划分路由

升级中的另一个重要部分是升级路由。 我们固然可以升级整个应用但仍然使用AngularJS的路由器,然后一举把所有路由迁移过去。 但更好地方式是在升级每个路由时逐个把它们迁移过去。

让两个版本的路由器并存的第一步就是为每个路由器添加一个包含单一出口的根组件。 AngularJS将会使用ng-view,而Angular将会使用router-outlet。 当使用其中的一个路由器时,另一个路由出口就是空白的。

app.component.ts

  1. import { Component } from '@angular/core';
  2. @Component({
  3. selector: 'my-app',
  4. template: `
  5. <router-outlet></router-outlet>
  6. <div ng-view></div>
  7. `,
  8. })
  9. export class AppComponent { }

我们要在index.htmlbody中使用该组件来代替AngularJS的组件。

app.component.ts (body)

  1. <body>
  2. <my-app>Loading...</my-app>
  3. </body>

接下来,我们用标准方式同时声明AngularJS和Angular的路由:

app.module.ts (AngularJS route)

  1. $routeProvider
  2. .when('/villain', { template: '<villain-detail></villain-detail>' });

hero.module.ts (Angular route)

  1. RouterModule.forChild([
  2. { path: 'hero', children: [
  3. { path: '', component: HeroDetailComponent },
  4. ] },
  5. ])

app.module.ts中,我们需要把AppComponent添加到declarationsbootstrap数组中。

接下来,我们配置路由器本身。 我们要在Angular中使用hash navigation,因为我们也要在AngularJS中使用这种方式。

最后,最重要的是,我们要使用一个自定义的UrlHandlingStrategy,它会告诉Angular路由器应该渲染(且只渲染)哪个路由。

app.module.ts (router config)

  1. import { HashLocationStrategy, LocationStrategy } from '@angular/common';
  2. import { RouterModule, UrlHandlingStrategy, UrlTree } from '@angular/router';
  3. import { AppComponent } from './app.component';
  4. class HybridUrlHandlingStrategy implements UrlHandlingStrategy {
  5. // use only process the `/hero` url
  6. shouldProcessUrl(url: UrlTree) { return url.toString().startsWith('/hero'); }
  7. extract(url: UrlTree) { return url; }
  8. merge(url: UrlTree, whole: UrlTree) { return url; }
  9. }
  10. @NgModule({
  11. imports: [
  12. BrowserModule,
  13. UpgradeModule,
  14. HeroModule,
  15. RouterModule.forRoot([])
  16. ],
  17. providers: [
  18. // use hash location strategy
  19. { provide: LocationStrategy, useClass: HashLocationStrategy },
  20. // use custom url handling strategy
  21. { provide: UrlHandlingStrategy, useClass: HybridUrlHandlingStrategy }
  22. ],
  23. declarations: [ AppComponent ],
  24. bootstrap: [ AppComponent ]
  25. })
  26. export class AppModule { }

就这样!现在我们可以同时运行这两个路由器了。

PhoneCat升级教程

在本节和下节中,我们将看一个完整的例子,它使用upgrade模块准备和升级了一个应用程序。 该应用就是来自原AngularJS教程中的Angular PhoneCat。 那是我们很多人当初开始Angular探险之旅的起点。 现在,我们来看看如何把该应用带入Angular的美丽新世界。

这期间,我们将学到如何在实践中应用准备指南中列出的那些重点步骤: 我们先让该应用向Angular看齐,然后为它引入SystemJS模块加载器和TypeScript。

要跟随本教程,请先把angular-phonecat仓库克隆到本地,并跟我们一起应用这些步骤。

在项目结构方面,我们工作的起点是这样的:

angular-phonecat
bower.json
karma.conf.js
package.json
app
core
checkmark
checkmark.filter.js
checkmark.filter.spec.js
phone
phone.module.js
phone.service.js
phone.service.spec.js
core.module.js
phone-detail
phone-detail.component.js
phone-detail.component.spec.js
phone-detail.module.js
phone-detail.template.html
phone-list
phone-list.component.js
phone-list.component.spec.js
phone-list.module.js
phone-list.template.html
img
...
phones
...
app.animations.js
app.config.js
app.css
app.module.js
index.html
e2e-tests
protractor-conf.js
scenarios.js

这确实是一个很好地起点。特别是,该结构遵循了AngularJS 风格指南, 要想成功升级,这是一个很重要的准备步骤

切换到TypeScript

因为我们将使用TypeScript编写Angular的代码,所以在开始升级之前,我们把TypeScript的编译器设置好是很合理的。

我们还将开始逐步淘汰Bower包管理器,换成我们更喜欢的NPM。后面我们将使用NPM来安装新的依赖包,并最终从项目中移除Bower。

让我们先把TypeScript包安装到项目中。

npm i typescript --save-dev

我们还要把用来运行TypeScript编译器tsctypings工具的脚本添加到package.json中:

package.json

  1. {
  2. "scripts": {}
  3. }

现在我们可以使用typings工具来安装AngularJS和Jasmine单元测试框架的类型定义文件。

npm install @types/jasmine @types/angular  @types/angular-animate @types/angular-cookies @types/angular-mocks @types/angular-resource @types/angular-route @types/angular-sanitize --save-dev

我们还应该配置TypeScript编译器,以便它能理解我们的项目结构。我们要往项目目录下添加一个tsconfig.json文件, 就像在搭建本地开发环境中做过的那样。它将告诉TypeScript编译器,该如何编译我们的源文件。

tsconfig.json

  1. {
  2. "compilerOptions": {
  3. "target": "es5",
  4. "module": "commonjs",
  5. "moduleResolution": "node",
  6. "sourceMap": true,
  7. "emitDecoratorMetadata": true,
  8. "experimentalDecorators": true,
  9. "removeComments": false,
  10. "noImplicitAny": false,
  11. "suppressImplicitAnyIndexErrors": true
  12. }
  13. }

我们告诉TypeScript编译器,把TypeScript文件转换成ES5代码,并打包进CommonJS模块中。

我们现在可以从命令行启动TypeScript编译器。它将监控.ts源码文件,并随时把它们编译成JavaScript。 然后这些编译出的.js文件被SystemJS加载到浏览器中。当我们继续往前走的时候,这个过程将在后台持续运行。

npm run tsc:w

我们要做的下一件事是把JavaScript文件转换成TypeScript文件。 由于TypeScript是ECMAScript 2015的一个超集,而ES2015又是ECMAScript 5的超集,所以我们可以简单的把文件的扩展名从.js换成.ts, 它们还是会像以前一样工作。由于TypeScript编译器仍在运行,它会为每一个.ts文件生成对应的.js文件,而真正运行的是编译后的.js文件。 如果你用npm start开启了本项目的HTTP服务器,你会在浏览器中看到一个功能完好的应用。

有了TypeScript,我们就可以从它的一些特性中获益了。此语言可以为AngularJS应用提供很多价值。

首先,TypeScript是一个ES2015的超集。任何以前用ES5写的程序(就像PhoneCat范例)都可以开始通过TypeScript 纳入那些添加到ES2015中的新特性。 这包括letconst、箭头函数、函数默认参数以及解构(destructure)赋值。

我们能做的另一件事就是把类型安全添加到代码中。这实际上已经部分完成了,因为我们已经安装了AngularJS的类型定义。 当我们正确调用AngularJS的API时,TypeScript会帮我们检查它 —— 比如往Angular模块中注册组件。

我们还能开始把类型注解添加到自己的代码中,来从TypeScript的类型系统中获得更多帮助。 比如,我们可以给checkmark过滤器加上注解,表明它期待一个boolean类型的参数。 这可以更清楚的表明此过滤器打算做什么

app/core/checkmark/checkmark.filter.ts

  1. angular.
  2. module('core').
  3. filter('checkmark', function() {
  4. return function(input: boolean) {
  5. return input ? '\u2713' : '\u2718';
  6. };
  7. });

Phone服务中,我们可以明确的把$resource服务声明为angular.resource.IResourceService,一个AngularJS类型定义提供的类型。

app/core/phone/phone.service.ts

  1. angular.
  2. module('core.phone').
  3. factory('Phone', ['$resource',
  4. function($resource: angular.resource.IResourceService) {
  5. return $resource('phones/:phoneId.json', {}, {
  6. query: {
  7. method: 'GET',
  8. params: {phoneId: 'phones'},
  9. isArray: true
  10. }
  11. });
  12. }
  13. ]);

我们可以在应用的路由配置中使用同样的技巧,那里我们用到了location和route服务。 一旦给它们提供了类型信息,TypeScript就能检查我们是否在用类型的正确参数来调用它们了。

app/app.config.ts

  1. angular.
  2. module('phonecatApp').
  3. config(['$locationProvider', '$routeProvider',
  4. function config($locationProvider: angular.ILocationProvider,
  5. $routeProvider: angular.route.IRouteProvider) {
  6. $locationProvider.hashPrefix('!');
  7. $routeProvider.
  8. when('/phones', {
  9. template: '<phone-list></phone-list>'
  10. }).
  11. when('/phones/:phoneId', {
  12. template: '<phone-detail></phone-detail>'
  13. }).
  14. otherwise('/phones');
  15. }
  16. ]);

我们用typings工具安装的这个AngularJS.x类型定义文件 并不是由Angular开发组维护的,但它也已经足够全面了。借助这些类型定义的帮助,它可以为AngularJS.x程序加上全面的类型注解。

如果我们想这么做,那么在tsconfig.json中启用noImplicitAny配置项就是一个好主意。 这样,如果遇到什么还没有类型注解的代码,TypeScript编译器就会显示一个警告。 我们可以用它作为指南,告诉我们现在与一个完全类型化的项目距离还有多远。

我们能用的另一个TypeScript特性是。具体来讲,我们可以把控制器转换成类。 这种方式下,我们离成为Angular组件类就又近了一步,它会令我们的升级之路变得更简单。

AngularJS期望控制器是一个构造函数。这实际上就是ES2015/TypeScript中的类, 这也就意味着只要我们把一个类注册为组件控制器,AngularJS就会愉快的使用它。

新的“电话列表(phone list)”组件控制器类是这样的:

app/phone-list/phone-list.component.ts

  1. class PhoneListController {
  2. phones: any[];
  3. orderProp: string;
  4. query: string;
  5. static $inject = ['Phone'];
  6. constructor(Phone: any) {
  7. this.phones = Phone.query();
  8. this.orderProp = 'age';
  9. }
  10. }
  11. angular.
  12. module('phoneList').
  13. component('phoneList', {
  14. templateUrl: 'phone-list/phone-list.template.html',
  15. controller: PhoneListController
  16. });

以前在控制器函数中实现的一切,现在都改由类的构造函数来实现了。类型注入注解通过静态属性$inject 被附加到了类上。在运行时,它们变成了PhoneListController.$inject

该类还声明了另外三个成员:电话列表、当前排序键的名字和搜索条件。 这些东西我们以前就加到了控制器上,只是从来没有在任何地方显式定义过它们。最后一个成员从未真正在TypeScript代码中用过, 因为它只是在模板中被引用过。但为了清晰起见,我们还是应该定义出此控制器应有的所有成员。

在电话详情控制器中,我们有两个成员:一个是用户正在查看的电话,另一个是正在显示的图像:

app/phone-detail/phone-detail.component.ts

  1. class PhoneDetailController {
  2. phone: any;
  3. mainImageUrl: string;
  4. static $inject = ['$routeParams', 'Phone'];
  5. constructor($routeParams: angular.route.IRouteParamsService, Phone: any) {
  6. let phoneId = $routeParams['phoneId'];
  7. this.phone = Phone.get({phoneId}, (phone: any) => {
  8. this.setImage(phone.images[0]);
  9. });
  10. }
  11. setImage(imageUrl: string) {
  12. this.mainImageUrl = imageUrl;
  13. }
  14. }
  15. angular.
  16. module('phoneDetail').
  17. component('phoneDetail', {
  18. templateUrl: 'phone-detail/phone-detail.template.html',
  19. controller: PhoneDetailController
  20. });

这已经让我们的控制器代码看起来更像Angular了。我们的准备工作做好了,可以引进Angular到项目中了。

如果项目中有任何AngularJS的服务,它们也是转换成类的优秀候选人,像控制器一样,它们也是构造函数。 但是在本项目中,我们只有一个Phone工厂,这有点特别,因为它是一个ngResource工厂。 所以我们不会在准备阶段中处理它,而是在下一节中直接把它转换成Angular服务。

安装Angular

我们已经完成了准备工作,接下来就开始把PhoneCat升级到Angular。 我们将在Angular升级模块的帮助下增量式的完成此项工作。 等我们完成的那一刻,就能把AngularJS从项目中完全移除了,但其中的关键是在不破坏此程序的前提下一小块一小块的完成它。

该项目还包含一些动画,在此指南的当前版本我们先不升级它,等到后面的发行版再改。

我们来使用SystemJS模块加载器把Angular安装到项目中。 看看搭建本地开发环境中的指南,并从那里获得如下配置:

这些完成之后,就运行:

npm install

我们可以通过index.html来把Angular的依赖快速加载到应用中, 但首先,我们得做一些目录结构调整。这是因为我们正准备从node_modules中加载文件,然而目前项目中的每一个文件都是从/app目录下加载的。

app/index.html移入项目的根目录,然后把package.json中的开发服务器根目录也指向项目的根目录,而不再是app目录:

package.json (start script)

  1. {
  2. "scripts": {
  3. "start": "http-server -a localhost -p 8000 -c-1 ./"
  4. }
  5. }

现在,我们能把项目根目录下的每一样东西发给浏览器了。但我们不想为了适应开发环境中的设置,被迫修改应用代码中用到的所有图片和数据的路径。因此,我们往index.html中添加一个<base>标签,它将导致各种相对路径被解析回/app目录:

index.html

<base href="/app/">

现在我们可以通过SystemJS加载Angular了。我们将把Angular的填充库(polyfills) 和SystemJS的配置加到<head>区的末尾,然后,我们就用System.import来加载实际的应用:

index.html

  1. <script src="/node_modules/core-js/client/shim.min.js"></script>
  2. <script src="/node_modules/zone.js/dist/zone.js"></script>
  3. <script src="/node_modules/systemjs/dist/system.src.js"></script>
  4. <script src="/systemjs.config.js"></script>
  5. <script>
  6. System.import('/app');
  7. </script>

我们还需要对环境设置期间安装的systemjs.config.js文件做一些调整。

我们要在通过SystemJS加载期间为浏览器指出项目的根在哪里,而不再使用<base> URL。

我们还要通过npm install @angular/upgrade --save来安装upgrade包,并为@angular/upgrade/static包添加一个映射。

systemjs.config.js

  1. System.config({
  2. paths: {
  3. // paths serve as alias
  4. 'npm:': '/node_modules/'
  5. },
  6. map: {
  7. app: '/app',
  8. /* . . . */
  9. '@angular/upgrade/static': 'npm:@angular/upgrade/bundles/upgrade-static.umd.js',
  10. /* . . . */
  11. },

创建AppModule

现在,创建一个名叫AppModule的根NgModule类。 我们已经有了一个名叫app.module.ts的文件,其中存放着AngularJS的模块。 把它改名为app.module.ng1.ts,同时也要在index.html中更新对应的脚本名。 文件的内容保留:

app.module.ajs.ts

  1. 'use strict';
  2. // Define the `phonecatApp` AngularJS module
  3. angular.module('phonecatApp', [
  4. 'ngAnimate',
  5. 'ngRoute',
  6. 'core',
  7. 'phoneDetail',
  8. 'phoneList',
  9. ]);

然后创建一个新的app.module.ts文件,其中是一个最小化的NgModule类:

app.module.ts

  1. import { NgModule } from '@angular/core';
  2. import { BrowserModule } from '@angular/platform-browser';
  3. @NgModule({
  4. imports: [
  5. BrowserModule,
  6. ],
  7. })
  8. export class AppModule {
  9. }

引导PhoneCat的1+2混合式应用

接下来,我们把该应用程序引导改装为一个同时支持AngularJS和Angular的混合式应用。 然后,就能开始把这些不可分割的小块转换到Angular了。

要引导一个混合式应用程序, 我们首先需要在AppModule中导入`UpgradeModule,并覆盖它的启动方法:

app/app.module.ts

  1. import { UpgradeModule } from '@angular/upgrade/static';
  2. @NgModule({
  3. imports: [
  4. BrowserModule,
  5. UpgradeModule,
  6. ],
  7. })
  8. export class AppModule {
  9. ngDoBootstrap() {}
  10. }

我们的应用现在是使用宿主页面中附加到<html>元素上的ng-app指令引导的。 但在Angular中,它不再工作了。我们得切换成JavaScript驱动的引导方式。

所以,从index.html中移除ng-app属性,并把这些加载main.ts中。 在systemjs.config.js中已经将此文件配置为应用的入口,所以它已被浏览器所加载。

  1. import { platformBrowserDynamic } from '@angular/platform-browser-dynamic';
  2. import { UpgradeModule } from '@angular/upgrade/static';
  3. import { AppModule } from './app.module';
  4. platformBrowserDynamic().bootstrapModule(AppModule).then(platformRef => {
  5. const upgrade = platformRef.injector.get(UpgradeModule) as UpgradeModule;
  6. upgrade.bootstrap(document.documentElement, ['phonecatApp']);
  7. });

这里使用的参数是应用的根元素(也就是以前我们放ng-app的元素),和我们准备加载的AngularJS.x模块。 由于我们是通过UpgradeAdapter引导应用的,所以实际在运行的应用实际上是一个混合体。

我们现在同时运行着AngularJS和Angular。漂亮!不过我们还没有运行什么实际的Angular组件,接下来我们就做这件事。

为何要声明angularangular.IAngularStatic

@types/angular声明为UMD模块,根据UMD类型 的工作方式,一旦你在文件中有一条ES6的import语句,所有的UMD类型化的模型必须都通过import语句导入, 而是不是全局可用。

AngularJS是日前是通过index.html中的script标签加载,这意味着整个应用是作为一个全局变量进行访问的, 使用同一个angular变量的实例。 但如果我们使用import * as angular from 'angular',我还需要彻底修改AngularJS应用中加载每个文件的方式, 确保AngularJS应用被正确加载。

这需要相当多的努力,通常也不值得去做,特别是我们的应用正在朝着Angular前进。 但如果我们声明angularangular.IAngularStatic,指明它是一个全局变量, 仍然可以获得全面的类型支持。

升级Phone服务

我们要移植到Angular的第一块是Phone工厂(位于app/js/core/phones.factory.ts), 并且让它能帮助控制器从服务器上加载电话信息。目前,它是用ngResource实现的,我们用它做两件事:

我们可以用Angular的服务类来替换这个实现,而把控制器继续留在AngularJS的地盘上。

在这个新版本中,我们导入了Angular的HTTP模块,并且用它的Http服务替换掉NgResource

再次打开app.module.ts文件,导入并把HttpModule添加到AppModuleimports数组中:

app.module.ts

  1. import { HttpModule } from '@angular/http';
  2. @NgModule({
  3. imports: [
  4. BrowserModule,
  5. UpgradeModule,
  6. HttpModule,
  7. ],
  8. })
  9. export class AppModule {
  10. ngDoBootstrap() {}
  11. }

现在,我们已经准备好了升级Phones服务本身。我们将为phone.service.ts文件中基于ngResource的服务加上@Injectable装饰器:

app/core/phone/phone.service.ts (skeleton)

@Injectable()
export class Phone {
/* . . . */
}

@Injectable装饰器将把一些依赖注入相关的元数据附加到该类上,让Angular知道它的依赖信息。 就像在依赖注入指南中描述过的那样, 这是一个标记装饰器,我们要把它用在那些没有其它Angular装饰器,并且自己有依赖注入的类上。

在它的构造函数中,该类期待一个Http服务。Http服务将被注入进来并存入一个私有字段。 然后该服务在两个实例方法中被使用到,一个加载所有电话的列表,另一个加载一台指定电话的详情:

  1. @Injectable()
  2. export class Phone {
  3. constructor(private http: Http) { }
  4. query(): Observable<PhoneData[]> {
  5. return this.http.get(`phones/phones.json`)
  6. .map((res: Response) => res.json());
  7. }
  8. get(id: string): Observable<PhoneData> {
  9. return this.http.get(`phones/${id}.json`)
  10. .map((res: Response) => res.json());
  11. }
  12. }

该方法现在返回一个Phone类型或Phone[]类型的可观察对象(Observable)。 这是一个我们从未用过的类型,因此我们得为它新增一个简单的接口:

app/core/phone/phone.service.ts (interface)

export interface PhoneData {
  name: string;
  snippet: string;
  images: string[];
}

@angular/upgrade/static有一个downgradeInjectable方法,可以使Angular服务在AngularJS的代码中可用。 使用它来插入Phone服务:

app/core/phone/phone.service.ts (downgrade)

declare var angular: angular.IAngularStatic;
import { downgradeInjectable } from '@angular/upgrade/static';
/* . . . */
@Injectable()
export class Phone {
/* . . . */
}

angular.module('core.phone')
  .factory('phone', downgradeInjectable(Phone));

最终,该类的全部代码如下:

app/core/phone/phone.service.ts

  1. import { Injectable } from '@angular/core';
  2. import { Http, Response } from '@angular/http';
  3. import { Observable } from 'rxjs/Rx';
  4. declare var angular: angular.IAngularStatic;
  5. import { downgradeInjectable } from '@angular/upgrade/static';
  6. import 'rxjs/add/operator/map';
  7. export interface PhoneData {
  8. name: string;
  9. snippet: string;
  10. images: string[];
  11. }
  12. @Injectable()
  13. export class Phone {
  14. constructor(private http: Http) { }
  15. query(): Observable<PhoneData[]> {
  16. return this.http.get(`phones/phones.json`)
  17. .map((res: Response) => res.json());
  18. }
  19. get(id: string): Observable<PhoneData> {
  20. return this.http.get(`phones/${id}.json`)
  21. .map((res: Response) => res.json());
  22. }
  23. }
  24. angular.module('core.phone')
  25. .factory('phone', downgradeInjectable(Phone));

注意,我们单独导入了RxJS Observable中的map操作符。 我们需要对想用的所有RxJS操作符这么做,因为Angular默认不会加载所有RxJS操作符。

这个新的Phone服务具有和老的基于ngResource的服务相同的特性。 因为它是Angular服务,我们通过NgModuleproviders数组来注册它:

app.module.ts

  1. import { Phone } from './core/phone/phone.service';
  2. @NgModule({
  3. imports: [
  4. BrowserModule,
  5. UpgradeModule,
  6. HttpModule,
  7. ],
  8. providers: [
  9. Phone,
  10. ]
  11. })
  12. export class AppModule {
  13. ngDoBootstrap() {}
  14. }

现在,我们正在用SystemJS加载phone.service.ts,我们应该从index.html移除该服务的<script>标签。 这也是我们在升级所有组件时将会做的事。在从AngularJS向2升级的同时,我们也把代码从脚本移植为模块。

这时,我们可以把两个控制器从使用老的服务切换成使用新的。我们像降级过的phones工厂一样$inject它, 但它实际上是一个Phones类的实例,并且我们可以据此注解它的类型:

app/phone-list/phone-list.component.ts

  1. declare var angular: angular.IAngularStatic;
  2. import { Phone, PhoneData } from '../core/phone/phone.service';
  3. class PhoneListController {
  4. phones: PhoneData[];
  5. orderProp: string;
  6. static $inject = ['phone'];
  7. constructor(phone: Phone) {
  8. phone.query().subscribe(phones => {
  9. this.phones = phones;
  10. });
  11. this.orderProp = 'age';
  12. }
  13. }
  14. angular.
  15. module('phoneList').
  16. component('phoneList', {
  17. templateUrl: 'app/phone-list/phone-list.template.html',
  18. controller: PhoneListController
  19. });

app/phone-detail/phone-detail.component.ts

  1. declare var angular: angular.IAngularStatic;
  2. import { Phone, PhoneData } from '../core/phone/phone.service';
  3. class PhoneDetailController {
  4. phone: PhoneData;
  5. mainImageUrl: string;
  6. static $inject = ['$routeParams', 'phone'];
  7. constructor($routeParams: angular.route.IRouteParamsService, phone: Phone) {
  8. let phoneId = $routeParams['phoneId'];
  9. phone.get(phoneId).subscribe(data => {
  10. this.phone = data;
  11. this.setImage(data.images[0]);
  12. });
  13. }
  14. setImage(imageUrl: string) {
  15. this.mainImageUrl = imageUrl;
  16. }
  17. }
  18. angular.
  19. module('phoneDetail').
  20. component('phoneDetail', {
  21. templateUrl: 'phone-detail/phone-detail.template.html',
  22. controller: PhoneDetailController
  23. });

这里的两个AngularJS控制器在使用Angular的服务!控制器不需要关心这一点,尽管实际上该服务返回的是可观察对象(Observable),而不是承诺(Promise)。 无论如何,我们达到的效果都是把服务移植到Angular,而不用被迫移植组件来使用它。

我们也能使用ObservabletoPromise方法来在服务中把这些可观察对象转变成承诺,以进一步减小组件控制器中需要修改的代码量。

升级组件

接下来,我们把AngularJS的控制器升级成Angular的组件。我们每次升级一个,同时仍然保持应用运行在混合模式下。 在做转换的同时,我们还将自定义首个Angular管道

让我们先看看电话列表组件。它目前包含一个TypeScript控制器类和一个组件定义对象。重命名控制器类, 并把AngularJS的组件定义对象更换为Angular @Component装饰器,这样我们就把它变形为Angular 的组件了。然后,我们还从类中移除静态$inject属性。

app/phone-list/phone-list.component.ts

  1. import { Component } from '@angular/core';
  2. import { Phone, PhoneData } from '../core/phone/phone.service';
  3. @Component({
  4. selector: 'phone-list',
  5. templateUrl: 'phone-list.template.html'
  6. })
  7. export class PhoneListComponent {
  8. phones: PhoneData[];
  9. query: string;
  10. orderProp: string;
  11. constructor(phone: Phone) {
  12. phone.query().subscribe(phones => {
  13. this.phones = phones;
  14. });
  15. this.orderProp = 'age';
  16. }
  17. /* . . . */
  18. }

selector属性是一个CSS选择器,用来定义组件应该被放在页面的哪。在AngularJS,我们基于组件名字来匹配, 但是在Angular中,我们要有一个专门指定的选择器。本组件将会对应元素名字phone-list,和AngularJS版本一样。

现在,我们还需要将组件的模版也转换为Angular语法。在搜索控件中,我们要为把AngularJS的$ctrl表达式替换成Angular的双向绑定语法[(ngModel)]

app/phone-list/phone-list.template.html (search controls)

<p>
  Search:
  <input [(ngModel)]="query" />
</p>

<p>
  Sort by:
  <select [(ngModel)]="orderProp">
    <option value="name">Alphabetical</option>
    <option value="age">Newest</option>
  </select>
</p>

我们需要把列表中的ng-repeat替换为*ngFor以及它的let var of iterable语法, 该语法在模板语法指南中讲过。 对于图片,我们可以把img标签的ng-src替换为一个标准的src属性(property)绑定。

app/phone-list/phone-list.template.html (phones)

<ul class="phones">
  <li *ngFor="let phone of getPhones()"
      class="thumbnail phone-list-item">
    <a href="/#!/phones/{{phone.id}}" class="thumb">
      <img [src]="phone.imageUrl" [alt]="phone.name" />
    </a>
    <a href="/#!/phones/{{phone.id}}" class="name">{{phone.name}}</a>
    <p>{{phone.snippet}}</p>
  </li>
</ul>

Angular中没有filterorderBy过滤器

Angular中并不存在AngularJS中内置的filterorderBy过滤器。 所以我们得自己实现进行过滤和排序。

我们把filterorderBy过滤器改成绑定到控制器中的getPhones()方法,通过该方法,组件本身实现了过滤和排序逻辑。

app/phone-list/phone-list.component.ts

  1. getPhones(): PhoneData[] {
  2. return this.sortPhones(this.filterPhones(this.phones));
  3. }
  4. private filterPhones(phones: PhoneData[]) {
  5. if (phones && this.query) {
  6. return phones.filter(phone => {
  7. let name = phone.name.toLowerCase();
  8. let snippet = phone.snippet.toLowerCase();
  9. return name.indexOf(this.query) >= 0 || snippet.indexOf(this.query) >= 0;
  10. });
  11. }
  12. return phones;
  13. }
  14. private sortPhones(phones: PhoneData[]) {
  15. if (phones && this.orderProp) {
  16. return phones
  17. .slice(0) // Make a copy
  18. .sort((a, b) => {
  19. if (a[this.orderProp] < b[this.orderProp]) {
  20. return -1;
  21. } else if ([b[this.orderProp] < a[this.orderProp]]) {
  22. return 1;
  23. } else {
  24. return 0;
  25. }
  26. });
  27. }
  28. return phones;
  29. }

现在我们需要降级我们的Angular组件,这样我们就可以在AngularJS中使用它。 我们需要注册一个phoneList指令,而不是注册一个组件,它是一个降级版的Angular组件。

强制类型转换as angular.IDirectiveFactory告诉TypeScript编译器downgradeComponent方法 的返回值是一个指令工厂。

app/phone-list/phone-list.component.ts

  1. declare var angular: angular.IAngularStatic;
  2. import { downgradeComponent } from '@angular/upgrade/static';
  3. /* . . . */
  4. @Component({
  5. selector: 'phone-list',
  6. templateUrl: 'phone-list.template.html'
  7. })
  8. export class PhoneListComponent {
  9. /* . . . */
  10. }
  11. angular.module('phoneList')
  12. .directive(
  13. 'phoneList',
  14. downgradeComponent({component: PhoneListComponent}) as angular.IDirectiveFactory
  15. );

新的PhoneListComponent使用Angular的ngModel指令,它位于FormsModule中。 把FormsModule添加到NgModuleimports中,并声明新的PhoneListComponent组件, 最后由我们把它降级了,添加到entryComponents

app.module.ts

  1. import { FormsModule } from '@angular/forms';
  2. import { PhoneListComponent } from './phone-list/phone-list.component';
  3. @NgModule({
  4. imports: [
  5. BrowserModule,
  6. UpgradeModule,
  7. HttpModule,
  8. FormsModule,
  9. ],
  10. declarations: [
  11. PhoneListComponent,
  12. ],
  13. entryComponents: [
  14. PhoneListComponent,
  15. })
  16. export class AppModule {
  17. ngDoBootstrap() {}
  18. }

index.html中移除电话列表组件的<script>标签。

现在,剩下的phone-detail.component.ts文件变成了这样:

app/phone-detail/phone-detail.component.ts

  1. declare var angular: angular.IAngularStatic;
  2. import { downgradeComponent } from '@angular/upgrade/static';
  3. import { Component } from '@angular/core';
  4. import { Phone, PhoneData } from '../core/phone/phone.service';
  5. import { RouteParams } from '../ajs-upgraded-providers';
  6. @Component({
  7. selector: 'phone-detail',
  8. templateUrl: './phone-detail.template.html',
  9. })
  10. export class PhoneDetailComponent {
  11. phone: PhoneData;
  12. mainImageUrl: string;
  13. constructor(routeParams: RouteParams, phone: Phone) {
  14. phone.get(routeParams['phoneId']).subscribe(phone => {
  15. this.phone = phone;
  16. this.setImage(phone.images[0]);
  17. });
  18. }
  19. setImage(imageUrl: string) {
  20. this.mainImageUrl = imageUrl;
  21. }
  22. }
  23. angular.module('phoneDetail')
  24. .directive(
  25. 'phoneDetail',
  26. downgradeComponent({component: PhoneDetailComponent}) as angular.IDirectiveFactory
  27. );

这和电话列表组件很相似。 这里的窍门在于@Inject装饰器,它标记出了$routeParams依赖。

AngularJS注入器具有AngularJS路由器的依赖,叫做$routeParams。 它被注入到了PhoneDetails中,但PhoneDetails现在还是一个AngularJS控制器。 我们应该把它注入到新的PhoneDetailsComponent中。

不幸的是,AngularJS的依赖不会自动在Angular的组件中可用。 我们必须使用工厂提供商(factory provider) 来把$routeParams包装成Angular的服务提供商。 新建一个名叫ajs-upgraded-providers.ts的文件,并且在app.module.ts中导入它:

app/ajs-upgraded-providers.ts

  1. export abstract class RouteParams {
  2. [key: string]: string;
  3. }
  4. export function routeParamsFactory(i: any) {
  5. return i.get('$routeParams');
  6. }
  7. export const routeParamsProvider = {
  8. provide: RouteParams,
  9. useFactory: routeParamsFactory,
  10. deps: ['$injector']
  11. };

app/app.module.ts ($routeParams)

import { routeParamsProvider } from './ajs-upgraded-providers';
  providers: [
    Phone,
    routeParamsProvider
  ]

我们现在也要把该组件的模板转变成Angular的语法。 这里是它完整的新模板:

app/phone-detail/phone-detail.template.html

  1. <div *ngIf="phone">
  2. <div class="phone-images">
  3. <img [src]="img" class="phone"
  4. [ngClass]="{selected: img === mainImageUrl}"
  5. *ngFor="let img of phone.images" />
  6. </div>
  7. <h1>{{phone.name}}</h1>
  8. <p>{{phone.description}}</p>
  9. <ul class="phone-thumbs">
  10. <li *ngFor="let img of phone.images">
  11. <img [src]="img" (click)="setImage(img)" />
  12. </li>
  13. </ul>
  14. <ul class="specs">
  15. <li>
  16. <span>Availability and Networks</span>
  17. <dl>
  18. <dt>Availability</dt>
  19. <dd *ngFor="let availability of phone.availability">{{availability}}</dd>
  20. </dl>
  21. </li>
  22. <li>
  23. <span>Battery</span>
  24. <dl>
  25. <dt>Type</dt>
  26. <dd>{{phone.battery?.type}}</dd>
  27. <dt>Talk Time</dt>
  28. <dd>{{phone.battery?.talkTime}}</dd>
  29. <dt>Standby time (max)</dt>
  30. <dd>{{phone.battery?.standbyTime}}</dd>
  31. </dl>
  32. </li>
  33. <li>
  34. <span>Storage and Memory</span>
  35. <dl>
  36. <dt>RAM</dt>
  37. <dd>{{phone.storage?.ram}}</dd>
  38. <dt>Internal Storage</dt>
  39. <dd>{{phone.storage?.flash}}</dd>
  40. </dl>
  41. </li>
  42. <li>
  43. <span>Connectivity</span>
  44. <dl>
  45. <dt>Network Support</dt>
  46. <dd>{{phone.connectivity?.cell}}</dd>
  47. <dt>WiFi</dt>
  48. <dd>{{phone.connectivity?.wifi}}</dd>
  49. <dt>Bluetooth</dt>
  50. <dd>{{phone.connectivity?.bluetooth}}</dd>
  51. <dt>Infrared</dt>
  52. <dd>{{phone.connectivity?.infrared | checkmark}}</dd>
  53. <dt>GPS</dt>
  54. <dd>{{phone.connectivity?.gps | checkmark}}</dd>
  55. </dl>
  56. </li>
  57. <li>
  58. <span>Android</span>
  59. <dl>
  60. <dt>OS Version</dt>
  61. <dd>{{phone.android?.os}}</dd>
  62. <dt>UI</dt>
  63. <dd>{{phone.android?.ui}}</dd>
  64. </dl>
  65. </li>
  66. <li>
  67. <span>Size and Weight</span>
  68. <dl>
  69. <dt>Dimensions</dt>
  70. <dd *ngFor="let dim of phone.sizeAndWeight?.dimensions">{{dim}}</dd>
  71. <dt>Weight</dt>
  72. <dd>{{phone.sizeAndWeight?.weight}}</dd>
  73. </dl>
  74. </li>
  75. <li>
  76. <span>Display</span>
  77. <dl>
  78. <dt>Screen size</dt>
  79. <dd>{{phone.display?.screenSize}}</dd>
  80. <dt>Screen resolution</dt>
  81. <dd>{{phone.display?.screenResolution}}</dd>
  82. <dt>Touch screen</dt>
  83. <dd>{{phone.display?.touchScreen | checkmark}}</dd>
  84. </dl>
  85. </li>
  86. <li>
  87. <span>Hardware</span>
  88. <dl>
  89. <dt>CPU</dt>
  90. <dd>{{phone.hardware?.cpu}}</dd>
  91. <dt>USB</dt>
  92. <dd>{{phone.hardware?.usb}}</dd>
  93. <dt>Audio / headphone jack</dt>
  94. <dd>{{phone.hardware?.audioJack}}</dd>
  95. <dt>FM Radio</dt>
  96. <dd>{{phone.hardware?.fmRadio | checkmark}}</dd>
  97. <dt>Accelerometer</dt>
  98. <dd>{{phone.hardware?.accelerometer | checkmark}}</dd>
  99. </dl>
  100. </li>
  101. <li>
  102. <span>Camera</span>
  103. <dl>
  104. <dt>Primary</dt>
  105. <dd>{{phone.camera?.primary}}</dd>
  106. <dt>Features</dt>
  107. <dd>{{phone.camera?.features?.join(', ')}}</dd>
  108. </dl>
  109. </li>
  110. <li>
  111. <span>Additional Features</span>
  112. <dd>{{phone.additionalFeatures}}</dd>
  113. </li>
  114. </ul>
  115. </div>

这里有几个值得注意的改动:

PhoneDetailComponent组件添加到NgModuledeclarationsentryComponents中:

app.module.ts

  1. import { PhoneDetailComponent } from './phone-detail/phone-detail.component';
  2. @NgModule({
  3. imports: [
  4. BrowserModule,
  5. UpgradeModule,
  6. HttpModule,
  7. FormsModule,
  8. ],
  9. declarations: [
  10. PhoneListComponent,
  11. PhoneDetailComponent,
  12. ],
  13. entryComponents: [
  14. PhoneListComponent,
  15. PhoneDetailComponent
  16. ],
  17. providers: [
  18. Phone,
  19. routeParamsProvider
  20. ]
  21. })
  22. export class AppModule {
  23. ngDoBootstrap() {}
  24. }

我们现在应该从index.html中移除电话详情组件的<script>。

添加CheckmarkPipe

AngularJS指令中有一个checkmark过滤器,我们把它转换成Angular的管道

没有什么升级方法能把过滤器转换成管道。 但我们也并不需要它。 把过滤器函数转换成等价的Pipe类非常简单。 实现方式和以前一样,但把它们包装进transform方法中就可以了。 把该文件改名成checkmark.pipe.ts,以符合Angular中的命名约定:

app/core/checkmark/checkmark.pipe.ts

import { Pipe, PipeTransform } from '@angular/core';

@Pipe({name: 'checkmark'})
export class CheckmarkPipe implements PipeTransform {
  transform(input: boolean) {
    return input ? '\u2713' : '\u2718';
  }
}

当我们做这个修改时,也要同时从core模块文件中移除对该过滤器的注册。该模块的内容变成了:

app.module.ts

  1. import { CheckmarkPipe } from './core/checkmark/checkmark.pipe';
  2. @NgModule({
  3. imports: [
  4. BrowserModule,
  5. UpgradeModule,
  6. HttpModule,
  7. FormsModule,
  8. ],
  9. declarations: [
  10. PhoneListComponent,
  11. PhoneDetailComponent,
  12. CheckmarkPipe
  13. ],
  14. entryComponents: [
  15. PhoneListComponent,
  16. PhoneDetailComponent
  17. ],
  18. providers: [
  19. Phone,
  20. routeParamsProvider
  21. ]
  22. })
  23. export class AppModule {
  24. ngDoBootstrap() {}
  25. }

对混合式应用做AOT编译

要在混合式应用中使用AOT编译,我们首先要像其它Angular应用一样设置它,就像AOT编译一章所讲的那样。

然后,我们就要修改main-aot.ts的引导代码,也通过UpgradeModule来引导AngularJS应用:

app/main-aot.ts

  1. import { platformBrowser } from '@angular/platform-browser';
  2. import { UpgradeModule } from '@angular/upgrade/static';
  3. import { AppModuleNgFactory } from '../aot/app/app.module.ngfactory';
  4. platformBrowser().bootstrapModuleFactory(AppModuleNgFactory).then(platformRef => {
  5. const upgrade = platformRef.injector.get(UpgradeModule) as UpgradeModule;
  6. upgrade.bootstrap(document.documentElement, ['phonecatApp']);
  7. });

我们还要把在index.html中已经用到的所有AngularJS文件加载到aot/index.html中:

aot/index.html

  1. <!doctype html>
  2. <html lang="en">
  3. <head>
  4. <meta charset="utf-8">
  5. <base href="/app/">
  6. <title>Google Phone Gallery</title>
  7. <link rel="stylesheet" href="https://maxcdn.bootstrapcdn.com/bootstrap/3.3.6/css/bootstrap.min.css" />
  8. <link rel="stylesheet" href="app.css" />
  9. <link rel="stylesheet" href="app.animations.css" />
  10. <script src="https://code.jquery.com/jquery-2.2.4.js"></script>
  11. <script src="https://code.angularjs.org/1.5.5/angular.js"></script>
  12. <script src="https://code.angularjs.org/1.5.5/angular-animate.js"></script>
  13. <script src="https://code.angularjs.org/1.5.5/angular-resource.js"></script>
  14. <script src="https://code.angularjs.org/1.5.5/angular-route.js"></script>
  15. <script src="app.module.ajs.js"></script>
  16. <script src="app.config.js"></script>
  17. <script src="app.animations.js"></script>
  18. <script src="core/core.module.js"></script>
  19. <script src="core/phone/phone.module.js"></script>
  20. <script src="phone-list/phone-list.module.js"></script>
  21. <script src="phone-detail/phone-detail.module.js"></script>
  22. <script src="/node_modules/core-js/client/shim.min.js"></script>
  23. <script src="/node_modules/zone.js/dist/zone.min.js"></script>
  24. <script>window.module = 'aot';</script>
  25. </head>
  26. <body>
  27. <div class="view-container">
  28. <div ng-view class="view-frame"></div>
  29. </div>
  30. </body>
  31. <script src="/dist/build.js"></script>
  32. </html>

这些文件要带着相应的填充库复制到一起。应用运行时需要的文件,比如电话列表.json和图片,也需要复制过去。

通过npm install fs-extra --save-dev安装fs-extra可以更好的复制文件,并且把copy-dist-files.js文件改成这样:

copy-dist-files.js

  1. var fsExtra = require('fs-extra');
  2. var resources = [
  3. // polyfills
  4. 'node_modules/core-js/client/shim.min.js',
  5. 'node_modules/zone.js/dist/zone.min.js',
  6. // css
  7. 'app/app.css',
  8. 'app/app.animations.css',
  9. // images and json files
  10. 'app/img/',
  11. 'app/phones/',
  12. // app files
  13. 'app/app.module.ajs.js',
  14. 'app/app.config.js',
  15. 'app/app.animations.js',
  16. 'app/core/core.module.js',
  17. 'app/core/phone/phone.module.js',
  18. 'app/phone-list/phone-list.module.js',
  19. 'app/phone-detail/phone-detail.module.js'
  20. ];
  21. resources.map(function(sourcePath) {
  22. var destPath = `aot/${sourcePath}`;
  23. fsExtra.copySync(sourcePath, destPath);
  24. });

这就是想要在升级应用期间AOT编译所需的一切!

切换到Angular路由器和引导程序

此刻,我们已经把所有AngularJS的组件替换成了它们在Angular中的等价物,不过我们仍然在AngularJS路由器中使用它们。

大多数AngularJS应用都有多组路由,而如果能每次迁移一个路由就会非常有用。

让我们开始把最初的//phones路由迁移到Angular,但把/phones/:phoneId留在AngularJS路由器中。

添加Angular路由器

Angular有一个全新的路由器

像所有的路由器一样,它需要在UI中指定一个位置来显示路由的视图。 在Angular中,它是<router-outlet>,并位于应用组件树顶部的根组件中。

我们还没有这样一个根组件,因为该应用仍然是像一个AngularJS应用那样被管理的。 创建新的app.component.ts文件,放入像这样的AppComponent类:

app/app.component.ts

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

@Component({
  selector: 'phonecat-app',
  template: `
    <router-outlet></router-outlet>
    <div class="view-container">
      <div ng-view class="view-frame"></div>
    </div>
  `
})
export class AppComponent { }

它有一个很简单的模板,只包含Angular路由的<router-outlet>和AngularJS路由的ng-view指令。 该组件只负责渲染活动路由的内容,此外啥也不干。

该选择器告诉Angular:当应用启动时就把这个根组件插入到宿主页面的<phonecat-app>元素中。

把这个<phonecat-app>元素插入到index.html中。 用它来代替AngularJS中的ng-view指令:

index.html (body)

<body>
  <phonecat-app></phonecat-app>
</body>

创建路由模块

无论在AngularJS还是Angular或其它框架中,路由器都需要进行配置。

Angular路由器配置的详情最好去查阅下路由与导航文档。 它建议你创建一个专们用于路由器配置的NgModule(名叫路由模块)。

app/app-routing.module.ts

  1. import { NgModule } from '@angular/core';
  2. import { Routes, RouterModule, UrlHandlingStrategy, UrlTree } from '@angular/router';
  3. import { APP_BASE_HREF, HashLocationStrategy, LocationStrategy } from '@angular/common';
  4. import { PhoneListComponent } from './phone-list/phone-list.component';
  5. export class Ng1Ng2UrlHandlingStrategy implements UrlHandlingStrategy {
  6. shouldProcessUrl(url: UrlTree) {
  7. return url.toString() === '/' || url.toString() === '/phones';
  8. }
  9. extract(url: UrlTree) { return url; }
  10. merge(url: UrlTree, whole: UrlTree) { return url; }
  11. }
  12. const routes: Routes = [
  13. { path: '', redirectTo: 'phones', pathMatch: 'full' },
  14. { path: 'phones', component: PhoneListComponent }
  15. ];
  16. @NgModule({
  17. imports: [ RouterModule.forRoot(routes) ],
  18. exports: [ RouterModule ],
  19. providers: [
  20. { provide: APP_BASE_HREF, useValue: '!' },
  21. { provide: LocationStrategy, useClass: HashLocationStrategy },
  22. { provide: UrlHandlingStrategy, useClass: Ng1Ng2UrlHandlingStrategy }
  23. ]
  24. })
  25. export class AppRoutingModule { }

该模块定义了一个routes对象,它带有两个路由,分别指向两个电话组件,以及为空路径指定的默认路由。 它把routes传给RouterModule.forRoot方法,该方法会完成剩下的事。

一些额外的提供商让路由器使用“hash”策略解析URL,比如#!/phones,而不是默认的“Push State”策略。

这里路由模块会出现一个冲突:我们还添加了一个自定义的UrlHandlingStrategy,它会告诉Angular的路由器只处理//phones路由。

现在,修改AppModule,让它导入这个AppRoutingModule,并同时声明根组件AppComponent。 这会告诉Angular,它应该使用根组件AppComponent引导应用,并把它的视图插入到宿主页面中。

我们也可以移除app.module.ts中对ngDoBootstrap()的改写,因为我们正在从Angular中引导。

并且,由于PhoneListComponent不再渲染到<phone-list>标签下,而是路由到它,我们同样也可以去掉它的Angular选择器。

app/app.module.ts

  1. import { NgModule } from '@angular/core';
  2. import { BrowserModule } from '@angular/platform-browser';
  3. import { UpgradeModule } from '@angular/upgrade/static';
  4. import { HttpModule } from '@angular/http';
  5. import { FormsModule } from '@angular/forms';
  6. import { AppRoutingModule } from './app-routing.module';
  7. import { AppComponent } from './app.component';
  8. import { Phone } from './core/phone/phone.service';
  9. import { CheckmarkPipe } from './core/checkmark/checkmark.pipe';
  10. import { PhoneListComponent } from './phone-list/phone-list.component';
  11. import { PhoneDetailComponent } from './phone-detail/phone-detail.component';
  12. import { routeParamsProvider } from './ajs-upgraded-providers';
  13. @NgModule({
  14. imports: [
  15. BrowserModule,
  16. UpgradeModule,
  17. HttpModule,
  18. FormsModule,
  19. AppRoutingModule
  20. ],
  21. declarations: [
  22. AppComponent,
  23. PhoneListComponent,
  24. PhoneDetailComponent,
  25. CheckmarkPipe
  26. ],
  27. entryComponents: [
  28. PhoneListComponent,
  29. PhoneDetailComponent
  30. ],
  31. providers: [
  32. Phone,
  33. routeParamsProvider
  34. ],
  35. bootstrap: [ AppComponent ]
  36. })
  37. export class AppModule { }

现在,我们要让AngularJS路由器只处理/phones/:phoneId路由:

app/app.config.ts (route config)

  1. $routeProvider
  2. .when('/phones/:phoneId', {
  3. template: '<phone-detail></phone-detail>'
  4. });

在电话列表中,我们不用再被迫硬编码电话详情的链接了。 我们可以通过把每个电话的id绑定到routerLink指令来生成它们了,该指令的构造函数会为PhoneDetailComponent生成正确的URL:

app/phone-list/phone-list.template.html (list with links)

<ul class="phones">
  <li *ngFor="let phone of getPhones()"
      class="thumbnail phone-list-item">
    <a [routerLink]="['/phones', phone.id]" class="thumb">
      <img [src]="phone.imageUrl" [alt]="phone.name" />
    </a>
    <a [routerLink]="['/phones', phone.id]" class="name">{{phone.name}}</a>
    <p>{{phone.snippet}}</p>
  </li>
</ul>

要了解详情,请查看路由与导航页。

我们现在同时运行着两个路由器! Angular负责处理初始URL /,并重定向到/phones。而AngularJS负责处理到手机详情的链接。

用这种方式,我们可以增量升级该应用,减少一次性更换路由带来的巨大风险。

下一步是迁移/phones/:phoneId路由。

Angular路由器会传入不同的路由参数。 改正PhoneDetail组件的构造函数,让它改用注入进来的ActivatedRoute对象。 从ActivatedRoute.snapshot.params中提取出phoneId,并像以前一样获取手机的数据:

app/phone-detail/phone-detail.component.ts

  1. import { Component } from '@angular/core';
  2. import { ActivatedRoute } from '@angular/router';
  3. import { Phone, PhoneData } from '../core/phone/phone.service';
  4. @Component({
  5. selector: 'phone-detail',
  6. templateUrl: './phone-detail.template.html'
  7. })
  8. export class PhoneDetailComponent {
  9. phone: PhoneData;
  10. mainImageUrl: string;
  11. constructor(activatedRoute: ActivatedRoute, phone: Phone) {
  12. phone.get(activatedRoute.snapshot.params['phoneId'])
  13. .subscribe((p: PhoneData) => {
  14. this.phone = p;
  15. this.setImage(p.images[0]);
  16. });
  17. }
  18. setImage(imageUrl: string) {
  19. this.mainImageUrl = imageUrl;
  20. }
  21. }

由于这是我们要迁移的最后一个路由,因此现在可以从app/app.config.ts中移除最后一个路由配置了,并把它添加到Angular的路由器配置里。

我们再也不需要UrlHandlingStrategy了,因为现在Angular会处理所有路由。

app/app-routing.module.ts

  1. import { NgModule } from '@angular/core';
  2. import { Routes, RouterModule } from '@angular/router';
  3. import { APP_BASE_HREF, HashLocationStrategy, LocationStrategy } from '@angular/common';
  4. import { PhoneDetailComponent } from './phone-detail/phone-detail.component';
  5. import { PhoneListComponent } from './phone-list/phone-list.component';
  6. const routes: Routes = [
  7. { path: '', redirectTo: 'phones', pathMatch: 'full' },
  8. { path: 'phones', component: PhoneListComponent },
  9. { path: 'phones/:phoneId', component: PhoneDetailComponent }
  10. ];
  11. @NgModule({
  12. imports: [ RouterModule.forRoot(routes) ],
  13. exports: [ RouterModule ],
  14. providers: [
  15. { provide: APP_BASE_HREF, useValue: '!' },
  16. { provide: LocationStrategy, useClass: HashLocationStrategy },
  17. ]
  18. })
  19. export class AppRoutingModule { }

我们现在运行的就是纯正的Angular应用了!

再见,AngularJS!

是时候把辅助训练的轮子摘下来了!让我们的应用作为一个纯粹、闪亮的Angular程序开始它的新生命吧。 剩下的所有任务就是移除代码 —— 这当然是每个程序员最喜欢的任务!

应用仍然以混合式应用的方式启动,然而这再也没有必要了。

把应用的引导(bootstrap)方法从UpgradeAdapter的改为Angular的。

main.ts

  1. import { platformBrowserDynamic } from '@angular/platform-browser-dynamic';
  2. import { AppModule } from './app.module';
  3. platformBrowserDynamic().bootstrapModule(AppModule);

如果你还没有这么做,请从app.module.ts删除所有UpgradeModule的引用, 以及所有用于AngularJS服务的工厂供应商(factory provider)app/ajs-upgraded-providers.ts文件。

还要删除所有的downgradeInjectable()downgradeComponent()以及与AngularJS相关的工厂或指令声明。 因为我们不再需要降级任何组件了,也不再需要把它们列在entryComponents中。

app.module.ts

  1. import { NgModule } from '@angular/core';
  2. import { BrowserModule } from '@angular/platform-browser';
  3. import { FormsModule } from '@angular/forms';
  4. import { HttpModule } from '@angular/http';
  5. import { AppRoutingModule } from './app-routing.module';
  6. import { AppComponent } from './app.component';
  7. import { CheckmarkPipe } from './core/checkmark/checkmark.pipe';
  8. import { Phone } from './core/phone/phone.service';
  9. import { PhoneDetailComponent } from './phone-detail/phone-detail.component';
  10. import { PhoneListComponent } from './phone-list/phone-list.component';
  11. @NgModule({
  12. imports: [
  13. BrowserModule,
  14. FormsModule,
  15. HttpModule,
  16. AppRoutingModule
  17. ],
  18. declarations: [
  19. AppComponent,
  20. PhoneListComponent,
  21. CheckmarkPipe,
  22. PhoneDetailComponent
  23. ],
  24. providers: [
  25. Phone
  26. ],
  27. bootstrap: [ AppComponent ]
  28. })
  29. export class AppModule {}

我们还要完全移除了下列文件。它们是AngularJS的模块配置文件和类型定义文件,在Angular中不需要了:

还需要反安装AngularJS的外部类型定义文件。我们现在只需要Jasmine的那些。 systemjs.config.js中的@angular/upgrade包及其映射也可以移除了。

npm uninstall @angular/upgrade --save
npm uninstall @types/angular @types/angular-animate @types/angular-cookies @types/angular-mocks @types/angular-resource @types/angular-route @types/angular-sanitize --save-dev

最后,从index.htmlkarma.conf.js中,移除所有到AngularJS脚本的引用,比如jQuery。 当这些全部做完时,index.html应该是这样的:

index.html

  1. <!doctype html>
  2. <html lang="en">
  3. <head>
  4. <meta charset="utf-8">
  5. <base href="/app/">
  6. <title>Google Phone Gallery</title>
  7. <link rel="stylesheet" href="https://maxcdn.bootstrapcdn.com/bootstrap/3.3.6/css/bootstrap.min.css" />
  8. <link rel="stylesheet" href="app.css" />
  9. <script src="/node_modules/core-js/client/shim.min.js"></script>
  10. <script src="/node_modules/zone.js/dist/zone.js"></script>
  11. <script src="/node_modules/systemjs/dist/system.src.js"></script>
  12. <script src="/systemjs.config.js"></script>
  13. <script>
  14. System.import('/app');
  15. </script>
  16. </head>
  17. <body>
  18. <phonecat-app></phonecat-app>
  19. </body>
  20. </html>

这是我们最后一次看到AngularJS了!它曾经带给我们很多帮助,不过现在,是时候说再见了。

附录:升级PhoneCat的测试

测试不仅要在升级过程中被保留,它还是确保应用在升级过程中不会被破坏的一个安全指示器。 要达到这个目的,E2E测试尤其有用。

E2E测试

PhoneCat项目中同时有基于Protractor的E2E测试和一些基于Karma的单元测试。 对这两者来说,E2E测试的转换要容易得多:根据定义,E2E测试通过与应用中显示的这些UI元素互动,从外部访问我们的应用来进行测试。 E2E测试实际上并不关心这些应用中各部件的内部结构。这也意味着,虽然我们已经修改了此应用程序, 但是E2E测试套件仍然应该能像以前一样全部通过。因为从用户的角度来说,我们并没有改变应用的行为。

在转成TypeScript期间,我们不用做什么就能让E2E测试正常工作。 只有当我们想做些修改而把组件及其模板升级到Angular时才需要做些处理。

需要对protractor-conf.js做如修改,与混合应用同步:

ng12Hybrid: true

当我们开始组件和模块升级到Angular时,还需要一系列后续的修改。 这是因为E2E测试有一些匹配器是AngularJS中特有的。对于PhoneCat来说,为了让它能在Angular下工作,我们得做下列修改:

老代码

新代码

说明

by.repeater('phone in $ctrl.phones').column('phone.name')

by.css('.phones .name')

repeater匹配器依赖于AngularJS中的ng-repeat

by.repeater('phone in $ctrl.phones')

by.css('.phones li')

repeater匹配器依赖于AngularJS中的ng-repeat

by.model('$ctrl.query')

by.css('input')

model匹配器依赖于AngularJS中的ng-model

by.model('$ctrl.orderProp')

by.css('select')

model匹配器依赖于AngularJS中的ng-model

by.binding('$ctrl.phone.name')

by.css('h1')

binding匹配器依赖于AngularJS的数据绑定

当引导方式从UpgradeModule切换到纯Angular的时,AngularJS就从页面中完全消失了。 此时,我们需要告诉Protractor,它不用再找AngularJS应用了,而是从页面中查找Angular应用。 于是在protractor-conf.js中做下列修改: Replace the ng12Hybrid previously added with the following in protractor-conf.js:

替换之前在protractor-conf.js中加入 ng12Hybrid,象这样:

useAllAngular2AppRoots: true,

同样,我们的测试代码中有两个Protractor API调用内部使用了$location。该服务没有了, 我们就得把这些调用用一个WebDriver的通用URL API代替。第一个API是“重定向(redirect)”规约:

e2e-tests/scenarios.ts

  1. it('should redirect `index.html` to `index.html#!/phones', function() {
  2. browser.get('index.html');
  3. browser.waitForAngular();
  4. browser.getCurrentUrl().then(function(url: string) {
  5. expect(url.endsWith('/phones')).toBe(true);
  6. });
  7. });

然后是“电话链接(phone links)”规约:

e2e-tests/scenarios.ts

  1. it('should render phone specific links', function() {
  2. let query = element(by.css('input'));
  3. query.sendKeys('nexus');
  4. element.all(by.css('.phones li a')).first().click();
  5. browser.getCurrentUrl().then(function(url: string) {
  6. expect(url.endsWith('/phones/nexus-s')).toBe(true);
  7. });
  8. });

单元测试

另一方面,对于单元测试来说,需要更多的转化工作。实际上,它们需要随着产品代码一起升级。

在转成TypeScript期间,严格来讲没有什么改动是必须的。但把单元测试代码转成TypeScript仍然是个好主意, 产品代码从TypeScript中获得的那些增益也同样适用于测试代码。

比如,在这个电话详情组件的规约中,我们不仅用到了ES2015中的箭头函数和块作用域变量这些特性,还为所用的一些 AngularJS服务提供了类型定义。

app/phone-detail/phone-detail.component.spec.ts

  1. describe('phoneDetail', () => {
  2. // Load the module that contains the `phoneDetail` component before each test
  3. beforeEach(angular.mock.module('phoneDetail'));
  4. // Test the controller
  5. describe('PhoneDetailController', () => {
  6. let $httpBackend: angular.IHttpBackendService;
  7. let ctrl: any;
  8. let xyzPhoneData = {
  9. name: 'phone xyz',
  10. images: ['image/url1.png', 'image/url2.png']
  11. };
  12. beforeEach(inject(($componentController: any,
  13. _$httpBackend_: angular.IHttpBackendService,
  14. $routeParams: angular.route.IRouteParamsService) => {
  15. $httpBackend = _$httpBackend_;
  16. $httpBackend.expectGET('phones/xyz.json').respond(xyzPhoneData);
  17. $routeParams['phoneId'] = 'xyz';
  18. ctrl = $componentController('phoneDetail');
  19. }));
  20. it('should fetch the phone details', () => {
  21. jasmine.addCustomEqualityTester(angular.equals);
  22. expect(ctrl.phone).toEqual({});
  23. $httpBackend.flush();
  24. expect(ctrl.phone).toEqual(xyzPhoneData);
  25. });
  26. });
  27. });

一旦我们开始了升级过程并引入了SystemJS,还需要对Karma进行配置修改。 我们需要让SystemJS加载所有的Angular新代码,

karma-test-shim.js

  1. // /*global jasmine, __karma__, window*/
  2. Error.stackTraceLimit = 0; // "No stacktrace"" is usually best for app testing.
  3. // Uncomment to get full stacktrace output. Sometimes helpful, usually not.
  4. // Error.stackTraceLimit = Infinity; //
  5. jasmine.DEFAULT_TIMEOUT_INTERVAL = 1000;
  6. var builtPath = '/base/app/';
  7. __karma__.loaded = function () { };
  8. function isJsFile(path) {
  9. return path.slice(-3) == '.js';
  10. }
  11. function isSpecFile(path) {
  12. return /\.spec\.(.*\.)?js$/.test(path);
  13. }
  14. function isBuiltFile(path) {
  15. return isJsFile(path) && (path.substr(0, builtPath.length) == builtPath);
  16. }
  17. var allSpecFiles = Object.keys(window.__karma__.files)
  18. .filter(isSpecFile)
  19. .filter(isBuiltFile);
  20. System.config({
  21. baseURL: '/base',
  22. // Extend usual application package list with test folder
  23. packages: { 'testing': { main: 'index.js', defaultExtension: 'js' } },
  24. // Assume npm: is set in `paths` in systemjs.config
  25. // Map the angular testing umd bundles
  26. map: {
  27. '@angular/core/testing': 'npm:@angular/core/bundles/core-testing.umd.js',
  28. '@angular/common/testing': 'npm:@angular/common/bundles/common-testing.umd.js',
  29. '@angular/compiler/testing': 'npm:@angular/compiler/bundles/compiler-testing.umd.js',
  30. '@angular/platform-browser/testing': 'npm:@angular/platform-browser/bundles/platform-browser-testing.umd.js',
  31. '@angular/platform-browser-dynamic/testing': 'npm:@angular/platform-browser-dynamic/bundles/platform-browser-dynamic-testing.umd.js',
  32. '@angular/http/testing': 'npm:@angular/http/bundles/http-testing.umd.js',
  33. '@angular/router/testing': 'npm:@angular/router/bundles/router-testing.umd.js',
  34. '@angular/forms/testing': 'npm:@angular/forms/bundles/forms-testing.umd.js',
  35. },
  36. });
  37. System.import('systemjs.config.js')
  38. .then(importSystemJsExtras)
  39. .then(initTestBed)
  40. .then(initTesting);
  41. /** Optional SystemJS configuration extras. Keep going w/o it */
  42. function importSystemJsExtras(){
  43. return System.import('systemjs.config.extras.js')
  44. .catch(function(reason) {
  45. console.log(
  46. 'Warning: System.import could not load the optional "systemjs.config.extras.js". Did you omit it by accident? Continuing without it.'
  47. );
  48. console.log(reason);
  49. });
  50. }
  51. function initTestBed(){
  52. return Promise.all([
  53. System.import('@angular/core/testing'),
  54. System.import('@angular/platform-browser-dynamic/testing')
  55. ])
  56. .then(function (providers) {
  57. var coreTesting = providers[0];
  58. var browserTesting = providers[1];
  59. coreTesting.TestBed.initTestEnvironment(
  60. browserTesting.BrowserDynamicTestingModule,
  61. browserTesting.platformBrowserDynamicTesting());
  62. })
  63. }
  64. // Import all spec files and start karma
  65. function initTesting () {
  66. return Promise.all(
  67. allSpecFiles.map(function (moduleName) {
  68. return System.import(moduleName);
  69. })
  70. )
  71. .then(__karma__.start, __karma__.error);
  72. }

这个shim文件首先加载了SystemJS的配置,然后是Angular的测试支持库,然后是应用本身的规约文件。

然后需要修改Karma配置,来让它使用本应用的根目录作为基础目录(base directory),而不是app

karma.conf.js

basePath: './',

一旦这些完成了,我们就能加载SystemJS和其它依赖,并切换配置文件来加载那些应用文件,而不用在Karma页面中包含它们。 我们要让这个shim文件和SystemJS去加载它们。

karma.conf.js

  1. // System.js for module loading
  2. 'node_modules/systemjs/dist/system.src.js',
  3. // Polyfills
  4. 'node_modules/core-js/client/shim.js',
  5. // zone.js
  6. 'node_modules/zone.js/dist/zone.js',
  7. 'node_modules/zone.js/dist/long-stack-trace-zone.js',
  8. 'node_modules/zone.js/dist/proxy.js',
  9. 'node_modules/zone.js/dist/sync-test.js',
  10. 'node_modules/zone.js/dist/jasmine-patch.js',
  11. 'node_modules/zone.js/dist/async-test.js',
  12. 'node_modules/zone.js/dist/fake-async-test.js',
  13. // RxJs.
  14. { pattern: 'node_modules/rxjs/**/*.js', included: false, watched: false },
  15. { pattern: 'node_modules/rxjs/**/*.js.map', included: false, watched: false },
  16. // Angular itself and the testing library
  17. {pattern: 'node_modules/@angular/**/*.js', included: false, watched: false},
  18. {pattern: 'node_modules/@angular/**/*.js.map', included: false, watched: false},
  19. {pattern: 'systemjs.config.js', included: false, watched: false},
  20. 'karma-test-shim.js',
  21. {pattern: 'app/**/*.module.js', included: false, watched: true},
  22. {pattern: 'app/*!(.module|.spec).js', included: false, watched: true},
  23. {pattern: 'app/!(bower_components)/**/*!(.module|.spec).js', included: false, watched: true},
  24. {pattern: 'app/**/*.spec.js', included: false, watched: true},
  25. {pattern: '**/*.html', included: false, watched: true},

由于Angular组件中的HTML模板也同样要被加载,所以我们得帮Karma一把,帮它在正确的路径下找到这些模板:

karma.conf.js

  1. // proxied base paths for loading assets
  2. proxies: {
  3. // required for component assets fetched by Angular's compiler
  4. "/phone-detail": '/base/app/phone-detail',
  5. "/phone-list": '/base/app/phone-list'
  6. },

如果产品代码被切换到了Angular,单元测试文件本身也需要切换过来。对勾(checkmark)管道的规约可能是最简单的,因为它没有任何依赖:

app/core/checkmark/checkmark.pipe.spec.ts

  1. import { CheckmarkPipe } from './checkmark.pipe';
  2. describe('CheckmarkPipe', function() {
  3. it('should convert boolean values to unicode checkmark or cross', function () {
  4. const checkmarkPipe = new CheckmarkPipe();
  5. expect(checkmarkPipe.transform(true)).toBe('\u2713');
  6. expect(checkmarkPipe.transform(false)).toBe('\u2718');
  7. });
  8. });

Phone服务的测试会牵扯到一点别的。我们需要把模拟版的AngularJS $httpBackend服务切换到模拟板的Angular Http后端。

app/core/phone/phone.service.spec.ts

  1. import { inject, TestBed } from '@angular/core/testing';
  2. import {
  3. Http,
  4. BaseRequestOptions,
  5. ResponseOptions,
  6. Response
  7. } from '@angular/http';
  8. import { MockBackend, MockConnection } from '@angular/http/testing';
  9. import { Phone, PhoneData } from './phone.service';
  10. describe('Phone', function() {
  11. let phone: Phone;
  12. let phonesData: PhoneData[] = [
  13. {name: 'Phone X', snippet: '', images: []},
  14. {name: 'Phone Y', snippet: '', images: []},
  15. {name: 'Phone Z', snippet: '', images: []}
  16. ];
  17. let mockBackend: MockBackend;
  18. beforeEach(() => {
  19. TestBed.configureTestingModule({
  20. providers: [
  21. Phone,
  22. MockBackend,
  23. BaseRequestOptions,
  24. { provide: Http,
  25. useFactory: (backend: MockBackend, options: BaseRequestOptions) => new Http(backend, options),
  26. deps: [MockBackend, BaseRequestOptions]
  27. }
  28. ]
  29. });
  30. });
  31. beforeEach(inject([MockBackend, Phone], (_mockBackend_: MockBackend, _phone_: Phone) => {
  32. mockBackend = _mockBackend_;
  33. phone = _phone_;
  34. }));
  35. it('should fetch the phones data from `/phones/phones.json`', (done: () => void) => {
  36. mockBackend.connections.subscribe((conn: MockConnection) => {
  37. conn.mockRespond(new Response(new ResponseOptions({body: JSON.stringify(phonesData)})));
  38. });
  39. phone.query().subscribe(result => {
  40. expect(result).toEqual(phonesData);
  41. done();
  42. });
  43. });
  44. });

对于组件的规约,我们可以模拟出Phone服务本身,并且让它提供电话的数据。我们可以对这些组件使用Angular的组件单元测试API。

app/phone-detail/phone-detail.component.spec.ts

  1. import { ActivatedRoute } from '@angular/router';
  2. import { Observable } from 'rxjs/Rx';
  3. import { async, TestBed } from '@angular/core/testing';
  4. import { PhoneDetailComponent } from './phone-detail.component';
  5. import { Phone, PhoneData } from '../core/phone/phone.service';
  6. import { CheckmarkPipe } from '../core/checkmark/checkmark.pipe';
  7. function xyzPhoneData(): PhoneData {
  8. return {
  9. name: 'phone xyz',
  10. snippet: '',
  11. images: ['image/url1.png', 'image/url2.png']
  12. };
  13. }
  14. class MockPhone {
  15. get(id: string): Observable<PhoneData> {
  16. return Observable.of(xyzPhoneData());
  17. }
  18. }
  19. class ActivatedRouteMock {
  20. constructor(public snapshot: any) {}
  21. }
  22. describe('PhoneDetailComponent', () => {
  23. beforeEach(async(() => {
  24. TestBed.configureTestingModule({
  25. declarations: [ CheckmarkPipe, PhoneDetailComponent ],
  26. providers: [
  27. { provide: Phone, useClass: MockPhone },
  28. { provide: ActivatedRoute, useValue: new ActivatedRouteMock({ params: { 'phoneId': 1 } }) }
  29. ]
  30. })
  31. .compileComponents();
  32. }));
  33. it('should fetch phone detail', () => {
  34. const fixture = TestBed.createComponent(PhoneDetailComponent);
  35. fixture.detectChanges();
  36. let compiled = fixture.debugElement.nativeElement;
  37. expect(compiled.querySelector('h1').textContent).toContain(xyzPhoneData().name);
  38. });
  39. });

app/phone-list/phone-list.component.spec.ts

  1. import { NO_ERRORS_SCHEMA } from '@angular/core';
  2. import { ActivatedRoute } from '@angular/router';
  3. import { Observable } from 'rxjs/Rx';
  4. import { async, ComponentFixture, TestBed } from '@angular/core/testing';
  5. import { SpyLocation } from '@angular/common/testing';
  6. import { PhoneListComponent } from './phone-list.component';
  7. import { Phone, PhoneData } from '../core/phone/phone.service';
  8. class ActivatedRouteMock {
  9. constructor(public snapshot: any) {}
  10. }
  11. class MockPhone {
  12. query(): Observable<PhoneData[]> {
  13. return Observable.of([
  14. {name: 'Nexus S', snippet: '', images: []},
  15. {name: 'Motorola DROID', snippet: '', images: []}
  16. ]);
  17. }
  18. }
  19. let fixture: ComponentFixture<PhoneListComponent>;
  20. describe('PhoneList', () => {
  21. beforeEach(async(() => {
  22. TestBed.configureTestingModule({
  23. declarations: [ PhoneListComponent ],
  24. providers: [
  25. { provide: ActivatedRoute, useValue: new ActivatedRouteMock({ params: { 'phoneId': 1 } }) },
  26. { provide: Location, useClass: SpyLocation },
  27. { provide: Phone, useClass: MockPhone },
  28. ],
  29. schemas: [ NO_ERRORS_SCHEMA ]
  30. })
  31. .compileComponents();
  32. }));
  33. beforeEach(() => {
  34. fixture = TestBed.createComponent(PhoneListComponent);
  35. });
  36. it('should create "phones" model with 2 phones fetched from xhr', () => {
  37. fixture.detectChanges();
  38. let compiled = fixture.debugElement.nativeElement;
  39. expect(compiled.querySelectorAll('.phone-list-item').length).toBe(2);
  40. expect(
  41. compiled.querySelector('.phone-list-item:nth-child(1)').textContent
  42. ).toContain('Motorola DROID');
  43. expect(
  44. compiled.querySelector('.phone-list-item:nth-child(2)').textContent
  45. ).toContain('Nexus S');
  46. });
  47. xit('should set the default value of orderProp model', () => {
  48. fixture.detectChanges();
  49. let compiled = fixture.debugElement.nativeElement;
  50. expect(
  51. compiled.querySelector('select option:last-child').selected
  52. ).toBe(true);
  53. });
  54. });

最后,当我们切换到Angular路由时,我们需要重新过一遍这些组件测试。对详情组件来说,我们需要提供一个Angular RouteParams的mock对象,而不再用AngularJS中的$routeParams

app/phone-detail/phone-detail.component.spec.ts

  1. import { ActivatedRoute } from '@angular/router';
  2. /* . . . */
  3. class ActivatedRouteMock {
  4. constructor(public snapshot: any) {}
  5. }
  6. /* . . . */
  7. beforeEach(async(() => {
  8. TestBed.configureTestingModule({
  9. declarations: [ CheckmarkPipe, PhoneDetailComponent ],
  10. providers: [
  11. { provide: Phone, useClass: MockPhone },
  12. { provide: ActivatedRoute, useValue: new ActivatedRouteMock({ params: { 'phoneId': 1 } }) }
  13. ]
  14. })
  15. .compileComponents();
  16. }));

对于电话列表组件来说,我们需要为路由器本身略作设置,以便它的路由链接(routerLink)指令能够正常工作。

app/phone-list/phone-list.component.spec.ts

  1. import { NO_ERRORS_SCHEMA } from '@angular/core';
  2. import { ActivatedRoute } from '@angular/router';
  3. import { Observable } from 'rxjs/Rx';
  4. import { async, ComponentFixture, TestBed } from '@angular/core/testing';
  5. import { SpyLocation } from '@angular/common/testing';
  6. import { PhoneListComponent } from './phone-list.component';
  7. import { Phone, PhoneData } from '../core/phone/phone.service';
  8. /* . . . */
  9. beforeEach(async(() => {
  10. TestBed.configureTestingModule({
  11. declarations: [ PhoneListComponent ],
  12. providers: [
  13. { provide: ActivatedRoute, useValue: new ActivatedRouteMock({ params: { 'phoneId': 1 } }) },
  14. { provide: Location, useClass: SpyLocation },
  15. { provide: Phone, useClass: MockPhone },
  16. ],
  17. schemas: [ NO_ERRORS_SCHEMA ]
  18. })
  19. .compileComponents();
  20. }));
  21. beforeEach(() => {
  22. fixture = TestBed.createComponent(PhoneListComponent);
  23. });