1. 概要
目標
この Codelab では、Cloud Firestore をベースとした Android のレストランおすすめアプリを構築します。ここでは以下について学びます。
- Android アプリから Firestore のデータの読み取りと書き込みを行う
- Firestore データの変更をリアルタイムでリッスンする
- Firebase Authentication とセキュリティ ルールを使用して Firestore データを保護する
- 複雑な Firestore クエリを作成する
前提条件
この Codelab を始める前に、以下のものが揃っていることを確認してください。
- Android Studio Flamingo 以降
- API 19 以降を搭載した Android Emulator
- Node.js バージョン 16 以降
- Java バージョン 17 以降
2. Firebase プロジェクトを作成する
- Google アカウントで Firebase コンソールにログインします。
- Firebase コンソールで [プロジェクトを追加] をクリックします。
- 下のスクリーンショットに示すように、Firebase プロジェクトの名前（「Friendly Eats」など）を入力し、[続行] をクリックします。
- この Codelab では、Google アナリティクスを有効にするよう求められる場合があります。この Codelab では、ここでの選択は問題になりません。
- 1 分ほど待つと、Firebase プロジェクトが準備できるようになります。[続行] をクリックします。
3. サンプル プロジェクトをセットアップする
コードをダウンロードする
次のコマンドを実行して、この Codelab のサンプルコードのクローンを作成します。これにより、マシンに friendlyeats-android というフォルダが作成されます。
$ git clone https://github.com/firebase/friendlyeats-android
マシンに git がない場合は、GitHub からコードを直接ダウンロードすることもできます。
Firebase 構成を追加する
- Firebase コンソールの左側のナビゲーションで、[プロジェクトの概要] を選択します。[Android] ボタンをクリックしてプラットフォームを選択します。パッケージ名の入力を求められたら、
com.google.firebase.example.fireeatsを使用します。
- [アプリを登録] をクリックし、手順に沿って
google-services.jsonファイルをダウンロードして、ダウンロードしたコードのapp/フォルダに移動します。[次へ] をクリックします。
プロジェクトをインポートする
Android Studio を開きます。[ファイル] >新規 >Import Project - friendeats-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-android フォルダ内で firebase use --add を実行して、ローカル プロジェクトを Firebase プロジェクトに接続します。プロンプトに従って、先ほど作成したプロジェクトを選択します。エイリアスを選択するように求められたら「default」と入力します。
5. アプリを実行する
これで、Firebase Emulator Suite と FriendlyEats Android アプリを初めて実行する準備が整いました。
エミュレータを実行する
ターミナルで friendlyeats-android ディレクトリ内から firebase emulators:start を実行して、Firebase Emulator を起動します。次のようなログが表示されます。
$ 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.kt ファイルと util/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] >プロジェクトを再構築し、エラーが残っていないことを確認します。
Android Studio で、Android Emulator でアプリを実行します。最初に [ログイン] 画面が表示されます。表示されます。任意のメールアドレスとパスワードを使用してアプリにログインできます。このログイン プロセスは Firebase Authentication エミュレータに接続しているため、実際の認証情報は送信されません。
ウェブブラウザで http://localhost:4000 にアクセスして、エミュレータの UI を開きます。[Authentication] タブをクリックすると、先ほど作成したアカウントが表示されます。
ログイン プロセスが完了すると、アプリのホーム画面が表示されます。
まもなく、ホーム画面にデータを表示する機能を追加する予定です。
6. Firestore にデータを書き込む
このセクションでは、現在空のホーム画面にデータを入力できるように、Firestore にデータを書き込みます。
このアプリのメインのモデル オブジェクトはレストランです（model/Restaurant.kt を参照）。Firestore データは、ドキュメント、コレクション、サブコレクションに分割されます。各レストランは、"restaurants" という名前の最上位のコレクションにドキュメントとして保存します。Firestore データモデルの詳細については、こちらのドキュメントでドキュメントとコレクションをご覧ください。
デモ用に、オーバーフロー メニューの [ランダムにアイテムを追加] ボタンをクリックすると、ランダムに 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 を指定する必要はありません。
アプリをもう一度実行し、右上のオーバーフロー メニューにある [Add Random Items] ボタンをクリックして、先ほど作成したコードを呼び出します。
ウェブブラウザで http://localhost:4000 に移動してエミュレータ UI を開きます。[Firestore] タブをクリックすると、追加したデータが表示されます。
このデータはマシンに対して 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 イベントを受け取ります。クエリの結果セットが時間とともに変化すると、リスナーは変更を含むイベントをさらに受信します。では、リスナーの実装を完了しましょう。まず、onDocumentAdded、onDocumentModified、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 からデータを読み取るようにアプリが完全に構成されました。アプリをもう一度実行すると、前の手順で追加したレストランが表示されます。
ブラウザでエミュレータ UI に戻り、いずれかのレストランの名前を編集します。すぐにアプリの表示が変わるはずです。
8. データの並べ替えとフィルタを行う
このアプリは現在、コレクション全体で高評価のレストランを表示しますが、実際のレストラン アプリではデータの並べ替えやフィルタが必要になります。たとえば、「フィラデルフィアで人気のシーフード レストラン」と表示されるようにする必要があります。“最も低価なピザ”と検索します
アプリの上部にある白いバーをクリックすると、フィルタ ダイアログが表示されます。このセクションでは、Firestore クエリを使用して、このダイアログを機能させます。
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 オブジェクトを構築しています。
アプリを再度実行し、次のフィルタを選択して、人気の低価格レストランを表示します。
これで、低価格オプションのみを含むレストランの一覧がフィルタされて表示されます。
これで、Firestore で完全に機能するレストランのおすすめを表示するアプリが完成しました。レストランをリアルタイムで並べ替え、フィルタできるようになりました。次の数セクションでは、レストランのレビューを追加し、アプリにセキュリティ ルールを追加します。
9. サブコレクションでデータを整理する
このセクションでは、ユーザーがお気に入りの（または最もお気に入りでない）レストランをレビューできるように、アプリに評価を追加します。
コレクションとサブコレクション
これまで、レストランに関するすべてのデータは「restaurants」というトップレベルのコレクションに保存してきました。ユーザーがレストランに評価を付けると、レストランに新しい Rating オブジェクトが追加されます。このタスクでは、サブコレクションを使用します。サブコレクションは、ドキュメントに添付されたコレクションと考えることができます。そのため、各レストランのドキュメントには、評価ドキュメントでいっぱいの ratings サブコレクションがあります。サブコレクションを使用すると、ドキュメントの肥大化や複雑なクエリの必要性を回避しながらデータを整理できます。
サブコレクションにアクセスするには、親ドキュメントで .collection() を呼び出します。
val subRef = firestore.collection("restaurants")
.document("abc123")
.collection("ratings")
サブコレクションは、トップレベル コレクションと同様にアクセスしてクエリを実行でき、サイズの制限やパフォーマンスの変化はありません。Firestore のデータモデルについて詳しくは、こちらをご覧ください。
トランザクションでデータを書き込む
Rating を適切なサブコレクションに追加するには、.add() を呼び出すだけで済みますが、Restaurant オブジェクトの平均評価と評価数を更新して新しいデータを反映する必要もあります。これら 2 つの変更に別々のオペレーションを使用すると、さまざまな競合状態が発生し、データが古くなったり、不正確になったりする可能性があります。
Google では、評価が適切に追加されるようにするため、トランザクションを使用してレストランに評価を追加しています。このトランザクションでは、次の処理が行われます。
- レストランの現在の評価を読み取り、新しい評価を計算する
- 評価をサブコレクションに追加する
- レストランの平均評価と評価数を更新する
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() では、トランザクションの結果に応答するために、関数リスナーがタスクに追加されます。
アプリを再度実行していずれかのレストランをクリックすると、レストランの詳細画面が表示されます。[+] ボタンをクリックして、レビューの追加を開始します。星の数を選択してテキストを入力し、レビューを追加します。
[送信] をクリックすると、トランザクションが開始されます。取引が完了すると、下にクチコミが表示され、レストランのクチコミ数が更新されます。
お疲れさまでした。これで、ソーシャル、ローカル、モバイル レストランのレビュー アプリが Cloud Firestore 上に構築されました。最近ではとても人気があると聞きました。
10. データを保護する
これまで、このアプリケーションのセキュリティについては考慮していません。ユーザーが自分の正しいデータのみを読み取り、書き込みできることをどのように確認すればよいですか？Firestore データベースは、セキュリティ ルールと呼ばれる構成ファイルによって保護されています。
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 Authentication
Firebase コンソールで [Authentication] セクションに移動し、[使ってみる] をクリックします。[ログイン方法] タブに移動し、[ネイティブ プロバイダ] から [メール/パスワード] オプションを選択します。
[メール/パスワード] を有効にして [保存] をクリックします。
Firestore
データベースの作成
コンソールの [Firestore データベース] セクションに移動し、[データベースの作成] をクリックします。
- セキュリティ ルールを本番環境モードで開始することを選択する旨が求められたら、まもなくルールが更新されます。
- アプリに使用するデータベースのロケーションを選択します。データベースのロケーションの選択は永続的な決定であり、変更するには新しいプロジェクトを作成する必要があります。プロジェクトのロケーションの選択の詳細については、ドキュメントをご覧ください。
デプロイルール
先ほど作成したセキュリティ ルールをデプロイするには、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 プロジェクトでアプリをテストする場合は、次のいずれかを行います。
- リリースモードでアプリをビルドし、デバイス上で実行します。
BuildConfig.DEBUGを一時的にfalseに置き換えて、アプリをもう一度実行します。
本番環境に正しく接続するには、アプリからログアウトして再度ログインすることが必要になる場合があります。