Bắt đầu với Cấu hình từ xa Firebase

Bạn có thể sử dụng Cấu hình từ xa Firebase để xác định các thông số trong ứng dụng của mình và cập nhật giá trị của chúng trên đám mây, cho phép bạn sửa đổi giao diện và hành vi của ứng dụng mà không cần phân phối bản cập nhật ứng dụng. Hướng dẫn này giúp bạn qua các bước để bắt đầu và cung cấp một số mẫu mã, tất cả đều có sẵn để clone hoặc tải về từ căn cứ hỏa lực / quickstart-android GitHub kho.

Thêm Firebase và SDK cấu hình từ xa vào ứng dụng của bạn

  1. Nếu bạn chưa sẵn sàng, thêm căn cứ hỏa lực cho dự án Android của bạn .

  2. Cho Remote Config, Google Analytics là cần thiết cho việc nhắm mục tiêu có điều kiện của trường hợp ứng dụng để tính người dùng, khán giả, và dự đoán căn cứ hỏa lực. Hãy chắc chắn rằng bạn cho phép Google Analytics trong dự án của bạn.

  3. Sử dụng các căn cứ hỏa lực Android HĐQT , kê khai phụ thuộc cho các thư viện Config Android từ xa trong module của bạn (ứng dụng cấp) tập tin Gradle (thường là app/build.gradle ).

    Ngoài ra, là một phần của quá trình thiết lập Analytics, bạn cần thêm SDK Firebase cho Google Analytics vào ứng dụng của mình.

    Java

    dependencies {
        // Import the BoM for the Firebase platform
        implementation platform('com.google.firebase:firebase-bom:29.0.4')
    
        // Declare 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'
    }
    

    Bằng việc sử dụng căn cứ hỏa lực Android HĐQT , ứng dụng của bạn sẽ luôn luôn sử dụng các phiên bản tương thích của các thư viện căn cứ hỏa lực Android.

    (Alternative) Khai báo căn cứ hỏa lực phụ thuộc thư viện mà không sử dụng HĐQT

    Nếu bạn chọn không sử dụng Firebase BoM, bạn phải chỉ định từng phiên bản thư viện Firebase trong dòng phụ thuộc của nó.

    Lưu ý rằng nếu bạn sử dụng nhiều thư viện căn cứ hỏa lực trong ứng dụng của bạn, chúng tôi khuyên bạn nên sử dụng HĐQT để quản lý các phiên bản thư viện, đảm bảo rằng tất cả các phiên bản tương thích.

    dependencies {
        // Declare 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.0.1'
        implementation 'com.google.firebase:firebase-analytics:20.0.2'
    }
    

    Kotlin + KTX

    dependencies {
        // Import the BoM for the Firebase platform
        implementation platform('com.google.firebase:firebase-bom:29.0.4')
    
        // Declare 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-ktx'
        implementation 'com.google.firebase:firebase-analytics-ktx'
    }
    

    Bằng việc sử dụng căn cứ hỏa lực Android HĐQT , ứng dụng của bạn sẽ luôn luôn sử dụng các phiên bản tương thích của các thư viện căn cứ hỏa lực Android.

    (Alternative) Khai báo căn cứ hỏa lực phụ thuộc thư viện mà không sử dụng HĐQT

    Nếu bạn chọn không sử dụng Firebase BoM, bạn phải chỉ định từng phiên bản thư viện Firebase trong dòng phụ thuộc của nó.

    Lưu ý rằng nếu bạn sử dụng nhiều thư viện căn cứ hỏa lực trong ứng dụng của bạn, chúng tôi khuyên bạn nên sử dụng HĐQT để quản lý các phiên bản thư viện, đảm bảo rằng tất cả các phiên bản tương thích.

    dependencies {
        // Declare 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-ktx:21.0.1'
        implementation 'com.google.firebase:firebase-analytics-ktx:20.0.2'
    }
    

Lấy đối tượng singleton Cấu hình từ xa

Nhận một phiên bản đối tượng Cấu hình từ xa và đặt khoảng thời gian tìm nạp tối thiểu để cho phép làm mới thường xuyên:

Java

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

Kotlin + KTX

remoteConfig = Firebase.remoteConfig
val configSettings = remoteConfigSettings {
    minimumFetchIntervalInSeconds = 3600
}
remoteConfig.setConfigSettingsAsync(configSettings)

Đối tượng singleton được sử dụng để lưu trữ các giá trị thông số mặc định trong ứng dụng, tìm nạp các giá trị thông số cập nhật từ chương trình phụ trợ và kiểm soát thời điểm các giá trị đã tìm nạp được cung cấp cho ứng dụng của bạn.

Trong quá trình phát triển, bạn nên đặt khoảng thời gian tìm nạp tối thiểu tương đối thấp. Xem tốc độ nhâp để biết thêm thông tin.

Đặt giá trị thông số mặc định trong ứng dụng

Bạn có thể đặt các giá trị thông số mặc định trong ứng dụng trong đối tượng Cấu hình từ xa để ứng dụng của bạn hoạt động như dự kiến ​​trước khi kết nối với phần phụ trợ Cấu hình từ xa và để các giá trị mặc định có sẵn nếu không có giá trị nào được đặt trong phần phụ trợ.

  1. Xác định một tập hợp các tên tham số và giá trị tham số mặc định sử dụng một đồ vật hoặc một tập tin tài nguyên XML lưu trữ trong ứng dụng của bạn res/xml thư mục. Remote Config QuickStart mẫu sử dụng ứng dụng một tập tin XML để xác định tên tham số mặc định và giá trị.
  2. Thêm các giá trị cho các đối tượng Config từ xa sử dụng setDefaultsAsync(int) , như:

Java

mFirebaseRemoteConfig.setDefaultsAsync(R.xml.remote_config_defaults);

Kotlin + KTX

remoteConfig.setDefaultsAsync(R.xml.remote_config_defaults)

Nhận các giá trị thông số để sử dụng trong ứng dụng của bạn

Bây giờ bạn có thể nhận các giá trị tham số từ đối tượng Cấu hình từ xa. Nếu bạn đặt các giá trị trong phần phụ trợ, tìm nạp chúng rồi kích hoạt chúng, thì những giá trị đó sẽ có sẵn cho ứng dụng của bạn. Nếu không, bạn sẽ có được các giá trị tham số trong ứng dụng cấu hình sử dụng setDefaultsAsync(int) . Để nhận các giá trị này, hãy gọi phương thức được liệt kê bên dưới ánh xạ tới loại dữ liệu mà ứng dụng của bạn mong đợi, cung cấp khóa tham số làm đối số:

Đặt giá trị tham số trong phần phụ trợ Cấu hình từ xa

Sử dụng các căn cứ hỏa lực console hoặc API backend Config từ xa , bạn có thể tạo các giá trị mặc định server-side mới ghi đè lên các giá trị trong ứng dụng theo mục tiêu mong muốn logic có điều kiện ngừơi tiêu dùng của bạn. Phần này mô tả các bước của bảng điều khiển Firebase để tạo các giá trị này.

  1. Trong căn cứ hỏa lực console , mở dự án của bạn.
  2. Chọn từ xa Config từ menu để xem các bảng điều khiển từ xa Config.
  3. Xác định các thông số có cùng tên với các thông số mà bạn đã xác định trong ứng dụng của mình. Đối với mỗi thông số, bạn có thể đặt giá trị mặc định (giá trị này cuối cùng sẽ ghi đè giá trị mặc định trong ứng dụng tương ứng) và bạn cũng có thể đặt giá trị có điều kiện. Để tìm hiểu thêm, xem từ xa Config thông số và điều kiện .

Tìm nạp và kích hoạt các giá trị

  1. Để lấy giá trị tham số từ Config backend từ xa, hãy gọi fetch() phương pháp. Bất kỳ giá trị nào bạn đặt trong phần phụ trợ đều được tìm nạp và lưu trữ trong đối tượng Cấu hình từ xa.
  2. Để làm cho giá trị tham số lấy sẵn cho ứng dụng của bạn, hãy gọi activate() phương pháp.

    Đối với trường hợp bạn muốn lấy và kích hoạt giá trị trong một cuộc gọi, bạn có thể sử dụng một fetchAndActivate() yêu cầu để lấy giá trị từ Config backend từ xa và làm cho họ có sẵn cho các ứng dụng:

    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();
                }
            });

    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()
            }

Vì các giá trị thông số được cập nhật này ảnh hưởng đến hoạt động và giao diện của ứng dụng, bạn nên kích hoạt các giá trị được tìm nạp tại một thời điểm để đảm bảo trải nghiệm mượt mà cho người dùng của bạn, chẳng hạn như lần tiếp theo người dùng mở ứng dụng của bạn. Xem chiến lược tải Config từ xa để biết thêm thông tin và ví dụ.

Throttling

Nếu một ứng dụng lấy về quá nhiều lần trong một khoảng thời gian ngắn, lấy cuộc gọi được Throttled và SDK trả FirebaseRemoteConfigFetchThrottledException . Trước phiên bản SDK 17.0.0, giới hạn là 5 yêu cầu tìm nạp trong cửa sổ 60 phút (các phiên bản mới hơn có nhiều giới hạn cho phép hơn).

Trong quá trình phát triển ứng dụng, bạn có thể muốn tìm nạp và kích hoạt các cấu hình rất thường xuyên (nhiều lần mỗi giờ) để cho phép bạn lặp lại nhanh chóng khi bạn phát triển và thử nghiệm ứng dụng của mình. Để thích ứng với lần lặp nhanh chóng trên một dự án lên đến 10 nhà phát triển, bạn có thể tạm thời thiết lập một FirebaseRemoteConfigSettings đối tượng với tối thiểu thấp lấy khoảng ( setMinimumFetchIntervalInSeconds ) trong ứng dụng của bạn.

Khoảng thời gian tìm nạp tối thiểu mặc định cho Cấu hình từ xa là 12 giờ, có nghĩa là các cấu hình sẽ không được tìm nạp từ chương trình phụ trợ nhiều hơn một lần trong cửa sổ 12 giờ, bất kể có bao nhiêu lệnh gọi tìm nạp thực sự được thực hiện. Cụ thể, khoảng thời gian tìm nạp tối thiểu được xác định theo thứ tự sau:

  1. Các tham số trong fetch(long)
  2. Các tham số trong FirebaseRemoteConfigSettings.setMinimumFetchIntervalInSeconds(long)
  3. Giá trị mặc định của 12 giờ

Để cài đặt tối thiểu lấy khoảng một giá trị tùy chỉnh, sử dụng FirebaseRemoteConfigSettings.Builder.setMinimumFetchIntervalInSeconds(long) .

Bước tiếp theo

Nếu bạn chưa sẵn sàng, khám phá những Config từ xa trường hợp sử dụng , và có một cái nhìn tại một số các khái niệm then chốt và các tài liệu chiến lược tiên tiến, bao gồm: