Atelier de programmation Android Cloud Firestore

1. Vue d'ensemble

Buts

Dans cet atelier de programmation, vous allez créer une application de recommandation de restaurants sur Android soutenue par Cloud Firestore. Vous apprendrez à :

  • Lire et écrire des données sur Firestore à partir d'une application Android
  • Écoutez les modifications apportées aux données Firestore en temps réel
  • Utiliser l'authentification Firebase et les règles de sécurité pour sécuriser les données Firestore
  • Écrire des requêtes Firestore complexes

Conditions préalables

Avant de commencer cet atelier de programmation, assurez-vous d'avoir :

  • Android Studio 4.0 ou supérieur
  • Un émulateur Android avec API 19 ou supérieur
  • Node.js version 10 ou supérieure
  • Java version 8 ou supérieure

2. Créer un projet Firebase

  1. Connectez-vous à la console Firebase avec votre compte Google.
  2. Dans la console Firebase , cliquez sur Ajouter un projet .
  3. Comme indiqué dans la capture d'écran ci-dessous, saisissez un nom pour votre projet Firebase (par exemple, "Friendly Eats"), puis cliquez sur Continuer .

9d2f625aebcab6af.png

  1. Il peut vous être demandé d'activer Google Analytics. Pour les besoins de cet atelier de programmation, votre sélection n'a pas d'importance.
  2. Après environ une minute, votre projet Firebase sera prêt. Cliquez sur Continuer .

3. Configurer l'exemple de projet

Télécharger le code

Exécutez la commande suivante pour cloner l'exemple de code pour cet atelier de programmation. Cela créera un dossier appelé friendlyeats-android sur votre machine :

$ git clone https://github.com/firebase/friendlyeats-android

Si vous n'avez pas git sur votre machine, vous pouvez également télécharger le code directement depuis GitHub.

Ajouter une configuration Firebase

  1. Dans la console Firebase , sélectionnez Présentation du projet dans la barre de navigation de gauche. Cliquez sur le bouton Android pour sélectionner la plateforme. Lorsque vous êtes invité à entrer un nom de package, utilisez com.google.firebase.example.fireeats

73d151ed16016421.png

  1. Cliquez sur Enregistrer l'application et suivez les instructions pour télécharger le fichier google-services.json et déplacez-le dans le dossier app/ du code que vous venez de télécharger. Cliquez ensuite sur Suivant .

Importer le projet

Ouvrez AndroidStudio. Cliquez sur Fichier > Nouveau > Importer un projet et sélectionnez le dossier friendlyeats-android .

4. Configurer les émulateurs Firebase

Dans cet atelier de programmation, vous utiliserez Firebase Emulator Suite pour émuler localement Cloud Firestore et d'autres services Firebase. Cela fournit un environnement de développement local sûr, rapide et gratuit pour créer votre application.

Installer l'interface de ligne de commande Firebase

Vous devrez d'abord installer la CLI Firebase . Si vous utilisez macOS ou Linux, vous pouvez exécuter la commande cURL suivante :

curl -sL https://firebase.tools | bash

Si vous utilisez Windows, lisez les instructions d'installation pour obtenir un binaire autonome ou pour installer via npm .

Une fois que vous avez installé la CLI, l'exécution de firebase --version doit indiquer une version 9.0.0 ou supérieure :

$ firebase --version
9.0.0

Connexion

Exécutez firebase login pour connecter la CLI à votre compte Google. Cela ouvrira une nouvelle fenêtre de navigateur pour terminer le processus de connexion. Assurez-vous de choisir le même compte que celui que vous avez utilisé lors de la création de votre projet Firebase plus tôt.

Depuis le dossier friendlyeats-android , exécutez firebase use --add pour connecter votre projet local à votre projet Firebase. Suivez les invites pour sélectionner le projet que vous avez créé précédemment et si vous êtes invité à choisir un alias, entrez default .

5. Exécutez l'application

Il est maintenant temps d'exécuter Firebase Emulator Suite et l'application Android FriendlyEats pour la première fois.

Exécutez les émulateurs

Dans votre terminal, à partir du répertoire friendlyeats-android , exécutez firebase emulators:start pour démarrer les émulateurs Firebase. Vous devriez voir des journaux comme celui-ci :

$ firebase emulators:start
i  emulators: Starting emulators: auth, firestore
i  firestore: Firestore Emulator logging to firestore-debug.log
i  ui: Emulator UI logging to ui-debug.log

┌─────────────────────────────────────────────────────────────┐
│ ✔  All emulators ready! It is now safe to connect your app. │
│ i  View Emulator UI at http://localhost:4000                │
└─────────────────────────────────────────────────────────────┘

┌────────────────┬────────────────┬─────────────────────────────────┐
│ Emulator       │ Host:Port      │ View in Emulator UI             │
├────────────────┼────────────────┼─────────────────────────────────┤
│ Authentication │ localhost:9099 │ http://localhost:4000/auth      │
├────────────────┼────────────────┼─────────────────────────────────┤
│ Firestore      │ localhost:8080 │ http://localhost:4000/firestore │
└────────────────┴────────────────┴─────────────────────────────────┘
  Emulator Hub running at localhost:4400
  Other reserved ports: 4500

Issues? Report them at https://github.com/firebase/firebase-tools/issues and attach the *-debug.log files.

Vous disposez maintenant d'un environnement de développement local complet fonctionnant sur votre machine ! Assurez-vous de laisser cette commande en cours d'exécution pour le reste du laboratoire de programmation, votre application Android devra se connecter aux émulateurs.

Connecter l'application aux émulateurs

Ouvrez le fichier FirebaseUtil.java dans Android Studio. Ce fichier contient la logique permettant de connecter les SDK Firebase aux émulateurs locaux exécutés sur votre ordinateur.

En haut du fichier, examinez cette ligne :

    /** Use emulators only in debug builds **/
    private static final boolean sUseEmulators = BuildConfig.DEBUG;

Nous utilisons BuildConfig pour nous assurer que nous ne nous connectons aux émulateurs que lorsque notre application s'exécute en mode debug . Lorsque nous compilons l'application en mode release , cette condition sera fausse.

Jetez maintenant un œil à la méthode getFirestore() :

    public static FirebaseFirestore getFirestore() {
        if (FIRESTORE == null) {
            FIRESTORE = FirebaseFirestore.getInstance();

            // Connect to the Cloud Firestore emulator when appropriate. The host '10.0.2.2' is a
            // special IP address to let the Android emulator connect to 'localhost'.
            if (sUseEmulators) {
                FIRESTORE.useEmulator("10.0.2.2", 8080);
            }
        }

        return FIRESTORE;
    }

Nous pouvons voir qu'il utilise la useEmulator(host, port) pour connecter le SDK Firebase à l'émulateur Firestore local. Tout au long de l'application, nous utiliserons FirebaseUtil.getFirestore() pour accéder à cette instance de FirebaseFirestore afin d'être sûrs que nous nous connectons toujours à l'émulateur Firestore lors de l'exécution en mode debug .

Exécutez l'application

Si vous avez correctement ajouté le fichier google-services.json , le projet devrait maintenant être compilé. Dans Android Studio, cliquez sur Build > Rebuild Project et assurez-vous qu'il ne reste aucune erreur.

Dans Android Studio Exécutez l'application sur votre émulateur Android. Au début, un écran "Connexion" vous sera présenté. Vous pouvez utiliser n'importe quel e-mail et mot de passe pour vous connecter à l'application. Ce processus de connexion se connecte à l'émulateur Firebase Authentication, donc aucune véritable information d'identification n'est transmise.

Ouvrez maintenant l'interface utilisateur des émulateurs en accédant à http://localhost:4000 dans votre navigateur Web. Cliquez ensuite sur l'onglet Authentification et vous devriez voir apparaître le compte que vous venez de créer :

Émulateur d'authentification Firebase

Une fois que vous avez terminé le processus de connexion, vous devriez voir l'écran d'accueil de l'application :

de06424023ffb4b9.png

Bientôt, nous ajouterons des données pour remplir l'écran d'accueil.

6. Écrire des données sur Firestore

Dans cette section, nous allons écrire des données sur Firestore afin de pouvoir remplir l'écran d'accueil actuellement vide.

L'objet modèle principal de notre application est un restaurant (voir model/Restaurant.java ). Les données Firestore sont divisées en documents, collections et sous-collections. Nous stockerons chaque restaurant sous la forme d'un document dans une collection de niveau supérieur appelée "restaurants" . Pour en savoir plus sur le modèle de données Firestore, lisez les informations sur les documents et les collections dans la documentation .

À des fins de démonstration, nous ajouterons une fonctionnalité dans l'application pour créer dix restaurants aléatoires lorsque nous cliquerons sur le bouton "Ajouter des éléments aléatoires" dans le menu de débordement. Ouvrez le fichier MainActivity.java et remplacez le contenu de la méthode onAddItemsClicked() par :

    private void onAddItemsClicked() {
        // Get a reference to the restaurants collection
        CollectionReference restaurants = mFirestore.collection("restaurants");

        for (int i = 0; i < 10; i++) {
            // Get a random Restaurant POJO
            Restaurant restaurant = RestaurantUtil.getRandom(this);

            // Add a new document to the restaurants collection
            restaurants.add(restaurant);
        }
    }

Il y a quelques points importants à noter à propos du code ci-dessus :

  • Nous avons commencé par obtenir une référence à la collection "restaurants" . Les collections sont créées implicitement lorsque des documents sont ajoutés, il n'était donc pas nécessaire de créer la collection avant d'écrire des données.
  • Les documents peuvent être créés à l'aide de POJO (Plain Old Java Object), que nous utilisons pour créer chaque document Restaurant.
  • La méthode add() ajoute un document à une collection avec un identifiant généré automatiquement, nous n'avons donc pas besoin de spécifier un identifiant unique pour chaque restaurant.

Maintenant, exécutez à nouveau l'application et cliquez sur le bouton "Ajouter des éléments aléatoires" dans le menu de débordement (en haut à droite) pour invoquer le code que vous venez d'écrire :

95691e9b71ba55e3.png

Ouvrez maintenant l'interface utilisateur des émulateurs en accédant à http://localhost:4000 dans votre navigateur Web. Cliquez ensuite sur l'onglet Firestore et vous devriez voir les données que vous venez d'ajouter :

Émulateur d'authentification Firebase

Ces données sont 100% locales à votre machine. En fait, votre vrai projet ne contient même pas encore de base de données Firestore ! Cela signifie qu'il est sûr d'expérimenter la modification et la suppression de ces données sans conséquence.

Félicitations, vous venez d'écrire des données dans Firestore ! Dans l'étape suivante, nous apprendrons comment afficher ces données dans l'application.

7. Afficher les données de Firestore

Dans cette étape, nous apprendrons comment récupérer les données de Firestore et les afficher dans notre application. La première étape pour lire les données de Firestore consiste à créer une Query . Ouvrez le fichier MainActivity.java et ajoutez le code suivant au début de la méthode onCreate() :

        mFirestore = FirebaseUtil.getFirestore();

        // Get the 50 highest rated restaurants
        mQuery = mFirestore.collection("restaurants")
                .orderBy("avgRating", Query.Direction.DESCENDING)
                .limit(LIMIT);

Maintenant, nous voulons écouter la requête, afin d'obtenir tous les documents correspondants et d'être informés des futures mises à jour en temps réel. Étant donné que notre objectif final est de lier ces données à un RecyclerView , nous devons créer une classe RecyclerView.Adapter pour écouter les données.

Ouvrez la classe FirestoreAdapter , qui a déjà été partiellement implémentée. Tout d'abord, faisons en sorte que l'adaptateur implémente EventListener et définissons la fonction onEvent afin qu'il puisse recevoir les mises à jour d'une requête Firestore :

public abstract class FirestoreAdapter<VH extends RecyclerView.ViewHolder>
        extends RecyclerView.Adapter<VH>
        implements EventListener<QuerySnapshot> { // Add this "implements"

    // ...

    // Add this method
    @Override
    public void onEvent(QuerySnapshot documentSnapshots,
                        FirebaseFirestoreException e) {

        // Handle errors
        if (e != null) {
            Log.w(TAG, "onEvent:error", e);
            return;
        }

        // Dispatch the event
        for (DocumentChange change : documentSnapshots.getDocumentChanges()) {
            // Snapshot of the changed document
            DocumentSnapshot snapshot = change.getDocument();

            switch (change.getType()) {
                case ADDED:
                    // TODO: handle document added
                    break;
                case MODIFIED:
                    // TODO: handle document modified
                    break;
                case REMOVED:
                    // TODO: handle document removed
                    break;
            }
        }

        onDataChanged();
    }

  // ...
}

Lors du chargement initial, le programme d'écoute recevra un événement ADDED pour chaque nouveau document. Au fur et à mesure que le jeu de résultats de la requête change au fil du temps, l'écouteur recevra plus d'événements contenant les modifications. Finissons maintenant d'implémenter l'écouteur. Ajoutez d'abord trois nouvelles méthodes : onDocumentAdded , onDocumentModified et onDocumentRemoved :

    protected void onDocumentAdded(DocumentChange change) {
        mSnapshots.add(change.getNewIndex(), change.getDocument());
        notifyItemInserted(change.getNewIndex());
    }

    protected void onDocumentModified(DocumentChange change) {
        if (change.getOldIndex() == change.getNewIndex()) {
            // Item changed but remained in same position
            mSnapshots.set(change.getOldIndex(), change.getDocument());
            notifyItemChanged(change.getOldIndex());
        } else {
            // Item changed and changed position
            mSnapshots.remove(change.getOldIndex());
            mSnapshots.add(change.getNewIndex(), change.getDocument());
            notifyItemMoved(change.getOldIndex(), change.getNewIndex());
        }
    }

    protected void onDocumentRemoved(DocumentChange change) {
        mSnapshots.remove(change.getOldIndex());
        notifyItemRemoved(change.getOldIndex());
    }

Appelez ensuite ces nouvelles méthodes depuis onEvent :

    @Override
    public void onEvent(QuerySnapshot documentSnapshots,
                        FirebaseFirestoreException e) {

        // ...

        // Dispatch the event
        for (DocumentChange change : documentSnapshots.getDocumentChanges()) {
            // Snapshot of the changed document
            DocumentSnapshot snapshot = change.getDocument();

            switch (change.getType()) {
                case ADDED:
                    onDocumentAdded(change); // Add this line
                    break;
                case MODIFIED:
                    onDocumentModified(change); // Add this line
                    break;
                case REMOVED:
                    onDocumentRemoved(change); // Add this line
                    break;
            }
        }

        onDataChanged();
    }

Enfin, implémentez la méthode startListening() pour attacher l'écouteur :

    public void startListening() {
        if (mQuery != null && mRegistration == null) {
            mRegistration = mQuery.addSnapshotListener(this);
        }
    }

L'application est maintenant entièrement configurée pour lire les données de Firestore. Exécutez à nouveau l'application et vous devriez voir les restaurants que vous avez ajoutés à l'étape précédente :

9e45f40faefce5d0.png

Revenez maintenant à l'interface utilisateur de l'émulateur dans votre navigateur et modifiez l'un des noms de restaurant. Vous devriez le voir changer dans l'application presque instantanément !

8. Trier et filtrer les données

L'application affiche actuellement les restaurants les mieux notés sur l'ensemble de la collection, mais dans une véritable application de restaurant, l'utilisateur souhaiterait trier et filtrer les données. Par exemple, l'application devrait pouvoir afficher "Les meilleurs restaurants de fruits de mer de Philadelphie" ou "La pizza la moins chère".

Cliquer sur la barre blanche en haut de l'application fait apparaître une boîte de dialogue de filtres. Dans cette section, nous utiliserons des requêtes Firestore pour faire fonctionner cette boîte de dialogue :

67898572a35672a5.png

Modifions la méthode onFilter() de MainActivity.java . Cette méthode accepte un objet Filters qui est un objet d'assistance que nous avons créé pour capturer la sortie de la boîte de dialogue des filtres. Nous allons modifier cette méthode pour construire une requête à partir des filtres :

    @Override
    public void onFilter(Filters filters) {
        // Construct basic query
        Query query = mFirestore.collection("restaurants");

        // Category (equality filter)
        if (filters.hasCategory()) {
            query = query.whereEqualTo("category", filters.getCategory());
        }

        // City (equality filter)
        if (filters.hasCity()) {
            query = query.whereEqualTo("city", filters.getCity());
        }

        // Price (equality filter)
        if (filters.hasPrice()) {
            query = query.whereEqualTo("price", filters.getPrice());
        }

        // Sort by (orderBy with direction)
        if (filters.hasSortBy()) {
            query = query.orderBy(filters.getSortBy(), filters.getSortDirection());
        }

        // Limit items
        query = query.limit(LIMIT);

        // Update the query
        mQuery = query;
        mAdapter.setQuery(query);

        // Set header
        mCurrentSearchView.setText(Html.fromHtml(filters.getSearchDescription(this)));
        mCurrentSortByView.setText(filters.getOrderDescription(this));

        // Save filters
        mViewModel.setFilters(filters);
    }

Dans l'extrait ci-dessus, nous construisons un objet Query en attachant les clauses where et orderBy pour correspondre aux filtres donnés.

Exécutez à nouveau l'application et sélectionnez le filtre suivant pour afficher les restaurants à bas prix les plus populaires :

7a67a8a400c80c50.png

Vous devriez maintenant voir une liste filtrée de restaurants contenant uniquement des options à bas prix :

a670188398c3c59.png

Si vous êtes arrivé jusqu'ici, vous avez maintenant créé une application de visualisation de recommandations de restaurants entièrement fonctionnelle sur Firestore ! Vous pouvez désormais trier et filtrer les restaurants en temps réel. Dans les prochaines sections, nous ajouterons des critiques aux restaurants et ajouterons des règles de sécurité à l'application.

9. Organiser les données en sous-collections

Dans cette section, nous ajouterons des notes à l'application afin que les utilisateurs puissent évaluer leurs restaurants préférés (ou les moins préférés).

Collections et sous-collections

Jusqu'à présent, nous avons stocké toutes les données des restaurants dans une collection de niveau supérieur appelée "restaurants". Lorsqu'un utilisateur évalue un restaurant, nous souhaitons ajouter un nouvel objet d' Rating aux restaurants. Pour cette tâche, nous utiliserons une sous-collection. Vous pouvez considérer une sous-collection comme une collection attachée à un document. Ainsi, chaque document de restaurant aura une sous-collection d'évaluations remplie de documents d'évaluation. Les sous-collections aident à organiser les données sans gonfler nos documents ni nécessiter de requêtes complexes.

Pour accéder à une sous-collection, appelez .collection() sur le document parent :

CollectionReference subRef = mFirestore.collection("restaurants")
        .document("abc123")
        .collection("ratings");

Vous pouvez accéder et interroger une sous-collection comme avec une collection de niveau supérieur, il n'y a pas de limitation de taille ni de changement de performances. Vous pouvez en savoir plus sur le modèle de données Firestore ici .

Écrire des données dans une transaction

L'ajout d'une Rating à la sous-collection appropriée nécessite uniquement d'appeler .add() , mais nous devons également mettre à jour la note moyenne et le nombre de notes de l'objet Restaurant pour refléter les nouvelles données. Si nous utilisons des opérations distinctes pour effectuer ces deux modifications, il existe un certain nombre de conditions de concurrence qui pourraient entraîner des données obsolètes ou incorrectes.

Pour nous assurer que les notes sont ajoutées correctement, nous utiliserons une transaction pour ajouter des notes à un restaurant. Cette transaction effectuera quelques actions :

  • Lire la note actuelle du restaurant et calculer la nouvelle
  • Ajouter la note à la sous-collection
  • Mettre à jour la note moyenne du restaurant et le nombre de notes

Ouvrez RestaurantDetailActivity.java et implémentez la fonction addRating :

    private Task<Void> addRating(final DocumentReference restaurantRef,
                                 final Rating rating) {
        // Create reference for new rating, for use inside the transaction
        final DocumentReference ratingRef = restaurantRef.collection("ratings")
                .document();

        // In a transaction, add the new rating and update the aggregate totals
        return mFirestore.runTransaction(new Transaction.Function<Void>() {
            @Override
            public Void apply(Transaction transaction)
                    throws FirebaseFirestoreException {

                Restaurant restaurant = transaction.get(restaurantRef)
                        .toObject(Restaurant.class);

                // Compute new number of ratings
                int newNumRatings = restaurant.getNumRatings() + 1;

                // Compute new average rating
                double oldRatingTotal = restaurant.getAvgRating() *
                        restaurant.getNumRatings();
                double newAvgRating = (oldRatingTotal + rating.getRating()) /
                        newNumRatings;

                // Set new restaurant info
                restaurant.setNumRatings(newNumRatings);
                restaurant.setAvgRating(newAvgRating);

                // Commit to Firestore
                transaction.set(restaurantRef, restaurant);
                transaction.set(ratingRef, rating);

                return null;
            }
        });
    }

La fonction addRating() renvoie une Task représentant l'intégralité de la transaction. Dans la fonction onRating() , des écouteurs sont ajoutés à la tâche pour répondre au résultat de la transaction.

Maintenant , exécutez à nouveau l'application et cliquez sur l'un des restaurants, ce qui devrait faire apparaître l'écran de détail du restaurant. Cliquez sur le bouton + pour commencer à ajouter un avis. Ajoutez un avis en choisissant un certain nombre d'étoiles et en saisissant du texte.

78fa16cdf8ef435a.png

Appuyer sur Soumettre lancera la transaction. Une fois la transaction terminée, vous verrez votre avis affiché ci-dessous et une mise à jour du nombre d'avis du restaurant :

f9e670f40bd615b0.png

Félicitations! Vous disposez maintenant d'une application d'évaluation de restaurants sociale, locale et mobile basée sur Cloud Firestore. J'entends ceux-ci sont très populaires ces jours-ci.

10. Sécurisez vos données

Jusqu'à présent, nous n'avons pas pris en compte la sécurité de cette application. Comment savons-nous que les utilisateurs ne peuvent lire et écrire que leurs propres données correctes ? Les bases de données Firestore sont sécurisées par un fichier de configuration appelé Règles de sécurité .

Ouvrez le fichier firestore.rules , vous devriez voir ceci :

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

Modifions ces règles pour empêcher l'accès ou les modifications indésirables aux données, ouvrons le fichier firestore.rules et remplaçons le contenu par ce qui suit :

rules_version = '2';
service cloud.firestore {
  match /databases/{database}/documents {
    // Determine if the value of the field "key" is the same
    // before and after the request.
    function isUnchanged(key) {
      return (key in resource.data)
        && (key in request.resource.data)
        && (resource.data[key] == request.resource.data[key]);
    }

    // Restaurants
    match /restaurants/{restaurantId} {
      // Any signed-in user can read
      allow read: if request.auth != null;

      // Any signed-in user can create
      // WARNING: this rule is for demo purposes only!
      allow create: if request.auth != null;

      // Updates are allowed if no fields are added and name is unchanged
      allow update: if request.auth != null
                    && (request.resource.data.keys() == resource.data.keys())
                    && isUnchanged("name");

      // Deletes are not allowed.
      // Note: this is the default, there is no need to explicitly state this.
      allow delete: if false;

      // Ratings
      match /ratings/{ratingId} {
        // Any signed-in user can read
        allow read: if request.auth != null;

        // Any signed-in user can create if their uid matches the document
        allow create: if request.auth != null
                      && request.resource.data.userId == request.auth.uid;

        // Deletes and updates are not allowed (default)
        allow update, delete: if false;
      }
    }
  }
}

Ces règles restreignent l'accès pour garantir que les clients n'effectuent que des modifications sécurisées. Par exemple, les mises à jour d'un document de restaurant ne peuvent modifier que les notes, pas le nom ou toute autre donnée immuable. Les évaluations ne peuvent être créées que si l'ID utilisateur correspond à l'utilisateur connecté, ce qui empêche l'usurpation d'identité.

Pour en savoir plus sur les règles de sécurité, consultez la documentation .

11.Conclusion

Vous avez maintenant créé une application complète sur Firestore. Vous avez découvert les fonctionnalités les plus importantes de Firestore, notamment :

  • Documents et collections
  • Lire et écrire des données
  • Trier et filtrer avec des requêtes
  • Sous-collections
  • Transactions

Apprendre encore plus

Pour continuer à en savoir plus sur Firestore, voici quelques bons points de départ :

L'application de restaurant de cet atelier de programmation était basée sur l'exemple d'application "Friendly Eats". Vous pouvez parcourir le code source de cette application ici .

Facultatif : déployer en production

Jusqu'à présent, cette application n'a utilisé que Firebase Emulator Suite. Si vous souhaitez apprendre à déployer cette application dans un véritable projet Firebase, passez à l'étape suivante.

12. (Facultatif) Déployez votre application

Jusqu'à présent, cette application était entièrement locale, toutes les données sont contenues dans Firebase Emulator Suite. Dans cette section, vous apprendrez à configurer votre projet Firebase afin que cette application fonctionne en production.

Authentification Firebase

Dans la console Firebase, accédez à la section Authentification et cliquez sur Démarrer . Accédez à l'onglet Méthode de connexion et sélectionnez l'option E-mail/Mot de passe des fournisseurs natifs .

Activez la méthode de connexion par e-mail/mot de passe et cliquez sur Enregistrer .

fournisseurs-de-connexion.png

Firestore

Créer une base de données

Accédez à la section Base de données Firestore de la console et cliquez sur Créer une base de données :

  1. Lorsque vous serez invité à choisir les règles de sécurité pour démarrer en mode production , nous mettrons bientôt à jour ces règles.
  2. Choisissez l'emplacement de la base de données que vous souhaitez utiliser pour votre application. Notez que la sélection d'un emplacement de base de données est une décision permanente et pour la modifier, vous devrez créer un nouveau projet. Pour plus d'informations sur le choix d'un emplacement de projet, consultez la documentation .

Déployer des règles

Pour déployer les règles de sécurité que vous avez écrites précédemment, exécutez la commande suivante dans le répertoire codelab :

$ firebase deploy --only firestore:rules

Cela déploiera le contenu de firestore.rules sur votre projet, ce que vous pouvez confirmer en accédant à l'onglet Règles de la console.

Déployer les index

L'application FriendlyEats a un tri et un filtrage complexes qui nécessitent un certain nombre d'index composés personnalisés. Ceux-ci peuvent être créés à la main dans la console Firebase mais il est plus simple d'écrire leurs définitions dans le fichier firestore.indexes.json et de les déployer à l'aide de la CLI Firebase.

Si vous ouvrez le fichier firestore.indexes.json , vous verrez que les index requis ont déjà été fournis :

{
  "indexes": [
    {
      "collectionId": "restaurants",
      "queryScope": "COLLECTION",
      "fields": [
        { "fieldPath": "city", "mode": "ASCENDING" },
        { "fieldPath": "avgRating", "mode": "DESCENDING" }
      ]
    },
    {
      "collectionId": "restaurants",
      "queryScope": "COLLECTION",
      "fields": [
        { "fieldPath": "category", "mode": "ASCENDING" },
        { "fieldPath": "avgRating", "mode": "DESCENDING" }
      ]
    },
    {
      "collectionId": "restaurants",
      "queryScope": "COLLECTION",
      "fields": [
        { "fieldPath": "price", "mode": "ASCENDING" },
        { "fieldPath": "avgRating", "mode": "DESCENDING" }
      ]
    },
    {
      "collectionId": "restaurants",
      "queryScope": "COLLECTION",
      "fields": [
        { "fieldPath": "city", "mode": "ASCENDING" },
        { "fieldPath": "numRatings", "mode": "DESCENDING" }
      ]
    },
    {
      "collectionId": "restaurants",
      "queryScope": "COLLECTION",
      "fields": [
        { "fieldPath": "category", "mode": "ASCENDING" },
        { "fieldPath": "numRatings", "mode": "DESCENDING" }
      ]
    },
    {
      "collectionId": "restaurants",
      "queryScope": "COLLECTION",
      "fields": [
        { "fieldPath": "price", "mode": "ASCENDING" },
        { "fieldPath": "numRatings", "mode": "DESCENDING" }
      ]
    },
    {
      "collectionId": "restaurants",
      "queryScope": "COLLECTION",
      "fields": [
        { "fieldPath": "city", "mode": "ASCENDING" },
        { "fieldPath": "price", "mode": "ASCENDING" }
      ]
    },
    {
      "collectionId": "restaurants",
      "fields": [
        { "fieldPath": "category", "mode": "ASCENDING" },
        { "fieldPath": "price", "mode": "ASCENDING" }
      ]
    }
  ],
  "fieldOverrides": []
}

Pour déployer ces index, exécutez la commande suivante :

$ firebase deploy --only firestore:indexes

Notez que la création d'index n'est pas instantanée, vous pouvez suivre la progression dans la console Firebase.

Configurer l'application

Dans la classe FirebaseUtil , nous avons configuré le SDK Firebase pour qu'il se connecte aux émulateurs en mode débogage :

public class FirebaseUtil {

    /** Use emulators only in debug builds **/
    private static final boolean sUseEmulators = BuildConfig.DEBUG;

    // ...
}

Si vous souhaitez tester votre application avec votre véritable projet Firebase, vous pouvez :

  1. Créez l'application en mode de publication et exécutez-la sur un appareil.
  2. Modifiez temporairement sUseEmulators sur false et exécutez à nouveau l'application.

Notez que vous devrez peut-être vous déconnecter de l'application et vous reconnecter pour vous connecter correctement à la production.