前提条件

Android 用 App Configuration サービス SDK を使用するための前提条件は以下のとおりです。

• Android API レベル 22 以降
• Android Studio
• Gradle

Kotlin で書かれた Android アプリ用のクライアント SDK の統合

App Configuration サービスは、Android アプリケーションと統合される Android クライアント SDK を提供します。 SDK を統合することで、プロパティーおよび機能フラグの値を評価できます。

1. 以下のいずれかのオプションを使用して SDK をインストールします。

   • パッケージをダウンロードし、Android Studio プロジェクトにインポートします。
   • Gradle からパッケージを取得するには、以下を追加します。

     • プロジェクト・レベルの build.gradle ファイルに App Configuration Android クライアント SDK 従属関係を追加します。

       repositories {
           mavenCentral()
       }
       

     • モジュール・レベルの build.gradle ファイルに App Configuration Android クライアント SDK 従属関係を追加します。

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

2. AndroidManifest.xml ファイルにインターネット許可を構成します。

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

3. 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)
   

   ここで、

   • region- App Configuration サービスインスタンスが作成されるリージョン名。 対応拠点のリストは こちら。 例： us-south、 au-syd など。
   • guid - App Configuration サービスの GUID。 ダッシュボードのサービス資格情報セクションから取得してください。
   • apikey - App Configuration サービスの API キー。 ダッシュボードのサービス資格情報セクションから取得してください。
   • collectionId - 「コレクション」セクションの下の App Configuration サービス・インスタンスで作成されたコレクションの ID。
   • environmentId -「環境」セクションの下のアプリ構成サービス・インスタンスで作成された環境の ID。

4. 機能またはプロパティーのデータ変更に対してリスナーを設定します。

   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)

Java で書かれた Android アプリ用のクライアント SDK の統合

App Configuration サービスは、Android アプリケーションと統合される Android クライアント SDK を提供します。 SDK を統合することで、プロパティーおよび機能フラグの値を評価できます。

1. 以下のいずれかのオプションを使用して SDK をインストールします。

   • パッケージをダウンロードし、Android Studio プロジェクトにインポートします。
   • Gradle からパッケージを取得するには、以下を追加します。

     • プロジェクト・レベルの build.gradle ファイルに App Configuration Android クライアント SDK 従属関係を追加します。

       repositories {
          mavenCentral()
       }
       

     • モジュール・レベルの build.gradle ファイルに App Configuration Android クライアント SDK 従属関係を追加します。

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

2. AndroidManifest.xml ファイルにインターネット許可を構成します。

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

3. 以下の手順で、Java プロジェクトに Kotlin を統合します。

   • Kotlin Gradle プラグインをモジュール・レベルに追加する build.gradle

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

   • アプリ・レベルの kotlin-android に build.gradle プラグインを追加します。

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

4. 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");
   

   ここで、

   • region - サービス・インスタンスが作成されたリージョン名。 ダラスは AppConfiguration.REGION_US_SOUTH、ワシントン DC は AppConfiguration.REGION_US_EAST、ロンドンは AppConfiguration.REGION_EU_GB、シドニーは AppConfiguration.REGION_AU_SYD を使用します。
   • guid - App Configuration サービスの GUID。 ダッシュボードのサービス資格情報セクションから取得してください。
   • apikey - App Configuration サービスの API キー。 ダッシュボードのサービス資格情報セクションから取得してください。
   • collectionId - App Configuration サービス・インスタンスで作成されたコレクションの ID。
   • environmentId - App Configuration サービス・インスタンスの「環境」セクションで作成された環境の ID。

5. 機能変更を listen します。

   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)