Unity の Firebase Realtime Database を使ってみる

Firebase Realtime Database は NoSQL クラウド データベースを使用してデータの保管と同期を行います。データはすべてのクライアントにわたってリアルタイムで同期され、アプリがオフラインになっても引き続き使用できます。

準備

Firebase Realtime Database を使用するには、Firebase プロジェクトを作成してから、Firebase Unity SDK パッケージを Unity プロジェクトに追加する必要があります。

設定

事前準備

Unity プロジェクトをまだ用意していない場合は、いずれかのクイックスタート サンプルをダウンロードし、特定の Firebase 機能をお試しいただけます。クイックスタートを使用する場合は、次のステップでバンドル識別子が必要になるため、プロジェクト設定からバンドル識別子を忘れずに取得してください。

Firebase コンソールでアプリを設定する

アプリに Firebase を追加するには、Firebase プロジェクトと、アプリ用の Firebase 構成ファイルが必要です。

Firebase プロジェクトを作成するには:

1. Firebase コンソールに移動します。

2. [プロジェクトを追加] をクリックし、[プロジェクト名] でプロジェクト名を選択するか、新しいプロジェクト名を入力します。

   • アプリに関連付けられた既存の Google プロジェクトがある場合は、[プロジェクト名] プルダウン メニューからプロジェクトを選択します。
   • 既存の Google プロジェクトがない場合は、[プロジェクト名] に新しいプロジェクト名を入力します。

3. （省略可）プロジェクト ID を編集します。

   Firebase プロジェクトには一意の ID が自動的に割り当てられます。一般公開される Firebase サービスでは、この ID は次のように表示されます。

   • デフォルト データベース URL - your-project-id.firebaseio.com
   • デフォルト ホスティング サブドメイン - your-project-id.firebaseapp.com

4. 残りの設定手順に沿って操作した後、[プロジェクトを作成]（既存の Google プロジェクトを使用する場合は [Firebase を追加]）をクリックします。

Firebase プロジェクトのリソースが自動的にプロビジョニングされます。通常、この処理には数分かかります。処理が完了すると、Firebase コンソールに Firebase プロジェクトの概要ページが表示されます。

アプリに Firebase Unity SDK を追加する

1. Firebase Unity SDK をダウンロードします。
2. [Assets] > [Import Package] > [Custom Package] メニュー項目を選択します。
3. 使用している Unity のバージョンと一致するディレクトリから FirebaseDatabase.unitypackage をインポートします。
   • Unity 5.x 以前では、.NET 3.x フレームワークを使用しているため、dotnet3/FirebaseDatabase.unitypackage パッケージをインポートする必要があります。
   • Unity 2017.x 以降では、.NET 4.x フレームワークを使用できます。プロジェクトが .NET 4.x を使用するように構成されている場合は、dotnet4/FirebaseDatabase.unitypackage パッケージをインポートします。
4. [Import Unity Package] ウィンドウが表示されたら [Import] をクリックします。

SDK の初期化

Android の Firebase Unity SDK には Google Play 開発者サービスが必要であり、SDK を使用する前に最新版にしておく必要があります。次のコードをアプリケーションの先頭に追加して、SDK で他のメソッドを呼び出す前に Google Play 開発者サービスを確認し、必要であれば、Firebase Unity SDK で必要とされるバージョンに更新します。

Firebase.FirebaseApp.CheckAndFixDependenciesAsync().ContinueWith(task => {
  var dependencyStatus = task.Result;
  if (dependencyStatus == Firebase.DependencyStatus.Available) {
    // Create and hold a reference to your FirebaseApp, i.e.
    //   app = Firebase.FirebaseApp.DefaultInstance;
    // where app is a Firebase.FirebaseApp property of your application class.

    // Set a flag here indicating that Firebase is ready to use by your
    // application.
  } else {
    UnityEngine.Debug.LogError(System.String.Format(
      "Could not resolve all Firebase dependencies: {0}", dependencyStatus));
    // Firebase Unity SDK is not safe to use here.
  }
});

アプリをビルドする

公開アクセスを設定する

Realtime Database には宣言型のルール言語が用意されているため、データの構造化方法、インデックスの作成方法、データの書き込みと読み取りのタイミングを定義できます。認証ユーザーのみがデータの読み取りと書き込みができるように、データベースへの読み書きアクセスはデフォルトで制限されます。Authentication を設定せずに開始するには、公開アクセスルールを構成します。この場合、アプリを使用しない人を含むあらゆる人々にデータベースが公開されるので、認証の設定時には、データベースへのアクセスを必ず制限してください。

Unity エディタ用に SDK を構成する

Unity エディタでシーンをテストする際は、Realtime Database を使用できます。 その場合は、適切なデータベース URL で SDK を構成する必要があります。それには、データベースの URL を指定して SetEditorDatabaseUrl を呼び出します。

using Firebase;
using Firebase.Unity.Editor;

public class MyScript: MonoBehaviour {
  void Start() {
    // Set this before calling into the realtime database.
    FirebaseApp.DefaultInstance.SetEditorDatabaseUrl("https://YOUR-FIREBASE-APP.firebaseio.com/");
  }
}

公開アクセスルールを使用することにしてデータベース URL を設定した場合は、データの保存と取得に関するセクションに進むことができます。

省略可: 制限付きアクセス用にエディタを設定する

公開アクセスを無効にするルールを使用する場合は、Unity エディタ内でサービス アカウントを使用して実行するように SDK を構成する必要があります。これにより、テストの際にエンドユーザー権限を使用することも可能になります。この設定を行うには、まず、以下の URL にアクセスして新しい p12 ファイルを作成します。

https://console.cloud.google.com/iam-admin/serviceaccounts/project?project=YOUR-FIREBASE-APP

生成されたサービス アカウントのメールアドレスとパスワードを記録しておきます。

Unity プロジェクト内の [Editor Default Resources] に p12 ファイルを配置します。 次に、サービス アカウントの使用を初期化するための以下のコードを追加します。

using Firebase;
using Firebase.Unity.Editor;

public class MyScript: MonoBehaviour {
  void Start() {
    // Set these values before calling into the realtime database.
    FirebaseApp.DefaultInstance.SetEditorDatabaseUrl("https://YOUR-FIREBASE-APP.firebaseio.com/");
    FirebaseApp.DefaultInstance.SetEditorP12FileName("YOUR-FIREBASE-APP-P12.p12");
    FirebaseApp.DefaultInstance.SetEditorServiceAccountEmail("SERVICE-ACCOUNT-ID@YOUR-FIREBASE-APP.iam.gserviceaccount.com");
    FirebaseApp.DefaultInstance.SetEditorP12Password("notasecret");
  }
}

次のステップ

• Realtime Database でのデータの構造化を学習する
• 複数のデータベース インスタンスにデータをスケーリングする
• データを保存する
• データを取得する
• Firebase コンソールでデータベースを表示する

既知の問題

• 試験運用版の .NET 4.6 Framework を使用している場合、Realtime Database は Unity 2017.2 搭載の macOS で動作しません。これは、2017.2.0 で導入された、その構成の SslStream を壊すリグレッションによるものです。このリグレッションは 2017.3.0 で修正され、Realtime Database はそのバージョンで動作します。