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

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


フロントエンドエンジニアの今村です。

この記事はAngular Advent Calendar 2018 11日目の記事で、テーマは多言語対応です。
Angular Advent CalendarなのでAngularの話を中心に書きますが、手法としてはAngularに限らず、ひろく(TypeScriptで書かれた)Webフロントエンド全般の多言語対応に適用可能なものです。というのも、私は以前にも似たような記事をQiitaに投稿していて、その時はReactをやっていました。
この記事ではQiitaに投稿した方法を少し改良したやり方をご紹介しますが、TypeScriptの型に甘えて多言語対応を実現したいという気持ちは一貫しています。

TL;DR

辞書ファイルをTypeScriptで書きたいという思いのもと、Angularの標準のi18n機能やその他のライブラリに頼らずに実装した多言語対応を紹介します。

Demo: https://stackblitz.com/edit/angular-rwuzwv
Source Code: https://github.com/kimamula/ts-i18n-angular

1. 辞書ファイルの用意

// 英語
// translate/dictionary/en.ts
export const dictionary = {
  greeting: (name: string) => `Hello ${name}!`,
  title: 'translate example'
};
// 型定義
// translate/dictionary/index.ts
import { dictionary } from './en';
export type Dictionary = typeof dictionary;
export type Lang = 'en' | 'de' | 'ja';
// 日本語
// translate/dictionary/ja.ts
import { Dictionary } from '.';

export const dictionary: Dictionary = {
  greeting: (name: string) => `こんにちは ${name}!`,
  title: 'translate 例'
};

(デモではドイツ語も用意しましたが省略)

2. 辞書ファイルのロード

// translate/translate.service.ts
@Injectable({
  providedIn: 'root'
})
export class TranslateService {
  // lang$ に対して next() するとその度に言語が切り替わる
  readonly lang$ = new ReplaySubject<Lang>(1);

  readonly dictionary$ = this.lang$.pipe(
    distinctUntilChanged(),
    // 言語の切り替え時に辞書ファイルを dynamic import
    switchMap<Lang, Dictionary>(lang => import(`./dictionary/${lang}`)
      .then(({ dictionary }) => dictionary))
  );

  readonly availableLanguages: ReadonlyArray<Lang> = ['en', 'ja', 'de'];

  constructor() {
    // デフォルトではブラウザの言語を使う
    const index = this.availableLanguages.indexOf(navigator.language as any);
    this.lang$.next(this.availableLanguages[index] || 'en');
  }
}

dynamic importを使うため、tsconfig.json"module": "esnext"を指定する必要があります。この結果辞書ファイルの内容は言語ごとに独立したchunkに分離され、メインのchunkには含まれなくなります。必要な時に必要な辞書ファイルだけをロードするため、効率がよくなります(ただし、初回ロード時の注意点については後述します)。

3. 辞書の利用

TranslateServicedictionary$をどこかでsubscribe()し、それをComponentに渡していきます。説明するほどのことでもありませんが、Componentでは次のように使います。

@Component({
  selector: 'app-hello',
  template: `
  <h1>{{ dictionary.title }}</h1>
  <p>{{ dictionary.greeting('Andreas') }}</p>
`
})
export class HelloComponent {
  @Input() dictionary!: Dictionary;
}

Angularの一般的な多言語対応

Angularでは公式のi18n機能の他に、ngx-translateangular-l10nが用いられることが多いようです。これら3つの機能の大まかな比較は、angular-l10nのREADMEに記載の表を見ると分かりやすいかと思います。

https://github.com/robisim74/angular-l10n#angular-i18n-solutions より

ここでFile formatsの行を見ると、JSONやXLIFFXMB/XTBといったi18n規格が使われていることが分かります。これはAngularに限らず、一般にJavaScriptのi18n系のライブラリは同じような状況だと思います。
たとえばngx-translateでは辞書ファイルを以下のようにJSONで書きます。

{
    "HELLO": "hello {{value}}"
}

この場合、valueは翻訳時に渡す変数ですが、型は宣言できませんし、変数名をtypoしたりそもそも変数を渡し忘れたりしてもコンパイルエラーにはなりません。
そこで、辞書ファイルをTypeScriptで書いて型安全なものとしたいというのが、今回のモチベーションです。

なお、標準機能があるにもかかわらず、ngx-translateやangular-l10nなどのライブラリが使われているということは、標準機能に不満を感じる開発者が少なからずいるということです。現状のAngular標準のi18n機能への主な不満は以下のようなものと考えられます。

  1. Angularのtemplateの中でしか使えない(通常のTypeScriptのコードの中で使えない)
  2. 言語ごとにバンドルを生成する必要がある
    • 言語の切り替えの際にはページリロードが必要
  3. 辞書ファイルとしてJSONがサポートされていない

これらについては、Angularの新しいrendererであるivyが導入される際に、i18n機能も更新が予定されており、下記のissueで議論が進められています。

https://github.com/angular/angular/issues/16477

コメントが非常に多いのですべて追うのは大変ですが、issueの本文が逐次更新されているため、それを読むだけでも概要は掴めます。上記1, 2についてはivy導入後は解決する見込み(※)であり、3についてもサポートしたいというコメントがあります。

※: 2に関しては言語切り替え時にアプリのリロードは必要になってしまうとのことです。ただし、「アプリのリロード」とは「ページのリロード」ではなく、クライアントサイドでアプリを1からマウントし直すことを意味します

この方法のメリット

1. 型安全

TypeScriptの型の恩恵が受けられます。辞書ファイルのキーや、渡す変数の名前や型に誤りがあった場合は、コンパイルエラーになります。
当然、これに付随してIDEによる補完やリファクタリングのサポートもバッチリです。

2. 柔軟

辞書ファイルはTypeScriptのコードなので、わりとなんでもできます。文言の生成のために渡す引数や生成結果も、文字列でも数値でもオブジェクトでも配列でも正規表現でも関数でもTemplateRefでも、なんでも使えます。

3. シンプル

TypeScript以外に依存するものがなく、新たに何かを覚える必要もありません。シンプルすぎるため、単数形と複数形の切り替えなどのi18nの基本的な機能が備わっていませんが、柔軟性のメリットを生かして適当なライブラリを導入して解決可能です。

この方法のデメリット

TypeScript以外の環境との互換性がなくなることが最大のデメリットになると思われます。
JSONなどを使っている場合は、他言語でも使い回せる他、BabelEditのようなツールのサポートを受けることもできます。
辞書ファイルは非エンジニアに直接編集してもらう、といった運用も、TypeScriptを採用すると難しくなってくるかもしれません。

初回ロードの時間を短縮するために

TL;DRでごく素朴にdynamic importするやり方を紹介しましたが、これをそのまま動かすと、

  1. HTMLのロード
  2. メインのJSの取得
  3. メインのJSが読み込まれてその中でdynamic importが実行される
  4. 辞書ファイルのJSの取得
  5. 辞書ファイルのJSが読み込まれて文言が適用される

という手順を経なければ文言が画面に適用されません。これではdynamic importの分、文言の適用が遅れてしまいます。
これを回避する手段を考えてみます。

全言語の辞書ファイルをメインのバンドルに含める(SSR、CSR)

たとえばTL;DRのtranslate/translate.service.tsで、

import './dictionary/en';
import './dictionary/ja';
import './dictionary/de';

と書いてしまえば、辞書ファイルがメインのJSに含まれるようになり、dynamic importのところでサーバーへのJSのリクエストが発生しなくなります。
非常にシンプルな方法ですが、言うまでもなくメインのJSの肥大化がデメリットになります。対応言語の数が数ヶ国語に止まるなら、それほど気にする必要はないかもしれませんが、数十ヶ国語以上に対応しなければならないなら、あまり現実的ではないかもしれません。

Transfer Stateの仕組みを利用する(SSR)

SSRをしているなら、Transfer Stateで初回ロード用の辞書ファイルの情報をHTMLに埋め込む方法が使えます。現在のプロジェクトではこの方法を採用しています。
Angular以外のSSRでも同様の仕組みがあると思いますが、サーバーサイドで初期化した情報をHTMLに埋め込んだ状態でクライアントサイドに渡すことで、クライアントサイドで初期化処理を繰り返す必要がなくなります(初回のdynamic importをスキップできる)。

注意しなければならないのは、ドキュメントにも書いてあるとおり、Transfer StateではサーバーサイドでJSON.stringifyによる状態のシリアライズ、クライアントサイドでJSON.parseによる状態のデシリアライズが行われることです。

たとえば、

{
  dictionary: {
    greeting: (name: string) => `Hello ${name}!`,
    title: 'translate example';
  }
}

JSON.stringifyすると

"{"dictionary":{"title":"translate example"}}"

になってしまいます。つまり、辞書ファイルのうち、関数で実装した部分の情報が失われます。これを避けるには、辞書全体を関数として実装し、

export const dictionary = () => ({
  greeting: (name: string) => `Hello ${name}!`,
  title: 'translate example'
});

サーバーサイドでシリアライズする際にFucntion.prototype.toString()を噛ませます。また、クライアントサイドでデシリアライズする際には、Function()を使います。

さらに、辞書ファイルが外部のモジュールに依存するような実装になっている場合も注意が必要で、

import foo from 'foo';

export const dictionary = () => ({
  greeting: (name: string) => `Hello ${name}! ${foo()}`,
  title: 'translate example'
});

このfootoString()した後の文字列表現では何者か分からなくなってしまうため、このようなものは関数の引数にしてあげる必要があります。

import _foo from 'foo';

export const dictionary = (foo: typeof _foo) => ({
  greeting: (name: string) => `Hello ${name}! ${foo()}`,
  title: 'translate example'
});

このようにしておけば、クライアントサイドでデシリアライズした後で適切な引数を渡すことで辞書を復元できます。

なお、実行時のサーバーサイドのコードがES2015以降の形式である場合、サーバーサイドでシリアライズしたものをクライアントサイドでデシリアライズすると、一部のブラウザでエラーとなる可能性があります。その場合は辞書ファイルだけはES5にトランスパイルするなど、追加で一手間必要になってしまいそうです。

サーバーサイドで言語ごとに異なるindex.htmlを返す(SSR、CSR)

サーバーサイドで言語の判定を行い、その言語に対応した辞書ファイルのJSに対応するscriptタグをHTMLに埋め込んだ状態で返してあげる方法です。
試したことがないのと、そこそこ手間がかかりそうなので、詳細は省略します。

終わりに

個人的にはこの方法はかなり気に入っているのですが、ネット検索しても同じようなことをやっている人があまりいなさそうなので若干不安を感じています。ご意見、ご感想などいただければ嬉しいです。
また、弊社ではエンジニア(フロントエンド、サーバーサイド、機械学習)、Webデザイナーを絶賛募集中なので、そういったご連絡も大歓迎です。

明日のAngular Advent Calendarは@kpondaさんです。

その他の記事

Other Articles

2019/06/25
カブクエンジニア開発合宿に行ってきました 2019夏


Hola! KubeCon Europe 2019の参加レポート

2019/06/19
Clean Resume きれいな環境できれいな履歴書を作成する

2019/05/20
[Web フロントエンド] 状態更新ロジックをフレームワークから独立させる

2019/04/16
C++のenable_shared_from_thisを使う

2019/04/12
OpenAPI 3 ファーストな Web アプリケーション開発(Python で API 編)

2019/04/08
WebGLでレイマーチングを使ったCSGを実現する

2019/04/02
『エンジニア採用最前線』に感化されて2週間でエンジニア主導の求人票更新フローを構築した話

2019/03/29
その1 Jetson TX2でk3s(枯山水)を動かしてみた

2019/03/27
任意のブラウザ上でJestで書いたテストを実行する

2019/02/08
TypeScript で “radian” と “degree” を間違えないようにする

2019/02/05
Python3でGoogle Cloud ML Engineをローカルで動作する方法

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/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/23
ngUpgrade を使って AngularJS から Angular に移行

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

バックエンドエンジニア(Python・Go)

業務内容

当ポジションは弊社Webサービスのバックエンド機能設計及び実装を担当します。 サービス毎の開発チームで2週間スプリントのスクラム開発を実施しています。 週次で開発チームミーティングを実施し、実装設計の相談や工数見積もりを行います。 全ての開発コードはレビューと自動テストによって品質を保っています。 また、リファクタリングやフレームワークのバージョンアップも開発フローに組込み、技術的負債を放置しない開発を目指しています。

フロントエンドエンジニア(TypeScript)

業務内容

当ポジションは弊社Webサービスのフロントエンド機能設計及び実装を担当します。 サービス毎の開発チームで2週間スプリントのスクラム開発を実施しています。 週次で開発チームミーティングを実施し、実装設計の相談や工数見積もりを行います。 全ての開発コードはレビューと自動テストによって品質を保っています。 また、リファクタリングやフレームワークのバージョンアップも開発フローに組込み、技術的負債を放置しない開発を目指しています。

機械学習エンジニア

業務内容

センサーデータの分析モデルの調査・研究・開発。 Kabuku Connectの製造データ(3D、2D)から情報を抽出するモデルの構築。 データの前処理や学習、ハイパーパラメータチューニング、獲得モデルの評価、プロダクションのデータパイプラインとの連携をお願いします。

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

業務内容

業務から独立した、調査・研究系のタスクをおまかせしています。コードレビュー、 社内での報告会、 ブログ記事執筆を通して着実にスキルアップしていただくことを目指しています。 (希望があれば、プロダクトの開発業務もおまかせします。)

→
←

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

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