林 優一

FirebaseとAngular2を使ってリアルタイムでデータのやり取り【導入編】

    Firebaseはリアルタイム同期なデータベースを中心に、Auth認証やPushNotificationやユーザーの行動分析といったアプリケーションに最適な機能を提供するBasSです。先月行われたGoogle IOにて、PushNotificationや行動分析機能が追加されるなど話題となりました。

    今回はFirebaseのリアルタイムベースとAngular2を用いて、リアルタイムにデータをやり取りする方法について解説します。

    Firebaseのリアルタイムデータベース

    Firebaseのリアルタイムデータベースはクラウドホスト型のNoSQLデータベースです。JSONの形式でデータは保存されます。 APIはもちろん、iOS/Android/Web用のSDKが提供されているので、非常に簡単に導入することができます。

    また、ネットワークが途中で切れた場合は自動的に再接続を行い、復帰後に改めてデータが同期されます。同時100コネクション、1GBのデータ、10GBの転送量までは無料で使うことができるので、まず試してみるといったことができます。

    今回はこの無料プランとAngular2を使って進めていきます。

    Angular CLIで環境構築

    Angular2の環境構築が初めての方でも簡単に導入できるように、Angular2ではCLIが公開されています。これを利用して環境を構築していきます。(※別途、Node.jsのインストールが必要です)

    angular-cli

    まずはnpmを使って、angular-cliをインストールします。

    インストールが成功していれば、ng versionでバージョンが表示されます。

    続いて、ng newコマンドを用いてプロジェクトを作成します。newの後には任意のプロジェクト名を入力してください。(angularやfirebaseという名称を用いるとパッケージ名が重複してしまうため、関連ライブラリのインストールに失敗するのでご注意ください)

    今回はng new sampleでプロジェクトを作成します。

    sampleというフォルダができるのでcd sampleで移動し、この状態で ng serve コマンドを実行するとサンプルのアプリケーションがビルドされ、http://localhost:4200にブラウザでアクセスするとsample works!と表示されます。

    これで開発環境の準備が整いました。

    AngularFire導入

    本題のAngularFireを導入していきます。

    angularfire2

    ※ 6月14日現在の最新版は、firebase 2.4.2に対応しています。

    続いて、firebase用の型定義ファイルをインストールします。 typingsがインストールされていない場合は npm i -g typingsを実行してインストールをしてください。

    ※ 注意

    typings 1系と0系では、コマンドやインストールされるファイルの構成が異なります。現在のバージョンのangular-cliでは0系でインストールされますが、npmでインストールされる最新版は1系になります。本稿では1系がインストールされている状態で解説を行います。0系の場合は以下のtypingsに追記する作業は必要ありません。

    src/typings.d.tsにインストールされたfirebaseの型定義ファイル群を追記します。

    angular-cli-build.jsを開き、vendorNpmFiles'angularfire2/**/*.js' 'firebase/lib/*.js' を追記します。

    続いて、/src/system-config.tsに以下のようにfirebase,angularfire2の記述を追記します。

    これでAngular2でFirebaseを使う準備が整いました。

    Firebaseの登録

    続いて、Firebaseの登録と設定を行っていきましょう。

    firebase

    Screen Shot 0028-06-14 at 22.46.07

    FirebaseはGoogleアカウントで登録することができます。登録が完了すると、プロジェクトを作るためのボタンが表示されます。

    Screen Shot 0028-06-14 at 22.47.30

    「新規プロジェクトを作成」ボタンをクリックして、アプリケーションを作成しましょう。

    Screen Shot 0028-06-14 at 22.48.17

    アプリケーションが作成できたら「Database」ページを開きます。 以下のように、まだデータベースには何も入っていません。まずはこの画面から初期データを登録してみましょう。

    Screen Shot 0028-06-14 at 22.55.35

    このようにデータを作成しました。

    Firebase上では、すべてオブジェクトの形式でデータが構成されるようにしておきます。

    続いて、「ルール」のタブをクリックしてルールを設定します。 ルールはデータベースへの値に対してのアクセス権の設定を行うことができます。JSONの形式でデータを定義していきます。

    Screen Shot 0028-06-14 at 22.58.07

    詳しいルールの記載は、以下のページに説明があります。 https://html5exp-sample.firebaseio.com/

    ここではサンプルということで、読み書きともに誰からでもできるように設定しておきましょう。

    これによってデータベースのitems以下は、読み書きともに誰でも許可されるようになりました。では、これで登録したデータが読み取れるか試してみましょう。/src/main.tsを開きます。

    main.ts にangularfire2のファイルをimportし、bootstrap関数の第2引数にFIREBASE_PROVIDERSdefaultFirebase('https://.firebaseio.com') を配列で渡しておきます。

    こうすることによって、今後Angular2のコンポーネント内でFirebaseに必要な設定とプロバイダが提供されるようになります。

    続いて、画面にデータを表示するためのコンポーネントに変更を加えます。

    *ngFor="let item of items | async" のasyncはAsyncPipeと呼ばれるAngular2にはじめから組み込まれているPipeのひとつです。これはitemsのObservableをsubscribeしたときの引数を自動的に取得して表示してくれるPipeです。詳しい使い方や解説は以下のページにありますので、こちらをご一読ください。

    Async Pipe

    ng serve コマンドを改めて実行すると、Firebaseで登録されたデータが表示されるようになります。

    データの追加

    次にブラウザからデータを追加する処理を実装していきましょう。

    FirebaseListObservableにデータをpushするだけで配列データにデータを追加することができます。

    データの更新

    今度はリストのデータを更新してみましょう。

    this.items.update(key,{value:value});のように更新したいデータの$keyと値を渡すことで更新ができます。 Firebaseのオブジェクトには$keyというプロパティがあり、各データのKey名を取得することができます。 pushで追加されたデータは、一意なKeyが自動で振られるようになっています。

    データの削除

    続いて、リストのデータを削除してみましょう。

    更新と同様にthis.items.remove(key);と削除したいデータのKeyを渡すことで、そのデータのみを削除することができます。

    this.items.remove();とKeyを渡さずにremoveするとリスト全体が削除されるので注意してください。

    このように非常に簡単にデータの読み書きが実装できてしまいます。

    オブジェクトデータの取り扱い

    続いて、今度はリストデータでなく単一のオブジェクトのデータを扱ってみましょう。Firebaseの管理画面でDatabaseのデータに以下のようなconstantsを追加しました。

    ルール設定ページにいき、constantsは読み込み専用に設定しておきます。

    src/app/sample.component.tsを、以下のように修正します。

    そして、ビューのタイトル部分をconstantsから取得して表示させるようにします。

    こうすることで、オブジェクトのデータを読み込んで画面に表示させることができました。

    オブジェクトの更新

    オブジェクトの更新をする際は、リストと同様にupdate関数を用いて変更を行うことができます。その時にはルールで書き込みが許可されている必要があります。

    オブジェクトの削除

    オブジェクトの削除を行う際にはremove関数を用いますが、以下のようにremoveするとconstantsごと削除されます。

    1つのプロパティのみを削除したい場合は、以下のように削除したいプロパティまで取得した上でremove関数を実行します。

    まとめ

    このようにAngular2とFirebaseを使うことで、簡単にリアルタイムにデータのやり取りを行うことができるようになります。

    今回はサンプルということで誰でも読み書きできる形にしていますが、ユーザー認証をFirebaseで作ったり、既にあるログイン情報を利用して認証させたりできるので、新規でも追加でも導入しやすくなっています。

    次回はその認証機能を用いてログインすると書き込みができるようにしていきたいと思います。

    de:code 2017
    Powered byNTT Communications

    tag list

    アクセシビリティ イベント エンタープライズ デザイン ハイブリッド パフォーマンス ブラウザ プログラミング マークアップ モバイル 海外 高速化 Angular2 AngularJS Canvas Chrome Cordova CSS de:code ECMAScript Edge Firefox Google Google I/O 2014 HTML5 Conference 2013 html5j IoT JavaScript Microsoft Node.js PhoneGap Polymer React Safari SkyWay TypeScript UI UX W3C W3C仕様 Webアプリ Web Components WebGL WebRTC WebSocket