ngUpgrade を使って AngularJS から Angular に移行

2018/03/23
このエントリーをはてなブックマークに追加


ソフトウェアエンジニアの花岡です。今回は弊社で ngUpgrade を使って AngularJS から Angular に移行した際の実例についてご紹介したいと思います。

本記事は前回の記事の背景の

既存の AngularJS のコードベースをなるべくそのままインポートして動作させる

に相当します。

バージョン

TypeScript、AngularJS、Angular、Angular CLI のバージョンは以下の通りです。

  • TypeScript 2.3
  • AngularJS 1.5
  • Angular version 4.4
  • Angular CLI 1.5

移行した後で TypeScript、Angular、Angular CLI はそれぞれ 2.6、5.2、1.7 に更新しています。

移行前・移行後の構成

移行前

以降前の構成は以下の通りです。

  • フロントエンド
    • TypeScript、CoffeeScript
    • AngularJS
    • npm、Bower
    • Grunt
  • バックエンド
    • Python
    • Flask
      • HTML ファイルや AngularJS テンプレートを生成
      • Web API
      • i18n(Jinja2)

フロントエンドはもともと CoffeeScript で書かれていて大部分が TypeScript に書き換えられている状態でした。JavaScript ライブラリなどの管理は Bower が使われていて Grunt でビルドしていました。一部 npm でインストールされるパッケージもありました。

バックエンドは Flask を使っていて、HTML ファイルだけでなく AngularJS テンプレートも Jinja2 の i18n 機能で多言語化対応して生成していました。Flask は Python の Web フレームワークで Jinja2 は Flask のテンプレートエンジンです。

移行後

移行後の構成は以下の通りです。AngularJS アプリのコードベースは ng1 ディレクトリに閉じ込めています。

Bower はなくなりパッケージは npm だけでインストールされます。ビルドは Angular CLI に委譲します。ディレクトリ構成も Angular CLI のものをそのまま使っています。

i18n は Jinja2 から暫定的に AngularJS の angular-translate に移行しました(理由は後述)。Grunt はそのメッセージファイルの生成のためだけに使っています。

Flask アプリはもはや AngularJS テンプレートを生成しません。AngularJS テンプレートは ng1 ディレクトリから静的な HTML ファイルとして利用されます。

移行の進め方

  • なるべく素早く移行したい
  • 移行中も既存のコードベースをメンテナンスしたい
  • もしかしたら移行できないかも

という理由から既存のコードベースを大きく変更することなく進めていくことにしました。具体的には Upgrading from AngularJS の Preparation はスキップしました。

そして移行前のコードベースの frontend の隣に Angular CLI で frontend2 というプロジェクトを生成して、frontend2 から frontend のファイルを .angular-cli.json で参照するようにしました。

.
|-- frontend/
|   |-- README.md
|   |-- bower_components/
|   |-- node_modules/
|   |-- ...
|   `-- tslint.json
|-- frontend2/
|   |-- README.md
|   |-- node_modules
|   |-- ...
|   `-- tslint.json
...

たとえば Bower のパッケージも .angular-cli.json で参照していました。そうすることで frontend の方では Angular への移行を意識することなくパッケージの更新を含むメンテナンスが可能でした。Bower から npm への移行は Angular への移行の最終段階で行いました。

ただしこのやり方が可能なのは Angular CLI 1.5.3 までで 1.5.4 からはセキュリティのためプロジェクトの外のファイルを .angular-cli.json で参照できなくなったため、移行が終わるまでは Angular CLI 1.5.3 を使っていました。

移行ポイント

Jinja2 テンプレート

移行前のコードベースでは templateUrl にバックエンドの URL を指定していたのですがビルドできなくなりました。たとえば

angular.module('myModule').component('myComponent', {
  controller: MyComponentController,
  templateUrl: '/url/for/my-component.template.html',
})

をビルドすると

Module not found: Error: Can't resolve './/url/for/my-component.template.html

というエラーになります。

angular.module('myModule').component('myComponent', {
  controller: MyComponentController,
  templateUrl: './my-component.template.html',
})

のようにバックエンドの URL ではなく、そのソースコードからのファイルパスを指定するとビルドできるようになります。

つまり Anguar への移行では AngularJS テンプレートは静的な HTML ファイルである必要があり、Jinja2 テンプレートから Jinja2 構文を取り除いて AngularJS テンプレートに変換しなければなりませんでした。

i18n

Jinja2 構文には i18n が含まれるため i18n 機能の移行も必要になります。念のため Angular の i18n を AngularJS のテンプレートに適用しようとしてみましたができませんでした。

そのため今回は暫定的に angular-translate に移行し、コンポーネントなどを Angular に移行するタイミングで Angular の i18n に移行しようと考えています。

script タグでの text/ng-template によるテンプレート

script タグでの text/ng-template によるテンプレートの定義も templateUrl で Module not found エラーとなるため別ファイルに抽出する必要がありました。

UI Router でバックエンドの URL

UI Router でもバックエンドの URL を指定すると Module not found エラーとなります。

バックエンドのロジックが複雑で AngularJS テンプレートへの変換が難しいところは

const createTemplateProvider = (url: string) => {
  return ($templateCache: angular.ITemplateCacheService, $http: angular.IHttpService) => {
    'ngInject';
    return $http.get(url, { cache: $templateCache }).then(response => response.data);
  };
};

$stateProvider.state('root.dashboard', {
  url: '/',
  templateProvider: createTemplateProvider('/dashboard'),
  // ...
})

のように UI Router の templateProvider で指定することにしました。

CoffeeScript

一部残っていた CoffeeScript の TypeScript への移行は Decaffeinate を使い、ES 2015 に変換した結果を微調整しました。

AngularJS の dependency annotation

前回の記事でご紹介した ts-ng-annotate を使って dependency annotation を追加しました。

テーマ機能

Angular への移行と直接は関係ないのですが、今回はテーマに応じて CSS ファイルを切り替える簡単なテーマ機能の移行も必要でした。CSS ファイルの生成自体は .angular-cli.json

{
  ...
  "apps": [
    {
      ...
      "styles": [
        { "input": "themes/black.scss", "output": "theme-black", "lazy": true },
        { "input": "themes/dark-gray.scss", "output": "theme-dark-gray", "lazy": true },
        ...
      ]
      ...
    }
  ]
}

と書いて npm run build -- --extract-css すると、dist ディレクトリに CSS ファイルが生成されます。

開発ビルド時には theme-black.bundle.css というファイルが生成されますが、プロダクションビルド時には --output-hashing フラグが all となり theme-black.184f93a894912f969bde.bundle.css のようなハッシュ値つきのファイルが生成されます。

Flask アプリでは、これらを透過的に扱えるように以下のようなエンドポイントを定義しました。

def build_theme_to_url_map():
    theme_to_url = {
        theme: '/theme-' + theme + '.bundle.css'
        for theme in THEMES
    }
    for filename in glob.glob(THEME_DIR + '/theme-*.bundle.css'):
        basename = os.path.basename(filename)
        theme = basename.split('.', 1)[0][len('theme-'):]
        theme_to_url[theme] = '/' + basename
    return theme_to_url


_theme_to_url_map = build_theme_to_url_map()


@app.route('/theme.css')
def theme():
    theme = get_theme()
    return redirect(_theme_to_url_map[theme])

npm start 時には実際の CSS ファイルが生成されず glob でマッチしないため、npm start 用のハッシュ値なしバージョンを theme_to_url の初期化式で定義しています。

最後に

これで

既存の AngularJS のコードベースを段階的に Angular に移行していく

ことができるようになりました。

弊社では Angular に興味のある/Angular をお任せできるエンジニアを募集しています。興味のある方は是非こちらからご応募ください。

その他の記事

Other Articles

2019/01/18
SIGGRAPH Asia 2018 参加レポート

2019/01/08
お正月だョ!ECMAScript Proposal全員集合!!

2019/01/08
カブクエンジニア開発合宿に行ってきました 2018秋

2018/12/25
OpenAPI 3 ファーストな Web アプリケーション開発(環境編)

2018/12/23
いまMLKitカスタムモデル(TF Lite)は使えるのか

2018/12/21
[IoT] Docker on JetsonでMQTTを使ってCloud IoT Coreと通信する

2018/12/11
TypeScriptで実現する型安全な多言語対応(Angularを例に)

2018/12/05
GASでCompute Engineの時間に応じた自動停止/起動ツールを作成する 〜GASで簡単に好きなGoogle APIを叩く方法〜

2018/12/02
single quotes な Black を vendoring して packaging

2018/11/14
3次元データに2次元データの深層学習の技術(Inception V3, ResNet)を適用

2018/11/04
Node Knockout 2018 に参戦しました

2018/10/24
SIGGRAPH 2018参加レポート-後編(VR/AR)

2018/10/11
Angular 4アプリケーションをAngular 6に移行する

2018/10/05
SIGGRAPH 2018参加レポート-特別編(VR@50)

2018/10/03
Three.jsでVRしたい

2018/10/02
SIGGRAPH 2018参加レポート-前編

2018/09/27
ズーム可能なSVGを実装する方法の解説

2018/09/25
Kerasを用いた複数入力モデル精度向上のためのTips

2018/09/21
競技プログラミングの勉強会を開催している話

2018/09/19
Ladder Netwoksによる半教師あり学習

2018/08/10
「Maker Faire Tokyo 2018」に出展しました

2018/08/02
Kerasを用いた複数時系列データを1つの深層学習モデルで学習させる方法

2018/07/26
Apollo GraphQLでWebサービスを開発してわかったこと

2018/07/19
【深層学習】時系列データに対する1次元畳み込み層の出力を可視化

2018/07/11
きたない requirements.txt から Pipenv への移行

2018/06/26
CSS Houdiniを味見する

2018/06/25
不確実性を考慮した時系列データ予測

2018/06/20
Google Colaboratory を自分のマシンで走らせる

2018/06/18
Go言語でWebAssembly

2018/06/15
カブクエンジニア開発合宿に行ってきました 2018春

2018/06/08
2018 年の tree shaking

2018/06/07
隠れマルコフモデル 入門

2018/05/30
DASKによる探索的データ分析(EDA)

2018/05/10
TensorFlowをソースからビルドする方法とその効果

2018/04/23
EGLとOpenGLを使用するコードのビルド方法〜libGLからlibOpenGLへ

2018/04/23
技術書典4にサークル参加してきました

2018/04/13
Python で Cura をバッチ実行するためには

2018/04/04
ARCoreで3Dプリント風エフェクトを実現する〜呪文による積層造形映像制作の舞台裏〜

2018/04/02
深層学習を用いた時系列データにおける異常検知

2018/04/01
音声ユーザーインターフェースを用いた新方式積層造形装置の提案

2018/03/31
Container builderでコンテナイメージをBuildしてSlackで結果を受け取る開発スタイルが捗る

2018/03/14
Three.jsのパフォーマンスTips

2018/02/14
C++17の新機能を試す〜その1「3次元版hypot」

2018/01/17
時系列データにおける異常検知

2018/01/11
異常検知の基礎

2018/01/09
three.ar.jsを使ったスマホAR入門

2017/12/17
Python OpenAPIライブラリ bravado-core の発展的な使い方

2017/12/15
WebAssembly(wat)を手書きする

2017/12/14
AngularJS を Angular に移行: ng-annotate 相当の機能を TypeScrpt ファイルに適用

2017/12/08
Android Thingsで4足ロボットを作る ~ Android ThingsとPCA9685でサーボ制御)

2017/12/06
Raspberry PIとDialogflow & Google Cloud Platformを利用した、3Dプリンターボット(仮)の開発 (概要編)

2017/11/20
カブクエンジニア開発合宿に行ってきました 2017秋

2017/10/19
Android Thingsを使って3Dプリント戦車を作ろう ① ハードウェア準備編

2017/10/13
第2回 魁!! GPUクラスタ on GKE ~PodからGPUを使う編~

2017/10/05
第1回 魁!! GPUクラスタ on GKE ~GPUクラスタ構築編~

2017/09/13
「Maker Faire Tokyo 2017」に出展しました。

2017/09/11
PyConJP2017に参加しました

2017/09/08
bravado-coreによるOpenAPIを利用したPythonアプリケーション開発

2017/08/23
OpenAPIのご紹介

2017/08/18
EuroPython2017で2名登壇しました。

2017/07/26
3DプリンターでLチカ

2017/07/03
Three.js r86で何が変わったのか

2017/06/21
3次元データへの深層学習の適用

2017/06/01
カブクエンジニア開発合宿に行ってきました 2017春

2017/05/08
Three.js r85で何が変わったのか

2017/04/10
GCPのGPUインスタンスでレンダリングを高速化

2017/02/07
Three.js r84で何が変わったのか

2017/01/27
Google App EngineのFlexible EnvironmentにTmpfsを導入する

2016/12/21
Three.js r83で何が変わったのか

2016/12/02
Three.jsでのクリッピング平面の利用

2016/11/08
Three.js r82で何が変わったのか

2016/12/17
SIGGRAPH 2016 レポート

2016/11/02
カブクエンジニア開発合宿に行ってきました 2016秋

2016/10/28
PyConJP2016 行きました

2016/10/17
EuroPython2016で登壇しました

2016/10/13
Angular 2.0.0ファイナルへのアップグレード

2016/10/04
Three.js r81で何が変わったのか

2016/09/14
カブクのエンジニアインターンシッププログラムについての詩

2016/09/05
カブクのエンジニアインターンとして3ヶ月でやった事 〜高橋知成の場合〜

2016/08/30
Three.js r80で何が変わったのか

2016/07/15
Three.js r79で何が変わったのか

2016/06/02
Vulkanを試してみた

2016/05/20
MakerGoの作り方

2016/05/08
TensorFlow on DockerでGPUを使えるようにする方法

2016/04/27
Blenderの3DデータをMinecraftに送りこむ

2016/04/20
Tensorflowを使ったDeep LearningにおけるGPU性能調査

→
←

関連職種

Recruit

サーバーサイドエンジニア

業務内容

カブク自社で開発・運営しているWebサービス(3Dプリンターなどを活用したデジタル製造サービス)のサーバサイド開発。WebサービスのバックエンドやAPIの設計・実装をお任せします。

フロントエンドエンジニア

業務内容

カブク自社で開発・運営しているWebサービス(3Dプリンターなどを活用したデジタル製造サービス)のWebフロントエンド開発。フロントエンドの設計や実装をお任せします。

機械学習エンジニア

業務内容

機械学習を用いた3Dデータや2Dデータからの情報抽出モデルの構築やセンサーデータの分析モデルの調査・研究・開発。 PoCだけでなく、データの前処理や学習、ハイパーパラメータチューニング、獲得モデルの評価、適用、運用のパイプライン構築まで、機械学習をプロダクション適用する全てのお仕事に携われます。

インターン(エンジニア)

業務内容

カブクの社員と肩を並べて、実業務を中心とした知識やスキルを身につけていただく実践型インターンシップ。スタートアップならではのスピードがあり、ダイナミックな就業経験を体験することが可能です。

→
←

お客様のご要望に「Kabuku」はお応えいたします。
ぜひお気軽にご相談ください。

お電話でも受け付けております
03-6380-2750
営業時間:09:30~18:00
※土日祝は除く