หน้านี้ได้รับการแปลโดย Cloud Translation API

เริ่มต้นการกำหนดค่าระยะไกลของ Firebase

คุณใช้การกำหนดค่าระยะไกลของ Firebase เพื่อกำหนดพารามิเตอร์ในแอปและอัปเดตค่าในระบบคลาวด์ได้ ซึ่งทำให้แก้ไขรูปลักษณ์และลักษณะการทำงานของแอปได้โดยไม่ต้องเผยแพร่การอัปเดตแอป คู่มือนี้จะอธิบายขั้นตอนในการเริ่มต้นใช้งานและให้โค้ดตัวอย่าง ซึ่งสามารถโคลนหรือดาวน์โหลดได้จากที่เก็บ GitHub ของ firebase/quickstart-android

ขั้นตอนที่ 1: เพิ่ม Firebase และ SDK การกำหนดค่าระยะไกลลงในแอป

เพิ่ม Firebase ลงในโปรเจ็กต์ Android หากยังไม่ได้ทำ
สำหรับการกำหนดค่าระยะไกล คุณต้องใช้ Google Analytics สำหรับการกำหนดเป้าหมายแบบมีเงื่อนไขของอินสแตนซ์แอปไปยังพร็อพเพอร์ตี้ผู้ใช้และกลุ่มเป้าหมาย ดูให้แน่ใจว่าคุณเปิดใช้ Google Analytics ในโปรเจ็กต์แล้ว
ในไฟล์ Gradle ของโมดูล (ระดับแอป) (โดยทั่วไปจะเป็น <project>/<app-module>/build.gradle.kts หรือ <project>/<app-module>/build.gradle) ให้เพิ่ม Dependency สำหรับไลบรารีการกำหนดค่าระยะไกลสำหรับ Android เราขอแนะนำให้ใช้ Firebase Android BoM เพื่อควบคุมการกำหนดเวอร์ชันไลบรารี

นอกจากนี้ ในการตั้งค่า Analytics คุณต้องเพิ่ม Firebase SDK สำหรับ Google Analytics ลงในแอปด้วย
```
dependencies {
    // Import the BoM for the Firebase platform
    implementation(platform("com.google.firebase:firebase-bom:33.1.1"))

    // 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 เวอร์ชันที่เข้ากันได้เสมอ
(ทางเลือก) เพิ่มทรัพยากร Dependency ของไลบรารี Firebase โดยไม่ต้องใช้ BoM

หากเลือกไม่ใช้ Firebase BoM คุณต้องระบุเวอร์ชันไลบรารี Firebase แต่ละเวอร์ชันในบรรทัดทรัพยากร Dependency

โปรดทราบว่าหากคุณใช้ไลบรารี 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:22.0.0")
    implementation("com.google.firebase:firebase-analytics:22.0.2")
}
```
หากกำลังมองหาโมดูลไลบรารีสำหรับ Kotlin โดยเฉพาะ ตั้งแต่ เดือนตุลาคม 2023 (Firebase BoM 32.5.0) ทั้งนักพัฒนา Kotlin และ Java จะ ขึ้นอยู่กับโมดูลไลบรารีหลัก (ดูรายละเอียดได้ที่ คําถามที่พบบ่อยเกี่ยวกับโครงการริเริ่มนี้)

ขั้นตอนที่ 2: รับออบเจ็กต์ Singleton สำหรับการกำหนดค่าระยะไกล

รับอินสแตนซ์ออบเจ็กต์การกำหนดค่าระยะไกล แล้วตั้งช่วงเวลาการดึงข้อมูลขั้นต่ำเพื่อให้มีการรีเฟรชบ่อยๆ ดังนี้

Kotlin+KTX

val remoteConfig: FirebaseRemoteConfig = Firebase.remoteConfig
val configSettings = remoteConfigSettings {
    minimumFetchIntervalInSeconds = 3600
}
remoteConfig.setConfigSettingsAsync(configSettings)MainActivity.kt

Java

FirebaseRemoteConfig mFirebaseRemoteConfig = FirebaseRemoteConfig.getInstance();
FirebaseRemoteConfigSettings configSettings = new FirebaseRemoteConfigSettings.Builder()
        .setMinimumFetchIntervalInSeconds(3600)
        .build();
mFirebaseRemoteConfig.setConfigSettingsAsync(configSettings);MainActivity.java

ออบเจ็กต์ Singleton ใช้ในการจัดเก็บค่าพารามิเตอร์เริ่มต้นในแอป ดึงข้อมูลค่าพารามิเตอร์ที่อัปเดตจากแบ็กเอนด์ และควบคุมเมื่อค่าที่ดึงข้อมูลพร้อมใช้งานสำหรับแอป

ในช่วงการพัฒนา ขอแนะนำให้กำหนดช่วงเวลาการดึงข้อมูลขั้นต่ำที่ค่อนข้างต่ำ ดูข้อมูลเพิ่มเติมที่การควบคุม

ขั้นตอนที่ 3: ตั้งค่าพารามิเตอร์เริ่มต้นในแอป

คุณสามารถตั้งค่าพารามิเตอร์เริ่มต้นในแอปในออบเจ็กต์การกำหนดค่าระยะไกลเพื่อให้แอปทำงานตามที่ต้องการก่อนเชื่อมต่อกับแบ็กเอนด์การกำหนดค่าระยะไกล และเพื่อให้ค่าเริ่มต้นพร้อมใช้งานหากไม่มีการตั้งค่าในแบ็กเอนด์

กำหนดชุดของชื่อพารามิเตอร์และค่าพารามิเตอร์เริ่มต้นโดยใช้ออบเจ็กต์แมป หรือไฟล์ทรัพยากร XML ที่จัดเก็บในโฟลเดอร์ res/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
1. ในแท็บพารามิเตอร์ ให้เปิดเมนู แล้วเลือกดาวน์โหลดค่าเริ่มต้น
2. เมื่อได้รับข้อความแจ้ง ให้เปิดใช้ .xml สำหรับ Android แล้วคลิกดาวน์โหลดไฟล์
เพิ่มค่าเหล่านี้ลงในออบเจ็กต์การกำหนดค่าระยะไกลโดยใช้ setDefaultsAsync(int) ดังที่แสดงด้านล่างนี้
Kotlin+KTX
```
remoteConfig.setDefaultsAsync(R.xml.remote_config_defaults)
```
Java
```
mFirebaseRemoteConfig.setDefaultsAsync(R.xml.remote_config_defaults);
```

ขั้นตอนที่ 4: รับค่าพารามิเตอร์เพื่อใช้ในแอป

ตอนนี้คุณสามารถรับค่าพารามิเตอร์จากออบเจ็กต์การกำหนดค่าระยะไกลได้แล้ว หากคุณตั้งค่าในแบ็กเอนด์ ให้ดึงข้อมูลแล้วเปิดใช้งานค่าเหล่านั้น ค่าเหล่านั้นจะพร้อมใช้งานสำหรับแอป ไม่เช่นนั้นจะได้รับค่าพารามิเตอร์ในแอปที่กำหนดค่าโดยใช้ setDefaultsAsync(int) ในการรับค่าเหล่านี้ ให้เรียกใช้เมธอดด้านล่างซึ่งแมปกับประเภทข้อมูลที่แอปคาดหวัง โดยให้คีย์พารามิเตอร์เป็นอาร์กิวเมนต์

ขั้นตอนที่ 5: ตั้งค่าค่าพารามิเตอร์ในแบ็กเอนด์การกำหนดค่าระยะไกล

เมื่อใช้คอนโซล Firebase หรือ API แบ็กเอนด์ของการกำหนดค่าระยะไกล คุณสามารถสร้างค่าเริ่มต้นฝั่งเซิร์ฟเวอร์ใหม่ๆ ที่ลบล้างค่าในแอปตามตรรกะแบบมีเงื่อนไขหรือการกำหนดเป้าหมายผู้ใช้ที่คุณต้องการ ส่วนนี้จะอธิบายขั้นตอนในการสร้างค่าเหล่านี้ในคอนโซล Firebase

เปิดโปรเจ็กต์ในคอนโซล Firebase
เลือกการกำหนดค่าระยะไกลจากเมนูเพื่อดูหน้าแดชบอร์ดการกำหนดค่าระยะไกล
กำหนดพารามิเตอร์ด้วยชื่อเดียวกันกับพารามิเตอร์ที่คุณกำหนดในแอป คุณสามารถกำหนดค่าเริ่มต้นให้กับพารามิเตอร์แต่ละรายการ (ซึ่งสุดท้ายจะแทนที่ค่าเริ่มต้นที่เกี่ยวข้องในแอป) และยังกำหนดค่าแบบมีเงื่อนไขได้ด้วย ดูข้อมูลเพิ่มเติมได้ที่เงื่อนไขและพารามิเตอร์การกำหนดค่าระยะไกล

ขั้นตอนที่ 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();
            }
        });

เนื่องจากค่าพารามิเตอร์ที่อัปเดตเหล่านี้ส่งผลต่อลักษณะการทำงานและรูปลักษณ์ของแอป คุณจึงควรเปิดใช้งานค่าที่ดึงมาในช่วงเวลาหนึ่งๆ เพื่อให้ผู้ใช้ได้รับประสบการณ์การใช้งานที่ราบรื่น เช่น ในครั้งถัดไปที่ผู้ใช้เปิดแอป ดูกลยุทธ์การโหลดการกำหนดค่าระยะไกลเพื่อดูข้อมูลเพิ่มเติมและตัวอย่าง

หมายเหตุ: หากแอปไม่ได้สร้างด้วย Gradle คุณต้องเพิ่มทรัพยากรสตริง google_app_id ที่ถูกต้องลงในแอปด้วยตนเองเพื่อให้การกำหนดค่าระยะไกลเริ่มต้นได้ ปกติแล้วปลั๊กอิน Gradle ของ google-services จะเพิ่มค่านี้โดยอัตโนมัติ แต่คุณสามารถหาค่าที่เหมาะสมได้ในไฟล์ google-services.json ที่ดาวน์โหลดจากคอนโซล Firebase ดูข้อมูลเพิ่มเติมเกี่ยวกับการรับค่า google_app_id จากไฟล์ google-services.json ได้ที่การประมวลผลไฟล์ JSON

ขั้นตอนที่ 7: ฟังข้อมูลอัปเดตแบบเรียลไทม์

หลังจากดึงข้อมูลค่าพารามิเตอร์แล้ว คุณจะใช้การกำหนดค่าระยะไกลแบบเรียลไทม์เพื่อฟังข้อมูลอัปเดตจากแบ็กเอนด์การกำหนดค่าระยะไกลได้ แบบเรียลไทม์ สัญญาณการกำหนดค่าระยะไกลจะส่งสัญญาณให้กับอุปกรณ์ที่เชื่อมต่อเมื่อมีการอัปเดต และจะดึงข้อมูลการเปลี่ยนแปลงโดยอัตโนมัติหลังจากที่คุณเผยแพร่การกำหนดค่าระยะไกลเวอร์ชันใหม่

Firebase SDK สำหรับ Android เวอร์ชัน 21.3.0 ขึ้นไป (Firebase BoM v31.2.4 ขึ้นไป) รองรับการอัปเดตแบบเรียลไทม์

สำคัญ: การกำหนดค่าระยะไกลแบบเรียลไทม์จำเป็นต้องใช้ Realtime API ของการกำหนดค่าระยะไกลของ Firebase ซึ่งควรเปิดใช้ให้คุณอยู่แล้ว หากต้องการยืนยัน ให้เปิด Google Cloud Console เลือกโปรเจ็กต์ แล้วเปิดหน้า API และบริการ API ควรจะปรากฏว่าเปิดใช้อยู่ หากไม่มีหรือไม่ได้เปิดใช้ ให้คลิกเปิดใช้ API และบริการ ค้นหา Realtime API ของการกำหนดค่าระยะไกลของ Firebase แล้วเปิดใช้

ในแอป ให้ใช้ addOnConfigUpdateListener() เพื่อเริ่มฟังการอัปเดต และดึงข้อมูลค่าพารามิเตอร์ใหม่โดยอัตโนมัติ ใช้ Callback 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 ขีดจำกัดคือคำขอดึงข้อมูล 5 รายการในช่วงเวลา 60 นาที (เวอร์ชันใหม่จะมีขีดจำกัดที่เข้มงวดมากกว่า)

เคล็ดลับ: ตั้งแต่ Android SDK v21.3.0 ขึ้นไป (Firebase BoM v31.3.0 ขึ้นไป) คุณจะใช้การกำหนดค่าระยะไกลแบบเรียลไทม์เพื่อดึงข้อมูลค่าพารามิเตอร์ที่อัปเดตแล้วจากแบ็กเอนด์การกำหนดค่าระยะไกลโดยอัตโนมัติได้ทันทีที่มีการเผยแพร่ โดยจะข้ามการตั้งค่าช่วงเวลาการดึงข้อมูลขั้นต่ำ ดูข้อมูลเพิ่มเติมได้ที่ฟังการอัปเดตแบบเรียลไทม์

ในระหว่างการพัฒนาแอป คุณอาจต้องดึงข้อมูลและเปิดใช้งานการกำหนดค่าบ่อยมาก (หลายครั้งต่อชั่วโมง) เพื่อให้คุณปรับปรุงอย่างรวดเร็วขณะพัฒนาและทดสอบแอป การอัปเดตการกำหนดค่าระยะไกลแบบเรียลไทม์จะข้ามแคชโดยอัตโนมัติเมื่อมีการอัปเดตการกำหนดค่าบนเซิร์ฟเวอร์ คุณตั้งค่าออบเจ็กต์ FirebaseRemoteConfigSettings ที่มีช่วงเวลาการดึงข้อมูลขั้นต่ำต่ำ (setMinimumFetchIntervalInSeconds) ในแอปได้ชั่วคราว เพื่อรองรับการดำเนินการซ้ำอย่างรวดเร็วในโปรเจ็กต์ที่มีนักพัฒนาซอฟต์แวร์สูงสุด 10 คน

ช่วงเวลาการดึงข้อมูลขั้นต่ำเริ่มต้นสำหรับการกำหนดค่าระยะไกลคือ 12 ชั่วโมง ซึ่งหมายความว่าระบบจะไม่ดึงข้อมูลการกำหนดค่าจากแบ็กเอนด์มากกว่า 1 ครั้งในกรอบเวลา 12 ชั่วโมง ไม่ว่าจริงๆ แล้วการเรียกใช้การดึงข้อมูลจะเป็นจำนวนเท่าใดก็ตาม โดยเฉพาะอย่างยิ่ง รอบการดึงข้อมูลขั้นต่ำจะกำหนดตามลำดับต่อไปนี้

พารามิเตอร์ใน fetch(long)
พารามิเตอร์ใน FirebaseRemoteConfigSettings.setMinimumFetchIntervalInSeconds(long)
ค่าเริ่มต้นคือ 12 ชั่วโมง

หากต้องการกำหนดช่วงเวลาการดึงข้อมูลขั้นต่ำเป็นค่าที่กำหนดเอง ให้ใช้ FirebaseRemoteConfigSettings.Builder.setMinimumFetchIntervalInSeconds(long)

โปรดทราบว่าการตั้งค่านี้ควรใช้สำหรับการพัฒนาเท่านั้น ไม่ใช่สำหรับแอปที่ทำงานในเวอร์ชันที่ใช้งานจริง หากคุณแค่ทดสอบแอปกับทีมพัฒนาขนาดเล็กที่มีสมาชิก 10 คน คุณจะไม่มีแนวโน้มที่จะถึงขีดจำกัดโควต้าด้านบริการรายชั่วโมง แต่หากคุณพุชแอปไปยังผู้ใช้ทดสอบหลายพันรายด้วยช่วงเวลาการดึงข้อมูลขั้นต่ำที่ต่ำมาก แอปของคุณก็อาจจะใช้โควต้านี้หมด

ขั้นตอนถัดไป

หากยังไม่ทราบข้อมูล ให้ลองดูกรณีการใช้งานการกำหนดค่าระยะไกลและดูแนวคิดหลักบางส่วนและเอกสารกลยุทธ์ขั้นสูงซึ่งได้แก่