Codelab Swift de Firebase para iOS

1. Descripción general

Te damos la bienvenida al codelab de Friendly Chat. En este codelab, aprenderás a usar la plataforma de Firebase para crear aplicaciones para iOS. Implementarás un cliente de chat y supervisarás su rendimiento con Firebase.

Qué aprenderás

• Permite que los usuarios accedan.
• Sincroniza datos con Firebase Realtime Database.
• Almacena archivos binarios en Firebase Storage.

Requisitos

• Xcode
• CocoaPods
• Un dispositivo de prueba con iOS 8.0 o versiones posteriores, o un simulador

¿Cómo usarás este instructivo?

Leer Leer y completar los ejercicios

¿Cómo calificarías tu experiencia con la compilación de apps para iOS?

Principiante Intermedio Avanzado

2. Obtén el código de muestra

Clona el repositorio de GitHub desde la línea de comandos.

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

El repositorio "friendlychat-ios" contiene muchos proyectos de muestra. En este codelab, solo se usan dos:

• ios-starter/swift-starter: Es el código inicial que usarás como base para compilar en este codelab.
• ios/swift: Es el código completo de la app de ejemplo finalizada.

3. Compila la app de partida

Para compilar la app de partida, haz lo siguiente:

1. En una ventana de terminal, navega al directorio ios-starter/swift-starter de la descarga del código de muestra.
2. Ejecución pod install --repo-update
3. Abre el archivo FriendlyChatSwift.xcworkspace para abrir el proyecto en Xcode.
4. Haz clic en el botón Ejecutar.

Después de unos segundos, deberías ver la pantalla principal de Friendly Chat. Debería aparecer la IU. Sin embargo, en este momento no puedes acceder, ni enviar ni recibir mensajes. La app se abortará con una excepción hasta que completes el siguiente paso.

4. Crea un proyecto de Firebase console

Cómo crear un proyecto

En Firebase console, selecciona Agregar proyecto.

Llama al proyecto FriendlyChat y, luego, haz clic en Create Project.

Actualiza tu plan de precios de Firebase

Para usar Cloud Storage para Firebase, tu proyecto de Firebase debe tener el plan de precios de pago por uso (Blaze), lo que significa que está vinculado a una cuenta de Facturación de Cloud.

• Una cuenta de Facturación de Cloud requiere una forma de pago, como una tarjeta de crédito.
• Si es la primera vez que usas Firebase y Google Cloud, verifica si cumples con los requisitos para obtener un crédito de USD 300 y una cuenta de Facturación de Cloud de prueba gratuita.
• Si realizas este codelab como parte de un evento, pregúntale al organizador si hay créditos de Cloud disponibles.

Para actualizar tu proyecto al plan Blaze, sigue estos pasos:

1. En Firebase console, selecciona la opción para actualizar tu plan.
2. Selecciona el plan Blaze. Sigue las instrucciones en pantalla para vincular una cuenta de Facturación de Cloud a tu proyecto.
   Si necesitas crear una cuenta de Facturación de Cloud como parte de esta actualización, es posible que debas volver al flujo de actualización en Firebase console para completarla.

Nota: Puedes cambiar tu proyecto al plan de precios sin costo (Spark) después de completar este codelab.

Cómo conectar tu app para iOS

1. En la pantalla Descripción general del proyecto de tu proyecto nuevo, haz clic en Agregar Firebase a tu app para iOS.
2. Ingresa el ID del paquete como "com.google.firebase.codelab.FriendlyChatSwift".
3. Ingresa el ID de App Store como "123456".
4. Haga clic en Registrar app.

Agrega el archivo GoogleService-Info.plist a tu app

En la segunda pantalla, haz clic en Download GoogleService-Info.plist para descargar un archivo de configuración que contiene todos los metadatos de Firebase necesarios para tu app. Copia ese archivo en tu aplicación y agrégalo al objetivo FriendlyChatSwift.

Ahora puedes hacer clic en la "X" de la esquina superior derecha de la ventana emergente para cerrarla y omitir los pasos 3 y 4, ya que los realizarás aquí.

Importa el módulo de Firebase

Primero, asegúrate de que se haya importado el módulo Firebase.

AppDelegate.swift, FCViewController.swift

import Firebase

Cómo configurar Firebase en AppDelegate

Usa el método "configure" en FirebaseApp dentro de la función application:didFinishLaunchingWithOptions para configurar los servicios subyacentes de Firebase desde tu archivo .plist.

AppDelegate.swift

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

5. Identifica a los usuarios

Usa reglas para restringir el acceso a los usuarios autenticados

Ahora agregaremos una regla para exigir la autenticación antes de leer o escribir cualquier mensaje. Para ello, agregamos las siguientes reglas a nuestro objeto de datos de mensajes. En la sección Base de datos de Firebase console, selecciona Realtime Database y, luego, haz clic en la pestaña Reglas. Luego, actualiza las reglas para que se vean de la siguiente manera:

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

Para obtener más información sobre cómo funciona esto (incluida la documentación sobre la variable "auth"), consulta la documentación de seguridad de Firebase.

Configura las APIs de Authentication

Para que tu aplicación pueda acceder a las APIs de Firebase Authentication en nombre de tus usuarios, deberás habilitarla.

1. Navega a Firebase console y selecciona tu proyecto.
2. Selecciona Autenticación.
3. Selecciona la pestaña Método de acceso.
4. Mueve el interruptor de Google a la posición de habilitado (azul).
5. Presiona Guardar en el cuadro de diálogo resultante.

Si más adelante en este codelab recibes errores con el mensaje "CONFIGURATION_NOT_FOUND", vuelve a este paso y verifica tu trabajo.

Confirma la dependencia de Firebase Auth

Confirma que las dependencias de Firebase Auth existan en el archivo Podfile.

Podfile

pod 'Firebase/Auth'

Configura tu archivo Info.plist para el Acceso con Google.

Deberás agregar un esquema de URL personalizado a tu proyecto de XCode.

1. Abre la configuración del proyecto: haz doble clic en el nombre del proyecto en la vista de árbol a la izquierda. Selecciona tu app en la sección OBJETIVOS, luego selecciona la pestaña Información y expande la sección Tipos de URL.
2. Haz clic en el botón + y agrega un esquema de URL para tu ID de cliente invertido. Para encontrar este valor, abre el archivo de configuración GoogleService-Info.plist y busca la clave REVERSED_CLIENT_ID. Copia el valor de esa clave y pégalo en el cuadro Esquemas de URL de la página de configuración. Deja los demás campos en blanco.
3. Cuando termines, la configuración debería ser similar a la que se muestra a continuación (pero con los valores específicos de tu aplicación):

Cómo establecer clientID para Acceder con Google

Después de configurar Firebase, podemos usar el clientID para configurar el Acceso con Google dentro del método "didFinishLaunchingWithOptions:".

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
}

Agrega el controlador de acceso

Una vez que el resultado del Acceso con Google sea exitoso, usa la cuenta para autenticar con 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
      }
    }
  }

Permite que el usuario acceda automáticamente. Luego, agrega un objeto de escucha a Firebase Auth para permitir que el usuario ingrese a la app después de acceder correctamente. Además, quita el objeto de escucha en 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)
    }
  }

Salir

Agrega el método de salida

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

Cómo probar la lectura de mensajes como usuario que accedió a su cuenta

1. Haz clic en el botón Ejecutar.
2. Deberías ir de inmediato a la pantalla de acceso. Presiona el botón de acceso de Google.
3. Si todo funciona bien, deberías ir a la pantalla de mensajería.

6. Cómo activar Realtime Database

Cómo importar mensajes

En tu proyecto de Firebase console, selecciona el elemento Base de datos en la barra de navegación izquierda. En el menú ampliado de la base de datos, selecciona Importar JSON. Navega al archivo initial_messages.json en el directorio friendlychat, selecciónalo y, luego, haz clic en el botón Importar. Esto reemplazará todos los datos que se encuentren actualmente en tu base de datos. También puedes editar la base de datos directamente con el signo + verde y la X roja para agregar y quitar elementos.

Después de la importación, tu base de datos debería verse de la siguiente manera:

Confirma la dependencia de la base de datos de Firebase

En el bloque de dependencias del archivo Podfile, confirma que se incluya Firebase/Database.

Podfile

pod 'Firebase/Database'

Cómo sincronizar mensajes existentes

Agrega código que sincronice los mensajes agregados recientemente con la IU de la app.

El código que agregues en esta sección hará lo siguiente:

• Inicializa la base de datos de Firebase y agrega un objeto de escucha para controlar los cambios que se realicen en ella.
• Actualiza DataSnapshot para que se muestren los mensajes nuevos.

Modifica los métodos "deinit", "configureDatabase" y "tableView:cellForRow indexPath:" de FCViewController. Reemplaza el código por el que se define a continuación:

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
  }

Cómo probar la sincronización de mensajes

1. Haz clic en el botón Ejecutar.
2. Haz clic en el botón Acceder para comenzar para ir a la ventana de mensajes.
3. Para agregar mensajes nuevos directamente en Firebase console, haz clic en el símbolo verde + junto a la entrada "messages" y agrega un objeto como el siguiente:
4. Confirma que aparezcan en la IU de Friendly Chat.

7. Enviar mensajes

Cómo implementar la función Send Message

Envía valores a la base de datos. Cuando uses el método push para agregar datos a Firebase Realtime Database, se agregará un ID automático. Estos IDs generados automáticamente son secuenciales, lo que garantiza que los mensajes nuevos se agreguen en el orden correcto.

Modifica el método "sendMessage:" de tu FCViewController y reemplázalo por el código que se define a continuación:

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

Cómo probar el envío de mensajes

1. Haz clic en el botón Ejecutar.
2. Haz clic en Acceder para ir a la ventana de mensajes.
3. Escribe un mensaje y presiona Enviar. El mensaje nuevo debería ser visible en la IU de la app y en Firebase console.

8. Almacena y recibe imágenes

Confirma la dependencia de Firebase Storage

En el bloque de dependencias de Podfile, confirma que se incluya Firebase/Storage.

Podfile

pod 'Firebase/Storage'

Cómo configurar Cloud Storage para Firebase

Sigue estos pasos para configurar Cloud Storage para Firebase en tu proyecto de Firebase:

1. En el panel izquierdo de Firebase console, expande Compilación y, luego, selecciona Almacenamiento.
2. Haz clic en Comenzar.
3. Selecciona una ubicación para tu bucket de Storage predeterminado.
   Los buckets de US-WEST1, US-CENTRAL1 y US-EAST1 pueden aprovechar el nivel “Siempre gratis” de Google Cloud Storage. Los buckets de todas las demás ubicaciones siguen los precios y el uso de Google Cloud Storage.
4. Haz clic en Iniciar en modo de prueba. Lee la renuncia de responsabilidad sobre las reglas de seguridad.
   Más adelante en este codelab, agregarás reglas de seguridad para proteger tus datos. No distribuyas ni expongas una app públicamente sin agregar reglas de seguridad para tu bucket de almacenamiento.
5. Haz clic en Crear.

Configura FirebaseStorage

FCViewController.swift

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

Cómo recibir imágenes en mensajes existentes

Agrega código que descargue imágenes de Firebase Storage.

Modifica el método "tableView: cellForRowAt indexPath:" de FCViewController y reemplázalo por el código que se define a continuación:

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. Cómo enviar mensajes con imágenes

Implementa Almacenar y enviar imágenes

Sube una imagen del usuario y, luego, sincroniza la URL de almacenamiento de esta imagen con la base de datos para que se envíe dentro del mensaje.

Modifica el método "imagePickerController: didFinishPickingMediaWithInfo:" de tu FCViewController y reemplázalo por el código que se define a continuación:

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

Cómo probar el envío y la recepción de mensajes con imágenes

1. Haz clic en el botón Run.
2. Haz clic en Acceder para ir a la ventana de mensajes.
3. Haz clic en el ícono "Agregar una foto" para elegir una. El mensaje nuevo con la foto debería ser visible en la IU de la app y en Firebase console.

10. ¡Felicitaciones!

Utilizaste Firebase para compilar fácilmente una aplicación de chat en tiempo real.

Temas abordados

• Realtime Database
• Acceso federado
• Almacenamiento

Más información

• Firebase.google.com