Cloud Firestore Android Codelab

コレクションでコンテンツを整理 必要に応じて、コンテンツの保存と分類を行います。

1。概要

目標

この Codelab では、Cloud Firestore を利用して、Android でレストラン レコメンデーション アプリを作成します。次の方法を学習します:

  • Android アプリから Firestore へのデータの読み取りと書き込み
  • Firestore データの変更をリアルタイムで聞く
  • Firebase Authentication とセキュリティ ルールを使用して Firestore データを保護する
  • 複雑な Firestore クエリを作成する

前提条件

この Codelab を開始する前に、次のものが揃っていることを確認してください。

  • Android Studio 4.0以降
  • API 19以上の Android エミュレーター
  • Node.js バージョン10以降
  • Java バージョン8以降

2.Firebase プロジェクトを作成する

  1. Google アカウントでFirebase コンソールにサインインします。
  2. Firebase コンソールで、[プロジェクトを追加] をクリックします。
  3. 以下のスクリーン キャプチャに示すように、Firebase プロジェクトの名前 (「Friendly Eats」など) を入力し、[続行] をクリックします。

9d2f625aebcab6af.png

  1. この Codelab の目的上、Google アナリティクスを有効にするよう求められる場合がありますが、その選択は重要ではありません。
  2. 1 分ほどで、Firebase プロジェクトの準備が整います。 [続行]をクリックします。

3. サンプル プロジェクトのセットアップ

コードをダウンロード

次のコマンドを実行して、この Codelab のサンプル コードのクローンを作成します。これにより、マシンfriendlyeats-androidというフォルダーが作成されます。

$ git clone https://github.com/firebase/friendlyeats-android

マシンに git がない場合は、GitHub からコードを直接ダウンロードすることもできます。

Firebase 構成を追加する

  1. Firebase コンソールで、左側のナビゲーションにある [プロジェクトの概要] を選択します。 Androidボタンをクリックして、プラットフォームを選択します。パッケージ名の入力を求められたら、 com.google.firebase.example.fireeatsを使用します

73d151ed16016421.png

  1. [アプリの登録] をクリックし、指示に従ってgoogle-services.jsonファイルをダウンロードし、ダウンロードしたコードのapp/フォルダーに移動します。次に、[次へ] をクリックします。

プロジェクトをインポートする

Android Studio を開きます。 [ファイル] > [新規] > [プロジェクトのインポート] をクリックして、 friendlyeats-androidフォルダーを選択します。

4. Firebase エミュレーターをセットアップする

この Codelab では、 Firebase Emulator Suiteを使用して、Cloud Firestore やその他の Firebase サービスをローカルでエミュレートします。これにより、アプリを構築するための安全で高速な無料のローカル開発環境が提供されます。

Firebase CLI をインストールする

まず、 Firebase CLIをインストールする必要があります。 macOS または Linux を使用している場合は、次の cURL コマンドを実行できます。

curl -sL https://firebase.tools | bash

Windows を使用している場合は、インストール手順を読んで、スタンドアロン バイナリを取得するか、 npm経由でインストールしてください。

CLI をインストールしたら、 firebase --versionを実行すると、バージョン9.0.0以降が報告されます。

$ firebase --version
9.0.0

ログインする

firebase loginを実行して、CLI を Google アカウントに接続します。これにより、新しいブラウザ ウィンドウが開き、ログイン プロセスが完了します。以前に Firebase プロジェクトを作成したときに使用したものと同じアカウントを選択してください。

Friendlyeats friendlyeats-androidフォルダー内から firebase を実行しfirebase use --addを使用してローカル プロジェクトを Firebase プロジェクトに接続します。プロンプトに従って、前に作成したプロジェクトを選択し、エイリアスを選択するように求められたら、 defaultと入力します。

5. アプリを実行する

Firebase Emulator Suite と FriendlyEats Android アプリを初めて実行します。

エミュレーターを実行する

ターミナルで、 Friendlyeats friendlyeats-androidディレクトリ内からfirebase emulators:startを実行して、Firebase Emulators を起動します。次のようなログが表示されます。

$ firebase emulators:start
i  emulators: Starting emulators: auth, firestore
i  firestore: Firestore Emulator logging to firestore-debug.log
i  ui: Emulator UI logging to ui-debug.log

┌─────────────────────────────────────────────────────────────┐
│ ✔  All emulators ready! It is now safe to connect your app. │
│ i  View Emulator UI at http://localhost:4000                │
└─────────────────────────────────────────────────────────────┘

┌────────────────┬────────────────┬─────────────────────────────────┐
│ Emulator       │ Host:Port      │ View in Emulator UI             │
├────────────────┼────────────────┼─────────────────────────────────┤
│ Authentication │ localhost:9099 │ http://localhost:4000/auth      │
├────────────────┼────────────────┼─────────────────────────────────┤
│ Firestore      │ localhost:8080 │ http://localhost:4000/firestore │
└────────────────┴────────────────┴─────────────────────────────────┘
  Emulator Hub running at localhost:4400
  Other reserved ports: 4500

Issues? Report them at https://github.com/firebase/firebase-tools/issues and attach the *-debug.log files.

これで、完全なローカル開発環境がマシン上で実行されました! Codelab の残りの部分では、このコマンドを実行したままにしておいてください。Android アプリをエミュレータに接続する必要があります。

アプリをエミュレータに接続する

Android Studio でファイルutil/FirestoreInitializer.ktutil/AuthInitializer.ktを開きます。これらのファイルには、アプリケーションの起動時に、マシンで実行されているローカル エミュレーターに Firebase SDK を接続するためのロジックが含まれています。

FirestoreInitializerクラスのcreate()メソッドで、次のコードを調べます。

    // Use emulators only in debug builds
    if (BuildConfig.DEBUG) {
        firestore.useEmulator(FIRESTORE_EMULATOR_HOST, FIRESTORE_EMULATOR_PORT)
    }

BuildConfigを使用して、アプリがdebugモードで実行されているときにのみエミュレーターに接続するようにします。アプリをreleaseモードでコンパイルすると、この条件は false になります。

useEmulator(host, port)メソッドを使用して Firebase SDK をローカルの Firestore エミュレータに接続していることがわかります。アプリ全体でFirebaseUtil.getFirestore()を使用してFirebaseFirestoreのこのインスタンスにアクセスするため、 debugモードで実行しているときに常に Firestore エミュレーターに接続していることを確認できます。

アプリを実行する

google-services.jsonファイルを適切に追加した場合、プロジェクトはコンパイルされるはずです。 Android Studio で [ Build ] > [ Rebuild Project ] をクリックし、エラーが残っていないことを確認します。

Android Studio で Android エミュレーターでアプリを実行します。最初に「サインイン」画面が表示されます。アプリへのサインインには、任意の電子メールとパスワードを使用できます。このサインイン プロセスは Firebase Authentication エミュレータに接続しているため、実際の認証情報は送信されていません。

Web ブラウザーでhttp://localhost:4000に移動して、エミュレーター UI を開きます。次に、[認証] タブをクリックすると、作成したばかりのアカウントが表示されます。

Firebase 認証エミュレータ

サインイン プロセスが完了すると、アプリのホーム画面が表示されます。

de06424023ffb4b9.png

すぐに、ホーム画面に入力するデータを追加します。

6. Firestore にデータを書き込む

このセクションでは、現在空のホーム画面に入力できるように、いくつかのデータを Firestore に書き込みます。

アプリのメイン モデル オブジェクトはレストランです ( model/Restaurant.ktを参照)。 Firestore データは、ドキュメント、コレクション、およびサブコレクションに分割されます。 "restaurants"と呼ばれる最上位のコレクションに、各レストランをドキュメントとして保存します。 Firestore データ モデルの詳細については、ドキュメントのドキュメントとコレクションをご覧ください。

デモンストレーションの目的で、オーバーフロー メニューの [Add Random Items] ボタンをクリックすると、10 のランダムなレストランを作成する機能をアプリに追加します。 MainFragment.ktファイルを開き、 onAddItemsClicked()メソッドの内容を次のように置き換えます。

    private fun onAddItemsClicked() {
        val restaurantsRef = firestore.collection("restaurants")
        for (i in 0..9) {
            // Create random restaurant / ratings
            val randomRestaurant = RestaurantUtil.getRandom(requireContext())

            // Add restaurant
            restaurantsRef.add(randomRestaurant)
        }
    }

上記のコードについて注意すべき重要な点がいくつかあります。

  • "restaurants"コレクションへの参照を取得することから始めました。コレクションはドキュメントが追加されると暗黙的に作成されるため、データを書き込む前にコレクションを作成する必要はありませんでした。
  • ドキュメントは、各レストラン ドキュメントの作成に使用する Kotlin データ クラスを使用して作成できます。
  • add()メソッドは、自動生成された ID を持つコレクションにドキュメントを追加するため、レストランごとに一意の ID を指定する必要はありませんでした。

アプリを再度実行し、オーバーフロー メニュー (右上隅) の [ランダム アイテムを追加] ボタンをクリックして、作成したばかりのコードを呼び出します。

95691e9b71ba55e3.png

Web ブラウザーでhttp://localhost:4000に移動して、エミュレーター UI を開きます。次にFirestoreタブをクリックすると、追加したばかりのデータが表示されます。

Firebase 認証エミュレータ

このデータは、マシンに対して 100% ローカルです。実際、実際のプロジェクトにはまだ Firestore データベースが含まれていません!これは、結果を伴わずにこのデータの変更と削除を試しても安全であることを意味します。

おめでとうございます。Firestore にデータが書き込まれました。次のステップでは、このデータをアプリに表示する方法を学習します。

7. Firestore からのデータを表示する

このステップでは、Firestore からデータを取得してアプリに表示する方法を学習します。 Firestore からデータを読み取るための最初のステップは、 Queryを作成することです。 MainFragment.ktファイルを開き、次のコードをonViewCreated()メソッドの先頭に追加します。

        // Firestore
        firestore = Firebase.firestore

        // Get the 50 highest rated restaurants
        query = firestore.collection("restaurants")
            .orderBy("avgRating", Query.Direction.DESCENDING)
            .limit(LIMIT.toLong())

ここで、クエリをリッスンして、一致するすべてのドキュメントを取得し、将来の更新についてリアルタイムで通知されるようにします。最終的な目標は、このデータをRecyclerViewにバインドすることであるため、データをリッスンするRecyclerView.Adapterクラスを作成する必要があります。

すでに部分的に実装されているFirestoreAdapterクラスを開きます。まず、アダプタにEventListenerを実装させ、 onEvent関数を定義して、Firestore クエリの更新を受信できるようにします。

abstract class FirestoreAdapter<VH : RecyclerView.ViewHolder>(private var query: Query?) :
        RecyclerView.Adapter<VH>(),
        EventListener<QuerySnapshot> { // Add this implements
    
    // ...

    // Add this method
    override fun onEvent(documentSnapshots: QuerySnapshot?, e: FirebaseFirestoreException?) {
        
        // Handle errors
        if (e != null) {
            Log.w(TAG, "onEvent:error", e)
            return
        }

        // Dispatch the event
        if (documentSnapshots != null) {
            for (change in documentSnapshots.documentChanges) {
                // snapshot of the changed document
                when (change.type) {
                    DocumentChange.Type.ADDED -> {
                        // TODO: handle document added
                    }
                    DocumentChange.Type.MODIFIED -> {
                        // TODO: handle document changed
                    }
                    DocumentChange.Type.REMOVED -> {
                        // TODO: handle document removed
                    }
                }
            }
        }

        onDataChanged()
    }
    
    // ...
}

初期ロード時に、リスナーは新しいドキュメントごとに 1 つのADDEDイベントを受け取ります。クエリの結果セットが時間の経過とともに変化するにつれて、リスナーは変更を含むより多くのイベントを受け取ります。それでは、リスナーの実装を終了しましょう。まず、 onDocumentAddedonDocumentModified 、およびonDocumentRemovedの 3 つの新しいメソッドを追加します。

    private fun onDocumentAdded(change: DocumentChange) {
        snapshots.add(change.newIndex, change.document)
        notifyItemInserted(change.newIndex)
    }

    private fun onDocumentModified(change: DocumentChange) {
        if (change.oldIndex == change.newIndex) {
            // Item changed but remained in same position
            snapshots[change.oldIndex] = change.document
            notifyItemChanged(change.oldIndex)
        } else {
            // Item changed and changed position
            snapshots.removeAt(change.oldIndex)
            snapshots.add(change.newIndex, change.document)
            notifyItemMoved(change.oldIndex, change.newIndex)
        }
    }

    private fun onDocumentRemoved(change: DocumentChange) {
        snapshots.removeAt(change.oldIndex)
        notifyItemRemoved(change.oldIndex)
    }

次に、 onEventからこれらの新しいメソッドを呼び出します。

    override fun onEvent(documentSnapshots: QuerySnapshot?, e: FirebaseFirestoreException?) {

        // Handle errors
        if (e != null) {
            Log.w(TAG, "onEvent:error", e)
            return
        }

        // Dispatch the event
        if (documentSnapshots != null) {
            for (change in documentSnapshots.documentChanges) {
                // snapshot of the changed document
                when (change.type) {
                    DocumentChange.Type.ADDED -> {
                        onDocumentAdded(change) // Add this line
                    }
                    DocumentChange.Type.MODIFIED -> {
                        onDocumentModified(change) // Add this line
                    }
                    DocumentChange.Type.REMOVED -> {
                        onDocumentRemoved(change) // Add this line
                    }
                }
            }
        }

        onDataChanged()
    }

最後にstartListening()メソッドを実装してリスナーをアタッチします。

    fun startListening() {
        if (registration == null) {
            registration = query.addSnapshotListener(this)
        }
    }

これで、Firestore からデータを読み取るようにアプリが完全に構成されました。アプリを再度実行すると、前の手順で追加したレストランが表示されます。

9e45f40faefce5d0.png

ブラウザのエミュレータ UI に戻り、レストラン名の 1 つを編集します。アプリでほぼ瞬時に変更されるはずです。

8.データの並べ替えとフィルタリング

このアプリは現在、コレクション全体で最高評価のレストランを表示していますが、実際のレストラン アプリでは、ユーザーはデータの並べ替えとフィルター処理を行う必要があります。たとえば、アプリは「フィラデルフィアのトップ シーフード レストラン」または「最も安価なピザ」を表示できる必要があります。

アプリの上部にある白いバーをクリックすると、フィルター ダイアログが表示されます。このセクションでは、Firestore クエリを使用してこのダイアログを機能させます。

67898572a35672a5.png

MainFragment.kt のMainFragment.kt onFilter()メソッドを編集してみましょう。このメソッドは、フィルター ダイアログの出力をキャプチャするために作成したヘルパー オブジェクトであるFiltersオブジェクトを受け入れます。このメソッドを変更して、フィルターからクエリを作成します。

    override fun onFilter(filters: Filters) {
        // Construct query basic query
        var query: Query = firestore.collection("restaurants")

        // Category (equality filter)
        if (filters.hasCategory()) {
            query = query.whereEqualTo(Restaurant.FIELD_CATEGORY, filters.category)
        }

        // City (equality filter)
        if (filters.hasCity()) {
            query = query.whereEqualTo(Restaurant.FIELD_CITY, filters.city)
        }

        // Price (equality filter)
        if (filters.hasPrice()) {
            query = query.whereEqualTo(Restaurant.FIELD_PRICE, filters.price)
        }

        // Sort by (orderBy with direction)
        if (filters.hasSortBy()) {
            query = query.orderBy(filters.sortBy.toString(), filters.sortDirection)
        }

        // Limit items
        query = query.limit(LIMIT.toLong())

        // Update the query
        adapter.setQuery(query)

        // Set header
        binding.textCurrentSearch.text = HtmlCompat.fromHtml(
            filters.getSearchDescription(requireContext()),
            HtmlCompat.FROM_HTML_MODE_LEGACY
        )
        binding.textCurrentSortBy.text = filters.getOrderDescription(requireContext())

        // Save filters
        viewModel.filters = filters
    }

上記のスニペットでは、指定されたフィルターに一致するようにwhere句とorderBy句を追加してQueryオブジェクトを作成しています。

アプリを再度実行し、次のフィルターを選択して、最も人気のある低価格レストランを表示します。

7a67a8a400c80c50.png

低価格のオプションのみを含むレストランのフィルター処理されたリストが表示されます。

a670188398c3c59.png

ここまでできれば、Firestore で完全に機能するレストラン レコメンデーション表示アプリを作成したことになります。レストランをリアルタイムで並べ替え、フィルタリングできるようになりました。次のいくつかのセクションでは、レストランにレビューを追加し、アプリにセキュリティ ルールを追加します。

9. サブコレクションでデータを整理する

このセクションでは、アプリに評価を追加して、ユーザーがお気に入りの (またはあまりお気に入りでない) レストランをレビューできるようにします。

コレクションとサブコレクション

これまでのところ、すべてのレストラン データを「restaurants」と呼ばれる最上位のコレクションに保存しました。ユーザーがレストランを評価するとき、新しいRatingオブジェクトをレストランに追加したいと考えています。このタスクでは、サブコレクションを使用します。サブコレクションは、ドキュメントに添付されたコレクションと考えることができます。したがって、各レストラン ドキュメントには、評価ドキュメントでいっぱいの評価サブコレクションがあります。サブコレクションは、ドキュメントを肥大化させたり、複雑なクエリを必要としたりすることなく、データを整理するのに役立ちます。

サブコレクションにアクセスするには、親ドキュメントで.collection()を呼び出します。

val subRef = firestore.collection("restaurants")
        .document("abc123")
        .collection("ratings")

トップレベルのコレクションと同じように、サブコレクションにアクセスしてクエリを実行できます。サイズの制限やパフォーマンスの変更はありません。 Firestore データ モデルの詳細については、こちらをご覧ください。

トランザクションでのデータの書き込み

適切なサブコレクションにRatingを追加するには、 .add()を呼び出すだけで済みますが、 Restaurantオブジェクトの平均評価と評価数を更新して、新しいデータを反映する必要もあります。これら 2 つの変更を別々の操作で行うと、多くの競合状態が発生し、データが古くなったり正しくなくなったりする可能性があります。

評価が適切に追加されるように、トランザクションを使用してレストランに評価を追加します。このトランザクションはいくつかのアクションを実行します:

  • レストランの現在の評価を読み取り、新しい評価を計算します
  • サブコレクションに評価を追加する
  • レストランの平均評価と評価数を更新する

RestaurantDetailFragment.ktを開き、 addRating関数を実装します。

    private fun addRating(restaurantRef: DocumentReference, rating: Rating): Task<Void> {
        // Create reference for new rating, for use inside the transaction
        val ratingRef = restaurantRef.collection("ratings").document()

        // In a transaction, add the new rating and update the aggregate totals
        return firestore.runTransaction { transaction ->
            val restaurant = transaction.get(restaurantRef).toObject<Restaurant>()
                ?: throw Exception("Restaurant not found at ${restaurantRef.path}")

            // Compute new number of ratings
            val newNumRatings = restaurant.numRatings + 1

            // Compute new average rating
            val oldRatingTotal = restaurant.avgRating * restaurant.numRatings
            val newAvgRating = (oldRatingTotal + rating.rating) / newNumRatings

            // Set new restaurant info
            restaurant.numRatings = newNumRatings
            restaurant.avgRating = newAvgRating

            // Commit to Firestore
            transaction.set(restaurantRef, restaurant)
            transaction.set(ratingRef, rating)

            null
        }
    }

addRating()関数は、トランザクション全体を表すTaskを返します。 onRating()関数では、リスナーがタスクに追加され、トランザクションの結果に応答します。

アプリを再度実行し、レストランの 1 つをクリックすると、レストランの詳細画面が表示されます。 +ボタンをクリックして、レビューの追加を開始します。星の数を選択し、テキストを入力して、レビューを追加します。

78fa16cdf8ef435a.png

[送信] をクリックすると、トランザクションが開始されます。取引が完了すると、下にレビューが表示され、レストランのレビュー数が更新されます。

f9e670f40bd615b0.png

おめでとう!これで、Cloud Firestore 上に構築された、ソーシャルでローカルなモバイル レストラン レビュー アプリができました。最近はとても人気があると聞きます。

10. データを保護する

これまでのところ、このアプリケーションのセキュリティについては考慮していません。ユーザーが正しい自分のデータのみを読み書きできることをどのように知ることができますか? Firestore データベースは、 Security Rulesと呼ばれる構成ファイルによって保護されます。

firestore.rulesファイルを開くと、次のように表示されます。

rules_version = '2';
service cloud.firestore {
  match /databases/{database}/documents {
    match /{document=**} {
      //
      // WARNING: These rules are insecure! We will replace them with
      // more secure rules later in the codelab
      //
      allow read, write: if request.auth != null;
    }
  }
}

不要なデータ アクセスや変更を防ぐためにこれらのルールを変更し、 firestore.rulesファイルを開き、内容を次のように置き換えます。

rules_version = '2';
service cloud.firestore {
  match /databases/{database}/documents {
    // Determine if the value of the field "key" is the same
    // before and after the request.
    function isUnchanged(key) {
      return (key in resource.data)
        && (key in request.resource.data)
        && (resource.data[key] == request.resource.data[key]);
    }

    // Restaurants
    match /restaurants/{restaurantId} {
      // Any signed-in user can read
      allow read: if request.auth != null;

      // Any signed-in user can create
      // WARNING: this rule is for demo purposes only!
      allow create: if request.auth != null;

      // Updates are allowed if no fields are added and name is unchanged
      allow update: if request.auth != null
                    && (request.resource.data.keys() == resource.data.keys())
                    && isUnchanged("name");

      // Deletes are not allowed.
      // Note: this is the default, there is no need to explicitly state this.
      allow delete: if false;

      // Ratings
      match /ratings/{ratingId} {
        // Any signed-in user can read
        allow read: if request.auth != null;

        // Any signed-in user can create if their uid matches the document
        allow create: if request.auth != null
                      && request.resource.data.userId == request.auth.uid;

        // Deletes and updates are not allowed (default)
        allow update, delete: if false;
      }
    }
  }
}

これらのルールはアクセスを制限して、クライアントが安全な変更のみを行うようにします。たとえば、レストランのドキュメントを更新すると、評価のみが変更され、名前やその他の不変データは変更されません。評価は、ユーザー ID がサインインしているユーザーと一致する場合にのみ作成できるため、なりすましが防止されます。

セキュリティ ルールの詳細については、ドキュメントを参照してください。

11. 結論

これで、Firestore 上にフル機能のアプリを作成できました。次のような最も重要な Firestore 機能について学習しました。

  • ドキュメントとコレクション
  • データの読み取りと書き込み
  • クエリによる並べ替えとフィルタリング
  • サブコレクション
  • 取引

もっと詳しく知る

Firestore について学び続けるには、ここから始めるのに適した場所がいくつかあります。

この Codelab のレストラン アプリは、「Friendly Eats」のサンプル アプリケーションに基づいています。そのアプリのソース コードは、こちらで参照できます。

オプション: 本番環境へのデプロイ

これまでのところ、このアプリは Firebase Emulator Suite のみを使用しています。このアプリを実際の Firebase プロジェクトにデプロイする方法を知りたい場合は、次のステップに進んでください。

12. (オプション) アプリをデプロイする

これまでのところ、このアプリは完全にローカルであり、すべてのデータは Firebase Emulator Suite に含まれています。このセクションでは、このアプリが本番環境で動作するように Firebase プロジェクトを構成する方法を学習します。

Firebase 認証

Firebase コンソールで [ Authentication ] セクションに移動し、[ Get started ] をクリックします。 [サインイン方法] タブに移動し、[ネイティブ プロバイダー] から [メール/パスワード] オプションを選択します。

電子メール/パスワードによるサインイン方法を有効にして、[保存] をクリックします。

sign-in-providers.png

ファイアストア

データベースの作成

コンソールのFirestore データベースセクションに移動し、[データベースの作成] をクリックします。

  1. Security Rules choose to start in Production Modeについてプロンプトが表示されたら、すぐにそれらのルールを更新します。
  2. アプリに使用するデータベースの場所を選択します。データベースの場所の選択は永続的な決定であり、変更するには新しいプロジェクトを作成する必要があることに注意してください。プロジェクトの場所の選択について詳しくは、ドキュメントを参照してください。

ルールの導入

前に作成したセキュリティ ルールをデプロイするには、codelab ディレクトリで次のコマンドを実行します。

$ firebase deploy --only firestore:rules

これにより、 firestore.rulesの内容がプロジェクトにデプロイされます。これは、コンソールの [ルール] タブに移動して確認できます。

インデックスを展開する

FriendlyEats アプリには、多数のカスタム複合インデックスを必要とする複雑な並べ替えとフィルター処理があります。これらは Firebase コンソールで手動で作成できますが、それらの定義をfirestore.indexes.jsonファイルに記述し、Firebase CLI を使用してデプロイする方が簡単です。

firestore.indexes.jsonファイルを開くと、必要なインデックスが既に提供されていることがわかります。

{
  "indexes": [
    {
      "collectionId": "restaurants",
      "queryScope": "COLLECTION",
      "fields": [
        { "fieldPath": "city", "mode": "ASCENDING" },
        { "fieldPath": "avgRating", "mode": "DESCENDING" }
      ]
    },
    {
      "collectionId": "restaurants",
      "queryScope": "COLLECTION",
      "fields": [
        { "fieldPath": "category", "mode": "ASCENDING" },
        { "fieldPath": "avgRating", "mode": "DESCENDING" }
      ]
    },
    {
      "collectionId": "restaurants",
      "queryScope": "COLLECTION",
      "fields": [
        { "fieldPath": "price", "mode": "ASCENDING" },
        { "fieldPath": "avgRating", "mode": "DESCENDING" }
      ]
    },
    {
      "collectionId": "restaurants",
      "queryScope": "COLLECTION",
      "fields": [
        { "fieldPath": "city", "mode": "ASCENDING" },
        { "fieldPath": "numRatings", "mode": "DESCENDING" }
      ]
    },
    {
      "collectionId": "restaurants",
      "queryScope": "COLLECTION",
      "fields": [
        { "fieldPath": "category", "mode": "ASCENDING" },
        { "fieldPath": "numRatings", "mode": "DESCENDING" }
      ]
    },
    {
      "collectionId": "restaurants",
      "queryScope": "COLLECTION",
      "fields": [
        { "fieldPath": "price", "mode": "ASCENDING" },
        { "fieldPath": "numRatings", "mode": "DESCENDING" }
      ]
    },
    {
      "collectionId": "restaurants",
      "queryScope": "COLLECTION",
      "fields": [
        { "fieldPath": "city", "mode": "ASCENDING" },
        { "fieldPath": "price", "mode": "ASCENDING" }
      ]
    },
    {
      "collectionId": "restaurants",
      "fields": [
        { "fieldPath": "category", "mode": "ASCENDING" },
        { "fieldPath": "price", "mode": "ASCENDING" }
      ]
    }
  ],
  "fieldOverrides": []
}

これらのインデックスをデプロイするには、次のコマンドを実行します。

$ firebase deploy --only firestore:indexes

インデックスの作成は瞬時に行われるわけではないことに注意してください。進行状況は Firebase コンソールで監視できます。

アプリを構成する

util/FirestoreInitializer.ktファイルとutil/AuthInitializer.ktファイルで、デバッグ モードのときにエミュレータに接続するように Firebase SDK を構成しました。

    override fun create(context: Context): FirebaseFirestore {
        val firestore = Firebase.firestore
        // Use emulators only in debug builds
        if (BuildConfig.DEBUG) {
            firestore.useEmulator(FIRESTORE_EMULATOR_HOST, FIRESTORE_EMULATOR_PORT)
        }
        return firestore
    }

実際の Firebase プロジェクトでアプリをテストする場合は、次のいずれかを実行できます。

  1. アプリをリリース モードでビルドし、デバイスで実行します。
  2. BuildConfig.DEBUGを一時的にfalseに置き換えて、アプリを再度実行します。

本番環境に正しく接続するには、アプリからサインアウトして再度サインインする必要がある場合があることに注意してください。