Voraussetzungen

Im Folgenden finden Sie die Voraussetzungen für die Verwendung des App Configuration-Service-SDK für Android:

• Android-API-Ebene 22 oder höher
• Android Studio
• Gradle

Client-SDK für in Kotlin geschriebene Android-App integrieren

Der App Configuration-Service stellt das Android-Client-SDK für die Integration in Ihre Android-Anwendung bereit. Sie können die Werte Ihrer Eigenschaft und des Feature-Flags durch Integration des SDK auswerten.

1. Installieren Sie das SDK mit einer der folgenden Optionen:

   • Laden Sie das Paket herunter und importieren Sie es in Ihr Android Studio-Projekt.
   • Rufen Sie das Paket über Gradle ab, indem Sie Folgendes hinzufügen:

     • Fügen Sie die Abhängigkeit des App Configuration-Android-Client-SDK zur Datei build.gradle auf Projektebene hinzu.

       repositories {
           mavenCentral()
       }
       

     • Fügen Sie die Abhängigkeit des App Configuration-Android-Client-SDK zur Datei build.gradle auf Modulebene hinzu.

       dependencies {
          implementation "com.ibm.cloud:appconfiguration-android-sdk:0.3.1"
       }
       

2. Konfigurieren Sie die Datei AndroidManifest.xml für die Internetberechtigung.

   <uses-permission android:name="android.permission.INTERNET"/>
   

3. Initialisieren Sie das SDK.

   import com.ibm.cloud.appconfiguration.android.sdk.AppConfiguration
   
   val collectionId = "airlines-webapp"
   val environmentId = "dev"
   
   val appConfigClient = AppConfiguration.getInstance()
   //application is a member of the AppCompatActivity() class, if you have inherited the
   //AppCompatActivity() class then you can call the application variable.
   appConfigClient.init(application,
                        "region",
                        "guid",
                        "apikey")
   appConfigClient.setContext(collectionId, environmentId)
   

   Dabei gilt:

   • region- Name der Region, in der die Dienstinstanz App Configuration erstellt wird. Eine Liste der unterstützten Standorte finden Sie hier. Zum Beispiel: us-south, au-syd usw.
   • guid - GUID des App Configuration-Service. Rufen Sie dies aus dem Abschnitt für Serviceberechtigungsnachweise des Dashboards auf.
   • apikey - API-Schlüssel des App Configuration-Service. Rufen Sie dies aus dem Abschnitt für Serviceberechtigungsnachweise des Dashboards auf.
   • collectionId -ID der Sammlung, die in der App Configuration Serviceinstanz unter dem Abschnitt "Sammlungen" erstellt wurde.
   • environmentId -Die ID der Umgebung, die in der Serviceinstanz für die App-Konfiguration unter dem Abschnitt "Umgebungen" erstellt wurde.

4. Listener für Feature-oder Eigenschaftsdatenänderungen festlegen

   appConfiguration.registerConfigurationUpdateListener(object : ConfigurationUpdateListener {
   
       override fun onConfigurationUpdate() {
           // ADD YOUR CODE
       }
   })
   

val feature: Feature? = appConfiguration.getFeature("json-feature")
feature.getFeatureDataType(); // STRING
feature.getFeatureDataFormat(); // JSON

// Example below (traversing the returned JSONObject)
if (feature != null) {
   val result = feature.getCurrentValue(entityId, entityAttributes) as JSONObject
   result.get("key") // returns the value of the key
}

val feature: Feature? = appConfiguration.getFeature("yaml-feature")
feature.getFeatureDataType(); // STRING
feature.getFeatureDataFormat(); // YAML
feature.getCurrentValue(entityId, entityAttributes); // returns the stringified yaml (check Table 1)

val property: Property? = appConfiguration.getProperty("json-property")
property.getPropertyDataType(); // STRING
property.getPropertyDataFormat(); // JSON

// Example below (traversing the returned JSONObject)
if (property != null) {
  val result = property.getCurrentValue(entityId, entityAttributes) as JSONObject
  result.get("key") // returns the value of the key
}

val property: Property? = appConfiguration.getProperty("yaml-property")
property.getPropertyDataType(); // STRING
property.getPropertyDataFormat(); // YAML
property.getCurrentValue(entityId, entityAttributes); // returns the stringified yaml (check above Table 1)

Client-SDK für in Java geschriebene Android-App integrieren

Der App Configuration-Service stellt das Android-Client-SDK für die Integration in Ihre Android-Anwendung bereit. Sie können die Werte Ihrer Eigenschaft und des Feature-Flags durch Integration des SDK auswerten.

1. Installieren Sie das SDK mit einer der folgenden Optionen:

   • Laden Sie das Paket herunter und importieren Sie es in Ihr Android Studio-Projekt.
   • Rufen Sie das Paket über Gradle ab, indem Sie Folgendes hinzufügen:

     • Fügen Sie die Abhängigkeit des App Configuration-Android-Client-SDK zur Datei build.gradle auf Projektebene hinzu.

       repositories {
          mavenCentral()
       }
       

     • Fügen Sie die Abhängigkeit des App Configuration-Android-Client-SDK zur Datei build.gradle auf Modulebene hinzu.

       dependencies {
          implementation "com.ibm.cloud:appconfiguration-android-sdk:0.3.1"
       }
       

2. Konfigurieren Sie die Datei AndroidManifest.xml für die Internetberechtigung.

   <uses-permission android:name="android.permission.INTERNET"/>
   

3. Integrieren Sie Kotlin in Ihr Java-Projekt mit den folgenden Schritten:

   • Fügen Sie das Kotlin Gradle-Plug-in zur Modulebene hinzu build.gradle

     dependencies {
       classpath "com.android.tools.build:gradle:4.1.1"
       classpath "org.jetbrains.kotlin:kotlin-gradle-plugin:$kotlin_version"
     }
     

   • Fügen Sie das kotlin-android-Plug-in zu build.gradle auf App-Ebene hinzu.

     plugins {
        id 'com.android.application'
        id 'kotlin-android'
     }
     

4. Initialisieren Sie das SDK.

   AppConfiguration appConfiguration = AppConfiguration.getInstance();
   appConfiguration.init(getApplication(), "region", "guid", "apikey");
   
   // To start the configuration fetching operation, set the collectionId in the following way.
   appConfiguration.setContext("collectionId", "environmentId");
   

   Dabei gilt:

   • region - Regionsname, unter dem die Serviceinstanz erstellt wird. Verwenden Sie AppConfiguration.REGION_US_SOUTH für Dallas, AppConfiguration.REGION_US_EAST für Washington DC, AppConfiguration.REGION_EU_GB für London und AppConfiguration.REGION_AU_SYD für Sydney.
   • guid - GUID des App Configuration-Service. Rufen Sie dies aus dem Abschnitt für Serviceberechtigungsnachweise des Dashboards auf.
   • apikey - API-Schlüssel des App Configuration-Service. Rufen Sie dies aus dem Abschnitt für Serviceberechtigungsnachweise des Dashboards auf.
   • collectionId -ID der Sammlung, die in der App Configuration Serviceinstanz erstellt wurde.
   • environmentId-ID der Umgebung, die in der App Configuration-Serviceinstanz im Abschnitt „Umgebungen“ erstellt wurde.

5. Empfangsbereitschaft für Änderungen an Features

   appConfiguration.registerConfigurationUpdateListener(new ConfigurationUpdateListener() {
       @Override
       public void onConfigurationUpdate() {
          // ADD YOUR CODE
       }
   });
   

Feature feature = appConfiguration.getFeature("json-feature");
feature.getFeatureDataType(); // STRING
feature.getFeatureDataFormat(); // JSON

// Example below (traversing the returned JSONObject)
if (feature != null) {
  JSONObject result = (JSONObject) feature.getCurrentValue(entityId, entityAttributes);
  result.get("key") // returns the value of the key
}

Feature feature = appConfiguration.getFeature("yaml-feature");
feature.getFeatureDataType(); // STRING
feature.getFeatureDataFormat(); // YAML
feature.getCurrentValue(entityId, entityAttributes); // returns the stringified yaml (check above Table 1)

Property property = appConfiguration.getProperty("json-property");
property.getPropertyDataType(); // STRING
property.getPropertyDataFormat(); // JSON

// Example below (traversing the returned JSONObject)
if (property != null) {
  JSONObject result = (JSONObject) property.getCurrentValue(entityId, entityAttributes);
  result.get("key") // returns the value of the key
}

Property property = appConfiguration.getProperty("yaml-property");
property.getPropertyDataType(); // STRING
property.getPropertyDataFormat(); // YAML
property.getCurrentValue(entityId, entityAttributes); // returns the stringified yaml (check Table 1)