1. 概要
目標
この Codelab では、Firestore を利用するレストランのおすすめアプリを Swift で iOS に作成します。ここでは以下について学びます。
- iOS アプリから Firestore へのデータの読み取りと書き込み
- Firestore データの変更をリアルタイムでリッスンする
- Firebase Authentication とセキュリティ ルールを使用して Firestore データを保護する
- 複雑な Firestore クエリを作成する
前提条件
この Codelab を始める前に、以下がインストールされていることを確認してください。
- Xcode バージョン 14.0 以降
- CocoaPods 1.12.0 以降
2. Firebase コンソール プロジェクトを作成する
Firebase をプロジェクトに追加する
- Firebase コンソールに移動します。
- [新しいプロジェクトを作成] を選択し、プロジェクトに「Firestore iOS Codelab」という名前を付けます。
3. サンプル プロジェクトを取得する
コードのダウンロード
まず、サンプル プロジェクトのクローンを作成し、プロジェクト ディレクトリで pod update を実行します。
git clone https://github.com/firebase/friendlyeats-ios cd friendlyeats-ios pod update
Xcode で FriendlyEats.xcworkspace を開き、実行します（Cmd+R）。GoogleService-Info.plist ファイルがないため、アプリが正しくコンパイルされ、起動時にすぐにクラッシュします。次のステップで修正します。
Firebase を設定する
ドキュメントに沿って、新しい Firestore プロジェクトを作成します。プロジェクトを取得したら、Firebase コンソールからプロジェクトの GoogleService-Info.plist ファイルをダウンロードして、Xcode プロジェクトのルートにドラッグします。プロジェクトを再度実行して、アプリが正しく設定され、起動時にクラッシュしなくなったことを確認します。ログインすると、以下の例のような空白の画面が表示されます。ログインできない場合は、Firebase コンソールの [Authentication] で、メール/パスワードによるログイン方法が有効になっていることを確認します。
4. Firestore にデータを書き込む
このセクションでは、アプリの UI にデータを入力できるように、Firestore にデータを書き込みます。この操作は、Firebase コンソールから手動で行うことができますが、ここでは、基本的な Firestore の書き込みのデモを行うために、アプリ自体で操作します。
アプリのメインのモデル オブジェクトはレストランです。Firestore のデータは、ドキュメント、コレクション、サブコレクションに分割されます。各レストランを、restaurants というトップレベルのコレクションにドキュメントとして保存します。Firestore データモデルについて詳しくは、ドキュメントでドキュメントとコレクションの説明をご覧ください。
Firestore にデータを追加する前に、レストラン コレクションへの参照を取得する必要があります。RestaurantsTableViewController.didTapPopulateButton(_:) メソッドの内部 for ループに以下を追加します。
let collection = Firestore.firestore().collection("restaurants")
コレクション リファレンスを作成したので、次にデータを書き込むことができます。追加したコードの最後の行の直後に次のコードを追加します。
let collection = Firestore.firestore().collection("restaurants")
// ====== ADD THIS ======
let restaurant = Restaurant(
name: name,
category: category,
city: city,
price: price,
ratingCount: 0,
averageRating: 0
)
collection.addDocument(data: restaurant.dictionary)
上記のコードでは、レストラン コレクションに新しいドキュメントを追加します。ドキュメント データは Restaurant 構造体から取得する辞書です。
もう少しで完了です。Firestore にドキュメントを書き込む前に、Firestore のセキュリティ ルールを開いて、データベースのどの部分をどのユーザーが書き込めるかを記述する必要があります。現時点では、認証されたユーザーのみにデータベース全体の読み取りと書き込みを許可します。製品版アプリにはやや制限が緩すぎますが、アプリの作成プロセスでは、テスト中に認証の問題が常に発生しないように、十分に緩和する必要があります。この Codelab の最後には、セキュリティ ルールを強化し、意図しない読み取りと書き込みの可能性を制限する方法について説明します。
Firebase コンソールの [ルール] タブで以下のルールを追加し、[公開] をクリックします。
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;
}
}
}
セキュリティ ルールについては後で詳しく説明しますが、お急ぎの場合は、セキュリティ ルールのドキュメントをご覧ください。
アプリを実行してログインします。次に、左上の [Populate] ボタンをタップすると、レストランのドキュメントのバッチが作成されます（ただし、アプリではまだこのボタンは表示されません）。
次に、Firebase コンソールの [Firestore データ] タブに移動します。これで、レストラン コレクションに新しいエントリが表示されます。
これで、iOS アプリから Firestore にデータが書き込まれました。次のセクションでは、Firestore からデータを取得してアプリに表示する方法について説明します。
5. Firestore のデータを表示する
このセクションでは、Firestore からデータを取得してアプリに表示する方法について説明します。主なステップは、クエリの作成とスナップショット リスナーの追加の 2 つです。このリスナーには、クエリに一致するすべての既存データが通知され、リアルタイムで更新が受信されます。
まず、フィルタされていないデフォルトのレストランリストを返すクエリを作成します。RestaurantsTableViewController.baseQuery() の実装を見てみましょう。
return Firestore.firestore().collection("restaurants").limit(to: 50)
このクエリは、「レストラン」という名前の最上位のコレクションから最大 50 軒のレストランを取得します。これでクエリが用意できたので、スナップショット リスナーをアタッチして、Firestore からアプリにデータを読み込む必要があります。stopObserving() 呼び出しの直後に、次のコードを RestaurantsTableViewController.observeQuery() メソッドに追加します。
listener = query.addSnapshotListener { [unowned self] (snapshot, error) in
guard let snapshot = snapshot else {
print("Error fetching snapshot results: \(error!)")
return
}
let models = snapshot.documents.map { (document) -> Restaurant in
if let model = Restaurant(dictionary: document.data()) {
return model
} else {
// Don't use fatalError here in a real app.
fatalError("Unable to initialize type \(Restaurant.self) with dictionary \(document.data())")
}
}
self.restaurants = models
self.documents = snapshot.documents
if self.documents.count > 0 {
self.tableView.backgroundView = nil
} else {
self.tableView.backgroundView = self.backgroundView
}
self.tableView.reloadData()
}
上記のコードは、Firestore からコレクションをダウンロードし、ローカルの配列に格納します。addSnapshotListener(_:) 呼び出しは、サーバーでデータが変更されるたびにビュー コントローラを更新するスナップショット リスナーをクエリに追加します。更新は自動的に行われるため、手動で変更を push する必要はありません。このスナップショット リスナーはサーバーサイドの変更の結果としていつでも呼び出すことができるため、アプリが変更を処理できることが重要です。
辞書を構造体にマッピングしたら（Restaurant.swift を参照）、いくつかのビュー プロパティを割り当てるだけでデータを表示できます。RestaurantsTableViewController.swift の RestaurantTableViewCell.populate(restaurant:) に次の行を追加します。
nameLabel.text = restaurant.name
cityLabel.text = restaurant.city
categoryLabel.text = restaurant.category
starsView.rating = Int(restaurant.averageRating.rounded())
priceLabel.text = priceString(from: restaurant.price)
この populate メソッドは、テーブルビューのデータソースの tableView(_:cellForRowAtIndexPath:) メソッドから呼び出されます。このメソッドは、以前の値タイプのコレクションを個々のテーブルビューのセルにマッピングします。
アプリを再度実行し、先ほどコンソールで見たレストランがシミュレータまたはデバイスに表示されることを確認します。このセクションを正常に完了すると、アプリは Cloud Firestore を使用してデータの読み取りと書き込みを行うようになりました。
6. データの並べ替えとフィルタリング
現在、このアプリにはレストランのリストが表示されますが、ユーザーがニーズに基づいてフィルタする方法はありません。このセクションでは、Firestore の高度なクエリを使用してフィルタリングを有効にします。
飲茶レストランをすべて取得するシンプルなクエリの例を次に示します。
let filteredQuery = query.whereField("category", isEqualTo: "Dim Sum")
whereField(_:isEqualTo:) メソッドは、その名前が示すように、設定した制限を満たすフィールドを持つコレクションのメンバーのみをクエリでダウンロードします。この例では、category が "Dim Sum" のレストランのみがダウンロードされます。
このアプリでは、ユーザーは複数のフィルタを連結して、「サンフランシスコのピザ」や「人気順でロサンゼルスのシーフードを注文」など、特定のクエリを作成できます。
RestaurantsTableViewController.swift を開き、query(withCategory:city:price:sortBy:) の中央に次のコードブロックを追加します。
if let category = category, !category.isEmpty {
filtered = filtered.whereField("category", isEqualTo: category)
}
if let city = city, !city.isEmpty {
filtered = filtered.whereField("city", isEqualTo: city)
}
if let price = price {
filtered = filtered.whereField("price", isEqualTo: price)
}
if let sortBy = sortBy, !sortBy.isEmpty {
filtered = filtered.order(by: sortBy)
}
上記のスニペットでは、複数の whereField 句と order 句を追加し、ユーザー入力に基づいて単一の複合クエリを作成しています。これで、このクエリはユーザーの要件を満たすレストランのみを返すようになります。
プロジェクトを実行し、料金、都市、カテゴリでフィルタできることを確認します（カテゴリと都市の名前を正確に入力してください）。テスト中に、次のようなエラーがログに表示されることがあります。
Error fetching snapshot results: Error Domain=io.grpc Code=9
"The query requires an index. You can create it here: https://console.firebase.google.com/project/project-id/database/firestore/indexes?create_composite=..."
UserInfo={NSLocalizedDescription=The query requires an index. You can create it here: https://console.firebase.google.com/project/project-id/database/firestore/indexes?create_composite=...}
これは、Firestore がほとんどの複合クエリに対してインデックスを必要とするためです。クエリでインデックスを必須にすることで、Firestore は大規模な処理でも高速になります。エラー メッセージからリンクを開くと、Firebase コンソールでインデックス作成 UI が自動的に開き、正しいパラメータが入力されます。Firestore のインデックスの詳細については、こちらのドキュメントをご覧ください。
7. トランザクションでのデータの書き込み
このセクションでは、ユーザーがレストランにレビューを送信できる機能を追加します。これまでのところ、すべての書き込みはアトミックで比較的シンプルでした。エラーが 1 つでもあった場合は、ユーザーに再試行を求めるか、自動的に再試行するように促すだけです。
レストランに評価を追加するには、複数の読み取りと書き込みを調整する必要があります。まずクチコミ自体を送信してから、レストランの評価数と平均評価を更新する必要があります。そのうちの 1 つが失敗し、もう 1 つが失敗すると、データベースのある部分のデータが別の部分のデータと一致しない、一貫性のない状態になります。
幸いなことに、Firestore にはトランザクション機能があり、単一のアトミック オペレーションで複数の読み取りと書き込みを実行できるため、データの整合性が維持されます。
RestaurantDetailViewController.reviewController(_:didSubmitFormWithReview:) のすべての let 宣言の下に次のコードを追加します。
let firestore = Firestore.firestore()
firestore.runTransaction({ (transaction, errorPointer) -> Any? in
// Read data from Firestore inside the transaction, so we don't accidentally
// update using stale client data. Error if we're unable to read here.
let restaurantSnapshot: DocumentSnapshot
do {
try restaurantSnapshot = transaction.getDocument(reference)
} catch let error as NSError {
errorPointer?.pointee = error
return nil
}
// Error if the restaurant data in Firestore has somehow changed or is malformed.
guard let data = restaurantSnapshot.data(),
let restaurant = Restaurant(dictionary: data) else {
let error = NSError(domain: "FireEatsErrorDomain", code: 0, userInfo: [
NSLocalizedDescriptionKey: "Unable to write to restaurant at Firestore path: \(reference.path)"
])
errorPointer?.pointee = error
return nil
}
// Update the restaurant's rating and rating count and post the new review at the
// same time.
let newAverage = (Float(restaurant.ratingCount) * restaurant.averageRating + Float(review.rating))
/ Float(restaurant.ratingCount + 1)
transaction.setData(review.dictionary, forDocument: newReviewReference)
transaction.updateData([
"numRatings": restaurant.ratingCount + 1,
"avgRating": newAverage
], forDocument: reference)
return nil
}) { (object, error) in
if let error = error {
print(error)
} else {
// Pop the review controller on success
if self.navigationController?.topViewController?.isKind(of: NewReviewViewController.self) ?? false {
self.navigationController?.popViewController(animated: true)
}
}
}
update ブロック内では、transaction オブジェクトを使用して実行するすべてのオペレーションが、Firestore によって単一のアトミック更新として扱われます。サーバーで更新が失敗すると、Firestore が自動的に再試行を数回繰り返します。つまり、デバイスが完全にオフラインになっている場合や、書き込み先のパスへの書き込みが許可されていない場合など、エラーは 1 つのエラーが繰り返し発生している可能性が高いということです。
8. セキュリティ ルール
アプリのユーザーがデータベースのすべてのデータを読み書きできないようにする必要があります。たとえば、レストランの評価はすべてのユーザーに表示されますが、評価の投稿は認証済みユーザーのみに許可する必要があります。クライアント上で良質なコードを記述するだけでは不十分です。データ セキュリティ モデルをバックエンドで指定して完全に保護する必要があります。このセクションでは、Firebase セキュリティ ルールを使用してデータを保護する方法を学びます。
まず、この Codelab の最初に作成したセキュリティ ルールを詳しく見てみましょう。Firebase コンソールを開き、[Firestore] タブの [データベース] > [ルール] に移動します。
rules_version = '2';
service cloud.firestore {
match /databases/{database}/documents {
match /{document=**} {
// Only authenticated users can read or write data
allow read, write: if request.auth != null;
}
}
}
上記のルールの request 変数は、すべてのルールで使用できるグローバル変数です。追加した条件を使用すると、ユーザーに何かを許可する前にリクエストが認証されます。これにより、認証されていないユーザーが Firestore API を使用してデータに不正な変更を加えることを防止できます。これは良いスタートですが、Firestore ルールを使用すると、より強力なことを実行できます。
レビューのユーザー ID が認証済みユーザーの ID と一致するように、レビューの書き込みを制限しましょう。これにより、ユーザーがお互いになりすましたり、不正なレビューを投稿したりすることがなくなります。セキュリティ ルールを次のように置き換えます。
rules_version = '2';
service cloud.firestore {
match /databases/{database}/documents {
match /restaurants/{any}/ratings/{rating} {
// Users can only write ratings with their user ID
allow read;
allow write: if request.auth != null
&& request.auth.uid == request.resource.data.userId;
}
match /restaurants/{any} {
// Only authenticated users can read or write data
allow read, write: if request.auth != null;
}
}
}
最初の match ステートメントは、restaurants コレクションに属するドキュメントの ratings という名前のサブコレクションと一致します。allow write 条件により、レビューのユーザー ID がユーザーの ID と一致しない場合、レビューは送信されません。2 つ目の match ステートメントを使用すると、認証されたすべてのユーザーがデータベースに対するレストランの読み取りと書き込みを行うことができます。
これはレビューで非常に有効です。セキュリティ ルールを使用して、ユーザーは自分のレビューしか書けないという、先ほどアプリに記述した暗黙的な保証を明示的に述べています。レビューに編集または削除機能を追加した場合、これとまったく同じルールセットによって、ユーザーが他のユーザーのレビューを変更または削除することもできなくなります。ただし、Firestore ルールをより細かく使用して、ドキュメント全体ではなくドキュメント内の個々のフィールドへの書き込みを制限することもできます。これを利用して、ユーザーがレストランの評価、平均評価、評価数のみを更新できるようにすることで、悪意のあるユーザーがレストランの名前や場所を変更する可能性を排除できます。
rules_version = '2';
service cloud.firestore {
match /databases/{database}/documents {
match /restaurants/{restaurant} {
match /ratings/{rating} {
allow read: if request.auth != null;
allow write: if request.auth != null
&& request.auth.uid == request.resource.data.userId;
}
allow read: if request.auth != null;
allow create: if request.auth != null;
allow update: if request.auth != null
&& request.resource.data.name == resource.data.name
&& request.resource.data.city == resource.data.city
&& request.resource.data.price == resource.data.price
&& request.resource.data.category == resource.data.category;
}
}
}
ここでは、許可する操作をより具体的にするために、書き込み権限を create と update に分割しています。この Codelab の開始時に作成した [入力] ボタンの機能を維持したまま、すべてのユーザーがデータベースにレストランを書き込むことができます。ただし、一度レストランの名前、場所、価格、カテゴリを変更することはできません。具体的には、最後のルールでは、レストランの更新操作に対して、データベース内の既存のフィールドの名前、都市、価格、カテゴリと同じものを維持する必要があります。
セキュリティ ルールで何ができるかについて詳しくは、こちらのドキュメントをご覧ください。
9. まとめ
この Codelab では、Firestore で基本的な読み取り / 高度な読み取り / 書き込みを行う方法と、セキュリティ ルールを使用してデータアクセスを保護する方法を学習しました。完全なソリューションは codelab-complete ブランチにあります。
Firestore の詳細については、次のリソースをご覧ください。