전제조건

다음은 Android용 App Configuration 서비스 SDK를 사용하기 위한 선행 조건입니다.

• Android API 레벨 22 이상
• Android Studio
• Gradle

Kotlin으로 작성된 Android 앱용 클라이언트 SDK 통합

App Configuration 서비스는 Android 애플리케이션과 통합할 수 있도록 Android 클라이언트 SDK를 제공합니다. SDK를 통합하여 특성 및 기능 플래그의 값을 평가할 수 있습니다.

1. 다음 옵션 중 하나를 사용하여 SDK를 설치합니다.

   • 패키지를 다운로드하여 Android Studio로 가져오십시오.
   • 다음을 추가하여 Gradle을 통해 패키지를 가져오십시오.

     • App Configuration Android 클라이언트 SDK 종속 항목을 프로젝트 레벨 build.gradle 파일에 추가하십시오.

       repositories {
           mavenCentral()
       }
       

     • App Configuration Android 클라이언트 SDK 종속 항목을 모듈 레벨 build.gradle 파일에 추가하십시오.

       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 서비스의 ApiKey입니다. 대시보드의 서비스 인증 정보 섹션에서 가져올 수 있습니다.
   • 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을 통해 패키지를 가져오십시오.

     • App Configuration Android 클라이언트 SDK 종속 항목을 프로젝트 레벨 build.gradle 파일에 추가하십시오.

       repositories {
          mavenCentral()
       }
       

     • App Configuration Android 클라이언트 SDK 종속 항목을 모듈 레벨 build.gradle 파일에 추가하십시오.

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

2. 인터넷 권한을 위해 AndroidManifest.xml 파일을 구성하십시오.

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

3. 다음 단계에 따라 Kotlin을 Java 프로젝트에 통합하십시오.

   • 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 서비스의 ApiKey입니다. 대시보드의 서비스 인증 정보 섹션에서 가져올 수 있습니다.
   • collectionId - App Configuration 서비스 인스턴스에서 작성된 콜렉션의 ID입니다.
   • environmentId-환경 섹션 아래의 App Configuration 서비스 인스턴스에서 작성된 환경의 ID.

5. 기능 변경사항 확인

   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)