Za pomocą Firebase Remote Config możesz definiować parametry w swojej aplikacji i aktualizować ich wartości w chmurze, co pozwala modyfikować wygląd i zachowanie aplikacji bez rozpowszechniania aktualizacji aplikacji.
Biblioteka Remote Config służy do przechowywania domyślnych wartości parametrów w aplikacji, pobierania zaktualizowanych wartości parametrów z zaplecza Remote Config i kontrolowania, kiedy pobrane wartości są udostępniane Twojej aplikacji. Aby dowiedzieć się więcej, zobacz Strategie ładowania zdalnej konfiguracji .
Ten przewodnik przeprowadzi Cię przez kolejne kroki i zawiera przykładowy kod, który można sklonować lub pobrać z repozytorium GitHub firebase/quickstart-unity .
Krok 1: Dodaj zdalną konfigurację do swojej aplikacji
Zanim będziesz mógł skorzystać ze Zdalnej konfiguracji , musisz:
Zarejestruj swój projekt Unity i skonfiguruj go do korzystania z Firebase.
Jeśli Twój projekt Unity korzysta już z Firebase, oznacza to, że jest już zarejestrowany i skonfigurowany dla Firebase.
Jeśli nie masz projektu Unity, możesz pobrać przykładową aplikację .
Dodaj pakiet SDK Firebase Unity (w szczególności
FirebaseRemoteConfig.unitypackage) do swojego projektu Unity.
Pamiętaj, że dodanie Firebase do projektu Unity obejmuje zadania zarówno w konsoli Firebase , jak i w otwartym projekcie Unity (na przykład pobierasz pliki konfiguracyjne Firebase z konsoli, a następnie przenosisz je do projektu Unity).
Krok 2: Ustaw domyślne wartości parametrów w aplikacji
Możesz ustawić domyślne wartości parametrów w aplikacji w obiekcie Remote Config, tak aby aplikacja zachowywała się zgodnie z oczekiwaniami przed połączeniem się z backendem Remote Config i aby dostępne były wartości domyślne, jeśli w backendie nie ustawiono żadnych wartości.
Aby to zrobić, utwórz słownik ciągów i wypełnij go parami klucz/wartość reprezentującymi wartości domyślne, które chcesz dodać. Jeśli wartości parametrów zaplecza usługi Remote Config zostały już skonfigurowane, możesz pobrać plik zawierający te pary klucz/wartość i użyć go do skonstruowania słownika ciągów. Aby uzyskać więcej informacji, zobacz Pobieranie domyślnych szablonów zdalnej konfiguracji .
(Właściwości inne niż ciąg zostaną przekonwertowane na typ właściwości po wywołaniu SetDefaultsAsync() ).
System.Collections.Generic.Dictionary<string, object> defaults =
new System.Collections.Generic.Dictionary<string, object>();
// These are the values that are used if we haven't fetched data from the
// server
// yet, or if we ask for values that the server doesn't have:
defaults.Add("config_test_string", "default local string");
defaults.Add("config_test_int", 1);
defaults.Add("config_test_float", 1.0);
defaults.Add("config_test_bool", false);
Firebase.RemoteConfig.FirebaseRemoteConfig.DefaultInstance.SetDefaultsAsync(defaults)
.ContinueWithOnMainThread(task => {
Krok 3: Uzyskaj wartości parametrów do wykorzystania w swojej aplikacji
Teraz możesz uzyskać wartości parametrów z obiektu Remote Config. Jeśli ustawisz wartości w zapleczu zdalnej konfiguracji, pobierzesz je, a następnie aktywujesz, te wartości będą dostępne dla Twojej aplikacji. W przeciwnym razie wartości parametrów w aplikacji zostaną skonfigurowane przy użyciu SetDefaultsAsync() .
Aby uzyskać te wartości, użyj GetValue() , podając klucz parametru jako argument. Zwraca to ConfigValue , który ma właściwości umożliwiające konwersję wartości na różne typy podstawowe.
Krok 4: Połącz swoją aplikację w konsoli Firebase
W konsoli Firebase dodaj aplikację do projektu Firebase.
Krok 5: Ustaw wartości parametrów
- W konsoli Firebase otwórz swój projekt.
- Wybierz opcję Zdalna konfiguracja z menu, aby wyświetlić pulpit nawigacyjny Zdalnej konfiguracji.
- 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 wartość domyślną w aplikacji) i wartości warunkowe. Aby dowiedzieć się więcej, zobacz Parametry i warunki Zdalnej konfiguracji .
Krok 6: Pobierz i aktywuj wartości (w razie potrzeby)
Aby pobrać wartości parametrów z zaplecza zdalnej konfiguracji, wywołaj metodę FetchAsync() . Wszelkie wartości ustawione w backendie są pobierane i buforowane w obiekcie Remote Config.
// Start a fetch request.
// FetchAsync only fetches new data if the current data is older than the provided
// timespan. Otherwise it assumes the data is "recent enough", and does nothing.
// By default the timespan is 12 hours, and for production apps, this is a good
// number. For this example though, it's set to a timespan of zero, so that
// changes in the console will always show up immediately.
public Task FetchDataAsync() {
DebugLog("Fetching data...");
System.Threading.Tasks.Task fetchTask =
Firebase.RemoteConfig.FirebaseRemoteConfig.DefaultInstance.FetchAsync(
TimeSpan.Zero);
return fetchTask.ContinueWithOnMainThread(FetchComplete);
}
W powyższym kodzie FetchComplete jest metodą, której sygnatura odpowiada parametrom jednego z przeciążeń ContinueWithOnMainThread() .
W poniższym przykładowym kodzie do metody FetchComplete przekazywane jest poprzednie zadanie ( fetchTask ), które pozwala FetchComplete określić, czy zostało ono zakończone. Kod używa Info.LastFetchStatus , aby następnie określić, czy zakończenie również się powiodło. Jeśli tak, wartości parametrów Remote Config są następnie aktywowane za pomocą ActivateAsync() .
private void FetchComplete(Task fetchTask) {
if (!fetchTask.IsCompleted) {
Debug.LogError("Retrieval hasn't finished.");
return;
}
var remoteConfig = FirebaseRemoteConfig.DefaultInstance;
var info = remoteConfig.Info;
if(info.LastFetchStatus != LastFetchStatus.Success) {
Debug.LogError($"{nameof(FetchComplete)} was unsuccessful\n{nameof(info.LastFetchStatus)}: {info.LastFetchStatus}");
return;
}
// Fetch successful. Parameter values must be activated to use.
remoteConfig.ActivateAsync()
.ContinueWithOnMainThread(
task => {
Debug.Log($"Remote data loaded and ready for use. Last fetch time {info.FetchTime}.");
});
}
Wartości pobrane za pomocą FetchAsync() są buforowane lokalnie po zakończeniu pobierania, ale nie są udostępniane do czasu wywołania ActivateAsync() . Dzięki temu można mieć pewność, że nowe wartości nie zostaną zastosowane w trakcie obliczeń lub w innym momencie, co mogłoby spowodować problemy lub dziwne zachowanie.
Krok 7: Słuchaj aktualizacji w czasie rzeczywistym
Po pobraniu wartości parametrów można używać funkcji Remote Config w czasie rzeczywistym do nasłuchiwania aktualizacji z zaplecza Remote Config. Zdalna konfiguracja w czasie rzeczywistym sygnalizuje podłączonym urządzeniom dostępność aktualizacji i automatycznie pobiera zmiany po opublikowaniu nowej wersji Zdalnej konfiguracji.
Aktualizacje w czasie rzeczywistym są obsługiwane przez pakiet Firebase Unity SDK w wersji 11.0.0 lub nowszej dla platform Android i Apple.
- Dodaj w swojej aplikacji obiekt
OnConfigUpdateListener, aby rozpocząć nasłuchiwanie aktualizacji i automatycznie pobierać nowe lub zaktualizowane wartości parametrów. Następnie utwórzConfigUpdateListenerEventHandler, aby przetwarzać zdarzenia aktualizacji. Poniższy przykład nasłuchuje aktualizacji i używa nowo pobranych wartości do wyświetlenia zaktualizowanej wiadomości powitalnej.
// Invoke the listener.
void Start()
{
Firebase.RemoteConfig.FirebaseRemoteConfig.DefaultInstance.OnConfigUpdateListener
+= ConfigUpdateListenerEventHandler;
}
// Handle real-time Remote Config events.
void ConfigUpdateListenerEventHandler(
object sender, Firebase.RemoteConfig.ConfigUpdateEventArgs args) {
if (args.Error != Firebase.RemoteConfig.RemoteConfigError.None) {
Debug.Log(String.Format("Error occurred while listening: {0}", args.Error));
return;
}
Debug.Log("Updated keys: " + string.Join(", ", args.UpdatedKeys));
// Activate all fetched values and then display a welcome message.
remoteConfig.ActivateAsync().ContinueWithOnMainThread(
task => {
DisplayWelcomeMessage();
});
}
// Stop the listener.
void OnDestroy() {
Firebase.RemoteConfig.FirebaseRemoteConfig.DefaultInstance.OnConfigUpdateListener
-= ConfigUpdateListenerEventHandler;
}
Gdy następnym razem opublikujesz nową wersję Zdalnej konfiguracji, urządzenia, na których działa Twoja aplikacja i nasłuchują zmian, wywołają procedurę obsługi zakończenia.
Następne kroki
Jeśli jeszcze tego nie zrobiłeś, zbadaj zdalne przypadki użycia konfiguracji i spójrz na niektóre z kluczowych koncepcji i zaawansowanych dokumentacji strategii, w tym: