Check out what’s new from Firebase at Google I/O 2022. Learn more

Installation et configuration sur Android

Connectez votre application à Firebase

Si vous ne l'avez pas déjà fait, ajoutez Firebase à votre projet Android .

Créer une base de données

  1. Accédez à la section Base de données en temps réel de la console Firebase . Vous serez invité à sélectionner un projet Firebase existant. Suivez le workflow de création de la base de données.

  2. Sélectionnez un mode de démarrage pour vos règles de sécurité Firebase :

    Mode d'essai

    Bon pour démarrer avec les bibliothèques de clients mobiles et Web, mais permet à n'importe qui de lire et d'écraser vos données. Après le test, assurez-vous de consulter la section Comprendre les règles de la base de données en temps réel Firebase .

    Pour démarrer avec le Web, Apple ou Android SDK, sélectionnez testmode.

    Mode verrouillé

    Refuse toutes les lectures et écritures des clients mobiles et Web. Vos serveurs d'applications authentifiés peuvent toujours accéder à votre base de données.

  3. Choisissez un emplacement pour la base de données.

    Selon l' emplacement de la base de données , l'URL de la nouvelle base de données se présentera sous l'une des formes suivantes :

    • DATABASE_NAME .firebaseio.com (pour les bases de données dans us-central1 )

    • DATABASE_NAME . REGION .firebasedatabase.app (pour les bases de données dans tous les autres emplacements)

  4. Cliquez sur Terminé .

Lorsque vous activez la base de données en temps réel, cela active également l'API dans Cloud API Manager .

Ajouter le SDK de base de données en temps réel à votre application

À l'aide de Firebase Android BoM , déclarez la dépendance de la bibliothèque Realtime Database Android dans le fichier Gradle de votre module (au niveau de l'application) (généralement app/build.gradle ).

Java

dependencies {
    // Import the BoM for the Firebase platform
    implementation platform('com.google.firebase:firebase-bom:30.1.0')

    // Declare the dependency for the Realtime Database library
    // When using the BoM, you don't specify versions in Firebase library dependencies
    implementation 'com.google.firebase:firebase-database'
}

En utilisant Firebase Android BoM , votre application utilisera toujours des versions compatibles des bibliothèques Firebase Android.

(Alternative) Déclarer les dépendances de la bibliothèque Firebase sans utiliser le BoM

Si vous choisissez de ne pas utiliser la nomenclature Firebase, vous devez spécifier chaque version de la bibliothèque Firebase dans sa ligne de dépendance.

Notez que si vous utilisez plusieurs bibliothèques Firebase dans votre application, nous vous recommandons vivement d'utiliser la BoM pour gérer les versions de la bibliothèque, ce qui garantit que toutes les versions sont compatibles.

dependencies {
    // Declare the dependency for the Realtime Database library
    // When NOT using the BoM, you must specify versions in Firebase library dependencies
    implementation 'com.google.firebase:firebase-database:20.0.5'
}

Kotlin+KTX

dependencies {
    // Import the BoM for the Firebase platform
    implementation platform('com.google.firebase:firebase-bom:30.1.0')

    // Declare the dependency for the Realtime Database library
    // When using the BoM, you don't specify versions in Firebase library dependencies
    implementation 'com.google.firebase:firebase-database-ktx'
}

En utilisant Firebase Android BoM , votre application utilisera toujours des versions compatibles des bibliothèques Firebase Android.

(Alternative) Déclarer les dépendances de la bibliothèque Firebase sans utiliser le BoM

Si vous choisissez de ne pas utiliser la nomenclature Firebase, vous devez spécifier chaque version de la bibliothèque Firebase dans sa ligne de dépendance.

Notez que si vous utilisez plusieurs bibliothèques Firebase dans votre application, nous vous recommandons vivement d'utiliser la BoM pour gérer les versions de la bibliothèque, ce qui garantit que toutes les versions sont compatibles.

dependencies {
    // Declare the dependency for the Realtime Database library
    // When NOT using the BoM, you must specify versions in Firebase library dependencies
    implementation 'com.google.firebase:firebase-database-ktx:20.0.5'
}

Configurer les règles de base de données en temps réel

La base de données en temps réel fournit un langage de règles déclaratives qui vous permet de définir comment vos données doivent être structurées, comment elles doivent être indexées et quand vos données peuvent être lues et écrites.

Ecrire dans votre base de données

Récupérez une instance de votre base de données à l'aide de getInstance() et référencez l'emplacement dans lequel vous souhaitez écrire.

Java

// Write a message to the database
FirebaseDatabase database = FirebaseDatabase.getInstance();
DatabaseReference myRef = database.getReference("message");

myRef.setValue("Hello, World!");

Kotlin+KTX

// Write a message to the database
val database = Firebase.database
val myRef = database.getReference("message")

myRef.setValue("Hello, World!")

Vous pouvez ainsi enregistrer une plage de types de données dans la base de données, y compris des objets Java. Lorsque vous enregistrez un objet, les réponses de tous les getters seront enregistrées en tant qu'enfants de cet emplacement.

Lire à partir de votre base de données

Pour mettre à jour les données de votre application en temps réel, vous devez ajouter un ValueEventListener à la référence que vous venez de créer.

La méthode onDataChange() de cette classe est déclenchée une fois lorsque l'écouteur est attaché et à nouveau chaque fois que les données changent, y compris les enfants.

Java

// Read from the database
myRef.addValueEventListener(new ValueEventListener() {
    @Override
    public void onDataChange(DataSnapshot dataSnapshot) {
        // This method is called once with the initial value and again
        // whenever data at this location is updated.
        String value = dataSnapshot.getValue(String.class);
        Log.d(TAG, "Value is: " + value);
    }

    @Override
    public void onCancelled(DatabaseError error) {
        // Failed to read value
        Log.w(TAG, "Failed to read value.", error.toException());
    }
});

Kotlin+KTX

// Read from the database
myRef.addValueEventListener(object : ValueEventListener {
    override fun onDataChange(dataSnapshot: DataSnapshot) {
        // This method is called once with the initial value and again
        // whenever data at this location is updated.
        val value = dataSnapshot.getValue<String>()
        Log.d(TAG, "Value is: $value")
    }

    override fun onCancelled(error: DatabaseError) {
        // Failed to read value
        Log.w(TAG, "Failed to read value.", error.toException())
    }
})

Facultatif : configurer ProGuard

Lorsque vous utilisez Firebase Realtime Database dans votre application avec ProGuard, vous devez tenir compte de la manière dont vos objets de modèle seront sérialisés et désérialisés après l'obscurcissement. Si vous utilisez DataSnapshot.getValue(Class) ou DatabaseReference.setValue(Object) pour lire et écrire des données, vous devrez ajouter des règles au fichier proguard-rules.pro :

    # Add this global rule
    -keepattributes Signature

    # This rule will properly ProGuard all the model classes in
    # the package com.yourcompany.models.
    # Modify this rule to fit the structure of your app.
    -keepclassmembers class com.yourcompany.models.** {
      *;
    }

Pour obtenir de l'aide pour des questions ou des problèmes liés à ProGuard, visitez les forums de la communauté Guardsquare pour obtenir l'aide d'un expert.

Préparez-vous pour le lancement

Avant de lancer votre application, nous vous recommandons de parcourir notre liste de contrôle de lancement pour vous assurer que votre application est prête à être utilisée !

Assurez-vous d'activer App Check pour vous assurer que seules vos applications peuvent accéder à vos bases de données.

Prochaines étapes