Inizia con Firebase Remote Config


Puoi utilizzare Firebase Remote Config per definire i parametri nella tua app e aggiornarne i valori nel cloud, consentendoti di modificare l'aspetto e il comportamento della tua app senza distribuire un aggiornamento dell'app. Questa guida ti guida attraverso i passaggi per iniziare e fornisce del codice di esempio, il tutto disponibile per essere clonato o scaricato dal repository GitHub firebase/quickstart-android .

Passaggio 1: aggiungi Firebase e Remote Config SDK alla tua app

  1. Se non l'hai già fatto, aggiungi Firebase al tuo progetto Android .

  2. Per Remote Config, Google Analytics è necessario per il targeting condizionale delle istanze dell'app alle proprietà utente e ai segmenti di pubblico. Assicurati di abilitare Google Analytics nel tuo progetto.

  3. Nel file Gradle del tuo modulo (a livello di app) (solitamente <project>/<app-module>/build.gradle.kts o <project>/<app-module>/build.gradle ), aggiungi la dipendenza per Remote Config libreria per Android. Ti consigliamo di utilizzare la distinta base Android Firebase per controllare il controllo delle versioni della libreria.

    Inoltre, come parte della configurazione di Analytics, devi aggiungere l'SDK Firebase per Google Analytics alla tua app.

    dependencies {
        // Import the BoM for the Firebase platform
        implementation(platform("com.google.firebase:firebase-bom:32.7.2"))
    
        // Add the dependencies for the Remote Config and Analytics libraries
        // When using the BoM, you don't specify versions in Firebase library dependencies
        implementation("com.google.firebase:firebase-config")
        implementation("com.google.firebase:firebase-analytics")
    }
    

    Utilizzando la distinta base Firebase per Android , la tua app utilizzerà sempre le versioni compatibili delle librerie Firebase Android.

    (Alternativa) Aggiungi le dipendenze della libreria Firebase senza utilizzare la distinta base

    Se scegli di non utilizzare la distinta base Firebase, devi specificare ciascuna versione della libreria Firebase nella relativa riga di dipendenza.

    Tieni presente che se utilizzi più librerie Firebase nella tua app, ti consigliamo vivamente di utilizzare la distinta base per gestire le versioni della libreria, il che garantisce che tutte le versioni siano compatibili.

    dependencies {
        // Add the dependencies for the Remote Config and Analytics libraries
        // When NOT using the BoM, you must specify versions in Firebase library dependencies
        implementation("com.google.firebase:firebase-config:21.6.1")
        implementation("com.google.firebase:firebase-analytics:21.5.1")
    }
    
    Cerchi un modulo di libreria specifico per Kotlin? A partire da ottobre 2023 (Firebase BoM 32.5.0) , sia gli sviluppatori Kotlin che Java potranno dipendere dal modulo della libreria principale (per i dettagli, vedere le FAQ su questa iniziativa ).

Passaggio 2: ottenere l'oggetto singleton Remote Config

Ottieni un'istanza dell'oggetto Remote Config e imposta l'intervallo di recupero minimo per consentire aggiornamenti frequenti:

Kotlin+KTX

val remoteConfig: FirebaseRemoteConfig = Firebase.remoteConfig
val configSettings = remoteConfigSettings {
    minimumFetchIntervalInSeconds = 3600
}
remoteConfig.setConfigSettingsAsync(configSettings)

Java

FirebaseRemoteConfig mFirebaseRemoteConfig = FirebaseRemoteConfig.getInstance();
FirebaseRemoteConfigSettings configSettings = new FirebaseRemoteConfigSettings.Builder()
        .setMinimumFetchIntervalInSeconds(3600)
        .build();
mFirebaseRemoteConfig.setConfigSettingsAsync(configSettings);

L'oggetto singleton viene utilizzato per archiviare i valori dei parametri predefiniti in-app, recuperare i valori dei parametri aggiornati dal back-end e controllare quando i valori recuperati vengono resi disponibili alla tua app.

Durante lo sviluppo, si consiglia di impostare un intervallo di recupero minimo relativamente basso. Per ulteriori informazioni, vedere Limitazione .

Passaggio 3: imposta i valori dei parametri predefiniti in-app

Puoi impostare i valori dei parametri predefiniti in-app nell'oggetto Remote Config, in modo che la tua app si comporti come previsto prima di connettersi al backend Remote Config e in modo che i valori predefiniti siano disponibili se non ne sono impostati nessuno nel backend.

  1. Definisci un set di nomi di parametri e valori di parametro predefiniti utilizzando un oggetto Map o un file di risorse XML archiviato nella cartella res/xml della tua app. L'app di esempio di avvio rapido Remote Config utilizza un file XML per definire nomi e valori dei parametri predefiniti.

    Se hai già configurato i valori dei parametri backend di Remote Config, puoi scaricare un file XML generato che include tutti i valori predefiniti e salvarlo nella directory res/xml della tua app:

    RIPOSO

    curl --compressed -D headers -H "Authorization: Bearer token" -X GET https://firebaseremoteconfig.googleapis.com/v1/projects/my-project-id/remoteConfig:downloadDefaults?format=XML -o remote_config_defaults.xml
    

    Console Firebase

    1. Nella scheda Parametri , apri il menu e seleziona Scarica valori predefiniti .

    2. Quando richiesto, abilita .xml per Android , quindi fai clic su Scarica file .

  2. Aggiungi questi valori all'oggetto Remote Config utilizzando setDefaultsAsync(int) , come mostrato:

    Kotlin+KTX

    remoteConfig.setDefaultsAsync(R.xml.remote_config_defaults)

    Java

    mFirebaseRemoteConfig.setDefaultsAsync(R.xml.remote_config_defaults);

Passaggio 4: ottieni i valori dei parametri da utilizzare nella tua app

Ora puoi ottenere i valori dei parametri dall'oggetto Remote Config. Se imposti valori nel backend, li recuperi e quindi li attivi, tali valori saranno disponibili per la tua app. In caso contrario, ottieni i valori dei parametri in-app configurati utilizzando setDefaultsAsync(int) . Per ottenere questi valori, chiama il metodo elencato di seguito che mappa il tipo di dati previsto dalla tua app, fornendo la chiave del parametro come argomento:

Passaggio 5: impostare i valori dei parametri nel backend Remote Config

Utilizzando la console Firebase o le API di backend Remote Config , puoi creare nuovi valori predefiniti lato server che sostituiscono i valori in-app in base alla logica condizionale o al targeting utente desiderato. Questa sezione descrive i passaggi della console Firebase per creare questi valori.

  1. Nella console Firebase , apri il tuo progetto.
  2. Selezionare Remote Config dal menu per visualizzare il dashboard Remote Config.
  3. Definisci i parametri con gli stessi nomi dei parametri che hai definito nella tua app. Per ogni parametro, puoi impostare un valore predefinito (che alla fine sovrascriverà il valore predefinito in-app corrispondente) e puoi anche impostare valori condizionali. Per ulteriori informazioni, consulta Parametri e condizioni di configurazione remota .

Passaggio 6: recupera e attiva i valori

  1. Per recuperare i valori dei parametri dal backend Remote Config, chiamare il metodo fetch() . Tutti i valori impostati nel backend vengono recuperati e archiviati nell'oggetto Remote Config.
  2. Per rendere disponibili alla tua app i valori dei parametri recuperati, chiama il activate() .

    Nei casi in cui desideri recuperare e attivare valori in una chiamata, puoi utilizzare una richiesta fetchAndActivate() per recuperare valori dal backend Remote Config e renderli disponibili all'app:

    Kotlin+KTX

    remoteConfig.fetchAndActivate()
        .addOnCompleteListener(this) { task ->
            if (task.isSuccessful) {
                val updated = task.result
                Log.d(TAG, "Config params updated: $updated")
                Toast.makeText(
                    this,
                    "Fetch and activate succeeded",
                    Toast.LENGTH_SHORT,
                ).show()
            } else {
                Toast.makeText(
                    this,
                    "Fetch failed",
                    Toast.LENGTH_SHORT,
                ).show()
            }
            displayWelcomeMessage()
        }

    Java

    mFirebaseRemoteConfig.fetchAndActivate()
            .addOnCompleteListener(this, new OnCompleteListener<Boolean>() {
                @Override
                public void onComplete(@NonNull Task<Boolean> task) {
                    if (task.isSuccessful()) {
                        boolean updated = task.getResult();
                        Log.d(TAG, "Config params updated: " + updated);
                        Toast.makeText(MainActivity.this, "Fetch and activate succeeded",
                                Toast.LENGTH_SHORT).show();
    
                    } else {
                        Toast.makeText(MainActivity.this, "Fetch failed",
                                Toast.LENGTH_SHORT).show();
                    }
                    displayWelcomeMessage();
                }
            });

Poiché questi valori dei parametri aggiornati influiscono sul comportamento e sull'aspetto della tua app, dovresti attivare i valori recuperati in un momento che garantisca un'esperienza fluida per il tuo utente, ad esempio la prossima volta che l'utente apre la tua app. Per ulteriori informazioni ed esempi, vedere Strategie di caricamento di Remote Config .

Passaggio 7: ascolta gli aggiornamenti in tempo reale

Dopo aver recuperato i valori dei parametri, puoi utilizzare Remote Config in tempo reale per ascoltare gli aggiornamenti dal backend Remote Config. Remote Config in tempo reale segnala ai dispositivi collegati quando sono disponibili aggiornamenti e recupera automaticamente le modifiche dopo aver pubblicato una nuova versione di Remote Config.

Gli aggiornamenti in tempo reale sono supportati da Firebase SDK per Android v21.3.0+ (Firebase BoM v31.2.4+).

  1. Nella tua app, utilizza addOnConfigUpdateListener() per iniziare ad ascoltare gli aggiornamenti e recuperare automaticamente eventuali nuovi valori di parametro. Implementa il callback onUpdate() per attivare la configurazione aggiornata.

    Kotlin+KTX

    remoteConfig.addOnConfigUpdateListener(object : ConfigUpdateListener {
        override fun onUpdate(configUpdate : ConfigUpdate) {
           Log.d(TAG, "Updated keys: " + configUpdate.updatedKeys);
    
           if (configUpdate.updatedKeys.contains("welcome_message")) {
               remoteConfig.activate().addOnCompleteListener {
                   displayWelcomeMessage()
               }
           }
        }
    
        override fun onError(error : FirebaseRemoteConfigException) {
            Log.w(TAG, "Config update error with code: " + error.code, error)
        }
    })
    

    Java

    mFirebaseRemoteConfig.addOnConfigUpdateListener(new ConfigUpdateListener() {
        @Override
        public void onUpdate(ConfigUpdate configUpdate) {
            Log.d(TAG, "Updated keys: " + configUpdate.getUpdatedKeys());
    
            mFirebaseRemoteConfig.activate().addOnCompleteListener(new OnCompleteListener() {
                @Override
                public void onComplete(@NonNull Task task) {
                    displayWelcomeMessage();
                }
            });
        }
    
        @Override
        public void onError(FirebaseRemoteConfigException error) {
            Log.w(TAG, "Config update error with code: " + error.getCode(), error);
        }
    });
    
  2. La prossima volta che pubblichi una nuova versione di Remote Config, i dispositivi che eseguono la tua app e sono in ascolto delle modifiche chiameranno ConfigUpdateListener .

Limitazione

Se un'app viene recuperata troppe volte in un breve periodo di tempo, le chiamate di recupero vengono limitate e l'SDK restituisce FirebaseRemoteConfigFetchThrottledException . Prima della versione 17.0.0 dell'SDK, il limite era di 5 richieste di recupero in una finestra di 60 minuti (le versioni più recenti hanno limiti più permissivi).

Durante lo sviluppo dell'app, potresti voler recuperare e attivare le configurazioni molto frequentemente (molte volte all'ora) per poter eseguire rapidamente l'iterazione mentre sviluppi e testi la tua app. Gli aggiornamenti di configurazione remota in tempo reale ignorano automaticamente la cache quando la configurazione viene aggiornata sul server. Per consentire un'iterazione rapida su un progetto con un massimo di 10 sviluppatori, puoi impostare temporaneamente un oggetto FirebaseRemoteConfigSettings con un intervallo di recupero minimo basso ( setMinimumFetchIntervalInSeconds ) nella tua app.

L'intervallo di recupero minimo predefinito per Remote Config è 12 ore, il che significa che le configurazioni non verranno recuperate dal backend più di una volta in una finestra di 12 ore, indipendentemente dal numero di chiamate di recupero effettivamente effettuate. Nello specifico, l'intervallo di recupero minimo è determinato nel seguente ordine:

  1. Il parametro in fetch(long)
  2. Il parametro in FirebaseRemoteConfigSettings.setMinimumFetchIntervalInSeconds(long)
  3. Il valore predefinito è 12 ore

Per impostare l'intervallo di recupero minimo su un valore personalizzato, utilizza FirebaseRemoteConfigSettings.Builder.setMinimumFetchIntervalInSeconds(long) .

Prossimi passi

Se non l'hai già fatto, esplora i casi d'uso di configurazione remota e dai un'occhiata ad alcuni dei concetti chiave e alla documentazione di strategie avanzate, tra cui: