1. Información general
Objetivos
En este codelab, crearás una aplicación de recomendación de restaurantes respaldada por Firestore en iOS en Swift. Aprenderás cómo:
- Leer y escribir datos en Firestore desde una aplicación de iOS
- Escuche los cambios en los datos de Firestore en tiempo real
- Utilice la autenticación de Firebase y las reglas de seguridad para proteger los datos de Firestore
- Escribe consultas complejas de Firestore
Requisitos previos
Antes de comenzar este codelab, asegúrese de haber instalado:
- Xcode versión 14.0 (o superior)
- CocoaPods 1.12.0 (o superior)
2. Crear proyecto de consola Firebase
Agregar Firebase al proyecto
- Vaya a la consola de Firebase .
- Seleccione Crear nuevo proyecto y nombre su proyecto "Firestore iOS Codelab".
3. Obtenga el proyecto de muestra
Descargar el Código
Comience clonando el proyecto de muestra y ejecutando pod update en el directorio del proyecto:
git clone https://github.com/firebase/friendlyeats-ios cd friendlyeats-ios pod update
Abra FriendlyEats.xcworkspace en Xcode y ejecútelo (Cmd+R). La aplicación debería compilarse correctamente y fallar inmediatamente al iniciarse, ya que le falta un archivo GoogleService-Info.plist . Lo corregiremos en el siguiente paso.
Configurar base de fuego
Siga la documentación para crear un nuevo proyecto de Firestore. Una vez que tenga su proyecto, descargue el archivo GoogleService-Info.plist de su proyecto desde Firebase console y arrástrelo a la raíz del proyecto Xcode. Ejecute el proyecto nuevamente para asegurarse de que la aplicación se configure correctamente y ya no falle al iniciarse. Después de iniciar sesión, debería ver una pantalla en blanco como en el siguiente ejemplo. Si no puede iniciar sesión, asegúrese de haber habilitado el método de inicio de sesión por correo electrónico/contraseña en Firebase console en Autenticación.
4. Escribe datos en Firestore
En esta sección escribiremos algunos datos en Firestore para poder completar la interfaz de usuario de la aplicación. Esto se puede hacer manualmente a través de la consola Firebase , pero lo haremos en la propia aplicación para demostrar una escritura básica en Firestore.
El objeto modelo principal de nuestra aplicación es un restaurante. Los datos de Firestore se dividen en documentos, colecciones y subcolecciones. Almacenaremos cada restaurante como un documento en una colección de nivel superior llamada restaurants . Si desea obtener más información sobre el modelo de datos de Firestore, lea sobre documentos y colecciones en la documentación .
Antes de que podamos agregar datos a Firestore, necesitamos obtener una referencia a la colección de restaurantes. Agregue lo siguiente al bucle for interno en el método RestaurantsTableViewController.didTapPopulateButton(_:) .
let collection = Firestore.firestore().collection("restaurants")
Ahora que tenemos una referencia de colección podemos escribir algunos datos. Agregue lo siguiente justo después de la última línea de código que agregamos:
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)
El código anterior agrega un nuevo documento a la colección de restaurantes. Los datos del documento provienen de un diccionario, que obtenemos de una estructura de restaurante.
Ya casi llegamos: antes de que podamos escribir documentos en Firestore, debemos abrir las reglas de seguridad de Firestore y describir qué partes de nuestra base de datos deben poder escribirse por qué usuarios. Por ahora, solo permitiremos que los usuarios autenticados lean y escriban en toda la base de datos. Esto es demasiado permisivo para una aplicación de producción, pero durante el proceso de creación de la aplicación queremos algo lo suficientemente relajado para no tener problemas de autenticación constantemente mientras experimentamos. Al final de este codelab hablaremos sobre cómo reforzar sus reglas de seguridad y limitar la posibilidad de lecturas y escrituras no deseadas.
En la pestaña Reglas de Firebase console, agregue las siguientes reglas y luego haga clic en Publicar .
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;
}
}
}
Analizaremos las reglas de seguridad en detalle más adelante, pero si tiene prisa, consulte la documentación sobre reglas de seguridad .
Ejecute la aplicación e inicie sesión. Luego toque el botón " Rellenar " en la parte superior izquierda, lo que creará un lote de documentos de restaurante, aunque todavía no verá esto en la aplicación.
A continuación, navegue hasta la pestaña de datos de Firestore en Firebase console. Ahora deberías ver nuevas entradas en la colección de restaurantes:
¡Felicitaciones, acaba de escribir datos en Firestore desde una aplicación de iOS! En la siguiente sección, aprenderá cómo recuperar datos de Firestore y mostrarlos en la aplicación.
5. Mostrar datos de Firestore
En esta sección aprenderá cómo recuperar datos de Firestore y mostrarlos en la aplicación. Los dos pasos clave son crear una consulta y agregar un detector de instantáneas. Este oyente será notificado de todos los datos existentes que coincidan con la consulta y recibirá actualizaciones en tiempo real.
Primero, construyamos la consulta que proporcionará la lista de restaurantes predeterminada y sin filtrar. Eche un vistazo a la implementación de RestaurantsTableViewController.baseQuery() :
return Firestore.firestore().collection("restaurants").limit(to: 50)
Esta consulta recupera hasta 50 restaurantes de la colección de nivel superior denominada "restaurantes". Ahora que tenemos una consulta, debemos adjuntar un detector de instantáneas para cargar datos de Firestore en nuestra aplicación. Agregue el siguiente código al método RestaurantsTableViewController.observeQuery() justo después de la llamada a 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()
}
El código anterior descarga la colección de Firestore y la almacena en una matriz localmente. La llamada addSnapshotListener(_:) agrega un detector de instantáneas a la consulta que actualizará el controlador de vista cada vez que los datos cambien en el servidor. Recibimos actualizaciones automáticamente y no tenemos que realizar cambios manualmente. Recuerde, este detector de instantáneas se puede invocar en cualquier momento como resultado de un cambio en el servidor, por lo que es importante que nuestra aplicación pueda manejar los cambios.
Después de asignar nuestros diccionarios a estructuras (consulte Restaurant.swift ), mostrar los datos es solo cuestión de asignar algunas propiedades de vista. Agregue las siguientes líneas a RestaurantTableViewCell.populate(restaurant:) en RestaurantsTableViewController.swift .
nameLabel.text = restaurant.name
cityLabel.text = restaurant.city
categoryLabel.text = restaurant.category
starsView.rating = Int(restaurant.averageRating.rounded())
priceLabel.text = priceString(from: restaurant.price)
Este método de llenado se llama desde el método tableView(_:cellForRowAtIndexPath:) de la fuente de datos de la vista de tabla, que se encarga de asignar la colección de tipos de valores anteriores a las celdas individuales de la vista de tabla.
Ejecute la aplicación nuevamente y verifique que los restaurantes que vimos anteriormente en la consola ahora estén visibles en el simulador o dispositivo. Si completó esta sección con éxito, su aplicación ahora lee y escribe datos con Cloud Firestore.
6. Ordenar y filtrar datos
Actualmente nuestra aplicación muestra una lista de restaurantes, pero no hay forma de que el usuario filtre según sus necesidades. En esta sección utilizará las consultas avanzadas de Firestore para habilitar el filtrado.
A continuación se muestra un ejemplo de una consulta sencilla para buscar todos los restaurantes de Dim Sum:
let filteredQuery = query.whereField("category", isEqualTo: "Dim Sum")
Como su nombre lo indica, el método whereField(_:isEqualTo:) hará que nuestra consulta descargue solo los miembros de la colección cuyos campos cumplan con las restricciones que establecimos. En este caso, solo descargará restaurantes cuya category sea "Dim Sum" .
En esta aplicación, el usuario puede encadenar múltiples filtros para crear consultas específicas, como "Pizza en San Francisco" o "Mariscos en Los Ángeles ordenados por popularidad".
Abra RestaurantsTableViewController.swift y agregue el siguiente bloque de código en medio de 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)
}
El fragmento anterior agrega múltiples cláusulas whereField y order para crear una única consulta compuesta basada en la entrada del usuario. Ahora nuestra consulta solo devolverá restaurantes que coincidan con los requisitos del usuario.
Ejecute su proyecto y verifique que puede filtrar por precio, ciudad y categoría (asegúrese de escribir exactamente los nombres de la categoría y la ciudad). Mientras realiza la prueba, es posible que vea errores en sus registros como este:
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/project-id/database/firestore/indexes?create_composite=..."
UserInfo={NSLocalizedDescription=The query requires an index. You can create it here: https://console.firebase.google.com/project/project-id/database/firestore/indexes?create_composite=...}
Esto se debe a que Firestore requiere índices para la mayoría de las consultas compuestas. Requerir índices en las consultas mantiene a Firestore rápido y a escala. Al abrir el enlace del mensaje de error, se abrirá automáticamente la interfaz de usuario de creación de índices en Firebase console con los parámetros correctos completados. Para obtener más información sobre los índices en Firestore, visite la documentación .
7. Escribir datos en una transacción
En esta sección, agregaremos la posibilidad de que los usuarios envíen reseñas sobre restaurantes. Hasta ahora, todas nuestras escrituras han sido atómicas y relativamente simples. Si alguno de ellos falla, probablemente le pediremos al usuario que lo vuelva a intentar o que lo vuelva a intentar automáticamente.
Para agregar una calificación a un restaurante, necesitamos coordinar múltiples lecturas y escrituras. Primero se debe enviar la reseña en sí y luego se debe actualizar el recuento de calificaciones y la calificación promedio del restaurante. Si uno de estos falla pero no el otro, nos quedamos en un estado inconsistente donde los datos de una parte de nuestra base de datos no coinciden con los datos de otra.
Afortunadamente, Firestore proporciona una funcionalidad de transacciones que nos permite realizar múltiples lecturas y escrituras en una sola operación atómica, lo que garantiza que nuestros datos sigan siendo consistentes.
Agregue el siguiente código debajo de todas las declaraciones let en RestaurantDetailViewController.reviewController(_:didSubmitFormWithReview:) .
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)
}
}
}
Dentro del bloque de actualización, Firestore tratará todas las operaciones que realicemos utilizando el objeto de transacción como una única actualización atómica. Si la actualización falla en el servidor, Firestore la reintentará automáticamente varias veces. Esto significa que nuestra condición de error probablemente sea un único error que ocurre repetidamente, por ejemplo, si el dispositivo está completamente fuera de línea o el usuario no está autorizado a escribir en la ruta que está intentando escribir.
8. Normas de seguridad
Los usuarios de nuestra aplicación no deberían poder leer ni escribir todos los datos de nuestra base de datos. Por ejemplo, todo el mundo debería poder ver las valoraciones de un restaurante, pero sólo un usuario autenticado debería poder publicar una valoración. No es suficiente escribir un buen código en el cliente, debemos especificar nuestro modelo de seguridad de datos en el backend para que sea completamente seguro. En esta sección aprenderemos cómo utilizar las reglas de seguridad de Firebase para proteger nuestros datos.
Primero, echemos un vistazo más profundo a las reglas de seguridad que escribimos al comienzo del codelab. Abra Firebase console y navegue hasta Base de datos > Reglas en la pestaña 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;
}
}
}
La variable request en las reglas anteriores es una variable global disponible en todas las reglas, y el condicional que agregamos garantiza que la solicitud se autentique antes de permitir a los usuarios hacer algo. Esto evita que usuarios no autenticados utilicen la API de Firestore para realizar cambios no autorizados en sus datos. Este es un buen comienzo, pero podemos usar las reglas de Firestore para hacer cosas mucho más poderosas.
Restrinjamos las escrituras de reseñas para que el ID de usuario de la revisión coincida con el ID del usuario autenticado. Esto garantiza que los usuarios no puedan hacerse pasar por otros y dejar reseñas fraudulentas. Reemplace sus reglas de seguridad con las siguientes:
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;
}
}
}
La primera declaración de coincidencia coincide con la subcolección denominada ratings de cualquier documento que pertenezca a la colección restaurants . La condición allow write evita que se envíe cualquier revisión si el ID de usuario de la revisión no coincide con el del usuario. La segunda declaración de coincidencia permite a cualquier usuario autenticado leer y escribir restaurantes en la base de datos.
Esto funciona muy bien para nuestras reseñas, ya que hemos utilizado reglas de seguridad para establecer explícitamente la garantía implícita que escribimos anteriormente en nuestra aplicación: que los usuarios solo pueden escribir sus propias reseñas. Si agregáramos una función de edición o eliminación para las reseñas, exactamente este mismo conjunto de reglas también evitaría que los usuarios modifiquen o eliminen las reseñas de otros usuarios. Pero las reglas de Firestore también se pueden usar de una manera más granular para limitar las escrituras en campos individuales dentro de los documentos en lugar de en los documentos completos. Podemos usar esto para permitir a los usuarios actualizar solo las calificaciones, la calificación promedio y la cantidad de calificaciones de un restaurante, eliminando la posibilidad de que un usuario malintencionado altere el nombre o la ubicación de un restaurante.
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;
}
}
}
Aquí hemos dividido nuestro permiso de escritura en crear y actualizar para que podamos ser más específicos sobre qué operaciones deben permitirse. Cualquier usuario puede escribir restaurantes en la base de datos, conservando la funcionalidad del botón Completar que creamos al inicio del codelab, pero una vez que se escribe un restaurante, su nombre, ubicación, precio y categoría no se pueden cambiar. Más específicamente, la última regla requiere que cualquier operación de actualización de un restaurante mantenga el mismo nombre, ciudad, precio y categoría de los campos ya existentes en la base de datos.
Para obtener más información sobre lo que puede hacer con las reglas de seguridad, consulte la documentación .
9. Conclusión
En este codelab, aprendió cómo realizar lecturas y escrituras básicas y avanzadas con Firestore, así como también cómo proteger el acceso a los datos con reglas de seguridad. Puede encontrar la solución completa en la rama codelab-complete .
Para obtener más información sobre Firestore, visite los siguientes recursos: