Descubre Firebase para Flutter

1. Antes de comenzar

En este codelab, aprenderás algunos de los conceptos básicos de Firebase que te permitirán crear apps de Flutter para dispositivos móviles en iOS y Android.

Requisitos previos

Qué aprenderás

  • Cómo compilar una app de chat para confirmar asistencia y un libro de visitas a un evento en Android, iOS, la Web y macOS con Flutter.
  • Cómo autenticar usuarios con Firebase Authentication y sincronizar datos con Firestore.

La pantalla principal de la app en Android

La pantalla principal de la app en iOS

Requisitos

Cualquiera de los siguientes dispositivos:

  • Un dispositivo Android o iOS físico conectado a tu computadora y configurado en modo de desarrollador
  • El simulador de iOS (requiere herramientas de Xcode)
  • Android Emulator (requiere configuración en Android Studio)

También necesitas lo siguiente:

  • Un navegador que elijas, como Google Chrome.
  • Un IDE o editor de texto que prefieras y configurado con los complementos de Dart y Flutter, como Android Studio o Visual Studio Code
  • La versión más reciente de stable de Flutter o beta si te gusta vivir al límite
  • Una Cuenta de Google para la creación y administración de tu proyecto de Firebase.
  • Accediste a tu Cuenta de Google con la CLI de Firebase.

2. Obtén el código de muestra

Descarga la versión inicial de tu proyecto desde GitHub:

  1. Desde la línea de comandos, clona el repositorio de GitHub en el directorio flutter-codelabs:
git clone https://github.com/flutter/codelabs.git flutter-codelabs

El directorio flutter-codelabs contiene el código de una colección de codelabs. El código de este codelab se encuentra en el directorio flutter-codelabs/firebase-get-to-know-flutter. El directorio contiene una serie de instantáneas que muestran cómo debería verse tu proyecto al final de cada paso. Por ejemplo, estás en el segundo paso.

  1. Busca los archivos coincidentes para el segundo paso:
cd flutter-codelabs/firebase-get-to-know-flutter/step_02

Si deseas adelantar o ver cómo debería verse algo después de un paso, busca en el directorio que lleva el nombre del paso que te interesa.

Importa la app de partida

  • Abre o importa el directorio flutter-codelabs/firebase-get-to-know-flutter/step_02 en tu IDE preferido. Este directorio contiene el código de partida para el codelab, que consiste en una app de Meetup de Flutter que aún no funciona.

Ubica los archivos que necesitan trabajo

El código de esta app se distribuye en varios directorios. Esta división de funcionalidad facilita el trabajo porque agrupa el código por funcionalidad.

  • Ubica los siguientes archivos:
    • lib/main.dart: Este archivo contiene el punto de entrada principal y el widget de la app.
    • lib/home_page.dart: Este archivo contiene el widget de la página principal.
    • lib/src/widgets.dart: Este archivo contiene algunos widgets para ayudar a estandarizar el estilo de la app. Forman la pantalla de la app de partida.
    • lib/src/authentication.dart: Este archivo contiene una implementación parcial de Authentication con un conjunto de widgets que crean una experiencia del usuario que permite acceder a la autenticación por correo electrónico de Firebase. Estos widgets para el flujo de Auth aún no se usan en la app de partida, pero los agregarás pronto.

Agregas archivos adicionales según sea necesario para compilar el resto de la app.

Revisa el archivo lib/main.dart

Esta app aprovecha el paquete google_fonts para hacer que Roboto sea la fuente predeterminada en toda la app. Puedes explorar fonts.google.com y usar las fuentes que descubras allí en diferentes partes de la app.

Usa los widgets auxiliares del archivo lib/src/widgets.dart en forma de Header, Paragraph y IconAndDetail. Estos widgets eliminan el código duplicado para reducir el desorden en el diseño de página descrito en HomePage. Esto también permite una apariencia coherente.

Así se ve tu app en Android, iOS, la Web y macOS:

La pantalla principal de la app en Android

La pantalla principal de la app en iOS

La pantalla principal de la app en la Web

La pantalla principal de la app en macOS

3. Crea y configura un proyecto de Firebase

La visualización de la información del evento es excelente para tus invitados, pero no es muy útil para nadie por sí sola. Debes agregar algunas funciones dinámicas a la app. Para hacerlo, debes conectar Firebase a la app. Para comenzar a usar Firebase, debes crear y configurar un proyecto de Firebase.

Crea un proyecto de Firebase

  1. Accede a Firebase.
  2. En la consola, haz clic en Agregar proyecto o Crear un proyecto.
  3. En el campo Nombre del proyecto, ingresa Firebase-Flutter-Codelab y, luego, haz clic en Continuar.

4395e4e67c08043a.png

  1. Haz clic para avanzar por las opciones de creación de proyectos. Si se te solicita, acepta las condiciones de Firebase, pero omite la configuración de Google Analytics porque no utilizarás la plataforma para esta app.

b7138cde5f2c7b61.png

Para obtener más información sobre los proyectos de Firebase, consulta la Información sobre los proyectos de Firebase.

La app usa los siguientes productos de Firebase, que están disponibles para las apps web:

  • Authentication: Permite que los usuarios accedan a tu app.
  • Firestore: Guarda datos estructurados en la nube y recibe notificaciones instantáneas cuando cambian los datos.
  • Reglas de seguridad de Firebase: Protege tu base de datos.

Algunos de estos productos necesitan una configuración especial o debes habilitarlos en Firebase console.

Habilitar la autenticación de acceso con correo electrónico

  1. En el panel Descripción general del proyecto de Firebase console, expande el menú Compilación.
  2. Haz clic en Autenticación > Comenzar > Método de acceso > Correo electrónico/Contraseña > Habilitar > Guardar.

58e3e3e23c2f16a4.png

Habilita Firestore

La aplicación web usa Firestore para guardar mensajes de chat y recibir mensajes de chat nuevos.

Habilita Firestore:

  • En el menú Compilar, haz clic en Base de datos de Firestore > Crear base de datos.

99e8429832d23fa3.png

  1. Selecciona Comenzar en modo de prueba y, luego, lee la renuncia de responsabilidad sobre las reglas de seguridad. El modo de prueba garantiza que puedas escribir con libertad en la base de datos durante el desarrollo.

6be00e26c72ea032.png

  1. Haz clic en Siguiente y, luego, selecciona la ubicación para tu base de datos. Puedes usar el predeterminado. No podrás cambiar la ubicación más adelante.

278656eefcfb0216.png

  1. Haz clic en Habilitar.

4. Configura Firebase

Si quieres usar Firebase con Flutter, debes completar las siguientes tareas para configurar el proyecto de Flutter y usar las bibliotecas FlutterFire correctamente:

  1. Agrega las dependencias FlutterFire a tu proyecto.
  2. Registra la plataforma deseada en el proyecto de Firebase.
  3. Descarga el archivo de configuración específico de la plataforma y, luego, agrégalo al código.

En el directorio de nivel superior de tu app de Flutter, encontrarás los subdirectorios android, ios, macos y web, que contienen los archivos de configuración específicos de la plataforma para iOS y Android, respectivamente.

Configura dependencias

Debes agregar las bibliotecas FlutterFire para los dos productos de Firebase que usas en esta app: Authentication y Firestore.

  • Desde la línea de comandos, agrega las siguientes dependencias:
$ flutter pub add firebase_core

El paquete firebase_core es el código común requerido para todos los complementos de Firebase para Flutter.

$ flutter pub add firebase_auth

El paquete firebase_auth permite la integración con Authentication.

$ flutter pub add cloud_firestore

El paquete cloud_firestore habilita el acceso al almacenamiento de datos de Firestore.

$ flutter pub add provider

El paquete firebase_ui_auth proporciona un conjunto de widgets y utilidades para aumentar la velocidad de los desarrolladores con flujos de autenticación.

$ flutter pub add firebase_ui_auth

Agregaste los paquetes necesarios, pero también debes configurar los proyectos de iOS, Android, macOS y Web Runner para usar Firebase de forma apropiada. También puedes usar el paquete provider, que permite separar la lógica empresarial de la lógica de visualización.

Instala la CLI de FlutterFire

La CLI de FlutterFire depende de Firebase CLI subyacente.

  1. Si aún no lo has hecho, instala Firebase CLI en tu máquina.
  2. Instala la CLI de FlutterFire:
$ dart pub global activate flutterfire_cli

Una vez instalado, el comando flutterfire estará disponible de manera global.

Configura tus apps

La CLI extrae información de tu proyecto de Firebase y las apps seleccionadas del proyecto para generar toda la configuración de una plataforma específica.

En la raíz de tu app, ejecuta el comando configure:

$ flutterfire configure

El comando de configuración te guía a través de los siguientes procesos:

  1. Selecciona un proyecto de Firebase según el archivo .firebaserc o desde Firebase console.
  2. Determina las plataformas para la configuración, como Android, iOS, macOS y la Web.
  3. Identifica las apps de Firebase de las que se debe extraer la configuración. De forma predeterminada, la CLI intenta hacer coincidir automáticamente las apps de Firebase según la configuración actual de tu proyecto.
  4. Genera un archivo firebase_options.dart en tu proyecto.

Cómo configurar macOS

Flutter en macOS crea apps completamente protegidas. Debido a que esta app se integra a la red para comunicarse con los servidores de Firebase, debes configurar la app con privilegios de cliente de red.

macos/Runner/DebugProfile.entitlements

<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE plist PUBLIC "-//Apple//DTD PLIST 1.0//EN" "http://www.apple.com/DTDs/PropertyList-1.0.dtd">
<plist version="1.0">
<dict>
	<key>com.apple.security.app-sandbox</key>
	<true/>
	<key>com.apple.security.cs.allow-jit</key>
	<true/>
	<key>com.apple.security.network.server</key>
	<true/>
  <!-- Add the following two lines -->
	<key>com.apple.security.network.client</key>
	<true/>
</dict>
</plist>

macos/Runner/Release.entitlements

<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE plist PUBLIC "-//Apple//DTD PLIST 1.0//EN" "http://www.apple.com/DTDs/PropertyList-1.0.dtd">
<plist version="1.0">
<dict>
	<key>com.apple.security.app-sandbox</key>
	<true/>
  <!-- Add the following two lines -->
	<key>com.apple.security.network.client</key>
	<true/>
</dict>
</plist>

Para obtener más información, consulta Compatibilidad de escritorio con Flutter.

5. Agrega la función para confirmar asistencia

Ahora que agregaste Firebase a la app, puedes crear un botón RSVP que registre a las personas con Authentication. En el caso de las versiones nativas de Android, de iOS y de la Web, hay paquetes FirebaseUI Auth precompilados, pero debes compilar esta capacidad para Flutter.

El proyecto que recuperaste antes incluía un conjunto de widgets que implementa la interfaz de usuario durante la mayor parte del flujo de autenticación. Implementarás la lógica empresarial para integrar Authentication en la app.

Agrega lógica empresarial con el paquete Provider

Usa el paquete provider para hacer que un objeto de estado de la app centralizado esté disponible en todo el árbol de widgets de Flutter de la app:

  1. Crea un archivo nuevo llamado app_state.dart con el siguiente contenido:

lib/app_state.dart.

import 'package:firebase_auth/firebase_auth.dart'
    hide EmailAuthProvider, PhoneAuthProvider;
import 'package:firebase_core/firebase_core.dart';
import 'package:firebase_ui_auth/firebase_ui_auth.dart';
import 'package:flutter/material.dart';

import 'firebase_options.dart';

class ApplicationState extends ChangeNotifier {
  ApplicationState() {
    init();
  }

  bool _loggedIn = false;
  bool get loggedIn => _loggedIn;

  Future<void> init() async {
    await Firebase.initializeApp(
        options: DefaultFirebaseOptions.currentPlatform);

    FirebaseUIAuth.configureProviders([
      EmailAuthProvider(),
    ]);

    FirebaseAuth.instance.userChanges().listen((user) {
      if (user != null) {
        _loggedIn = true;
      } else {
        _loggedIn = false;
      }
      notifyListeners();
    });
  }
}

Las sentencias import presentan Firebase Core y Auth, extraen el paquete provider que hace que el objeto del estado de la app esté disponible en todo el árbol de widgets e incluyen los widgets de autenticación del paquete firebase_ui_auth.

Este objeto de estado de la aplicación ApplicationState tiene una responsabilidad principal en este paso, que es alertar al árbol de widgets de que hubo una actualización en un estado autenticado.

Solo usas un proveedor para comunicar el estado de acceso de un usuario a la app. Para permitir que un usuario acceda, debes usar las IU que proporciona el paquete firebase_ui_auth, que es una excelente manera de iniciar rápidamente las pantallas de acceso en tus apps.

Integra el flujo de autenticación

  1. Modifica las importaciones en la parte superior del archivo lib/main.dart:

lib/main.dart

import 'package:firebase_ui_auth/firebase_ui_auth.dart'; // new
import 'package:flutter/material.dart';
import 'package:go_router/go_router.dart';               // new
import 'package:google_fonts/google_fonts.dart';
import 'package:provider/provider.dart';                 // new

import 'app_state.dart';                                 // new
import 'home_page.dart';
  1. Conecta el estado de la app con la inicialización de la app y, luego, agrega el flujo de autenticación a HomePage:

lib/main.dart

void main() {
  // Modify from here...
  WidgetsFlutterBinding.ensureInitialized();

  runApp(ChangeNotifierProvider(
    create: (context) => ApplicationState(),
    builder: ((context, child) => const App()),
  ));
  // ...to here.
}

La modificación de la función main() hace que el paquete del proveedor sea responsable de la creación de instancias del objeto de estado de la app con el widget ChangeNotifierProvider. Debes usar esta clase provider específica porque el objeto de estado de la app extiende la clase ChangeNotifier, lo que le permite al paquete provider saber cuándo volver a mostrar los widgets dependientes.

  1. Crea una configuración GoRouter para actualizar tu app de modo que controle la navegación a diferentes pantallas que proporciona FirebaseUI:

lib/main.dart

// Add GoRouter configuration outside the App class
final _router = GoRouter(
  routes: [
    GoRoute(
      path: '/',
      builder: (context, state) => const HomePage(),
      routes: [
        GoRoute(
          path: 'sign-in',
          builder: (context, state) {
            return SignInScreen(
              actions: [
                ForgotPasswordAction(((context, email) {
                  final uri = Uri(
                    path: '/sign-in/forgot-password',
                    queryParameters: <String, String?>{
                      'email': email,
                    },
                  );
                  context.push(uri.toString());
                })),
                AuthStateChangeAction(((context, state) {
                  final user = switch (state) {
                    SignedIn state => state.user,
                    UserCreated state => state.credential.user,
                    _ => null
                  };
                  if (user == null) {
                    return;
                  }
                  if (state is UserCreated) {
                    user.updateDisplayName(user.email!.split('@')[0]);
                  }
                  if (!user.emailVerified) {
                    user.sendEmailVerification();
                    const snackBar = SnackBar(
                        content: Text(
                            'Please check your email to verify your email address'));
                    ScaffoldMessenger.of(context).showSnackBar(snackBar);
                  }
                  context.pushReplacement('/');
                })),
              ],
            );
          },
          routes: [
            GoRoute(
              path: 'forgot-password',
              builder: (context, state) {
                final arguments = state.uri.queryParameters;
                return ForgotPasswordScreen(
                  email: arguments['email'],
                  headerMaxExtent: 200,
                );
              },
            ),
          ],
        ),
        GoRoute(
          path: 'profile',
          builder: (context, state) {
            return ProfileScreen(
              providers: const [],
              actions: [
                SignedOutAction((context) {
                  context.pushReplacement('/');
                }),
              ],
            );
          },
        ),
      ],
    ),
  ],
);
// end of GoRouter configuration

// Change MaterialApp to MaterialApp.router and add the routerConfig
class App extends StatelessWidget {
  const App({super.key});

  @override
  Widget build(BuildContext context) {
    return MaterialApp.router(
      title: 'Firebase Meetup',
      theme: ThemeData(
        buttonTheme: Theme.of(context).buttonTheme.copyWith(
              highlightColor: Colors.deepPurple,
            ),
        primarySwatch: Colors.deepPurple,
        textTheme: GoogleFonts.robotoTextTheme(
          Theme.of(context).textTheme,
        ),
        visualDensity: VisualDensity.adaptivePlatformDensity,
        useMaterial3: true,
      ),
      routerConfig: _router, // new
    );
  }
}

Cada pantalla tiene un tipo diferente de acción asociado en función del nuevo estado del flujo de autenticación. Después de la mayoría de los cambios de estado en la autenticación, puedes volver a dirigirte a una pantalla preferida, ya sea la pantalla principal o una pantalla diferente, como el perfil.

  1. En el método de compilación de la clase HomePage, integra el estado de la app con el widget AuthFunc:

lib/home_page.dart

import 'package:firebase_auth/firebase_auth.dart' // new
    hide EmailAuthProvider, PhoneAuthProvider;    // new
import 'package:flutter/material.dart';           // new
import 'package:provider/provider.dart';          // new

import 'app_state.dart';                          // new
import 'src/authentication.dart';                 // new
import 'src/widgets.dart';

class HomePage extends StatelessWidget {
  const HomePage({super.key});

  @override
  Widget build(BuildContext context) {
    return Scaffold(
      appBar: AppBar(
        title: const Text('Firebase Meetup'),
      ),
      body: ListView(
        children: <Widget>[
          Image.asset('assets/codelab.png'),
          const SizedBox(height: 8),
          const IconAndDetail(Icons.calendar_today, 'October 30'),
          const IconAndDetail(Icons.location_city, 'San Francisco'),
          // Add from here
          Consumer<ApplicationState>(
            builder: (context, appState, _) => AuthFunc(
                loggedIn: appState.loggedIn,
                signOut: () {
                  FirebaseAuth.instance.signOut();
                }),
          ),
          // to here
          const Divider(
            height: 8,
            thickness: 1,
            indent: 8,
            endIndent: 8,
            color: Colors.grey,
          ),
          const Header("What we'll be doing"),
          const Paragraph(
            'Join us for a day full of Firebase Workshops and Pizza!',
          ),
        ],
      ),
    );
  }
}

Creas una instancia del widget AuthFunc y lo unes a un widget Consumer. El widget de consumidor es la forma habitual en que se puede usar el paquete provider para recompilar parte del árbol cuando cambia el estado de la app. El widget AuthFunc corresponde a los widgets complementarios que probarás.

Prueba el flujo de autenticación

cdf2d25e436bd48d.png

  1. En la app, presiona el botón RSVP para iniciar SignInScreen.

2a2cd6d69d172369.png

  1. Ingresa una dirección de correo electrónico. Si ya te registraste, el sistema te solicitará que ingreses una contraseña. De lo contrario, el sistema te solicitará que completes el formulario de registro.

e5e65065dba36b54.png

  1. Ingresa una contraseña de menos de seis caracteres para verificar el flujo de manejo de errores. Si estás registrado, en su lugar verás la contraseña.
  2. Ingresar contraseñas incorrectas para verificar el flujo de manejo de errores
  3. Ingresa la contraseña correcta. Verás la experiencia de acceso, que le ofrece al usuario la posibilidad de salir.

4ed811a25b0cf816.png

6. Escribe mensajes en Firestore

Es genial saber que los usuarios vienen, pero necesitas darles a los invitados algo más que hacer en la app. ¿Y si pudieran dejar mensajes en un libro de visitas? Pueden compartir por qué les entusiasma venir o a quién esperan conocer.

Para almacenar los mensajes de chat que los usuarios escriben en la app, usa Firestore.

Modelo de datos

Firestore es una base de datos NoSQL; los datos almacenados en ella se dividen en colecciones, documentos, campos y subcolecciones. Almacenas cada mensaje del chat como un documento en una colección de guestbook, que es una colección de nivel superior.

8c20dc8424bb1d84.png

Agregue mensajes a Firestore

En esta sección, agregarás la funcionalidad para que los usuarios escriban mensajes en la base de datos. Primero, agregas un campo de formulario y un botón de envío, y, luego, agregas el código que conecta estos elementos con la base de datos.

  1. Crea un archivo nuevo llamado guest_book.dart y agrega un widget con estado GuestBook para construir los elementos de la IU de un campo de mensaje y un botón de envío:

lib/guest_book.dart

import 'dart:async';

import 'package:flutter/material.dart';

import 'src/widgets.dart';

class GuestBook extends StatefulWidget {
  const GuestBook({required this.addMessage, super.key});

  final FutureOr<void> Function(String message) addMessage;

  @override
  State<GuestBook> createState() => _GuestBookState();
}

class _GuestBookState extends State<GuestBook> {
  final _formKey = GlobalKey<FormState>(debugLabel: '_GuestBookState');
  final _controller = TextEditingController();

  @override
  Widget build(BuildContext context) {
    return Padding(
      padding: const EdgeInsets.all(8.0),
      child: Form(
        key: _formKey,
        child: Row(
          children: [
            Expanded(
              child: TextFormField(
                controller: _controller,
                decoration: const InputDecoration(
                  hintText: 'Leave a message',
                ),
                validator: (value) {
                  if (value == null || value.isEmpty) {
                    return 'Enter your message to continue';
                  }
                  return null;
                },
              ),
            ),
            const SizedBox(width: 8),
            StyledButton(
              onPressed: () async {
                if (_formKey.currentState!.validate()) {
                  await widget.addMessage(_controller.text);
                  _controller.clear();
                }
              },
              child: Row(
                children: const [
                  Icon(Icons.send),
                  SizedBox(width: 4),
                  Text('SEND'),
                ],
              ),
            ),
          ],
        ),
      ),
    );
  }
}

Hay algunos lugares de interés aquí. Primero, crea una instancia de un formulario para validar que el mensaje realmente incluya contenido y mostrarle al usuario un mensaje de error si no hay ninguno. Para validar un formulario, debes acceder al estado del formulario con un GlobalKey. Para obtener más información sobre las claves y cómo usarlas, consulta Cuándo usarlas.

Además, observa la forma en que los widgets están dispuestos, tienes un Row con un TextFormField y un StyledButton, que contiene un Row. Además, ten en cuenta que TextFormField se une a un widget Expanded, lo que obliga a TextFormField a llenar cualquier espacio adicional en la fila. Para comprender mejor por qué esto es necesario, consulta Información sobre las restricciones.

Ahora que tienes un widget que permite al usuario ingresar texto para agregar al Libro de visitas, debes tenerlo en la pantalla.

  1. Edita el cuerpo de HomePage para agregar las siguientes dos líneas al final de los elementos secundarios de ListView:
const Header("What we'll be doing"),
const Paragraph(
  'Join us for a day full of Firebase Workshops and Pizza!',
),
// Add the following two lines.
const Header('Discussion'),
GuestBook(addMessage: (message) => print(message)),

Si bien esto es suficiente para mostrar el widget, no es suficiente para hacer nada útil. Actualizas este código en breve para que sea funcional.

Vista previa de la app

La pantalla principal de la app en Android con integración de chat

La pantalla principal de la app en iOS con integración de chat

La pantalla principal de la app en la Web con integración de chat

Pantalla principal de la app en macOS con integración de chat

Cuando un usuario hace clic en ENVIAR, se activa el siguiente fragmento de código. Agrega el contenido del campo de entrada del mensaje a la colección guestbook de la base de datos. Específicamente, el método addMessageToGuestBook agrega el contenido del mensaje a un documento nuevo con un ID generado automáticamente en la colección guestbook.

Ten en cuenta que FirebaseAuth.instance.currentUser.uid es una referencia al ID único generado automáticamente que Authentication proporciona a todos los usuarios que accedieron a sus cuentas.

  • En el archivo lib/app_state.dart, agrega el método addMessageToGuestBook. Conectarás esta función con la interfaz de usuario en el siguiente paso.

lib/app_state.dart.

import 'package:cloud_firestore/cloud_firestore.dart'; // new
import 'package:firebase_auth/firebase_auth.dart'
    hide EmailAuthProvider, PhoneAuthProvider;
import 'package:firebase_core/firebase_core.dart';
import 'package:firebase_ui_auth/firebase_ui_auth.dart';
import 'package:flutter/material.dart';

import 'firebase_options.dart';

class ApplicationState extends ChangeNotifier {

  // Current content of ApplicationState elided ...

  // Add from here...
  Future<DocumentReference> addMessageToGuestBook(String message) {
    if (!_loggedIn) {
      throw Exception('Must be logged in');
    }

    return FirebaseFirestore.instance
        .collection('guestbook')
        .add(<String, dynamic>{
      'text': message,
      'timestamp': DateTime.now().millisecondsSinceEpoch,
      'name': FirebaseAuth.instance.currentUser!.displayName,
      'userId': FirebaseAuth.instance.currentUser!.uid,
    });
  }
  // ...to here.
}

Conecta la IU y la base de datos

Tienes una IU en la que el usuario puede ingresar el texto que desea agregar al libro de visitas y tú tienes el código para agregar la entrada a Firestore. Ahora, solo debes conectar los dos.

  • En el archivo lib/home_page.dart, realiza el siguiente cambio en el widget HomePage:

lib/home_page.dart

import 'package:firebase_auth/firebase_auth.dart'
    hide EmailAuthProvider, PhoneAuthProvider;
import 'package:flutter/material.dart';
import 'package:provider/provider.dart';

import 'app_state.dart';
import 'guest_book.dart';                         // new
import 'src/authentication.dart';
import 'src/widgets.dart';

class HomePage extends StatelessWidget {
  const HomePage({Key? key}) : super(key: key);

  @override
  Widget build(BuildContext context) {
    return Scaffold(
      appBar: AppBar(
        title: const Text('Firebase Meetup'),
      ),
      body: ListView(
        children: <Widget>[
          Image.asset('assets/codelab.png'),
          const SizedBox(height: 8),
          const IconAndDetail(Icons.calendar_today, 'October 30'),
          const IconAndDetail(Icons.location_city, 'San Francisco'),
          Consumer<ApplicationState>(
            builder: (context, appState, _) => AuthFunc(
                loggedIn: appState.loggedIn,
                signOut: () {
                  FirebaseAuth.instance.signOut();
                }),
          ),
          const Divider(
            height: 8,
            thickness: 1,
            indent: 8,
            endIndent: 8,
            color: Colors.grey,
          ),
          const Header("What we'll be doing"),
          const Paragraph(
            'Join us for a day full of Firebase Workshops and Pizza!',
          ),
          // Modify from here...
          Consumer<ApplicationState>(
            builder: (context, appState, _) => Column(
              crossAxisAlignment: CrossAxisAlignment.start,
              children: [
                if (appState.loggedIn) ...[
                  const Header('Discussion'),
                  GuestBook(
                    addMessage: (message) =>
                        appState.addMessageToGuestBook(message),
                  ),
                ],
              ],
            ),
          ),
          // ...to here.
        ],
      ),
    );
  }
}

Reemplazaste las dos líneas que agregaste al comienzo de este paso por la implementación completa. Una vez más, usarás Consumer<ApplicationState> para que el estado de la app esté disponible para la parte del árbol que renderizas. Esto te permite reaccionar cuando alguien ingresa un mensaje en la IU y publicarlo en la base de datos. En la siguiente sección, probarás si los mensajes agregados se publican en la base de datos.

Pruebe enviar mensajes

  1. Si es necesario, accede a la app.
  2. Ingresa un mensaje, como Hey there!, y haz clic en ENVIAR.

Esta acción escribe el mensaje en tu base de datos de Firestore. Sin embargo, no ves el mensaje en tu app de Flutter real porque aún debes implementar la recuperación de datos, lo que harás en el siguiente paso. Sin embargo, en el panel Database de Firebase console, puedes ver el mensaje que agregaste en la colección guestbook. Si envías más mensajes, agregarás más documentos a tu colección guestbook. Por ejemplo, consulta el siguiente fragmento de código:

713870af0b3b63c.png

7. Lea los mensajes

Es encantador que los invitados puedan escribir mensajes en la base de datos, pero aún no los pueden ver en la app. Es hora de corregirlo.

Cómo sincronizar mensajes

Para mostrar mensajes, debes agregar objetos de escucha que se activen cuando cambian los datos y, luego, crear un elemento de la IU que muestre los mensajes nuevos. Agregarás código al estado de la app que escucha los mensajes recién agregados desde la app.

  1. Crea un archivo nuevo guest_book_message.dart y agrega la siguiente clase para exponer una vista estructurada de los datos que almacenas en Firestore.

lib/guest_book_message.dart.

class GuestBookMessage {
  GuestBookMessage({required this.name, required this.message});

  final String name;
  final String message;
}
  1. En el archivo lib/app_state.dart, agrega las siguientes importaciones:

lib/app_state.dart.

import 'dart:async';                                     // new

import 'package:cloud_firestore/cloud_firestore.dart';
import 'package:firebase_auth/firebase_auth.dart'
    hide EmailAuthProvider, PhoneAuthProvider;
import 'package:firebase_core/firebase_core.dart';
import 'package:firebase_ui_auth/firebase_ui_auth.dart';
import 'package:flutter/material.dart';

import 'firebase_options.dart';
import 'guest_book_message.dart';                        // new
  1. En la sección de ApplicationState, en la que defines el estado y los métodos get, agrega las siguientes líneas:

lib/app_state.dart.

  bool _loggedIn = false;
  bool get loggedIn => _loggedIn;

  // Add from here...
  StreamSubscription<QuerySnapshot>? _guestBookSubscription;
  List<GuestBookMessage> _guestBookMessages = [];
  List<GuestBookMessage> get guestBookMessages => _guestBookMessages;
  // ...to here.
  1. En la sección de inicialización de ApplicationState, agrega las siguientes líneas para suscribirte a una consulta sobre la colección de documentos cuando un usuario acceda y anule la suscripción cuando sale:

lib/app_state.dart.

  Future<void> init() async {
    await Firebase.initializeApp(
        options: DefaultFirebaseOptions.currentPlatform);

    FirebaseUIAuth.configureProviders([
      EmailAuthProvider(),
    ]);
    
    FirebaseAuth.instance.userChanges().listen((user) {
      if (user != null) {
        _loggedIn = true;
        _guestBookSubscription = FirebaseFirestore.instance
            .collection('guestbook')
            .orderBy('timestamp', descending: true)
            .snapshots()
            .listen((snapshot) {
          _guestBookMessages = [];
          for (final document in snapshot.docs) {
            _guestBookMessages.add(
              GuestBookMessage(
                name: document.data()['name'] as String,
                message: document.data()['text'] as String,
              ),
            );
          }
          notifyListeners();
        });
      } else {
        _loggedIn = false;
        _guestBookMessages = [];
        _guestBookSubscription?.cancel();
      }
      notifyListeners();
    });
  }

Esta sección es importante porque es donde construyes una consulta en la colección guestbook y controlas las suscripciones a ella y las anuladas. Escucharás la transmisión, en la que reconstruyes una caché local de los mensajes de la colección guestbook y también almacenarás una referencia a esta suscripción para que puedas anular la suscripción más adelante. Hay mucho que explorar aquí, por lo que debes explorarlo en un depurador para inspeccionar lo que sucede para obtener un modelo mental más claro. Para obtener más información, consulta Obtén actualizaciones en tiempo real con Firestore.

  1. En el archivo lib/guest_book.dart, agrega la siguiente importación:
import 'guest_book_message.dart';
  1. En el widget GuestBook, agrega una lista de mensajes como parte de la configuración para conectar este estado cambiante a la interfaz de usuario:

lib/guest_book.dart

class GuestBook extends StatefulWidget {
  // Modify the following line:
  const GuestBook({
    super.key, 
    required this.addMessage, 
    required this.messages,
  });

  final FutureOr<void> Function(String message) addMessage;
  final List<GuestBookMessage> messages; // new

  @override
  _GuestBookState createState() => _GuestBookState();
}
  1. En _GuestBookState, modifica el método build como se indica a continuación para exponer esta configuración:

lib/guest_book.dart

class _GuestBookState extends State<GuestBook> {
  final _formKey = GlobalKey<FormState>(debugLabel: '_GuestBookState');
  final _controller = TextEditingController();

  @override
  // Modify from here...
  Widget build(BuildContext context) {
    return Column(
      crossAxisAlignment: CrossAxisAlignment.start,
      children: [
        // ...to here.
        Padding(
          padding: const EdgeInsets.all(8.0),
          child: Form(
            key: _formKey,
            child: Row(
              children: [
                Expanded(
                  child: TextFormField(
                    controller: _controller,
                    decoration: const InputDecoration(
                      hintText: 'Leave a message',
                    ),
                    validator: (value) {
                      if (value == null || value.isEmpty) {
                        return 'Enter your message to continue';
                      }
                      return null;
                    },
                  ),
                ),
                const SizedBox(width: 8),
                StyledButton(
                  onPressed: () async {
                    if (_formKey.currentState!.validate()) {
                      await widget.addMessage(_controller.text);
                      _controller.clear();
                    }
                  },
                  child: Row(
                    children: const [
                      Icon(Icons.send),
                      SizedBox(width: 4),
                      Text('SEND'),
                    ],
                  ),
                ),
              ],
            ),
          ),
        ),
        // Modify from here...
        const SizedBox(height: 8),
        for (var message in widget.messages)
          Paragraph('${message.name}: ${message.message}'),
        const SizedBox(height: 8),
      ],
      // ...to here.
    );
  }
}

Unes el contenido anterior del método build() con un widget Column y, luego, agregas una colección para al final de los elementos secundarios de Column para generar un Paragraph nuevo para cada mensaje de la lista.

  1. Actualiza el cuerpo de HomePage para construir correctamente GuestBook con el nuevo parámetro messages:

lib/home_page.dart

Consumer<ApplicationState>(
  builder: (context, appState, _) => Column(
    crossAxisAlignment: CrossAxisAlignment.start,
    children: [
      if (appState.loggedIn) ...[
        const Header('Discussion'),
        GuestBook(
          addMessage: (message) =>
              appState.addMessageToGuestBook(message),
          messages: appState.guestBookMessages, // new
        ),
      ],
    ],
  ),
),

Prueba la sincronización de mensajes

Firestore sincroniza los datos con los clientes suscritos a la base de datos de forma automática e instantánea.

Prueba la sincronización de mensajes:

  1. En la app, busca los mensajes que creaste anteriormente en la base de datos.
  2. Escribir mensajes nuevos Aparecen al instante.
  3. Abre tu lugar de trabajo en varias ventanas o pestañas. Los mensajes se sincronizan en tiempo real en todas las ventanas y pestañas.
  4. Opcional: En el menú Base de datos de Firebase console, borra, modifica o agrega mensajes nuevos de forma manual. Todos los cambios aparecen en la IU.

¡Felicitaciones! Lees documentos de Firestore en tu app.

Vista previa de la app

La pantalla principal de la app en Android con integración de chat

La pantalla principal de la app en iOS con integración de chat

La pantalla principal de la app en la Web con integración de chat

Pantalla principal de la app en macOS con integración de chat

8. Configura reglas de seguridad básicas

Inicialmente, configuraste Firestore para usar el modo de prueba, lo que significa que tu base de datos está abierta para operaciones de lectura y escritura. Sin embargo, solo debes usar el modo de prueba durante las primeras etapas del desarrollo. Como práctica recomendada, debes configurar reglas de seguridad para tu base de datos mientras desarrollas tu app. La seguridad es una parte fundamental de la estructura y el comportamiento de tu app.

Las reglas de seguridad de Firebase te permiten controlar el acceso a los documentos y las colecciones de tu base de datos. La sintaxis de reglas flexibles te permite crear reglas que coincidan con todo, desde todas las operaciones de escritura en la base de datos hasta las operaciones en un documento específico.

Configura reglas básicas de seguridad:

  1. En el menú Desarrollar de Firebase console, haz clic en Base de datos > Reglas. Deberías ver las siguientes reglas de seguridad predeterminadas y una advertencia que indique que son públicas:

7767a2d2e64e7275.png

  1. Identifica las colecciones en las que la app escribe datos:

En match /databases/{database}/documents, identifica la colección que deseas proteger:

rules_version = '2';
service cloud.firestore {
  match /databases/{database}/documents {
    match /guestbook/{entry} {
     // You'll add rules here in the next step.
  }
}

Debido a que usaste el UID de autenticación como un campo en cada documento de libro de visitas, puedes obtener el UID de autenticación y verificar que cualquier persona que intente escribir en el documento tenga un UID de autenticación coincidente.

  1. Agrega las reglas de lectura y escritura a tu conjunto de reglas:
rules_version = '2';
service cloud.firestore {
  match /databases/{database}/documents {
    match /guestbook/{entry} {
      allow read: if request.auth.uid != null;
      allow write:
        if request.auth.uid == request.resource.data.userId;
    }
  }
}

Ahora solo los usuarios que hayan accedido a sus cuentas podrán leer los mensajes del libro de invitados, pero solo el autor del mensaje podrá editarlo.

  1. Agrega la validación de datos para asegurarte de que todos los campos esperados estén presentes en el documento:
rules_version = '2';
service cloud.firestore {
  match /databases/{database}/documents {
    match /guestbook/{entry} {
      allow read: if request.auth.uid != null;
      allow write:
      if request.auth.uid == request.resource.data.userId
          && "name" in request.resource.data
          && "text" in request.resource.data
          && "timestamp" in request.resource.data;
    }
  }
}

9. Paso adicional: Practica lo que aprendiste

Grabar el estado de confirmación de asistencia de un asistente

En este momento, tu app solo permite que las personas chateen cuando están interesadas en el evento. Además, la única forma de saber si alguien va a venir es cuando lo dice en el chat.

En este paso, te organizas y permites que las personas sepan cuántas personas asistirán. Agregas un par de capacidades al estado de la app. La primera es la capacidad de un usuario registrado de nominar si asistirá. La segunda es un contador de cuántas personas asistirán.

  1. En el archivo lib/app_state.dart, agrega las siguientes líneas a la sección de descriptores de acceso de ApplicationState para que el código de la IU pueda interactuar con este estado:

lib/app_state.dart.

int _attendees = 0;
int get attendees => _attendees;

Attending _attending = Attending.unknown;
StreamSubscription<DocumentSnapshot>? _attendingSubscription;
Attending get attending => _attending;
set attending(Attending attending) {
  final userDoc = FirebaseFirestore.instance
      .collection('attendees')
      .doc(FirebaseAuth.instance.currentUser!.uid);
  if (attending == Attending.yes) {
    userDoc.set(<String, dynamic>{'attending': true});
  } else {
    userDoc.set(<String, dynamic>{'attending': false});
  }
}
  1. Actualiza el método init() de ApplicationState de la siguiente manera:

lib/app_state.dart.

  Future<void> init() async {
    await Firebase.initializeApp(
        options: DefaultFirebaseOptions.currentPlatform);

    FirebaseUIAuth.configureProviders([
      EmailAuthProvider(),
    ]);

    // Add from here...
    FirebaseFirestore.instance
        .collection('attendees')
        .where('attending', isEqualTo: true)
        .snapshots()
        .listen((snapshot) {
      _attendees = snapshot.docs.length;
      notifyListeners();
    });
    // ...to here.

    FirebaseAuth.instance.userChanges().listen((user) {
      if (user != null) {
        _loggedIn = true;
        _emailVerified = user.emailVerified;
        _guestBookSubscription = FirebaseFirestore.instance
            .collection('guestbook')
            .orderBy('timestamp', descending: true)
            .snapshots()
            .listen((snapshot) {
          _guestBookMessages = [];
          for (final document in snapshot.docs) {
            _guestBookMessages.add(
              GuestBookMessage(
                name: document.data()['name'] as String,
                message: document.data()['text'] as String,
              ),
            );
          }
          notifyListeners();
        });
        // Add from here...
        _attendingSubscription = FirebaseFirestore.instance
            .collection('attendees')
            .doc(user.uid)
            .snapshots()
            .listen((snapshot) {
          if (snapshot.data() != null) {
            if (snapshot.data()!['attending'] as bool) {
              _attending = Attending.yes;
            } else {
              _attending = Attending.no;
            }
          } else {
            _attending = Attending.unknown;
          }
          notifyListeners();
        });
        // ...to here.
      } else {
        _loggedIn = false;
        _emailVerified = false;
        _guestBookMessages = [];
        _guestBookSubscription?.cancel();
        _attendingSubscription?.cancel(); // new
      }
      notifyListeners();
    });
  }

Este código agrega una consulta con suscripción permanente para determinar la cantidad de asistentes y una segunda consulta que solo está activa cuando el usuario accede para determinar si asiste.

  1. Agrega la siguiente enumeración en la parte superior del archivo lib/app_state.dart.

lib/app_state.dart.

enum Attending { yes, no, unknown }
  1. Crea un nuevo archivo yes_no_selection.dart y define un nuevo widget que funcione como botones de selección:

lib/yes_no_selection.dart

import 'package:flutter/material.dart';

import 'app_state.dart';
import 'src/widgets.dart';

class YesNoSelection extends StatelessWidget {
  const YesNoSelection(
      {super.key, required this.state, required this.onSelection});
  final Attending state;
  final void Function(Attending selection) onSelection;

  @override
  Widget build(BuildContext context) {
    switch (state) {
      case Attending.yes:
        return Padding(
          padding: const EdgeInsets.all(8.0),
          child: Row(
            children: [
              FilledButton(
                onPressed: () => onSelection(Attending.yes),
                child: const Text('YES'),
              ),
              const SizedBox(width: 8),
              TextButton(
                onPressed: () => onSelection(Attending.no),
                child: const Text('NO'),
              ),
            ],
          ),
        );
      case Attending.no:
        return Padding(
          padding: const EdgeInsets.all(8.0),
          child: Row(
            children: [
              TextButton(
                onPressed: () => onSelection(Attending.yes),
                child: const Text('YES'),
              ),
              const SizedBox(width: 8),
              FilledButton(
                onPressed: () => onSelection(Attending.no),
                child: const Text('NO'),
              ),
            ],
          ),
        );
      default:
        return Padding(
          padding: const EdgeInsets.all(8.0),
          child: Row(
            children: [
              StyledButton(
                onPressed: () => onSelection(Attending.yes),
                child: const Text('YES'),
              ),
              const SizedBox(width: 8),
              StyledButton(
                onPressed: () => onSelection(Attending.no),
                child: const Text('NO'),
              ),
            ],
          ),
        );
    }
  }
}

Comienza en un estado indeterminado sin seleccionar ni No. Una vez que el usuario selecciona si desea asistir, la opción aparecerá destacada con un botón relleno, mientras que la otra se retrocede con una renderización plana.

  1. Actualiza el método build() de HomePage para aprovechar YesNoSelection, permitir que un usuario registrado indique si asistirá y mostrar la cantidad de asistentes al evento:

lib/home_page.dart

Consumer<ApplicationState>(
  builder: (context, appState, _) => Column(
    crossAxisAlignment: CrossAxisAlignment.start,
    children: [
      // Add from here...
      switch (appState.attendees) {
        1 => const Paragraph('1 person going'),
        >= 2 => Paragraph('${appState.attendees} people going'),
        _ => const Paragraph('No one going'),
      },
      // ...to here.
      if (appState.loggedIn) ...[
        // Add from here...
        YesNoSelection(
          state: appState.attending,
          onSelection: (attending) => appState.attending = attending,
        ),
        // ...to here.
        const Header('Discussion'),
        GuestBook(
          addMessage: (message) =>
              appState.addMessageToGuestBook(message),
          messages: appState.guestBookMessages,
        ),
      ],
    ],
  ),
),

Agregar reglas

Ya configuraste algunas reglas, por lo que se rechazarán los datos que agregues con los botones. Debes actualizar las reglas para permitir que se agreguen a la colección attendees.

  1. En la colección attendees, toma el UID de autenticación que usaste como nombre del documento y verifica que el uid del remitente sea el mismo que el del documento que está escribiendo:
rules_version = '2';
service cloud.firestore {
  match /databases/{database}/documents {
    // ... //
    match /attendees/{userId} {
      allow read: if true;
      allow write: if request.auth.uid == userId;
    }
  }
}

Así, todos pueden leer la lista de asistentes porque no hay datos privados, pero solo el creador puede actualizarla.

  1. Agrega la validación de datos para asegurarte de que todos los campos esperados estén presentes en el documento:
rules_version = '2';
service cloud.firestore {
  match /databases/{database}/documents {
    // ... //
    match /attendees/{userId} {
      allow read: if true;
      allow write: if request.auth.uid == userId
          && "attending" in request.resource.data;

    }
  }
}
  1. Opcional: En la app, haz clic en los botones para ver los resultados en el panel de Firestore en Firebase console.

Vista previa de la app

La pantalla principal de la app en Android

La pantalla principal de la app en iOS

La pantalla principal de la app en la Web

La pantalla principal de la app en macOS

10. ¡Felicitaciones!

Usaste Firebase para compilar una app web interactiva en tiempo real.

Más información