Firebase iOS Codelab Swift

一、概述

欢迎来到友好聊天代码实验室。在本 Codelab 中，您将学习如何使用 Firebase 平台创建 iOS 应用程序。您将使用 Firebase 实现聊天客户端并监控其性能。

这个 codelab 也可以在 Objective-C 中使用。

你会学到什么

• 允许用户登录。
• 使用 Firebase 实时数据库同步数据。
• 将二进制文件存储在 Firebase 存储中。

你需要什么

• Xcode
• 可可豆荚
• 带有 iOS 8.0+ 或模拟器的测试设备

您将如何使用本教程？

只通读一遍阅读并完成练习

您如何评价您构建 iOS 应用程序的体验？

新手中间的精通

2.获取示例代码

从命令行克隆 GitHub 存储库。

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

“friendlychat-ios”存储库包含许多示例项目。这个 codelab 只用到了两个：

• ios-starter/swift-starter — 您将在此 Codelab 中构建的起始代码。
• ios/swift — 完成的示例应用程序的完整代码。

3. 构建入门应用

要构建入门应用程序：

1. 在终端窗口中，导航到示例代码下载中ios-starter/swift-starter目录
2. 运行pod install --repo-update
3. 打开 FriendlyChatSwift.xcworkspace 文件以在 Xcode 中打开项目。
4. 点击运行按钮。

几秒钟后，您应该会看到友好聊天主屏幕出现。 UI 应该会出现。但是，此时您无法登录、发送或接收消息。该应用程序将异常中止，直到您完成下一步。

4. 创建 Firebase 控制台项目

创建项目

从Firebase 控制台选择Add Project 。

调用项目FriendlyChat ，然后单击Create Project 。

连接您的 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 文件添加到您的应用

在第二个屏幕上，单击下载 GoogleService-Info.plist以下载一个配置文件，其中包含您的应用所需的所有 Firebase 元数据。将该文件复制到您的应用程序并将其添加到FriendlyChatSwift目标。

您现在可以单击弹出窗口右上角的“x”将其关闭——跳过步骤 3 和 4——因为您将在此处执行这些步骤。

导入 Firebase 模块

首先确保Firebase模块已导入。

AppDelegate.swift , FCViewController.swift

import Firebase

在 AppDelegate 中配置 Firebase

使用应用程序内 FirebaseApp 中的“配置”方法：didFinishLaunchingWithOptions 函数从您的 .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 身份验证 API 之前，您必须启用它

1. 导航到Firebase 控制台并选择您的项目
2. 选择身份验证
3. 选择登录方法选项卡
4. 将Google开关切换为启用（蓝色）
5. 在出现的对话框上按保存

如果您稍后在此代码实验室中收到错误消息“CONFIGURATION_NOT_FOUND”，请返回此步骤并仔细检查您的工作。

确认 Firebase 身份验证依赖项

确认Podfile文件中存在 Firebase Auth 依赖项。

播客文件

pod 'Firebase/Auth'

为 Google 登录设置 Info.plist。

您需要将自定义 URL 方案添加到您的 XCode 项目。

1. 打开您的项目配置：双击左侧树视图中的项目名称。从 TARGETS 部分中选择您的应用程序，然后选择 Info 选项卡，然后展开 URL Types 部分。
2. 单击 + 按钮，并为您的反向客户端 ID 添加 URL 方案。要查找此值，请打开 GoogleService-Info.plist 配置文件，然后查找 REVERSED_CLIENT_ID 键。复制该键的值，并将其粘贴到配置页面上的 URL 方案框中。将其他字段留空。
3. 完成后，您的配置应类似于以下内容（但使用特定于应用程序的值）：

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

登出

添加注销方法

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. 点击运行按钮。
2. 您应该立即被发送到登录屏幕。点击 Google 登录按钮。
3. 如果一切正常，您应该会被发送到消息屏幕。

6.激活实时数据库

导入消息

在Firebase 控制台的项目中，选择左侧导航栏中的Database项。在数据库的溢出菜单中选择Import JSON 。浏览到friendlychat 目录中的initial_messages.json文件，选择它然后单击Import按钮。这将替换当前数据库中的所有数据。您也可以直接编辑数据库，使用绿色 + 和红色 x 来添加和删除项目。

导入数据库后应如下所示：

确认 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. 点击运行按钮。
2. 单击“登录以开始”按钮以转到消息窗口。
3. 通过单击“消息”条目旁边的绿色 + 符号并添加如下对象，直接在 Firebase 控制台中添加新消息：
4. 确认它们出现在友好聊天 UI 中。

7. 发送消息

实现发送消息

将值推送到数据库。当您使用 push 方法向 Firebase 实时数据库添加数据时，会自动添加一个 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. 点击运行按钮。
2. 单击登录以转到消息窗口。
3. 输入一条消息并点击发送。新消息应该在应用 UI 和 Firebase 控制台中可见。

8. 存储和接收图像

确认 Firebase 存储依赖关系

在Podfile的依赖项块中，确认包含Firebase/Storage 。

播客文件

pod 'Firebase/Storage'

在仪表板中激活 Firebase 存储

转到 Firebase 控制台并确认已使用“gs://PROJECTID.appspot.com”域激活存储

如果您看到的是激活窗口，请单击“开始使用”以使用默认规则激活它。

配置 Firebase 存储

FCViewController.swift

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

接收现有消息中的图像

添加从 Firebase 存储下载图像的代码。

修改你的 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. 点击运行按钮。
2. 单击登录以转到消息窗口。
3. 单击“添加照片”图标以选择照片。带有照片的新消息应该在应用 UI 和 Firebase 控制台中可见。

10. 恭喜！

您已经使用 Firebase 轻松构建了一个实时聊天应用程序。

我们涵盖的内容

• 实时数据库
• 联合登录
• 贮存

学到更多

• Firebase.google.com