Zacznij korzystać ze zdalnej konfiguracji Firebase

iOS+ Android Web Flutter Unity C++

Możesz użyć Firebase Remote Config do definiowania parametrów w swojej aplikacji i aktualizowania ich wartości w chmurze, co pozwala modyfikować wygląd i zachowanie aplikacji bez dystrybucji aktualizacji aplikacji. Ten przewodnik przeprowadzi Cię przez kroki, aby rozpocząć i zawiera przykładowy kod, z których wszystkie są dostępne do sklonowania lub pobrania z repozytorium GitHub firebase/quickstart-android .

Krok 1: Dodaj Firebase i pakiet SDK Remote Config do swojej aplikacji

1. Jeśli jeszcze tego nie zrobiłeś, dodaj Firebase do swojego projektu na Androida .

2. W przypadku zdalnej konfiguracji usługa Google Analytics jest wymagana do warunkowego kierowania instancji aplikacji na właściwości użytkowników i odbiorców. Upewnij się, że włączysz Google Analytics w swoim projekcie.

3. W pliku Gradle modułu (na poziomie aplikacji) (zwykle <project>/<app-module>/build.gradle ) dodaj zależność dla biblioteki Remote Config Android. Zalecamy używanie Firebase Android BoM do kontrolowania wersji bibliotek.

   Ponadto w ramach konfigurowania Analytics musisz dodać do swojej aplikacji pakiet Firebase SDK dla Google Analytics.

   Java

   dependencies {
       // Import the BoM for the Firebase platform
       implementation platform('com.google.firebase:firebase-bom:31.1.0')
   
       // 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'
   }
   

   Korzystając z Firebase Android BoM , Twoja aplikacja będzie zawsze korzystać ze zgodnych wersji bibliotek Firebase Android.

   (Alternatywnie) Dodaj zależności biblioteki Firebase bez korzystania z BoM

   Jeśli zdecydujesz się nie używać BoM Firebase, musisz określić każdą wersję biblioteki Firebase w jej wierszu zależności.

   Pamiętaj, że jeśli używasz w swojej aplikacji wielu bibliotek Firebase, zdecydowanie zalecamy korzystanie z BoM do zarządzania wersjami bibliotek, co zapewnia zgodność wszystkich wersji.

   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.2.0'
       implementation 'com.google.firebase:firebase-analytics:21.2.0'
   }
   

   Kotlin+KTX

   dependencies {
       // Import the BoM for the Firebase platform
       implementation platform('com.google.firebase:firebase-bom:31.1.0')
   
       // 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-ktx'
       implementation 'com.google.firebase:firebase-analytics-ktx'
   }
   

   Korzystając z Firebase Android BoM , Twoja aplikacja będzie zawsze korzystać ze zgodnych wersji bibliotek Firebase Android.

   (Alternatywnie) Dodaj zależności biblioteki Firebase bez korzystania z BoM

   Jeśli zdecydujesz się nie używać BoM Firebase, musisz określić każdą wersję biblioteki Firebase w jej wierszu zależności.

   Pamiętaj, że jeśli używasz w swojej aplikacji wielu bibliotek Firebase, zdecydowanie zalecamy korzystanie z BoM do zarządzania wersjami bibliotek, co zapewnia zgodność wszystkich wersji.

   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-ktx:21.2.0'
       implementation 'com.google.firebase:firebase-analytics-ktx:21.2.0'
   }
   

Uwaga: ponieważ zestaw Android SDK jest zależny od interfejsu API REST usługi Remote Config, pamiętaj, aby nie wyłączać tego interfejsu API, który jest domyślnie włączony w typowym projekcie.

Krok 2: Pobierz pojedynczy obiekt Remote Config

Uzyskaj instancję obiektu Remote Config i ustaw minimalny interwał pobierania, aby umożliwić częste odświeżanie:

Java

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

Kotlin+KTX

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

Obiekt singleton służy do przechowywania domyślnych wartości parametrów w aplikacji, pobierania zaktualizowanych wartości parametrów z zaplecza i kontrolowania, kiedy pobrane wartości są udostępniane Twojej aplikacji.

Podczas programowania zaleca się ustawienie stosunkowo niskiego minimalnego interwału pobierania. Zobacz Ograniczanie , aby uzyskać więcej informacji.

Krok 3: Ustaw domyślne wartości parametrów w aplikacji

Możesz ustawić domyślne wartości parametrów w aplikacji w obiekcie Zdalna konfiguracja, aby Twoja aplikacja zachowywała się zgodnie z oczekiwaniami, zanim połączy się z zapleczem Zdalnej konfiguracji, i aby wartości domyślne były dostępne, jeśli żadne nie zostaną ustawione w zapleczu.

1. Zdefiniuj zestaw nazw parametrów i domyślne wartości parametrów przy użyciu obiektu mapy lub pliku zasobów XML przechowywanego w folderze res/xml aplikacji. Przykładowa aplikacja Szybki start aplikacji Remote Config używa pliku XML do definiowania domyślnych nazw i wartości parametrów.

   Jeśli masz już skonfigurowane wartości parametrów zaplecza Remote Config, możesz pobrać wygenerowany plik XML zawierający wszystkie wartości domyślne i zapisać go w katalogu res/xml aplikacji:

   RESZTA

   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
   

   Konsola Firebase

   1. W zakładce Parametry otwórz menu i wybierz Pobierz wartości domyślne .

   2. Po wyświetleniu monitu włącz format .xml dla Androida , a następnie kliknij Pobierz plik .

2. Dodaj te wartości do obiektu Remote Config za pomocą setDefaultsAsync(int) , jak pokazano:

   Java

   mFirebaseRemoteConfig.setDefaultsAsync(R.xml.remote_config_defaults);

   Kotlin+KTX

   remoteConfig.setDefaultsAsync(R.xml.remote_config_defaults)

Krok 4: Pobierz wartości parametrów do wykorzystania w aplikacji

Teraz możesz uzyskać wartości parametrów z obiektu Remote Config. Jeśli ustawisz wartości w zapleczu, pobierzesz je, a następnie aktywujesz, wartości te będą dostępne dla Twojej aplikacji. W przeciwnym razie otrzymasz wartości parametrów w aplikacji skonfigurowane przy użyciu setDefaultsAsync(int) . Aby uzyskać te wartości, wywołaj metodę wymienioną poniżej, która odwzorowuje typ danych oczekiwany przez aplikację, podając klucz parametru jako argument:

• getBoolean()
• getDouble()
• getLong()
• getString()

Krok 5: Ustaw wartości parametrów w zapleczu Remote Config

Korzystając z konsoli Firebase lub interfejsów API zaplecza Remote Config , możesz tworzyć nowe wartości domyślne po stronie serwera, które zastępują wartości w aplikacji zgodnie z wymaganą logiką warunkową lub kierowaniem na użytkownika. W tej sekcji opisano kroki konsoli Firebase, które należy wykonać, aby utworzyć te wartości.

1. W konsoli Firebase otwórz swój projekt.
2. Wybierz opcję Zdalna konfiguracja z menu, aby wyświetlić pulpit nawigacyjny Zdalnej konfiguracji.
3. Zdefiniuj parametry o takich samych nazwach jak parametry zdefiniowane w aplikacji. Dla każdego parametru możesz ustawić wartość domyślną (która ostatecznie zastąpi odpowiednią wartość domyślną w aplikacji), a także możesz ustawić wartości warunkowe. Aby dowiedzieć się więcej, zobacz Parametry i warunki zdalnej konfiguracji .

Krok 6: Pobierz i aktywuj wartości

1. Aby pobrać wartości parametrów z zaplecza Remote Config, wywołaj metodę fetch() . Wszelkie wartości ustawione w zapleczu są pobierane i przechowywane w obiekcie Zdalna konfiguracja.

2. Aby udostępnić pobrane wartości parametrów swojej aplikacji, wywołaj metodę activate() .

   W przypadkach, w których chcesz pobrać i aktywować wartości w jednym wywołaniu, możesz użyć fetchAndActivate() w celu pobrania wartości z zaplecza Remote Config i udostępnienia ich aplikacji:

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

   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()
       }

Ponieważ te zaktualizowane wartości parametrów wpływają na zachowanie i wygląd Twojej aplikacji, należy aktywować pobrane wartości w czasie, który zapewni użytkownikowi bezproblemowe działanie, na przykład przy następnym otwarciu aplikacji przez użytkownika. Zobacz Strategie ładowania zdalnej konfiguracji, aby uzyskać więcej informacji i przykładów.

Uwaga: jeśli Twoja aplikacja nie tworzy się w Gradle, musisz ręcznie dodać prawidłowy zasób łańcuchowy google_app_id do swojej aplikacji, aby Zdalna konfiguracja mogła zostać zainicjowana. Wtyczka google-services Gradle zwykle dodaje to automatycznie, ale odpowiednią wartość można znaleźć w pliku google-services.json , który pobierasz z konsoli Firebase. Więcej informacji o pobieraniu wartości google_app_id z pliku google-services.json znajdziesz w artykule Przetwarzanie pliku JSON .

Ograniczanie

Jeśli aplikacja jest pobierana zbyt wiele razy w krótkim czasie, wywołania pobierania są ograniczane, a pakiet SDK zwraca FirebaseRemoteConfigFetchThrottledException . Przed SDK w wersji 17.0.0 limit wynosił 5 żądań pobrania w 60-minutowym oknie (nowsze wersje mają bardziej liberalne limity).

Podczas tworzenia aplikacji możesz chcieć bardzo często pobierać i aktywować konfiguracje (wiele razy na godzinę), aby umożliwić szybkie iteracje podczas opracowywania i testowania aplikacji. Aby dostosować się do szybkiej iteracji projektu z maksymalnie 10 programistami, możesz tymczasowo ustawić obiekt FirebaseRemoteConfigSettings z niskim minimalnym interwałem pobierania ( setMinimumFetchIntervalInSeconds ) w swojej aplikacji.

Domyślny minimalny interwał pobierania dla Zdalnej konfiguracji wynosi 12 godzin, co oznacza, że ​​konfiguracje nie będą pobierane z zaplecza więcej niż raz w ciągu 12 godzin, niezależnie od liczby faktycznie wykonanych wywołań pobierania. W szczególności minimalny interwał pobierania jest określany w następującej kolejności:

1. Parametr w fetch(long)
2. Parametr w FirebaseRemoteConfigSettings.setMinimumFetchIntervalInSeconds(long)
3. Wartość domyślna 12 godzin

Aby ustawić minimalny interwał pobierania na wartość niestandardową, użyj FirebaseRemoteConfigSettings.Builder.setMinimumFetchIntervalInSeconds(long) .

Pamiętaj, że to ustawienie powinno być używane tylko do programowania, a nie do aplikacji działającej w środowisku produkcyjnym. Jeśli tylko testujesz swoją aplikację z małym 10-osobowym zespołem programistów, jest mało prawdopodobne, że osiągniesz godzinowe limity przydziału po stronie usługi. Ale jeśli udostępnisz swoją aplikację tysiącom użytkowników testowych z bardzo niskim minimalnym interwałem pobierania, Twoja aplikacja prawdopodobnie osiągnie ten limit.

Next steps

If you haven't already, explore the Remote Config use cases , and take a look at some of the key concepts and advanced strategies documentation, including:

• Manage Remote Config template versions
• Config loading strategies