Cómo usar Firestore de Firebase en una aplicación iOS

Spanish (Español) translation by lás (you can also view the original English article)

En este tutorial, aprenderá cómo administrar datos en una base de datos Firestore de Firebas.

Para obtener algunos antecedentes sobre Firebase e instrucciones sobre cómo configurar su base de datos de Firestore, lea mi publicación anterior Introducción a Firebase.

Datos, documentos y colecciones

Trabajar con Firestore, datos, documentos y colecciones son los conceptos clave que debemos entender.

Datos

Los datos pueden ser cualquiera de los siguientes tipos:

String (Cadenas)
Number (Numeros)
Boolean (Booleano)
Map (Mapa)
Array (matriz)
Null (Nulo)
Timestamp (Marca de tiempo)
Geopoint (Geopunto)
Reference (Referencia)

Documentos

Los documentos contienen elementos de datos en un conjunto de pares clave-valor. Firebase Firestore está optimizado para almacenar grandes colecciones de documentos. Un documento es un registro ligero con campos que se asignan a valores. Cada documento se identifica por un nombre.

Por ejemplo, podríamos describir un documento Country de la siguiente manera:

1	Country
2	Name: "Canada"
3	Capital: "Ottawa"

Aquí, Country (País) es el documento que contiene dos campos: Name (Nombre) y Capital.

Colecciones

Las colecciones contienen conjuntos de documentos. Los documentos viven en colecciones, que son simplemente contenedores para documentos. Por ejemplo, podría tener una colección de países para contener sus diversos Countries (países), cada uno representado por un documento:

Countries 
    Country
        Name: “India”
        Capital: “New Delhi”
    Country
        Name: “England”
        Capital: “London"

En resumen, los datos son parte de un documento, que pertenece a una colección.

Aprenderemos más sobre datos, documentos y colecciones creando una aplicación muestra.

Creando una nueva aplicación Firebase

Para comenzar, deberá crear un nuevo proyecto Xcode y configurarlo en el portal Firestore de Firebase.

Primero, cree un proyecto en Xcode y asígnele el nombre ToDoApp. Luego, crea un proyecto correspondiente en Firebase y también llámalo ToDoApp.

Create a project in Firebase and name it ToDoApp

A continuación, registre su aplicación con un identificador de paquete.

Firebase creará un archivo de configuración para que lo incluyas en tu proyecto. Descarga el archivo de configuración y agrégalo a la raíz de su proyecto Xcode como se ve.

Aquí hay una captura de pantalla de la estructura de la carpeta de mi proyecto con el archivo de configuración de GoogleService resaltado.

The GoogleService config file in the project folder

A continuación, debes instalar CocoaPods para Firebase. CocoaPods facilita la instalación y administración de dependencias externas, como bibliotecas o marcos de terceros en sus proyectos de Xcode. Si aún no tienes un Podfile, siga las instrucciones para crear uno. Luego agrega los servicios básicos de Firebase a Podfile y ejecuta pod install.

A continuación, el asistente de configuración de Firebase dará un código para agregar a AppDelegate. Copie las líneas resaltadas a continuación en el archivo AppDelegate.

Add initialization code to your AppDelegate file

Cuando haya completado todos estos pasos, la pantalla de configuración del proyecto en Firebase se verá así:

Firebase project setup screen awaiting verification

Para completar la instalación, debe hacer que su aplicación se comunique con el servidor Firebase. Simplemente ejecute su proyecto Xcode y regrese a la pantalla de configuración del proyecto en Firebase, y debería ver algo como esto:

Manejo de datos en una aplicación Firebase

Ahora que hemos terminado con la configuración inicial, comencemos a manejar los datos en nuestra aplicación.

En esta sección del tutorial, crearemos una aplicación para editar, eliminar y leer datos sobre tareas. Pero antes de comenzar a agregar o crear tareas, debemos pensar en los campos que necesitaríamos para una tarea. Dado que esta es una aplicación simple, nos quedaremos con un solo campo:

task_details: texto que describe la tarea

También necesitamos una colección, que nombraremos tasks (tareas), y contendrá estos documentos Task (tarea). Así es como se verá la estructura:

tasks
    Task
        task_details
    Task
        task_details 

Para representar estos datos, creemos una clase de modelo task simple en TaskModel.swift con el siguiente código:

import Foundation

public struct TaskModelDetails {
    var taskDetails: String

    init(taskDetails: String){
        self.taskDetails = taskDetails
    }
}

class TaskModel {
    var task: TaskModelDetails
    
    init(task: TaskModelDetails) {
        self.task = TaskModelDetails(taskDetails: task.taskDetails)
    }
}

Tareas de lectura de la colección

Mostraremos las tareas en una vista de tabla simple.

Primero, creemos una clase ToDoListViewController.swift. Luego, agregue ToDoListViewController en Main.storyboard y conéctelo a ToDoListViewController.swift. Agregue un UITableView a ToDoListViewController en el storyboard e implemente delegados.

Ahora crearemos ListService.swift para guardar el código para recuperar los datos de la tarea. Comience importando FirebaseFirestore. Luego cree una instancia de Firestore con Firestore.firestore(). ListService.swift debería tener el siguiente aspecto:

import Foundation
import FirebaseFirestore

class ListService {
    let db = Firestore.firestore()
}

A continuación, agregaremos el método completeList en la clase ListService. Obtendremos todos los datos y documentos de la colección tasks mediante el método getDocuments() de Firebase. Esto devolverá datos o un error.

1	func completeList(completion: @escaping (Bool, [TaskModel]) -> ()){
2	db.collection("tasks").getDocuments() { (querySnapshot, err) in
3	}
4	}

En este código, querySnapshot contiene los datos devueltos. Será nulo si no hay una colección con el nombre tasks.

Aquí está el resto de la función completeList: recupera los datos de la tarea y llama a la devolución de llamada de finalización con los datos recuperados.

func completeList(completion: @escaping (Bool, [TaskModel]) -> ()){
    var tasks = [TaskModel]()
    db.collection("tasks").getDocuments() { (querySnapshot, err) in
        if let err = err {
            print("Error getting documents: \(err)")
            completion(false, tasks)
        } else {
            for document in querySnapshot!.documents {
                print("\(document.documentID) => \(document.data())")
            }
            completion(true, tasks)
        }
    }
}

¡Probémoslo! Use el siguiente código para llamar a completeList desde ToDoListViewController.

import Foundation
import UIKit

class ToDoListViewController: UIViewController, UITableViewDelegate, UITableViewDataSource, UIGestureRecognizerDelegate{
    let taskService = ListService()
    override func viewDidLoad() {
        super.viewDidLoad()
        getAllTasks()
    }

    func getAllTasks() {
        taskService.completeList(completion: { (status, tasks) in
            print(status)
        })
    }
}

No debería haber errores, pero querySnapshot será nulo ya que todavía no tenemos ningún documento en nuestra colección. En la siguiente sección, agregaremos algunos datos y luego intentaremos llamar al método completeList nuevamente.

Agregando tareas a la colección

Creemos un método addToList en ListService().

1	func addToList(taskDescription: String, completion: @escaping (Bool) -> ()) {
2	completion(false)
3	}

Usamos la descripción de la tarea pasada para crear una instancia taskData y agregarla a la colección tasks. Para hacer esto, usaremos el método addDocument de Firestore Firebase.

  func addToList(taskDescription: String, completion: @escaping (Bool) -> ()) {
        var ref: DocumentReference? = nil

        ref = db.collection("tasks").addDocument(data: [
            "task_details": taskDescription,
            "task_id" : "",
            ]) { err in
                if let err = err {
                    print("Error adding document: \(err)")
                    completion(false)
                } else {
                    print("Document added with ID: \(ref!.documentID)")
                    completion(true)
                }
        }
    }

Si no hay ningún error, imprimiremos la identificación del documento y devolveremos verdadero en nuestro bloque de finalización. task_id será la identificación del documento. Por ahora, solo enviaremos la cadena vacía, pero eventualmente actualizaremos el task_id con la identificación correcta del documento.

Agreguemos algunos datos de prueba llamando a addToList desde ViewController. Después de ejecutar el siguiente código, regrese a la consola y verá que se agregó una entrada. Ahora, ejecutar getAllTasks() debería devolver true y un recuento de tareas a 1.

import Foundation
import UIKit

class ToDoListViewController: UIViewController, UITableViewDelegate, UITableViewDataSource, UIGestureRecognizerDelegate{
    
    let taskService = ListService()
    override func viewDidLoad() {
        super.viewDidLoad()
        addTask(taskText: "Buy Grocery")
        getAllTasks()
    }

    func addTask(taskText: String) {
        taskService.addToList(taskDescription: text, completion: { (status) in
            if status {
                print("Status", status)
            }
        })
    }
    
     func getAllTasks() {
        taskService.completeList(completion: { (status, tasks) in
            print(tasks.count)
        })
    }
}

Por supuesto, en una aplicación real, ¡querrás crear una interfaz de usuario para agregar tareas!.

Eliminar un documento de tarea en Firestore

Finalmente, veamos cómo podemos eliminar un documento en Firestore. Vuelva a la consola de Firebase Firestore y tome nota del valor de identificación del documentopara "Buy Groceries" ("Comprar comestibles"). Vamos a eliminar el documento según la identificación del documento.

Ahora, agregue un método deleteFromList a ListService como se muestra a continuación.

func deleteFromList(taskId: String, completion: @escaping (Bool) -> ()){
    db.collection("tasks").document(taskId).delete() { err in
        if let err = err {
            print("Error removing document: \(err)")
            completion(false)
        } else {
            completion(true)
        }
    }
}

Llamemos a deleteFromList desde ToDoListViewController. Le pasaremos la identificación del documento de "Buy Groceries", ("Comprar comestibles"), que copiamos de la consola de Firebase.

import Foundation
import UIKit

class ToDoListViewController: UIViewController, UITableViewDelegate, UITableViewDataSource, UIGestureRecognizerDelegate{
    let taskService = ListService()
    
    override func viewDidLoad() {
        super.viewDidLoad()
        deleteTask(taskId: "ddiqw8bcnalkfhcavr")
    }

    func deleteTask(taskId: String) {
        taskService.deletFromList(taskId: taskId, completion: { (status) in
            print(status)
        })
    }
}

Al ejecutar el código anterior, debería ver status como true. Si vas a la consola Firestore, deberías ver que la tarea "Buy Groceries" ha sido eliminada.

Conclusión

Con eso, has aprendido cómo crear, leer y eliminar datos de una base de datos de Firebase con Firestore. En este tutorial, creamos una aplicación para administrar tareas usando Xcode y Firebase. Con suerte, esto te ha dado algunas habilidades nuevas que podrá poner en práctica en sus próximos proyectos.

Para que esta aplicación sea más funcional, puede implementar métodos de delegado de vista de tabla para mostrar las tareas de su base de datos, un UITextField para agregar nuevas tareas y un gesto de deslizamiento para eliminar tareas. ¡Pruébalo!

Si tiene alguna pregunta, hágamelo saber en los comentarios.