Inizia a utilizzare Remote Config su iOS

Puoi utilizzare Firebase Remote Config per definire i parametri nella tua app e aggiornarne i valori nel cloud, in modo da modificare l'aspetto e il comportamento dell'app senza distribuire un aggiornamento dell'app. Questa guida illustra i passaggi per iniziare e fornisce alcuni codici campione, tutti disponibili per il download o la clonazione dal repository GitHub firebase/quickstart-ios.

Passaggio 1: aggiungi Remote Config alla tua app

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

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

3. Crea l'oggetto singleton Remote Config, come mostrato nell'esempio seguente:

   Swift

   let remoteConfig = RemoteConfig.remoteConfig()
   let settings = RemoteConfigSettings()
   settings.minimumFetchInterval = 0
   RemoteConfig.remoteConfig().configSettings = settings
   MigratedSnippets.swift

   Objective-C

   FIRRemoteConfig *remoteConfig = [FIRRemoteConfig remoteConfig];
   FIRRemoteConfigSettings *remoteConfigSettings = [[FIRRemoteConfigSettings alloc] init];
   remoteConfigSettings.minimumFetchInterval = 0;
   remoteConfig.configSettings = remoteConfigSettings;
   ObjCMigratedSnippets.m

Questo oggetto viene utilizzato per archiviare i valori dei parametri predefiniti in-app, recuperare i valori parametro aggiornati dal backend Remote Config e controllare quando i valori recuperati vengono resi disponibili per la tua app.

Durante lo sviluppo, è consigliabile impostare un intervallo di recupero minimo relativamente basso. Per saperne di più, consulta Limitazione.

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

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

1. Definisci un insieme di nomi e valori parametro predefiniti utilizzando un oggetto NSDictionary o un file plist.

   Se hai già configurato i valori parametro di backend Remote Config, puoi scaricare un file plist generato che include tutti i valori predefiniti e salvarlo nel tuo progetto Xcode.

   REST

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

   Puoi generare un token di connessione eseguendo il comando seguente utilizzando Google Cloud CLI o Cloud Shell:

   gcloud auth print-access-token
   

   Questo token ha una durata breve, quindi potrebbe essere necessario rigenerarlo se ricevi un errore di autenticazione.

   Console Firebase

   1. Nella console Firebase, vai alla pagina DevOps e coinvolgimento > Remote Config > Parametri.

   2. Apri il more_vert Menu e seleziona Scarica valori predefiniti.

   3. Quando richiesto, attiva .plist per iOS, quindi fai clic su Scarica file.

2. Aggiungi questi valori all'oggetto Remote Config utilizzando setDefaults:. L'esempio seguente imposta i valori predefiniti in-app da un file plist:

   Swift

   RemoteConfig.remoteConfig().setDefaults(fromPlist: "RemoteConfigDefaults")
   MigratedSnippets.swift

   Objective-C

   [remoteConfig setDefaultsFromPlistFileName:@"RemoteConfigDefaults"];
   ObjCMigratedSnippets.m

Passaggio 3: ottieni i valori parametro da usare nell'app

Ora puoi ottenere i valori dei parametri dall'oggetto Remote Config. Se in un secondo momento imposti i valori nel backend Remote Config, li recuperi e li attivi, questi valori saranno disponibili per la tua app. In caso contrario, otterrai i valori parametro in-app configurati utilizzando setDefaults:. Per ottenere questi valori, chiama il metodo configValueForKey:, fornendo la chiave del parametro come argomento.

let remoteConfig = RemoteConfig.remoteConfig()

// Retrieve a parameter value using configValueForKey
let welcomeMessageValue = remoteConfig.configValue(forKey: "welcome_message")
let welcomeMessage = welcomeMessageValue.stringValue

let featureFlagValue = remoteConfig.configValue(forKey: "new_feature_flag")
let isFeatureEnabled = featureFlagValue.boolValue

Un modo più leggibile e comodo per accedere a questi valori in Swift è tramite la notazione subscript di Swift:

let remoteConfig = RemoteConfig.remoteConfig()

// Retrieve a string parameter value
let welcomeMessage = remoteConfig["welcome_message"].stringValue

// Retrieve a boolean parameter value
let isFeatureEnabled = remoteConfig["new_feature_flag"].boolValue

// Retrieve a number parameter value
let maxItemCount = remoteConfig["max_items"].numberValue.intValue

Utilizza Codable per una configurazione con sicurezza dei tipi

Per configurazioni più complesse, puoi utilizzare il protocollo Codable di Swift per decodificare i dati strutturati da Remote Config. In questo modo, la gestione della configurazione è sicura per i tipi e l'utilizzo di oggetti complessi è semplificato.

// Define a Codable struct for your configuration
struct AppFeatureConfig: Codable {
  let isNewFeatureEnabled: Bool
  let maxUploadSize: Int
  let themeColors: [String: String]
}

// Fetch and decode the configuration
func configureAppFeatures() {
  let remoteConfig = RemoteConfig.remoteConfig()
  remoteConfig.fetchAndActivate { status, error in
    guard error == nil else { return }

    do {
      let featureConfig = try remoteConfig["app_feature_config"].decoded(asType: AppFeatureConfig.self)
      configureApp(with: featureConfig)
    } catch {
      // Handle decoding errors
      print("Failed to decode configuration: \(error)")
    }
  }
}

Questo metodo ti consente di:

• Definire strutture di configurazione complesse.
• Analizza automaticamente le configurazioni JSON.
• Garantisci la sicurezza dei tipi quando accedi ai valori Remote Config.
• Fornisci un codice pulito e leggibile per la gestione dei modelli Remote Config strutturati.

Utilizza i wrapper delle proprietà per la configurazione dichiarativa in SwiftUI

I wrapper delle proprietà sono una potente funzionalità di Swift che consente di aggiungere un comportamento personalizzato alle dichiarazioni delle proprietà. In SwiftUI, i wrapper delle proprietà vengono utilizzati per gestire lo stato, le associazioni e altri comportamenti delle proprietà. Per saperne di più, consulta la guida al linguaggio Swift.

struct ContentView: View {
  @RemoteConfigProperty(key: "cardColor", fallback: "#f05138")
  var cardColor

  var body: some View {
    VStack {
      Text("Dynamic Configuration")
        .background(Color(hex: cardColor))
    }
    .onAppear {
      RemoteConfig.remoteConfig().fetchAndActivate()
    }
  }
}

Utilizza il wrapper della proprietà @RemoteConfigProperty quando vuoi un modo dichiarativo per accedere ai valori Remote Config in SwiftUI, con supporto integrato per i valori predefiniti e gestione semplificata delle configurazioni.

Passaggio 4: imposta i valori parametro

Utilizzando la console Firebase o le API di backend Remote Config, puoi creare nuovi valori predefiniti di backend che eseguono l'override dei valori in-app in base alla logica condizionale o al targeting degli utenti che preferisci. Questa sezione illustra i passaggi della console Firebase per creare questi valori.

1. Nella console Firebase, vai alla pagina DevOps e coinvolgimento > Remote Config > Parametri.

2. Definisci i parametri con gli stessi nomi di quelli definiti nella tua app. Per ogni parametro, puoi impostare un valore predefinito (che alla fine sostituirà il valore predefinito in-app) e puoi anche impostare valori condizionali. Per scoprire di più, consulta Parametri e condizioni di Remote Config.

3. Se utilizzi le condizioni degli indicatori personalizzati, definisci gli attributi e i relativi valori. I seguenti esempi mostrano come definire una condizione di indicatore personalizzato.

   Swift

       Task {
           let customSignals: [String: CustomSignalValue?] = [
           "city": .string("Tokyo"),
           "preferred_event_category": .string("sports")
         ]
   
         do {
           try await remoteConfig.setCustomSignals(customSignals)
           print("Custom signals set successfully!")
           } catch {
               print("Error setting custom signals: \(error)")
           }
     }

   Objective-C

       dispatch_async(dispatch_get_global_queue(DISPATCH_QUEUE_PRIORITY_DEFAULT, 0), ^{
         NSDictionary *customSignals = @{
           @"city": @"Tokyo",
           @"preferred_event_category": @"sports"
         };
   
         [self.remoteConfig setCustomSignals:customSignals withCompletion:^(NSError * _Nullable error) {
             if (error) {
                 NSLog(@"Error setting custom signals: %@", error);
             } else {
                 NSLog(@"Custom signals set successfully!");
             }
       }];
   });

Passaggio 5: recupera e attiva i valori

Per recuperare i valori dei parametri da Remote Config, chiama il metodo fetchWithCompletionHandler: o fetchWithExpirationDuration:completionHandler:. Tutti i valori impostati nel backend vengono recuperati e memorizzati nella cache nell'oggetto Remote Config.

Per i casi in cui vuoi recuperare e attivare i valori in un'unica chiamata, utilizza fetchAndActivateWithCompletionHandler:.

Questo esempio recupera i valori dal backend Remote Config (non i valori memorizzati nella cache) e chiama activateWithCompletionHandler: per renderli disponibili all'app:

remoteConfig.fetch { (status, error) -> Void in
  if status == .success {
    print("Config fetched!")
    remoteConfig.activate { changed, error in
      // ...
    }
  } else {
    print("Config not fetched")
    print("Error: \(error?.localizedDescription ?? "No error available.")")
  }
}
MigratedSnippets.swift

[remoteConfig fetchWithCompletionHandler:^(FIRRemoteConfigFetchStatus status, NSError *error) {
  if (status == FIRRemoteConfigFetchStatusSuccess) {
    NSLog(@"Config fetched!");
    [remoteConfig activateWithCompletion:^(BOOL changed, NSError * _Nullable error) {
      if (error != nil) {
        NSLog(@"Activate error: %@", error.localizedDescription);
      } else {
        dispatch_async(dispatch_get_main_queue(), ^{
          // update UI
        });
      }
    }];
  } else {
    NSLog(@"Config not fetched");
    NSLog(@"Error %@", error.localizedDescription);
  }
}];
ObjCMigratedSnippets.m

Poiché questi valori parametro aggiornati influiscono sul comportamento e sull'aspetto della tua app, devi attivare i valori recuperati in un momento che garantisca un'esperienza ottimale per l'utente, ad esempio la volta successiva che l'utente apre l'app. Per ulteriori informazioni ed esempi, consulta Strategie di caricamento di Remote Config.

Passaggio 6: ascolta gli aggiornamenti in tempo reale

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

Gli aggiornamenti in tempo reale sono supportati dall'SDK Firebase per le piattaforme Apple v10.7.0 e successive.

1. Nella tua app, chiama addOnConfigUpdateListener per iniziare a rimanere in ascolto degli aggiornamenti e recuperare automaticamente i valori parametro nuovi o aggiornati. L'esempio seguente rimane in ascolto degli aggiornamenti e, quando viene chiamato activateWithCompletionHandler, utilizza i valori appena recuperati per visualizzare un messaggio di benvenuto aggiornato.

   Swift

   remoteConfig.addOnConfigUpdateListener { configUpdate, error in
       guard let configUpdate, error == nil else {
         print("Error listening for config updates: \(error)")
       }
   
       print("Updated keys: \(configUpdate.updatedKeys)")
   
       self.remoteConfig.activate { changed, error in
         guard error == nil else { return self.displayError(error) }
         DispatchQueue.main.async {
           self.displayWelcome()
         }
       }
     }
     

   Objective-C

   __weak __typeof__(self) weakSelf = self;
     [self.remoteConfig addOnConfigUpdateListener:^(FIRRemoteConfigUpdate * _Nonnull configUpdate, NSError * _Nullable error) {
       if (error != nil) {
         NSLog(@"Error listening for config updates %@", error.localizedDescription);
       } else {
         NSLog(@"Updated keys: %@", configUpdate.updatedKeys);
   
         __typeof__(self) strongSelf = weakSelf;
         [strongSelf.remoteConfig activateWithCompletion:^(BOOL changed, NSError * _Nullable error) {
           if (error != nil) {
             NSLog(@"Activate error %@", error.localizedDescription);
           }
   
           dispatch_async(dispatch_get_main_queue(), ^{
             [strongSelf displayWelcome];
           });
         }];
       }
     }];
     

2. La prossima volta che pubblichi una nuova versione di Remote Config, i dispositivi che eseguono la tua app e ascoltano le modifiche chiameranno il gestore di completamento.

Limitazione

Se un'app esegue il recupero troppe volte in un breve periodo di tempo, le chiamate di recupero vengono limitate e l'SDK restituisce FIRRemoteConfigFetchStatusThrottled. Prima della versione 6.3.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 eseguire il recupero più spesso per aggiornare la cache molto frequentemente (molte volte all'ora) in modo da poter eseguire rapidamente l'iterazione durante lo sviluppo e il test dell'app. Gli aggiornamenti di Remote Config in tempo reale bypassano automaticamente la cache quando la configurazione viene aggiornata sul server. Per consentire un'iterazione rapida su un progetto con numerosi sviluppatori, puoi aggiungere temporaneamente una proprietà FIRRemoteConfigSettings con un intervallo di recupero minimo basso (MinimumFetchInterval) nella tua app.

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

1. Il parametro in fetch(long)
2. Il parametro in FIRRemoteConfigSettings.MinimumFetchInterval
3. Il valore predefinito di 12 ore