Firebase 원격 구성으로 클라우드에서 앱의 매개변수를 정의하고 값을 업데이트하면 앱 업데이트를 배포하지 않고도 앱의 모양과 동작을 수정할 수 있습니다. 이 가이드에서는 시작하는 단계를 안내하고 샘플 코드를 제공합니다. 모든 샘플 코드는 firebase/quickstart-android GitHub 저장소에서 클론하거나 다운로드할 수 있습니다.
1단계: 앱에 Firebase 및 원격 구성 SDK 추가
아직 추가하지 않았다면 Android 프로젝트에 Firebase를 추가합니다.
원격 구성의 경우 사용자 속성 및 잠재고객에 대한 앱 인스턴스의 조건부 타겟팅에는 Google 애널리틱스가 필수입니다. 프로젝트에서 Google 애널리틱스를 사용 설정해야 합니다.
모듈(앱 수준) Gradle 파일(일반적으로
<project>/<app-module>/build.gradle.kts또는<project>/<app-module>/build.gradle)에서 Android용 원격 구성 라이브러리의 종속 항목을 추가합니다. 라이브러리 버전 관리 제어에는 Firebase Android BoM을 사용하는 것이 좋습니다.또한 애널리틱스를 설정하는 과정에서 앱에 Google 애널리틱스용 Firebase SDK를 추가해야 합니다.
dependencies { // Import the BoM for the Firebase platform implementation(platform("com.google.firebase:firebase-bom:32.6.0")) // Add the dependencies for the Remote Config and Analytics libraries // When using the BoM, you don't specify versions in Firebase library dependencies implementation("com.google.firebase:firebase-config") implementation("com.google.firebase:firebase-analytics") }Firebase Android BoM을 사용하면 앱에서 항상 호환되는 Firebase Android 라이브러리 버전만 사용합니다.
(대안) BoM을 사용하지 않고 Firebase 라이브러리 종속 항목을 추가합니다.
Firebase BoM을 사용하지 않도록 선택한 경우에는 종속 항목 줄에 각 Firebase 라이브러리 버전을 지정해야 합니다.
앱에서 여러 Firebase 라이브러리를 사용하는 경우 모든 버전이 호환되도록 BoM을 사용하여 라이브러리 버전을 관리하는 것이 좋습니다.
dependencies { // Add the dependencies for the Remote Config and Analytics libraries // When NOT using the BoM, you must specify versions in Firebase library dependencies implementation("com.google.firebase:firebase-config:21.6.0") implementation("com.google.firebase:firebase-analytics:21.5.0") }
2단계: 원격 구성 싱글톤 객체 가져오기
원격 구성 객체 인스턴스를 불러온 뒤 가져오기 간격을 최솟값으로 설정하여 상시적으로 새로고침을 할 수 있도록 합니다.
Kotlin+KTX
val remoteConfig: FirebaseRemoteConfig = Firebase.remoteConfig
val configSettings = remoteConfigSettings {
minimumFetchIntervalInSeconds = 3600
}
remoteConfig.setConfigSettingsAsync(configSettings)
Java
FirebaseRemoteConfig mFirebaseRemoteConfig = FirebaseRemoteConfig.getInstance();
FirebaseRemoteConfigSettings configSettings = new FirebaseRemoteConfigSettings.Builder()
.setMinimumFetchIntervalInSeconds(3600)
.build();
mFirebaseRemoteConfig.setConfigSettingsAsync(configSettings);
이 싱글톤 객체를 사용하여 인앱 매개변수 기본값을 저장하고 업데이트된 매개변수 값을 백엔드에서 가져오며 가져온 값을 앱에 제공할 시점을 제어합니다.
개발 중에는 가져오기 간격 최솟값을 상대적으로 낮게 설정하는 것이 좋습니다. 자세한 내용은 제한을 참조하세요.
3단계: 인앱 매개변수 기본값 설정
원격 구성 객체에 인앱 매개변수 기본값을 설정하면 앱이 원격 구성 백엔드에 연결되기 전에 의도한 대로 작동하고 백엔드에서 아무것도 설정하지 않으면 기본값이 사용됩니다.
Map 객체나 앱의
res/xml폴더에 저장된 XML 리소스 파일을 사용하여 매개변수 이름과 매개변수 기본값 집합을 정의합니다. 원격 구성 빠른 시작 샘플 앱은 XML 파일을 사용하여 기본 매개변수 이름과 기본값을 정의합니다.원격 구성 백엔드 매개변수 값을 이미 구성한 경우 모든 기본값을 포함하는 생성된 XML 파일을 다운로드하여 앱의
res/xml디렉터리에 저장할 수 있습니다.REST
curl --compressed -D headers -H "Authorization: Bearer token -X GET https://firebaseremoteconfig.googleapis.com/v1/projects/my-project-id/remoteConfig:downloadDefaults?format=XML -o remote_config_defaults.xml
Firebase Console
매개변수 탭에서 메뉴를 열고 기본값 다운로드를 선택합니다.
메시지가 표시되면 Android의 경우 .xml을 사용 설정한 후 파일 다운로드를 클릭합니다.
아래와 같이
setDefaultsAsync(int)를 사용하여 원격 구성 객체에 이러한 값을 추가합니다.Kotlin+KTX
remoteConfig.setDefaultsAsync(R.xml.remote_config_defaults)
Java
mFirebaseRemoteConfig.setDefaultsAsync(R.xml.remote_config_defaults);
4단계: 앱에서 사용할 매개변수 값 가져오기
이제 원격 구성 객체에서 매개변수 값을 가져올 수 있습니다. 백엔드에서 값을 설정한 후 값을 가져와서 활성화하면 이 값이 앱에 적용됩니다. 그렇지 않은 경우 setDefaultsAsync(int)를 사용하여 인앱 매개변수 값을 구성합니다.
이러한 값을 가져오려면 매개변수 키를 인수로 전달하여 앱의 예상 데이터 유형에 매핑하는 아래의 메서드를 호출합니다.
5단계: 원격 구성 백엔드에 매개변수 값 설정
Firebase Console 또는 원격 구성 백엔드 API를 사용하여 원하는 조건부 로직 또는 사용자 타겟팅에 따라 인앱 값을 재정의하는 새 서버 측 기본값을 만들 수 있습니다. 이 섹션에서는 Firebase Console에서 이러한 값을 만드는 단계를 설명합니다.
- Firebase Console에서 프로젝트를 엽니다.
- 메뉴에서 원격 구성을 선택하여 원격 구성 대시보드를 표시합니다.
- 앱에 정의한 매개변수와 같은 이름으로 매개변수를 정의합니다. 각 매개변수에 기본값 및 조건부 값을 설정할 수 있습니다. 기본값은 이후에 해당하는 인앱 기본값을 재정의합니다. 자세한 내용은 원격 구성 매개변수 및 조건을 참조하세요.
6단계: 값 가져오기 및 활성화
- 원격 구성 백엔드에서 매개변수 값을 가져오려면
fetch()메서드를 호출합니다. 백엔드에 설정한 모든 값을 가져와 원격 구성 객체에 저장합니다. 가져온 매개변수 값을 앱에 적용하려면
activate()메서드를 호출합니다.호출 한 번으로 값을 가져오고 활성화하려는 경우에는
fetchAndActivate()요청으로 원격 구성 백엔드에서 값을 가져와 앱에서 사용할 수 있습니다.Kotlin+KTX
remoteConfig.fetchAndActivate() .addOnCompleteListener(this) { task -> if (task.isSuccessful) { val updated = task.result Log.d(TAG, "Config params updated: $updated") Toast.makeText( this, "Fetch and activate succeeded", Toast.LENGTH_SHORT, ).show() } else { Toast.makeText( this, "Fetch failed", Toast.LENGTH_SHORT, ).show() } displayWelcomeMessage() }Java
mFirebaseRemoteConfig.fetchAndActivate() .addOnCompleteListener(this, new OnCompleteListener<Boolean>() { @Override public void onComplete(@NonNull Task<Boolean> task) { if (task.isSuccessful()) { boolean updated = task.getResult(); Log.d(TAG, "Config params updated: " + updated); Toast.makeText(MainActivity.this, "Fetch and activate succeeded", Toast.LENGTH_SHORT).show(); } else { Toast.makeText(MainActivity.this, "Fetch failed", Toast.LENGTH_SHORT).show(); } displayWelcomeMessage(); } });
이러한 업데이트된 매개변수 값은 앱의 동작과 모양에 영향을 주므로 사용자 경험에 방해가 되지 않을 만한 시점, 예를 들어 사용자가 다음번에 앱을 열 때 등과 같은 상황에서 가져온 값을 활성화하는 것이 좋습니다. 자세한 내용과 예시는 원격 구성 로딩 전략을 참조하세요.
7단계: 실시간 업데이트 리슨
매개변수 값을 가져온 후 실시간 원격 구성을 사용하여 원격 구성 백엔드의 업데이트를 리슨할 수 있습니다. 실시간 원격 구성은 사용 가능한 업데이트가 있을 때 연결된 기기에 신호를 보내고 새로운 원격 구성 버전을 게시한 후 변경사항을 자동으로 가져옵니다.
실시간 업데이트는 Android용 Firebase SDK v21.3.0 이상(Firebase BoM v31.2.4 이상)에서 지원됩니다.
앱에서
addOnConfigUpdateListener()를 사용하여 업데이트 리슨을 시작하고 새 매개변수 값을 자동으로 가져옵니다.onUpdate()콜백을 구현하여 업데이트된 구성을 활성화합니다.Kotlin+KTX
remoteConfig.addOnConfigUpdateListener(object : ConfigUpdateListener { override fun onUpdate(configUpdate : ConfigUpdate) { Log.d(TAG, "Updated keys: " + configUpdate.updatedKeys); if (configUpdate.updatedKeys.contains("welcome_message")) { remoteConfig.activate().addOnCompleteListener { displayWelcomeMessage() } } } override fun onError(error : FirebaseRemoteConfigException) { Log.w(TAG, "Config update error with code: " + error.code, error) } })Java
mFirebaseRemoteConfig.addOnConfigUpdateListener(new ConfigUpdateListener() { @Override public void onUpdate(ConfigUpdate configUpdate) { Log.d(TAG, "Updated keys: " + configUpdate.getUpdatedKeys()); mFirebaseRemoteConfig.activate().addOnCompleteListener(new OnCompleteListener() { @Override public void onComplete(@NonNull Task task) { displayWelcomeMessage(); } }); } @Override public void onError(FirebaseRemoteConfigException error) { Log.w(TAG, "Config update error with code: " + error.getCode(), error); } }); 다음에 새로운 버전의 원격 구성을 게시하면 앱을 실행하고 변경사항을 리슨하는 기기가
ConfigUpdateListener를 호출합니다.
제한
앱에서 단기간에 가져오기를 너무 많이 수행하면 가져오기 호출이 제한되고 SDK는 FirebaseRemoteConfigFetchThrottledException을 반환합니다. SDK 버전 17.0.0 이전에는 60분 동안 가져오기 요청 수가 5회로 제한되었지만 최신 버전에서는 좀 더 많이 허용됩니다.
앱 개발 단계에서는 앱을 개발하고 테스트할 때 빠르게 반복할 수 있도록 구성 가져오기와 활성화를 자주(한 시간에 몇 번씩) 해야 할 수도 있습니다. 서버에서 구성을 업데이트하면 실시간 원격 구성 업데이트가 자동으로 캐시를 우회합니다. 개발자가 10명 이하인 프로젝트에서는 빠르게 반복할 수 있도록 앱에서 FirebaseRemoteConfigSettings 객체의 가져오기 간격 최솟값(setMinimumFetchIntervalInSeconds)을 임시로 낮게 설정할 수 있습니다.
원격 구성의 가져오기 간격 최솟값은 12시간(기본값)입니다. 즉, 실제로 발생하는 가져오기 호출 수에 관계없이 12시간 동안 백엔드에서 구성을 두 번 이상 가져올 수 없습니다. 가져오기 간격 최솟값은 구체적으로 다음과 같은 순서로 결정됩니다.
fetch(long)의 매개변수FirebaseRemoteConfigSettings.setMinimumFetchIntervalInSeconds(long)의 매개변수- 기본값 12시간
가져오기 간격 최솟값을 커스텀 값으로 설정하려면 FirebaseRemoteConfigSettings.Builder.setMinimumFetchIntervalInSeconds(long)를 사용하세요.
다음 단계
아직 원격 구성 사용 사례를 살펴보지 않았다면 살펴보고 다음을 포함하여 주요 개념과 고급 전략 문서를 참조하세요.