Pierwsze kroki ze Zdalnej konfiguracji Firebase

iOS+ Android Sieć Flutter Unity C++

Ważne: w tej sekcji znajdziesz instrukcje konfigurowania usługi Remote Config w przypadku klientów mobilnych i internetowych. W przypadku środowisk serwera zapoznaj się z artykułem o korzystaniu z Remote Config w środowiskach serwerów.

Za pomocą Zdalnej konfiguracji Firebase możesz definiować parametry w aplikacji i zmieniać ich wartości w chmurze, co umożliwia modyfikowanie wyglądu i zachowania aplikacji bez rozpowszechniania jej aktualizacji. W tym przewodniku znajdziesz instrukcje rozpoczęcia pracy oraz przykładowy kod.

Krok 1. Dodaj do aplikacji pakiet SDK Firebase i Zdalnej konfiguracji

1. Zainstaluj i zainicjuj pakiety SDK Firebase na potrzeby Flutter, jeśli jeszcze ich nie masz.

2. Zdalna konfiguracja wymaga Google Analytics do kierowania warunkowego instancji aplikacji na odbiorców i właściwości użytkowników. Pamiętaj, aby włączyć Google Analytics w swoim projekcie.

3. Aby zainstalować w katalogu głównym projektu Flutter wtyczkę Zdalna konfiguracja, uruchom to polecenie:

   flutter pub add firebase_remote_config
   

   Poza tym w ramach konfigurowania Zdalnej konfiguracji musisz dodać do swojej aplikacji pakiet SDK Firebase dla Google Analytics:

   flutter pub add firebase_analytics
   

4. Odbuduj projekt:

   flutter run
   

5. Jeśli używasz Zdalnej konfiguracji na macOS, włącz udostępnianie pęku kluczy w Xcode.

Uwaga: pakiet SDK Remote Config zależy od interfejsu Zdalnej konfiguracji REST API, więc upewnij się, że nie wyłączasz tego interfejsu API, który jest domyślnie włączony w typowym projekcie.

Krok 2. Pobierz obiekt klasy typu singleton Zdalnej konfiguracji

Pobierz instancję obiektu Zdalnej konfiguracji i ustaw minimalny interwał pobierania ustawień, aby umożliwić ich częste odświeżanie:

final remoteConfig = FirebaseRemoteConfig.instance;
await remoteConfig.setConfigSettings(RemoteConfigSettings(
    fetchTimeout: const Duration(minutes: 1),
    minimumFetchInterval: const Duration(hours: 1),
));

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

Podczas tworzenia zalecamy ustawić stosunkowo krótki minimalny interwał pobierania. Więcej informacji znajdziesz w sekcji Ograniczanie.

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

W obiekcie Zdalnej konfiguracji możesz ustawić domyślne wartości parametrów w aplikacji, aby działała ona zgodnie z oczekiwaniami, zanim połączy się z backendem Zdalnej konfiguracji. Dzięki temu domyślne wartości będą dostępne, jeśli nie zostaną ustawione na backendzie.

Ważne: nie przechowuj poufnych danych w kluczach ani wartościach parametrów Zdalnej konfiguracji. Dane zdalnej konfiguracji są szyfrowane podczas przesyłania, ale użytkownicy mają dostęp do dowolnego domyślnego lub pobranego parametru zdalnej konfiguracji, który jest dostępny dla ich instancji aplikacji klienckiej.

await remoteConfig.setDefaults(const {
    "example_param_1": 42,
    "example_param_2": 3.14159,
    "example_param_3": true,
    "example_param_4": "Hello, world!",
});

Krok 4. Uzyskaj wartości parametrów, które będą używane w Twojej aplikacji

Teraz możesz pobierać wartości parametrów z obiektu Zdalnej konfiguracji. Jeśli ustawisz wartości w backendzie, pobierzesz je i aktywujesz, będą one dostępne dla Twojej aplikacji. W przeciwnym razie otrzymasz wartości parametrów aplikacji skonfigurowane za pomocą funkcji setDefaults().

Aby uzyskać te wartości, wywołaj metodę wymienioną poniżej, która jest mapowana na typ danych oczekiwany przez aplikację, podając jako argument klucz parametru:

• getBool()
• getDouble()
• getInt()
• getString()

Krok 5. Ustaw wartości parametrów w backendzie Zdalnej konfiguracji

Korzystając z konsoli Firebase lub interfejsów API backendu Zdalnej konfiguracji, możesz tworzyć nowe domyślne wartości po stronie serwera, które zastąpią wartości w aplikacji zgodnie z wybraną przez Ciebie logiką warunkową lub kierowaniem na użytkowników. W tej sekcji opisano czynności do wykonania w konsoli Firebase, aby utworzyć te wartości.

1. W konsoli Firebase otwórz projekt.
2. W menu wybierz Zdalna konfiguracja, aby wyświetlić panel sterowania Zdalną konfiguracją.
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. Więcej informacji znajdziesz w artykule Parametry i warunki Zdalnej konfiguracji.

Krok 6. Pobierz i aktywuj wartości

1. Aby pobrać wartości parametrów z backendu Zdalnej konfiguracji, wywołaj metodę fetch(). Wszystkie wartości ustawione w backendzie są pobierane i przechowywane w obiekcie Zdalnej konfiguracji.

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

   Jeśli chcesz pobrać i aktywować wartości w jednym wywołaniu, możesz użyć żądania fetchAndActivate(), aby pobrać wartości z backendu Zdalnej konfiguracji i udostępnić je aplikacji:

   await remoteConfig.fetchAndActivate();
   

Zaktualizowane wartości parametrów wpływają na działanie i wygląd aplikacji, dlatego należy aktywować pobrane wartości w takim momencie, aby zapewnić użytkownikowi płynne działanie, np. gdy otworzy on aplikację po raz kolejny. Więcej informacji i przykładów znajdziesz w artykule Strategie wczytywania Zdalnej konfiguracji.

Krok 7. Słuchaj aktualizacji w czasie rzeczywistym

Po pobraniu wartości parametrów możesz używać Zdalnej konfiguracji w czasie rzeczywistym do odbierania aktualizacji z backendu Zdalnej konfiguracji. Sygnały konfiguracji zdalnej w czasie rzeczywistym na urządzeniach połączonych, gdy dostępne są aktualizacje, i automatyczne pobieranie zmian po opublikowaniu nowej wersji konfiguracji zdalnej.

Pamiętaj, że Zdalna konfiguracja w czasie rzeczywistym jest niedostępna w przeglądarkach.

1. W aplikacji użyj parametru onConfigUpdated, aby zacząć nasłuchiwać aktualizacji i automatycznie pobierać nowe wartości parametrów.

    remoteConfig.onConfigUpdated.listen((event) async {
      await remoteConfig.activate();
   
      // Use the new config values here.
    });
   

2. Gdy następnym razem opublikujesz nową wersję Zdalnej konfiguracji, nowa konfiguracja zostanie aktywowana na urządzeniach, na których działa Twoja aplikacja i nasłuchują zmian.

Wskazówka: aby zobaczyć przykład implementacji, zapoznaj się z przykładem konfiguracji zdalnej w Flutterfire.

Ograniczenia

Jeśli aplikacja pobierze zbyt wiele razy w krótkim okresie, wywołania pobierania zostaną ograniczone, a właściwość lastFetchStatus parametru FirebaseRemoteConfig będzie miała wartość RemoteConfigFetchStatus.throttle.

Domyślny minimalny interwał pobierania w przypadku usługi Zdalna konfiguracja wynosi 12 godzin, co oznacza, że konfiguracje nie będą pobierane z back-endu częściej niż raz w ciągu 12 godzin, niezależnie od liczby wywołań funkcji pobierania.

Wskazówka: od wersji 4.0.0 pakietu SDK Firebase dla Fluttera możesz używać Remote Config w czasie rzeczywistym, aby automatycznie pobierać zaktualizowane wartości parametrów z backendu Remote Config, gdy tylko zostaną opublikowane, bez względu na ustawienie minimalnego przedziału czasu pobierania. Więcej informacji znajdziesz w sekcji Nasłuchuj aktualizacji w czasie rzeczywistym.

Jeśli podczas tworzenia aplikacji nie używasz zdalnej konfiguracji w czasie rzeczywistym (co jest zalecane), możesz bardzo często pobierać i aktywować konfiguracje (wiele razy na godzinę), aby umożliwić szybkie iteracje podczas tworzenia i testowania aplikacji. Aby umożliwić szybkie iteracje w projekcie z maksymalnie 10 deweloperów, możesz tymczasowo ustawić krótki minimalny interwał pobierania za pomocą parametru setConfigSettings().

final remoteConfig = FirebaseRemoteConfig.instance;
await remoteConfig.setConfigSettings(RemoteConfigSettings(
    fetchTimeout: const Duration(minutes: 1),
    minimumFetchInterval: const Duration(minutes: 5),
));

Uwaga: tego ustawienia należy używać tylko w celu testowania, a nie w środowisku produkcyjnym. Jeśli aplikację testuje mały zespół programistów składający się z 10 osób, prawdopodobnie nie przekroczysz limitów godzinowych na stronie usługi. Jeśli jednak opublikujesz aplikację dla tysięcy użytkowników testowych z bardzo krótkim minimalnym interwałem pobierania, prawdopodobnie przekroczy ona ten limit.

Dalsze kroki

Jeśli jeszcze tego nie zrobisz, zapoznaj się z Remote Config przypadkami użycia i pojęciami kluczowymi oraz dokumentacją dotyczącą zaawansowanych strategii, w tym:

• Zarządzanie wersjami szablonu Remote Config
• Strategie wczytywania konfiguracji