Firebase iOS Codelab Swift

1。概要

2efe6805ef369641.png

フレンドリー チャット コードラボへようこそ。この Codelab では、Firebase プラットフォームを使用して iOS アプリケーションを作成する方法を学びます。チャット クライアントを実装し、Firebase を使用してそのパフォーマンスを監視します。

この Codelab は、Objective-C でも利用できます。

学習内容

  • ユーザーがサインインできるようにします。
  • Firebase Realtime Database を使用してデータを同期します。
  • バイナリ ファイルを Firebase Storage に保存します。

必要なもの

  • Xcode
  • ココアポッド
  • iOS 8.0 以降またはシミュレータを搭載したテスト デバイス

このチュートリアルをどのように使用しますか?

読み通すだけそれを読んで演習を完了してください

iOS アプリの構築に関するあなたの経験をどのように評価しますか?

初心者中級熟練した

2. サンプルコードを入手する

コマンド ラインから GitHub リポジトリのクローンを作成します。

$ git clone https://github.com/firebase/codelab-friendlychat-ios

3. スターター アプリをビルドする

2f4c98d858c453fe.png

スターター アプリをビルドするには:

  1. ターミナル ウィンドウで、 android_studio_folder.pngサンプル コード ダウンロードのios-starter/swift-starterディレクトリ
  2. pod install --repo-updateを実行します
  3. FriendlyChatSwift.xcworkspace ファイルを開き、Xcode でプロジェクトを開きます。
  4. クリック98205811bbed9d74.png実行ボタン。

数秒後に Friendly Chat のホーム画面が表示されます。 UI が表示されます。ただし、この時点ではサインイン、メッセージの送受信はできません。次のステップを完了するまで、アプリは例外で中止されます。

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

プロジェクトを作成

Firebase コンソールからAdd Projectを選択します。

プロジェクトFriendlyChat呼び出してから、 Create Projectをクリックします。

2015-11-06 14:13:39.png のスクリーンショット

iOS アプリを接続する

  1. 新しいプロジェクトの [Project Overview] 画面で、 [Add Firebase to your iOS app]をクリックします。
  2. バンドル ID を「 com.google.firebase.codelab.FriendlyChatSwift 」のように入力します。
  3. App Store ID を「 123456 」と入力します。
  4. [アプリの登録]をクリックします。

GoogleService-Info.plist ファイルをアプリに追加します

2 番目の画面で[GoogleService-Info.plist をダウンロード] をクリックして、アプリに必要なすべての Firebase メタデータを含む構成ファイルをダウンロードします。そのファイルをアプリケーションにコピーし、 FriendlyChatSwiftターゲットに追加します。

ポップアップの右上隅にある「x」をクリックしてポップアップを閉じることができます。手順 3 と 4 はスキップして、ここでこれらの手順を実行します。

19d59efb213ddbdc.png

Firebase モジュールのインポート

まず、 Firebaseモジュールがインポートされていることを確認します。

AppDelegate.swiftFCViewController.swift

import Firebase

AppDelegate で Firebase を構成する

application:didFinishLaunchingWithOptions 関数内の FirebaseApp の "configure" メソッドを使用して、.plist ファイルから基になる Firebase サービスを構成します。

AppDelegate.swift

  func application(_ application: UIApplication, didFinishLaunchingWithOptions
      launchOptions: [UIApplicationLaunchOptionsKey: Any]?) -> Bool {
  FirebaseApp.configure()
  GIDSignIn.sharedInstance().delegate = self
  return true
}

5. ユーザーを特定する

ルールを使用して認証済みユーザーに制限する

メッセージを読み書きする前に認証を要求するルールを追加します。これを行うには、次のルールをメッセージ データ オブジェクトに追加します。 Firebase コンソールの [データベース] セクションから [リアルタイム データベース] を選択し、[ルール] タブをクリックします。次に、ルールを次のように更新します。

{
  "rules": {
    "messages": {
      ".read": "auth != null",
      ".write": "auth != null"
    }
  }
}

これがどのように機能するか (「auth」変数に関するドキュメントを含む) の詳細については、Firebaseセキュリティ ドキュメントを参照してください。

認証 API の構成

アプリケーションがユーザーに代わって Firebase Authentication API にアクセスできるようにするには、それを有効にする必要があります。

  1. Firebase コンソールに移動し、プロジェクトを選択します
  2. 認証を選択
  3. サインイン方法タブを選択します
  4. Googleスイッチを有効 (青色) に切り替えます
  5. 結果のダイアログで保存を押します

このコードラボの後半で「CONFIGURATION_NOT_FOUND」というメッセージとともにエラーが発生した場合は、このステップに戻って作業を再確認してください。

Firebase Auth の依存関係を確認する

Firebase Auth の依存関係がPodfileファイルに存在することを確認します。

ポッドファイル

pod 'Firebase/Auth'

Google サインイン用に Info.plist をセットアップします。

カスタム URL スキームを XCode プロジェクトに追加する必要があります。

  1. プロジェクト構成を開きます。左側のツリー ビューでプロジェクト名をダブルクリックします。 [ターゲット] セクションからアプリを選択し、[情報] タブを選択して、[URL の種類] セクションを展開します。
  2. [+] ボタンをクリックし、反転したクライアント ID の URL スキームを追加します。この値を見つけるには、GoogleService-Info.plist 構成ファイルを開き、REVERSED_CLIENT_ID キーを探します。そのキーの値をコピーして、構成ページの [URL スキーム] ボックスに貼り付けます。他のフィールドは空白のままにします。
  3. 完了すると、構成は次のようになります (ただし、アプリケーション固有の値があります)。

1b54d5bd2f4f1448.png

Google サインインの clientID を設定する

Firebase を構成したら、clientID を使用して、「didFinishLaunchingWithOptions:」メソッド内で Google サインインをセットアップできます。

AppDelegate.swift

  func application(_ application: UIApplication, didFinishLaunchingWithOptions
      launchOptions: [UIApplicationLaunchOptionsKey: Any]?) -> Bool {
  FirebaseApp.configure()
  GIDSignIn.sharedInstance().clientID = FirebaseApp.app()?.options.clientID
  GIDSignIn.sharedInstance().delegate = self
  return true
}

サインイン ハンドラーを追加する

Google サインインの結果が成功したら、そのアカウントを使用して Firebase で認証します。

AppDelegate.swift

  func sign(_ signIn: GIDSignIn!, didSignInFor user: GIDGoogleUser!, withError error: Error?) {
    if let error = error {
      print("Error \(error)")
      return
    }

    guard let authentication = user.authentication else { return }
    let credential = GoogleAuthProvider.credential(withIDToken: authentication.idToken,
                                                      accessToken: authentication.accessToken)
    Auth.auth().signIn(with: credential) { (user, error) in
      if let error = error {
        print("Error \(error)")
        return
      }
    }
  }

ユーザーを自動的にサインインします。次に、Firebase Auth にリスナーを追加して、サインインが成功した後にユーザーをアプリに入れます。deinit でリスナーを削除します。

SignInViewController.swift

  override func viewDidLoad() {
    super.viewDidLoad()
    GIDSignIn.sharedInstance().uiDelegate = self
    GIDSignIn.sharedInstance().signInSilently()
    handle = Auth.auth().addStateDidChangeListener() { (auth, user) in
      if user != nil {
        MeasurementHelper.sendLoginEvent()
        self.performSegue(withIdentifier: Constants.Segues.SignInToFp, sender: nil)
      }
    }
  }

  deinit {
    if let handle = handle {
      Auth.auth().removeStateDidChangeListener(handle)
    }
  }

サインアウト

Sign out メソッドを追加する

FCViewController.swift

  @IBAction func signOut(_ sender: UIButton) {
    let firebaseAuth = Auth.auth()
    do {
      try firebaseAuth.signOut()
      dismiss(animated: true, completion: nil)
    } catch let signOutError as NSError {
      print ("Error signing out: \(signOutError.localizedDescription)")
    }
  }

サインインしたユーザーとしてメッセージの読み取りをテストする

  1. クリック98205811bbed9d74.png実行ボタン。
  2. すぐにサインイン画面に移動する必要があります。 [Google サインイン] ボタンをタップします。
  3. すべてがうまくいった場合は、メッセージ画面に送信されます。

6. Realtime Database を有効にする

2efe6805ef369641.png

メッセージのインポート

Firebase コンソールのプロジェクトで、左側のナビゲーション バーにある[データベース]項目を選択します。データベースのオーバーフロー メニューで[JSON のインポート]を選択します。 Friendlychat ディレクトリにあるinitial_messages.jsonファイルを参照して選択し、 [インポート]ボタンをクリックします。これにより、現在データベースにあるすべてのデータが置き換えられます。緑の + と赤の x を使用してアイテムを追加および削除して、データベースを直接編集することもできます。

20ccf4856b715b4c.png

データベースをインポートすると、次のようになります。

f3e0367f1c9cd187.png

Firebase データベースの依存関係を確認する

Podfileファイルの依存関係ブロックで、 Firebase/Databaseが含まれていることを確認します。

ポッドファイル

pod 'Firebase/Database'

既存のメッセージを同期する

新しく追加されたメッセージをアプリ UI に同期するコードを追加します。

このセクションに追加するコードは、次のことを行います。

  • Firebase データベースを初期化し、データベースに加えられた変更を処理するリスナーを追加します。
  • 新しいメッセージが表示されるようにDataSnapshotを更新します。

FCViewController の「deinit」、「configureDatabase」、および「tableView:cellForRow indexPath:」メソッドを変更します。以下に定義されたコードに置き換えます。

FCViewController.swift

  deinit {
    if let refHandle = _refHandle {
      self.ref.child("messages").removeObserver(withHandle: _refHandle)
    }
  }


  func configureDatabase() {
    ref = Database.database().reference()
    // Listen for new messages in the Firebase database
    _refHandle = self.ref.child("messages").observe(.childAdded, with: { [weak self] (snapshot) -> Void in
      guard let strongSelf = self else { return }
      strongSelf.messages.append(snapshot)
      strongSelf.clientTable.insertRows(at: [IndexPath(row: strongSelf.messages.count-1, section: 0)], with: .automatic)
    })
  }


  func tableView(_ tableView: UITableView, cellForRowAt indexPath: IndexPath) -> UITableViewCell {
    // Dequeue cell
    let cell = self.clientTable.dequeueReusableCell(withIdentifier: "tableViewCell", for: indexPath)
    // Unpack message from Firebase DataSnapshot
    let messageSnapshot = self.messages[indexPath.row]
    guard let message = messageSnapshot.value as? [String: String] else { return cell }
    let name = message[Constants.MessageFields.name] ?? ""
    let text = message[Constants.MessageFields.text] ?? ""
    cell.textLabel?.text = name + ": " + text
    cell.imageView?.image = UIImage(named: "ic_account_circle")
    if let photoURL = message[Constants.MessageFields.photoURL], let URL = URL(string: photoURL),
        let data = try? Data(contentsOf: URL) {
      cell.imageView?.image = UIImage(data: data)
    }
    return cell
  }

メッセージ同期のテスト

  1. クリック98205811bbed9d74.png実行ボタン。
  2. [サインインして開始]ボタンをクリックして、メッセージ ウィンドウに移動します。
  3. 「メッセージ」エントリの横にある緑色の + 記号をクリックし、次のようなオブジェクトを追加して、新しいメッセージを Firebase コンソールに直接追加します。 f9876ffc8b316b14.png
  4. Friendly-Chat UI に表示されることを確認します。

7.メッセージを送る

メッセージ送信の実装

値をデータベースにプッシュします。 push メソッドを使用して Firebase Realtime Database にデータを追加すると、自動 ID が追加されます。これらの自動生成された ID は連続しているため、新しいメッセージが正しい順序で追加されます。

FCViewController の「sendMessage:」メソッドを変更します。以下に定義されたコードに置き換えます。

FCViewController.swift

  func sendMessage(withData data: [String: String]) {
    var mdata = data
    mdata[Constants.MessageFields.name] = Auth.auth().currentUser?.displayName
    if let photoURL = Auth.auth().currentUser?.photoURL {
      mdata[Constants.MessageFields.photoURL] = photoURL.absoluteString
    }

    // Push data to Firebase Database
    self.ref.child("messages").childByAutoId().setValue(mdata)
  }

メッセージ送信のテスト

  1. クリック98205811bbed9d74.png実行ボタン。
  2. [サインイン]をクリックして、メッセージ ウィンドウに移動します。
  3. メッセージを入力し、送信を押します。アプリの UI と Firebase コンソールに新しいメッセージが表示されます。

8. 画像の保存と受信

Firebase ストレージの依存関係を確認する

Podfileの依存関係ブロックで、 Firebase/Storageが含まれていることを確認します。

ポッドファイル

pod 'Firebase/Storage'

ダッシュボードで Firebase Storage をアクティブ化

Firebase コンソールに移動し、「gs://PROJECTID.appspot.com」ドメインでストレージが有効になっていることを確認します

b0438b37a588bcee.png

代わりにアクティブ化ウィンドウが表示されている場合は、[開始する] をクリックしてデフォルト ルールでアクティブ化します。

c290bbebff2cafa7.png

FirebaseStorage を構成する

FCViewController.swift

  func configureStorage() {
    storageRef = Storage.storage().reference()
  }

既存のメッセージで画像を受信する

Firebase Storage から画像をダウンロードするコードを追加します。

FCViewController の "tableView: cellForRowAt indexPath:" メソッドを変更します。以下に定義されたコードに置き換えます。

FCViewController.swift

  func tableView(_ tableView: UITableView, cellForRowAt indexPath: IndexPath) -> UITableViewCell {
    // Dequeue cell
    let cell = self.clientTable .dequeueReusableCell(withIdentifier: "tableViewCell", for: indexPath)
    // Unpack message from Firebase DataSnapshot
    let messageSnapshot: DataSnapshot! = self.messages[indexPath.row]
    guard let message = messageSnapshot.value as? [String:String] else { return cell }
    let name = message[Constants.MessageFields.name] ?? ""
    if let imageURL = message[Constants.MessageFields.imageURL] {
      if imageURL.hasPrefix("gs://") {
        Storage.storage().reference(forURL: imageURL).getData(maxSize: INT64_MAX) {(data, error) in
          if let error = error {
            print("Error downloading: \(error)")
            return
          }
          DispatchQueue.main.async {
            cell.imageView?.image = UIImage.init(data: data!)
            cell.setNeedsLayout()
          }
        }
      } else if let URL = URL(string: imageURL), let data = try? Data(contentsOf: URL) {
        cell.imageView?.image = UIImage.init(data: data)
      }
      cell.textLabel?.text = "sent by: \(name)"
    } else {
      let text = message[Constants.MessageFields.text] ?? ""
      cell.textLabel?.text = name + ": " + text
      cell.imageView?.image = UIImage(named: "ic_account_circle")
      if let photoURL = message[Constants.MessageFields.photoURL], let URL = URL(string: photoURL),
          let data = try? Data(contentsOf: URL) {
        cell.imageView?.image = UIImage(data: data)
      }
    }
    return cell
  }

9. イメージメッセージを送る

画像の保存と送信を実装する

ユーザーから画像をアップロードし、この画像のストレージ URL をデータベースに同期して、この画像がメッセージ内で送信されるようにします。

FCViewController の「imagePickerController: didFinishPickingMediaWithInfo:」メソッドを変更します。以下に定義されたコードに置き換えます。

FCViewController.swift

  func imagePickerController(_ picker: UIImagePickerController,
    didFinishPickingMediaWithInfo info: [String : Any]) {
      picker.dismiss(animated: true, completion:nil)
    guard let uid = Auth.auth().currentUser?.uid else { return }

    // if it's a photo from the library, not an image from the camera
    if #available(iOS 8.0, *), let referenceURL = info[UIImagePickerControllerReferenceURL] as? URL {
      let assets = PHAsset.fetchAssets(withALAssetURLs: [referenceURL], options: nil)
      let asset = assets.firstObject
      asset?.requestContentEditingInput(with: nil, completionHandler: { [weak self] (contentEditingInput, info) in
        let imageFile = contentEditingInput?.fullSizeImageURL
        let filePath = "\(uid)/\(Int(Date.timeIntervalSinceReferenceDate * 1000))/\((referenceURL as AnyObject).lastPathComponent!)"
        guard let strongSelf = self else { return }
        strongSelf.storageRef.child(filePath)
          .putFile(from: imageFile!, metadata: nil) { (metadata, error) in
            if let error = error {
              let nsError = error as NSError
              print("Error uploading: \(nsError.localizedDescription)")
              return
            }
            strongSelf.sendMessage(withData: [Constants.MessageFields.imageURL: strongSelf.storageRef.child((metadata?.path)!).description])
          }
      })
    } else {
      guard let image = info[UIImagePickerControllerOriginalImage] as? UIImage else { return }
      let imageData = UIImageJPEGRepresentation(image, 0.8)
      let imagePath = "\(uid)/\(Int(Date.timeIntervalSinceReferenceDate * 1000)).jpg"
      let metadata = StorageMetadata()
      metadata.contentType = "image/jpeg"
      self.storageRef.child(imagePath)
        .putData(imageData!, metadata: metadata) { [weak self] (metadata, error) in
          if let error = error {
            print("Error uploading: \(error)")
            return
          }
          guard let strongSelf = self else { return }
          strongSelf.sendMessage(withData: [Constants.MessageFields.imageURL: strongSelf.storageRef.child((metadata?.path)!).description])
      }
    }
  }

画像メッセージの送受信をテストする

  1. クリック98205811bbed9d74.png実行ボタン。
  2. [サインイン]をクリックして、メッセージ ウィンドウに移動します。
  3. 「写真を追加」アイコンをクリックして写真を選択します。写真付きの新しいメッセージは、アプリの UI と Firebase コンソールに表示されます。

10.おめでとう!

Firebase を使用して、リアルタイム チャット アプリケーションを簡単に構築しました。

カバーした内容

  • リアルタイム データベース
  • フェデレーション サインイン
  • 保管所

もっと詳しく知る