Angular2でさくっとMEANスタックをはじめてみる


こんにちは、平奥です!
これは、 TECHSCORE Advent Calendar 2016 TECHSCORE BLOG の22日目の記事です。

弊社サービス Synergy! は、 AngularJS で実装されています。 AngularJS はご存知の方も多いとは思いますが、後継バージョンの Angular2 が登場しました。 Angular2 は AngularJS の問題点が整理されました。その結果、使いやすく、そしてパフォーマンスもものすごく改善されています。

しかし問題点もあります。 AngularJS との互換性がありません。

そのため Angular2 を動作させるには今まで使用していた AngularJS の環境を使うことはできず、新たに動作させる環境を用意しないといけません。

Plnkr などを使えば簡単に Angular2 の検証はできるのですが、せっかくなら Angular2 の MEAN スタックを用意してバックエンドやデータベースも用意していろいろ遊んでみようと思い、Angular2 で MEAN スタックを作ってみました。

そこで学んだことを、要点をまとめて書いてみようと思います。

そもそも MEAN スタックとは

MEAN スタックは Web アプリケーションの開発を簡素化し、高速化するフルスタックの JavaScript のフレームワークです。 MongoDB 、Express 、 AngularJS 、Node.js を組み合わせることによって JavaScript でクライアントからサーバまで開発することができる環境です。

それぞれのソフトウェアの簡単な説明は以下となります。

  • AngularJS は JavaScript で書かれた、シングルページアプリケーション( SPA )の開発が可能なフロントエンドのフレームワークです。
  • Node.js は Chrome の V8 JavaScript エンジンで動作するサーバーサイドの JavaScript 環境である。軽量で効率的に動作する非同期型のイベント駆動モデルを採用しています。
  • MongoDB はデータを非定型のデータ構造の集合体として JSON 形式のデータで蓄える、 NoSQL 型ドキュメント指向データベース管理システムです。
  • Express は Node.js 上で動作する Web アプリケーションのフレームワークです。MEAN スタックで使用される場合は Node.js 上で動作する MVC フレームワークとして AngularJS からリクエストを受け取り、レスポンスを返すような役割を担っています。

今回はタイトルにある通り、AngularJS を使うのではなく、Angular2 を使用する MEAN スタックを作成したいと思います。

Anglar2 の MEAN スタックのひな形

ひな形として以下のようなディレクトリ構成にしています。

各ディレクトリの説明

  • assets: フロントエンド側の Angular2 で使われるファイルを保存するディレクトリです。
  • bin: Node.js でサーバを起動するためのファイルを保存するディレクトリです。
  • models: 今回は None.js から MongoDB にアクセスするために mongoose を使います。mongoose はデータをモデル化してスキーマベースでロジックを組み立てることができます。このディレクトリにはそのスキーマを定義したファイルを保存します。
  • public: 今回は Angular2 のモジュールをモジュールバンドラーである webpack を使ってまとめてこのディレクトリに保存するようにしています。
  • routes: Express で提供されているルーティング機能を使って、ルーティングを実装したファイルを保存します。
  • views: この MEAN スタックで使用する HTML ファイルを保存します。

サンプルアプリについて

今回は、MEAN スタックを理解できるように、メッセージを DB に登録して、登録情報を一覧表示するサンプルアプリを作成します。
まず MongoDB と mongoose をインストールします。

オフィシャルサイトから実行環境に適したバージョンをインストールしてください。

MongoDB オフィシャルサイト: https://www.mongodb.com/
mongoose オフィシャルサイト: http://mongoosejs.com/

インストールができたら、次はファイルの編集をおこなっていきます。

開発環境を構築するためのファイル

package.json

MEAN スタックで必要なモジュールは npm を使用して取得するようにしています。そのため package.json に必要なモジュールを記載して npm で取得できるようにしています。
ソースは以下となります。

今回はモジュールバンドラである webpack を使って、フロントのソースをまとめています。scripts プロパティには、開発環境のサーバを起動する start と Angular2 の TypeScript のソースをトランスパイルして、ファイルをまとめるための build スクリプトを6~7行目に定義しています。

webpack.config.js

webpack の設定では部分的に抜粋して取り上げます。
まず、Entryですが、起点となるモジュールを webpack に設定します。ここでは、Angular2 の起動処理が記載されている main.ts を指定しています。
また、webpack が処理した結果を出力するための設定である、output も設定しています。ここで出力した JavaScript のファイルをアプリケーション起動時に参照するようにしています。

他にも TypeScript をトランスパイルするための設定ファイルである、tsconfig.json などもありますが、特に重要ではないので、ここでは割愛させていただきます。

バックエンド側を構成するファイル

app.js

Node.js のメインのファイルです。ここではバックエンドで使用する各アプリケーションの設定が行われています。

7行目、13行目が mongoose の設定です。ここでは、接続する MongoDB の設定を行っています。

mongoose.connect('mongodb://localhost:27017/techscore');

ではIPアドレス:ポート番号/ DB 名を指定しています。

それ以外はほとんど Express の設定です。
ヘッダの設定や view の設定などを行っています。
9~10行目、34行目~35行目はルーティングの設定を行っています。

www ファイル

このファイルは Node.js でサーバを起動するための設定などが記載されています。

22行目でサーバを起動しています。
15~16行目でポートを指定しています。

views/index.hbs

このファイルは、バックエンド側からレスポンスとして返される HTML ファイルです。
この HTML ファイルでは Angular2 の初期に表示する内容が実装されています。

11行目で Angular2 の Components を指定しています。
また13行目で webpack で作成された JavaScript のファイルを取り込んでいます。

routes/app.js

routes ディレクトリは Express の Routing 機能を実現するファイルです。ここでは REST API で実装することができます。
routes/app.js はルートのディレクトリを指定した場合に実行される処理です。
この処理が実行されると、views/index.hbs をレスポンスで返します。これにより、フロント側の Angular2 が実行されることになります。

routes/message.js

このファイルでは、フロント側のメッセージ取得要求( get )とメッセージ設定要求( post )の処理を実装しています。
それぞれ MongoDB からデータを取得、設定しています。

6行目や16行目で実装されている Message オブジェクトが mongoose の機能を実装したオブジェクトになります。
このクラスは models ディレクトリで定義されています。

models/message.js

このファイルでは、mongoose の機能を使用して、スキーマ定義を作成しています。このスキーマを使って、MongoDB に対して処理を要求します。

フロントエンド側を構成するファイル

assets/app/main.ts

Angular2 を起動するための処理が実装されているファイルです。このファイルは webpack の Entry に記載されており、一番初めに起動します。

assets/app/app.module.ts

ディレクティブやサービスなどをひとまとめにできる NgModule を実装したファイルです。

以下に各プロパティの説明を記載します。
・import : 各モジュールで定義されているディレクティブなどを登録するプロパティです。
・bootstrap : エントリポイントになるコンポーネントを指定します。
・provider : 使用するサービスを登録するプロパティです。

assets/app/app.component.html

my-app コンポーネントで使用される HTML が記述されたファイルです。
ここでは、メッセージを登録する UI と取得する UI を実装しています。

assets/app/app.component.ts

このファイルは my-app コンポーネントの設定が記載されされているファイルです。
コンポーネントの名称を設定する selector や使用する HTML ファイルが指定されています。

また AppComponent クラスも定義され、コンポーネントの振る舞いが実装されています。

assets/app/app.component.service.ts

このファイルは my-app コンポーネントで使用するサービスを実装しています。
このサービスでは、メッセージを取得する getMessage メソッドが実装されています。

MongoDB の準備

このアプリケーションが動作するように MongoDB を準備します。
といっても用意するのはデータベースだけです。

まずクライアントを立ち上げます。

./mongo

それからデータベースを作成します。今回は techscore という名称のデータベースを作成します。

use techscore

動かしてみる

以上でソースコードの説明は完了です。では実際に動作させてみましょう!

ブラウザでサーバが起動している IP アドレスとポート 3000 番を指定してアクセスしてみます。

起動すると、以下の画面が出てきます。

それでは「Set Message」のテキストボックスに任意のテキストを設定して、「Set Message」ボタンを押下してください。
今の実装だと redirect ができないので、以下のような画面が出てきますが、URL から /Message というパスを削除して、リロードしてください。

そうするとまた初期の画面が表示されます。
今度は「Get Message」ボタンを押下してください。
そうすると、先ほど登録したメッセージが表示されます。

まとめ

いかがでしたでしょうか。今回は MEAN スタックを Angular2 が使えるようにカスタマイズしてみました。実際に置き換えてみると各アプリケーションの役割がしっかり分かれているので、ディレクトリ構成をしっかりと検討してやれば、それほど苦労することなく置き換えることができました。
ですので、たとえば MongoDB を他の DB に置き換えることや、Node.js ではなく、Vert.x に置き換えることとかも予想よりも簡単にできるのではないかなと感じました。
みなさまもいろいろ試してみてください!


コメントを残す

メールアドレスが公開されることはありません。 * が付いている欄は必須項目です