Cloud Firestore iOS Codelab

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

1。概要

目標

この Codelab では、Swift を使用して iOS で Firestore を利用したレストラン レコメンデーション アプリを構築します。次の方法を学習します:

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

前提条件

この Codelab を開始する前に、以下がインストールされていることを確認してください。

  • Xcode バージョン 13.0 (またはそれ以降)
  • CocoaPods 1.11.0 (またはそれ以降)

2. Firebase コンソール プロジェクトを作成する

プロジェクトに Firebase を追加する

  1. Firebase コンソールに移動します。
  2. [ Create New Project ] を選択し、プロジェクトに「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 プロジェクトを作成します。プロジェクトを取得したら、プロジェクトのGoogleService-Info.plistファイルをFirebase コンソールからダウンロードし、Xcode プロジェクトのルートにドラッグします。プロジェクトを再度実行して、アプリが正しく構成され、起動時にクラッシュしないことを確認します。ログインすると、以下の例のような空白の画面が表示されます。ログインできない場合は、Firebase コンソールの [認証] でメール/パスワードによるサインイン方法が有効になっていることを確認してください。

d5225270159c040b.png

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 データ] タブに移動します。レストラン コレクションに新しいエントリが表示されます。

スクリーンショット 2017-07-06 at 12.45.38 PM.png

おめでとうございます。iOS アプリから Firestore にデータを書き込んだところです。次のセクションでは、Firestore からデータを取得してアプリに表示する方法を学習します。

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

このセクションでは、Firestore からデータを取得してアプリに表示する方法を学習します。 2 つの重要な手順は、クエリの作成とスナップショット リスナーの追加です。このリスナーには、クエリに一致するすべての既存データが通知され、リアルタイムで更新を受け取ります。

まず、デフォルトのフィルター処理されていないレストランのリストを提供するクエリを作成しましょう。 RestaurantsTableViewController.baseQuery()の実装を見てみましょう:

return Firestore.firestore().collection("restaurants").limit(to: 50)

このクエリは、"restaurants" という名前の最上位コレクションから最大 50 軒のレストランを取得します。クエリを作成したので、スナップショット リスナーをアタッチして、Firestore からアプリにデータを読み込む必要があります。次のコードをRestaurantsTableViewController.observeQuery()メソッドのstopObserving()への呼び出しの直後に追加します。

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(_:)呼び出しは、サーバー上のデータが変更されるたびにビュー コントローラーを更新するスナップショット リスナーをクエリに追加します。更新は自動的に取得されるため、変更を手動でプッシュする必要はありません。このスナップショット リスナーは、サーバー側の変更の結果としていつでも呼び出すことができるため、アプリが変更を処理できることが重要です。

辞書を構造体にマッピングした後 ( Restaurant.swiftを参照)、データを表示するには、いくつかのビュー プロパティを割り当てるだけです。次の行を RestaurantTableViewController.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 を使用してデータを読み書きできるようになります。

391c0259bf05ac25.png

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/testapp-5d356/database/firestore/indexes?create_index=..." 
UserInfo={NSLocalizedDescription=The query requires an index. You can create it here: https://console.firebase.google.com/project/project-id/database/firestore/indexes?create_index=...}

これは、Firestore がほとんどの複合クエリにインデックスを必要とするためです。クエリでインデックスを要求することで、Firestore を大規模に高速に保つことができます。エラー メッセージからリンクを開くと、Firebase コンソールでインデックス作成 UI が自動的に開き、正しいパラメータが入力されます。Firestore のインデックスの詳細については、ドキュメントを参照してください。

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

このセクションでは、ユーザーがレストランにレビューを送信できる機能を追加します。これまでのところ、すべての書き込みはアトミックで比較的単純なものでした。それらのいずれかがエラーになった場合、ユーザーに再試行するように促すか、自動的に再試行します。

レストランに評価を追加するには、複数の読み取りと書き込みを調整する必要があります。最初にレビュー自体を送信する必要があり、次にレストランの評価数と平均評価を更新する必要があります。これらのいずれかが失敗し、他の部分が失敗しない場合、データベースの一部のデータが別の部分のデータと一致しないという矛盾した状態になります。

幸いなことに、Firestore には、1 回のアトミック オペレーションで複数の読み取りと書き込みを実行できるトランザクション機能が用意されているため、データの一貫性が保たれます。

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)
    }
  }
}

更新ブロック内では、トランザクション オブジェクトを使用して行うすべての操作が、Firestore によって単一のアトミック更新として扱われます。サーバーで更新が失敗した場合、Firestore は自動的に数回再試行します。つまり、デバイスが完全にオフラインであるか、ユーザーが書き込み先のパスへの書き込みを許可されていない場合など、エラー状態は単一のエラーが繰り返し発生する可能性が高いことを意味します。

8. セキュリティ規則

アプリのユーザーは、データベース内のすべてのデータを読み書きできるべきではありません。たとえば、誰もがレストランの評価を表示できる必要がありますが、認証されたユーザーのみが評価を投稿できるようにする必要があります。クライアントで適切なコードを書くだけでは十分ではありません。バックエンドでデータ セキュリティ モデルを指定して、完全に安全にする必要があります。このセクションでは、Firebase セキュリティ ルールを使用してデータを保護する方法を学習します。

まず、コードラボの冒頭で作成したセキュリティ ルールを詳しく見てみましょう。 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;
    }
  }
}

ここでは、書き込み権限を作成と更新に分割して、どの操作を許可するかをより具体的にすることができます。 Codelab の最初に作成した [Populate] ボタンの機能を保持したまま、すべてのユーザーがレストランをデータベースに書き込むことができますが、レストランが書き込まれると、その名前、場所、価格、カテゴリは変更できなくなります。より具体的には、最後のルールでは、データベース内の既存のフィールドと同じ名前、都市、価格、およびカテゴリを維持するために、レストランの更新操作が必要です。

セキュリティ ルールでできることの詳細については、ドキュメントをご覧ください。

9. 結論

この Codelab では、Firestore を使用した基本的および高度な読み取りと書き込みの方法と、セキュリティ ルールでデータ アクセスを保護する方法を学びました。完全なソリューションはcodelab-completeブランチにあります。

Firestore の詳細については、次のリソースをご覧ください。