Mainly Devel Notes

Twitter, GitHub, StackOverflow: @ovrmrw (short hand of "overmorrow" that means the day after tomorrow)

新鮮なFalcorとAngular2のサンプル、季節のRxJSとminimongoを添えて(TypeScriptのAbstract Class風味)

Angular2, Falcor, RxJS, minimongo, TypeScript, Abstract Classデザインパターン

Angular2 Advent Calendar 2015 13日目です。

GithubリポジトリはAngular2 rc.0に対応しました。記事の内容とは異なる部分がありますのでご留意下さい。

今回の目玉は注目を集めつつあるニューフェイスFalcorです。
…が、
終わってみれば「モダンWebアプリにおけるDBアクセスに主眼を置いた総合講座」のようになってしまったかもしれません。

とりあえずFalcorがどういうものか、一番わかりやすいのがこれ↓
Web開発の未来 – React、FalcorおよびES6
今は全部読まなくていいですが、中盤ぐらいまでFalcorの話題です。僕はこれを何回か読んでようやく理解できました。かなり頭が疲れました。
最終的に上記の記事が理解できるかどうかが、Falcorを理解したかどうかのベンチマークになると思います。

もう先にお伝えしますが、この記事は企画だけ先行して途中からまとまる気がしなくなったためにかなりちんぷんかんぷんです。
いちいち記事読むのめんどくさいよサンプル出してよサンプル!という方のためにGitHubにアップロードしてあるのでcloneしてnpm iして早速動かしてみてください。

ovrmrw/angular2_falcor_minimongo
(ChromeFirefoxで動作確認済み)

自分で動かして後はソース読んでと言って終わりたいところですが、それではさすがにアレなので申し訳程度の解説を始めたいと思います。



Falcorとは

Falcor: One Model Everywhere
まずは公式から入りましょう。英語ですね。がんばって読みましょう。得ることは多いです。ちなみに発音はファルコーです。(英語っぽく言うとファゥコォ)
最低限、トップページとWhat is Falcor?How Does Falcor Work?は読んでください。 そうじゃないと何のためのライブラリかもわからないと思います。

あなたは今までにExpressとかASP.NET WebAPIとかで、いわゆるエンドポイント(API?)をたくさん書いたことがありますか?
エンドポイントというのは、そのURLに何かリクエストを投げると何かしらのレスポンスが返ってくるというものです。イマドキは大抵JSONが返ってきますね。XMLが主流だった時代もありました。
そういうの今までに書いたことがない人には残念ながらFalcorの衝撃は伝わらないかもしれません。

逆にリクエストの種類に応じて延々増え続けるエンドポイントでExpressが肥大化するのを目の当たりにしたような方、そう、あなたのためにこのまとまる予感がしない記事を書いているのです。
僕はうまく説明できないのでこの記事↓をざーっと読んでみてください。
米Netflix、データフェッチのためのJavaScriptライブラリ「Falcor」を公開

これ読んでわかる人、すごいですね!僕は何がなんだかさっぱりわかりませんでしたよ。おそらくほとんどの人にはピンとこないと思うので、
(僕なりに解釈した)Falcorの特徴を簡単にまとめると

  • エンドポイントを増やさずに出来ることを増やせる。柔軟性が高い。
  • フロントエンドのコードからもサーバーサイドのコードからもDBアクセスに関するコードを大幅に減らせる。
  • キャッシュしたものは2度目からDBにアクセスしない。だから速い。
  • エンドポイントは入りと出の帳尻が合っていれば中身をどのように書いても良い。
  • DBがなんなのか、どこにあるのか、どういう構造でデータを持っているのか、フロントエンドはほとんど考慮しなくて良い。
  • まるでそこにそういう構造をしたJSONがあって、それを取ってくるだけみたいな感覚。

わかりますよ。あまり伝わらないですね?
Google検索してみましょう。残念ながら日本語の記事はほとんどヒットしません。英語でも実践的なサンプルコードを伴った記事はなかなかありません。
(まだFalcor自体がアルファ版ということもありますし、最近出てきたばかりなので)

でも大丈夫。このサンプルアプリのソースを読めばきっと大体わかります。(投げやり)

これだけは言っておきましょう。Falcorまじですごいやつ。

(追記)
僕はどちらかというとサーバーサイド側のエンジニアなのでDBアクセスについては色々と悩まされてきたし試行錯誤の毎日です。 エンドポイントのマルチ対応に関しては過去に.NET Framework用ですが記事を書いていますのでよろしければご参照ください。↓
PetaPocoのクエリでODataを使えるようにする($top,$skip,$orderby,$filter,$selectとか

サーバーサイドの express.ts の中はどうなっている?

DBアクセスと言えば真っ先に思い浮かぶのは肥大化するExpressですね。
ではルートフォルダにあるexpress.tsの中を見てみましょう。エンドポイントに関するコードはどうなっているでしょう。

// ./express.ts

app.use('/model.json', falcorExpress.dataSourceRoute((req, res) => {
  return new MinimongoFalcorRouter();
}));

たったの3行。ほぼ公式サイトの書き方に準拠しています。
他に怪しいコードと言えば

const falcorExpress = require('falcor-express');
import {MinimongoFalcorRouter} from './src-server/minimongo-falcor-router';

これくらいでしょうか。 import文が怪しい!正解です。minimongo-falcor-router.tsにDBアクセスに関するコード(エンドポイント群)を追放しています。

じゃあ minimongo-falcor-router.ts の中はどうなっている?

// ./src-server/minimongo-falcor-router.ts

import {MinimongoFactory} from './minimongo-factory';
const db = new MinimongoFactory().getDatabase();

またimport文が怪しい!この2行でminimongoにサンプルデータを読み込んでメモリ上にDBを生成するという作業を行なっています。
(minimongoで生成できるDBにはいくつか種類がありますが、今回はMemoryDBという揮発性のDBを使います)
これはExpressが起動する度に生成され、終了する度に消滅します。

さてこのファイルの中にはエンドポイントが書かれているはずでしたね。探してみましょう。

let routes = [];
routes.push({
  route: "query2[{keys:keyword}]",
  get: (pathSet: any): any[] => {
    const keyword = pathSet.keyword[0] as string;
    let results = [];
    results.push({
      path: pathSet,
      value: `Hello, ${keyword}.`
    });
    return results;
  }
});

よくわからないかもしれませんが、これは簡単過ぎて実用的ではない例です。
(公式サイトを一通り眺めてみると上記がどういう意味なのかわかります。特にThe Falcor Routerは読んだ方がいいかもしれません)
今回のサンプルでは上記のようなroutes.push()が4回出てきます。つまりここでエンドポイントを4つ定義しています。
サンプルアプリにはPage1~4まであり、各々のページ用に1つずつエンドポイントを用意してあります。 最初は簡単でだんだん難しくなるように書きましたので、自分がどこまで理解できるか挑戦してみてください。

フロントエンドからどうやってエンドポイントを叩いている?

ざっくり過ぎるほどざっくりとサーバーサイドの解説をしましたが、早速フロントエンドの話に移ります。
サーバーサイドで定義したエンドポイントは当然フロントエンドから叩くことになりますね。リクエストを投げてJSONを受け取る、いわゆるWebAPIというやつです。

// ./src-front/page1/app-page1.component.ts

getJsonGraph() {
  const queryName = 'query1';
  
  this.model // this.modelは親クラスで定義されている。
    .get([queryName])
    .then(jsonGraph => {
      console.log(JSON.stringify(jsonGraph, null, 2)); // Falcorから返却されるJSON Graphを確認。
      this.messageByFalcor = jsonGraph ? jsonGraph.json[queryName] : '?????';
    });
}

一言で説明すると、Falcorの仮想JSONモデルとも言えるJSON Graphに対して'query1'という構造のJSONを要求したら{"query1":"何かしらの値"}みたいなJSONが返ってくるということです。

実際にサンプルを動かしてみて、サーバーサイドのコンソール、ブラウザのコンソール、ブラウザに表示される内容、HTMLテンプレート、色々観察してみてください。そうじゃないと伝わらない。たぶん。

ちなみにサンプルアプリでは、

  • サーバーサイドのTypeScriptファイルは ./src-server フォルダに
  • フロントエンドのTypeScriptファイルは ./src-front フォルダに

分けて保存してあります。
上記のコードはフロントエンドの中でもPage1のコードの抜粋です。Page4のこの部分はかなり難しくなっています。抜粋してみましょう。

// ./src-front/page4/app-page4.component.ts

getJsonGraph(condition: string, keyword: string, from: number = 0, length: number = 10) {
  const queryName = 'query4';
  const queryJson = serializeQueryObjectForFalcor<QueryParamsForQuery4>({
    collection: 'names',
    condition: condition,
    keyword: keyword     
  });
  
  this.model // this.modelは親クラスで定義されている。
    .get([queryName, queryJson, { from: from, length: length }, this.fields.concat('totalItems')])
    .then(jsonGraph => {
      console.log(JSON.stringify(jsonGraph, null, 2)); // Falcorから返却されるJSON Graphを確認。
      this.documentsByFalcor = jsonGraph ? lodash.toArray(jsonGraph.json[queryName][queryJson]) : [];
      this.totalItemsByFalcor = jsonGraph ? jsonGraph.json[queryName][queryJson][from]['totalItems'] : 0;
      console.log(this.documentsByFalcor); // tableに描画するための配列を確認。
    });
}

this.model.get()の中が難解ですが、これはこういう構造のJSONを要求するという意味になります。

何を言っているかわからないかもしれませんね。これはもう、実際の動きを見てもらいながらソースを追っていただくしかないかなと思います。
なるべくヒントになるような情報をコンソールに出力するようにコードを書いたつもりですので、動かしながらコンソールをよく観察してみてください。

queryJsonという変数にはJSONを少し加工(エスケープ)した文字列を格納し、this.model.get()に送り込んでいます。 というのも",#,%,&,+のような一部の文字列はそのままだとFalcorの処理の中でエラーになってしまうからです。

// ./src-front/app/falcor-json-serializer.ts

const PLUS = '@PLUS@';
const AMPERSAND = '@AMPERSAND@';
const SHARP = '@SHARP@';
const PERCENT = '@PERCENT@';

// フロントエンドからサーバーサイドにJSONを渡すときにFalcor用にシリアライズする。
function serializeQueryObjectForFalcor<T>(object: T): string {
  const json = JSON.stringify(object);
  let quotesReplacer = "`";
  while (json.indexOf(quotesReplacer) > -1) {
    quotesReplacer = quotesReplacer + "'";
  }
  const json2 = quotesReplacer + [['"', quotesReplacer], ['[+]', PLUS], ['&', AMPERSAND], ['#', SHARP], ['%', PERCENT]].reduce((p, replacer) => {
    return p.replace(new RegExp(replacer[0], 'g'), replacer[1]);
  }, json); // JSONの先頭にquotesReplacerを付け加える。
  console.log('serialized query json: ' + json2);
  return json2;
}

// サーバーサイドがフロントエンドからJSONを受け取ったときにJavaScriptオブジェクトにデシリアライズする。
function deserializeQueryJsonForFalcor<T>(json: string): T {
  const quotesReplacer = json.match(/^.*?{/)[0].slice(0, -1);
  const json2 = [[quotesReplacer, '"'], [PLUS, '+'], [AMPERSAND, '&'], [SHARP, '#'], [PERCENT, '%']].reduce((p, replacer) => {
    return p.replace(new RegExp(replacer[0], 'g'), replacer[1]);
  }, json).slice(1); // 先頭に余分な " が残るのでsliceで取り除く。
  console.log('deserialized query json: ' + json2);
  return JSON.parse(json2);
}

export {serializeQueryObjectForFalcor, deserializeQueryJsonForFalcor}

Falcorの思想とは逆行するようですが、サーバーサイドのパラメーターの実装をフロントエンドが把握している場合、TypeScriptのジェネリックを使うことで値の受け渡しを確実なものにすることができます。

サンプルコードのPage4ではジェネリックを使っていますので、フロントエンドからサーバーサイドにどのように値が渡されているかを追ってみてください。
このときサーバーサイドではデストラクチャリングという書き方をすることで一行で受け渡しを完了できます。下記はその部分の抜粋です。

const {collection, condition, keyword} = deserializeQueryJsonForFalcor<QueryParamsForQuery4>(queryJson);

ちなみにQueryParamsForQuery4の定義は下記の通りです。

// ./src-server/query-params.d.ts

declare interface QueryParamsForQuery4 {
  collection: string,
  condition: string,
  keyword: string
}

起動から画面表示までの大まかな流れ

Angular2に不慣れな方は、そもそも起動して画面が表示されるまでにどういう順番でファイルを読み込んでいるのかわからないかもしれないので、簡単に説明します。

  • Expressを起動。 express.ts
  • src-serverフォルダの minimongo-falcor-router.tsminimongo-factory.ts ここまでがサーバーサイドの準備。
  • viewsフォルダの index.jade_layout.jade ここからがフロントエンドの準備。
  • viewsフォルダの system.config.ts
  • src-frontフォルダの app/boot.tsapp/app.ts 主に上部のナビゲーションと下部のフッターの生成
  • src-frontフォルダの page1/app-page1.component.tsapp/app-page-parent.ts 各ページのメインコンテンツ

上記がExpressを起動してからPage1を表示するまでの大体のファイル読み込みの流れです。
よくわからなくなったときはこの流れに沿ってソースを読んでみてください。

サンプルアプリの遊び方

GitHubリポジトリcloneして、npm installして、gulp compileして、gulp exでブラウザが自動的に立ち上がります。

  • Page1 ここでFalcorがどうやってメッセージを取得しているかの流れを追ってください。ここが理解できないと以降もわかりません。
    • 読むべきソース ./src-front/page1/app-page1.component.ts,./src-server/minimongo-falcor-router.ts
  • Page2 こちらの入力に応じてFalcorが返すメッセージが変わります。Falcorがどうやって受け取ってどうやって返しているのかを追ってください。
    • 読むべきソース ./src-front/page2/app-page2.component.ts,./src-server/minimongo-falcor-router.ts
  • Page3 FalcorがminimongoのDBから取得したデータを画面に表示します。Page4の簡易版ですがPage2よりかなり難しくなります。
    • 読むべきソース ./src-front/page3/app-page3.component.ts,./src-server/minimongo-falcor-router.ts
  • Page4 Page3をさらに発展させてさらに子コンポーネントも登場します。コンポーネントと子コンポーネントがどうやって関連し合っているかを追えるかどうかがポイントです。ただし難解。
    • 読むべきソース ./src-front/page4/app-page4.component.ts,./src-server/minimongo-falcor-router.ts
    • 難解なソース ./src-front/page4/app-page4-table.component.ts(テーブルとページネーションの定義)
    • DBの元データ ./json/names_part_1000.json

ソースコードは可能な限り無駄をなくして読みやすくなるようにしたつもりですが、RxJSのAngular2への応用Abstract Classを使用したデザインパターンが盛り込まれていたりして多少複雑になっているのは否めません。
各ページには EXPLANATION ボタンがあり、クリックすると簡単な説明やお題が書いてあったりします。特にPage4のお題はFalcorの威力がわかるので全て解いていただきたいところです。


(ここで今回の記事は終わりたいところですがもう少し)


イベントハンドラについて

全てのページでRxJSのObservableが活躍します。Observableによるイベントハンドラで何ができるのかを感じ取っていただければと思います。

一言で説明すると、Observableから生成されたSubscription(イベントハンドラ)は一度生成されるとまるで浮遊して漂っているかのように常に存在し、イベントの発生を捕捉すると直ちに活動を開始するものです。

HTMLテンプレートに(click)='onClick()'とか書かなくてもイベントを捕捉できます。その様子は例えるなら鷹が上空から餌が出てくるのを監視しているかのようです。
全てのページに書いたわかりやすいRxJSのコードがこちら↓

Observable.fromEvent<MouseEvent>(document.getElementsByTagName(componentSelector), 'click')
  .map(event => event.target.textContent)
  .filter(text => _.trim(text).length > 0)
  .subscribe(text => {
    Materialize.toast(`You clicked "${text}"`, 300);
  });

何らかのHTMLエレメントをクリックすると発火し、条件を満たしたらメッセージを表示する、というような流れです。
これも実際にサンプルアプリを動かして確認してもらうのが一番早いですね。

Page4では子コンポーネントで発生するCustomEventを親コンポーネントのObservableで捕捉しています。この流れは是非とも追っていただきたい部分です。

minimongoについて

今回のサンプルアプリではデータベースにminimongoを用いています。
これについては過去記事 minimongoでバルクインサート用のjsonファイルをインポートしてLIKE検索までやってみた。 も参照してください。

サンプルアプリでとりあえずDBっぽいものを動かしたいというときには最適なソリューションかと思います。

Abstract Classデザインパターンについて

勝手にデザインパターン名を付けていますが、他になんと言えばいいのかわかりません。
これについては過去記事 Angular2の実践的なビューの作り方(Abstract Classを使う) も参照してください。

ページ遷移で入る度に適切な初期化処理をして、ページ遷移で出る度に適切なdispose処理をしています。
これには各ページに記述しているinitializable関数が関与しています。この親クラスと子クラスの流れを追っていただくと、どういうメリットがあるのかわかるかと思います。

System.jsについて

Angular2を代表とするモダンWebアプリ開発をするにあたって、Angular公式が推奨するSystem.jsを使う際の肝はずばり

System.config()の書き方一つ、です。

サンプルアプリではViewsフォルダのsystem.config.tsにまとめて書いてありますので、src-frontフォルダの各tsファイルのimportrequireとどう関連しているか追ってみてください。


最後に

「ソース読んで」「コード見て」「流れ追って」「動かしてみて」の連発で申し訳ありません。
これを書いている僕もWebアプリ開発の現場にいるわけではない初心者なのでうまくまとめて伝えるのが難しいです。
でもプログラミングって他人のソースを読んでとりあえず動かしてどこがどう関連しているのか自分なりに追っていく作業の連続だと思います。

上の方にも書きましたが、Page1~4のEXPLANATIONにあるお題(特にPage4)は是非とも取り組んでみていただきたいです。 特に僕のような初心者の方には色々な発見があると思います。


以上です、ありがとうございました。

Remove all ads