Angular 2.0.0ファイナルへのアップグレード
2016/10/13
  • このエントリーをはてなブックマークに追加

初めに

こんにちは。カブクのフロントエンドエンジニア、Simonです。

最近プリリリースのAngular 2 RC1で書かれていたプロジェクトを 一つ一つAngular 2 RC7そして安定版の2.0.0まで上げる業務をしましたので、その中で発見した気づきなどを書きたいと思います。

Angular 2について


Angular 2 は、非常に人気の高かったウェブフレームワークAngularJS 1を2016年の最新のテクノロジーを用いて作り直したフレームワークです。最近のウェブアプリケーション開発では、クライアントにロジックがどんどん入れていく流れが主流であり、JavaScriptはこの2,3年でかなりのペースで進化しています。2009年にリリースされたAngular1は今だと古く見え、Googleが再び一から作り直したJavaScriptフレームワークがAngular2です。

書き換え開始


書き換えを始めた当初の作戦は、単にpackage.json のRC1を全てその頃最新版のRC5に変え、とりあえずアプリをロードしてコンソールに出てくるエラーを一つ一つ直していくというものです。しかし、実際にはこの方法はうまくいきませんでした。なぜなら、解読不能なエラーばかりだったためです。そのため、この方法は早い段階で諦め、バージョン一つ一つ上げていく方針に変更しました。

バージョンを上げていく上で対応した大きなチェンジは3つ。
Forms APIの変身、
Router APIの変身、
そしてimportを管理するModuleが新しく入ってきたこと。
これらの変更については、ドキュメントが充実しており、変更量が多いいもののなんとか対応することができました。

しかし、実際に悩まされましたのは、細かくてドキュメントがほとんど無いチェンジやzone.js、angular/core、angular/http、Webpack などAngular2にコアなところに入ってたバグです。

このようなブレイキングチェンジやバグの内容を調べるには各Githubページをいろいろ読む必要があり、ソーシャルコーディング時代を感じました。

最終的にはプロジェクトがおよそ18000行に対して書き換えた行数2000以上と、着いていくためにコードベース1割以上の変換が必要になり、かなりメジャーなブレイキングチェンジでした。ベータソフトウェアは、便利な機能が使え、長くサポートが続くことを期待できますが、ブレイキングチェンジがどれだけ出てくるか予測できないので難しいところです。これからAngular 3.0.0までの最低6ヶ月間、ブレイキングチェンジのないのフレームワークを使用できるので、とても嬉しいです。

書き換えでつまずいた点


ここからは書き換えでつまずいた点を幾つか並べていきたいと思います。変更が小さいにもかかわらず、かなり悩まされたので、もしこれから対応する方がいれば、この記事を参考にするとスムーズにアップグレードできるはずです

1 Webpack 2のアップデート

Angular 2, TypeScript 2, Webpack 2と揃えていくのがAngularチームのオススメなのですが、Webpack 2がまだbeta状態です。最近の2.1.0.beta23で大きなブレイキングチェンジが入ってきました。
今は2.1.0.beta22にバージョンを収めてAPIが落ち着いてからのアップグレードが安全かと思います。

2 NgModule

地味にPipeが一つ動いていなかったりしたら、間違えた@NgModuleのセクションにそのimportをコピペしている可能性があります:

@NgModule({
    declarations: [Components, Directives, Pipes],
    imports:      [Modules],
    exports:      [親Moduleに公開したいもの > Exports (DeclarationsとExportsと2回書く必要がある)],
    providers:    [Services, Providers]
})


3 ライブラリ名の更新

ライブラリが動かない。ライブラリで使ってたdirectiveやpipeが急になくなったりしたら、ライブラリの名前がLibrary からLibraryModuleに変わってる可能性があります。

4 ng-content

ng-contentのselectorが今までカスタムなelementタグを使えたものの、RC6からはcssクラスなどを使うことが必要になりました。Angularがスペル間違いを防ぐために厳しくelementの名前の検証をしだしたからです。Native element かComponent selectorでなければエラーが出ます。


RC1:
<custom-element></custom-element>
2.0.0:
<div class=“custom-element”></div>

5 コードスタイルチェック

Codelyzer 0.0.17 以上に変えたらtslintからExceptionが飛ぶ:
Codelyzerのセットアップが少し変わりました。
tslint.jsonで:

"rulesDirectory": [
	"node_modules/codelyzer/dist/src"
],
から

"rulesDirectory": [
    "node_modules/codelyzer"
],

6 System.importからのウォーニング

angularのコンパイラの中からビルドウォーニングが出る:

WARNING in ./~/@angular/core/src/linker/system_js_ng_module_factory_loader.js
45:15 Critical dependency: the request of a dependency is an expression

WARNING in ./~/@angular/core/src/linker/system_js_ng_module_factory_loader.js
57:15 Critical dependency: the request of a dependency is an expression

System.importが使われているところに今のフォルダ名をinjectする必要がある:
Webpackだと、以下の追加で治ります

  plugins: [
    new webpack.ContextReplacementPlugin(
      /angular(\\|\/)core(\\|\/)(esm(\\|\/)src|src)(\\|\/)linker/,
      __dirname // Location of your source code
    ),
]
これはちょっと不便なのでAngularチームも将来これを直してくれるかもしれません。そのGithub Issue。

7 検索ツール

2.0.0はリリースされたばかりのため、参考にしようと検索エンジンで記事を検索しても、2.0.0対応の記事はあまりでてきません。。
Google > 検索ツール > 期限指定1週間以内 が必須でした。

8 angular/httpのバグ

RC5だとhttp getとrequestにbodyが必要というバグがありました。無いとexceptionが飛びます。
RC5の時だけrequestとgetの前にこれをチェックする必要がある:

        if (options && !options.body) {
            options.body = '';
        }

9 AoTコンパイラ

Ahead of Time コンパイラでAngular2コードを普通のJSコードに変換することでクライアント側へ送信するファイルサイズを減らすことができます。しかし、現状ではAoTコンパイラではrequireを使用することができません。
これまでは、requireを使ってテンプレートファイルを全てインラインしてきましたが、AOTコンパイラを使用する場合には、TemplateURLを使いwebpackのTemplateURLをインラインしてくれるモジュール「angular2-template-loader」を追加する必要があるようです。現在のプロジェクトでは、多くの箇所でrequireを使用しているので、AOTはまだ使えてません。

10 ブログ

あとラコさん(@laco0416)のブログがすごく役に立ちます。

まとめ


Angular2はAngular1よりパフォーマンスがよく、Angular1に比べて見た目が普通のES2016やウェブコンポーネンツに近いので、よりスムーズな開発ができると思います。
最後になりますが、カブクはAngular2で開発をしたい人材を募集してます!