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 tham số trong ứng dụng của mình và cập nhật giá trị của chúng trong đá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 hướng dẫn bạn qua các bước để bắt đầu và cung cấp một số mã mẫu, tất cả đều có sẵn để sao chép hoặc tải xuống từ kho lưu trữ firebase/quickstart-js GitHub.

Bước 1: Thêm và khởi tạo SDK cấu hình từ xa

1. Nếu bạn chưa cài đặt, hãy cài đặt SDK Firebase JS và khởi tạo Firebase .

2. Thêm Remote Config JS SDK và khởi tạo Remote Config:

import { initializeApp } from "firebase/app";
import { getRemoteConfig } from "firebase/remote-config";

// TODO: Replace the following with your app's Firebase project configuration
// See: https://firebase.google.com/docs/web/learn-more#config-object
const firebaseConfig = {
  // ...
};

// Initialize Firebase
const app = initializeApp(firebaseConfig);


// Initialize Remote Config and get a reference to the service
const remoteConfig = getRemoteConfig(app);

import firebase from "firebase/compat/app";
import "firebase/compat/remote-config";

// TODO: Replace the following with your app's Firebase project configuration
// See: https://firebase.google.com/docs/web/learn-more#config-object
const firebaseConfig = {
  // ...
};

// Initialize Firebase
firebase.initializeApp(firebaseConfig);


// Initialize Remote Config and get a reference to the service
const remoteConfig = firebase.remoteConfig();

Đối tượng này đượ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 cập nhật từ chương trình phụ trợ Cấu hình từ xa 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.

Bước 2: Đặt khoảng thời gian tìm nạp tối thiểu

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 Throttling để biết thêm thông tin.

remoteConfig.settings.minimumFetchIntervalMillis = 3600000;
rc_set_minimum_fetch_time.js

remoteConfig.settings.minimumFetchIntervalMillis = 3600000;
index.js

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

Bạn có thể đặt các giá trị tham 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 khả dụng nếu không có giá trị nào được đặt trên phần phụ trợ.

remoteConfig.defaultConfig = {
  "welcome_message": "Welcome"
};
rc_set_default_values.js

remoteConfig.defaultConfig = {
  "welcome_message": "Welcome"
};
index.js

Nếu đã định cấu hình các giá trị tham số phụ trợ Cấu hình từ xa, thì bạn có thể tải xuống tệp JSON được tạo bao gồm tất cả các giá trị mặc định và đưa tệp đó vào gói ứng dụng của mình:

curl --compressed -D headers -H "Authorization: Bearer token" -X GET https://firebaseremoteconfig.googleapis.com/v1/projects/my-project-id/remoteConfig:downloadDefaults?format=JSON -o remote_config_defaults.json

Các ví dụ sau đây cho thấy hai cách khác nhau mà bạn có thể nhập và đặt giá trị mặc định trong ứng dụng của mình. Ví dụ đầu tiên sử dụng fetch , sẽ tạo một yêu cầu HTTP tới tệp mặc định có trong gói ứng dụng của bạn:

  const rcDefaultsFile = await fetch('remote_config_defaults.json');
  const rcDefaultsJson = await rcDefaultsFile.json();
  remoteConfig.defaultConfig = rcDefaultsJson;
  

Ví dụ tiếp theo sử dụng require biên dịch các giá trị vào ứng dụng của bạn tại thời điểm xây dựng:

  let rcDefaults = require('./remote_config_defaults.json');
  remoteConfig.defaultConfig = rcDefaults;

Bước 4: Nhận các giá trị tham số để sử dụng trong ứng dụng của bạn

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

import { getValue } from "firebase/remote-config";

const val = getValue(remoteConfig, "welcome_messsage");
rc_get_values.js

const val = remoteConfig.getValue("welcome_messsage");
index.js

Bước 5: Đặt giá trị tham số

Bằng cách sử dụng bảng điều khiển Firebase hoặc API phụ trợ Cấu hình từ xa , bạn có thể tạo các giá trị mặc định phía máy chủ mới ghi đè các giá trị trong ứng dụng theo logic điều kiện mong muốn của bạn hoặc nhắm mục tiêu người dùng. Phần này hướng dẫn bạn qua các bước của bảng điều khiển Firebase để tạo các giá trị này.

1. Trong bảng điều khiển Firebase , hãy mở dự án của bạn.
2. Chọn Cấu hình từ xa từ menu để xem bảng điều khiển Cấu hình từ xa.
3. Xác định các tham số có cùng tên với các tham 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) và bạn cũng có thể đặt giá trị có điều kiện. Để tìm hiểu thêm, hãy xem Điều kiện và Tham số Cấu hình Từ xa .

Bước 6: Tìm nạp và kích hoạt các giá trị

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

Đối với trường hợp bạn muốn tìm nạp và kích hoạt các giá trị trong một lệnh gọi, hãy sử dụng fetchAndActivate() như trong ví dụ sau:

import { fetchAndActivate } from "firebase/remote-config";

fetchAndActivate(remoteConfig)
  .then(() => {
    // ...
  })
  .catch((err) => {
    // ...
  });
rc_fetch_config_callback.js

remoteConfig.fetchAndActivate()
  .then(() => {
    // ...
  })
  .catch((err) => {
    // ...
  });
index.js

Vì các giá trị thông số được cập nhật này ảnh hưởng đến hành vi và giao diện của ứng dụng, nên bạn nên kích hoạt các giá trị được tìm nạp vào 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 khi người dùng mở ứng dụng của bạn. Xem Chiến lược tải cấu hình từ xa để biết thêm thông tin và ví dụ.

tiết lưu

Nếu một ứng dụng tìm nạp quá nhiều lần trong một khoảng thời gian ngắn, lệnh gọi tìm nạp có thể bị điều chỉnh. Trong những trường hợp như vậy, SDK sẽ đưa ra lỗi FETCH_THROTTLE . Bạn nên phát hiện lỗi này và thử lại ở chế độ dự phòng theo cấp số nhân, chờ khoảng thời gian dài hơn giữa các yêu cầu tìm nạp tiếp theo.

Trong quá trình phát triển ứng dụng, bạn có thể muốn làm mới bộ đệm 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. Để phù hợp với quá trình lặp lại nhanh chóng trên một dự án có nhiều nhà phát triển, bạn có thể tạm thời thêm thuộc tính có khoảng thời gian tìm nạp tối thiểu thấp ( Settings.minimumFetchIntervalMillis ) trong ứng dụng của mình.

Khoảng thời gian tìm nạp sản xuất mặc định và được khuyến nghị cho Cấu hình từ xa là 12 giờ, điều đó 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 lần trong khoảng thời gian 12 giờ, bất kể có bao nhiêu cuộc 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. Tham số trong Settings.minimumFetchIntervalMillis .
2. Giá trị mặc định là 12 giờ.

Bước tiếp theo

If you haven't already, explore the Remote Config use cases , and take a look at some of the key concepts and advanced strategies documentation, including:

• Manage Remote Config template versions
• Config loading strategies