Bắt đầu sử dụng 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 các tham số đó trên đám mây. Điều nà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 sẽ chỉ cho bạn 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ữ GitHub firebase/Quickstart-js.

Bước 1: Thêm và khởi chạy 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 chạy Firebase.

  2. Thêm SDK JS của Cấu hình từ xa và khởi chạy Cấu hình từ xa:

API mô-đun web

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

API được đặt tên trong vùng chứa tên của web

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 dùng để lưu trữ giá trị thông số mặc định trong ứng dụng, tìm nạp giá trị thông số đã cập nhật từ phần phụ trợ Cấu hình từ xa và kiểm soát thời điểm cung cấp giá trị đã tìm nạ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. Vui lòng xem phần Điều tiết để biết thêm thông tin.

API mô-đun web

remoteConfig.settings.minimumFetchIntervalMillis = 3600000;

API được đặt tên trong vùng chứa tên của web

remoteConfig.settings.minimumFetchIntervalMillis = 3600000;

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

Bạn có thể đặt 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. Đồng thời, để các giá trị mặc định có sẵn nếu không có giá trị nào được đặt trên phần phụ trợ.

API mô-đun web

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

API được đặt tên trong vùng chứa tên của web

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

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

Kiến trúc chuyển trạng thái đại diện (REST)

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

bảng điều khiển của Firebase

  1. Trong thẻ Parameters (Tham số), hãy mở Trình đơn rồi chọn Tải giá trị mặc định xuống.
  2. Khi được nhắc, hãy bật .json cho web, sau đó nhấp vào Tải tệp xuống.

Các ví dụ sau đây minh hoạ hai cách để 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 để gửi yêu cầu HTTP đến 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ị này thành ứ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: Lấy các giá trị tham số để dùng trong ứng dụng

Bây giờ, bạn có thể nhận giá trị thông số từ đối tượng Cấu hình từ xa. Nếu sau đó bạn đặt giá trị trong phần phụ trợ, tìm nạp 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() và cung cấp khoá tham số làm đối số.

API mô-đun web

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

const val = getValue(remoteConfig, "welcome_messsage");

API được đặt tên trong vùng chứa tên của web

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

Bước 5: Đặt giá trị thông số

Bằng cách sử dụng bảng điều khiển của 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 mới phía máy chủ để ghi đè các giá trị trong ứng dụng theo logic có điều kiện hoặc tiêu chí nhắm mục tiêu người dùng mà bạn mong muốn. Phần này sẽ hướng dẫn bạn các bước tạo các giá trị này trong bảng điều khiển của Firebase.

  1. Trong bảng điều khiển của Firebase, hãy mở dự án của bạn.
  2. Chọn Cấu hình từ xa từ trình đơn để xem trang tổng quan Cấu hình từ xa.
  3. Hãy xác định tham số có tên giống với tham số bạn đã xác định trong ứng dụng của mình. Đối với mỗi tham 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 Các tham số và điều kiện của 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 giá trị thông số từ phần phụ trợ Cấu hình từ xa, hãy gọi phương thức fetchConfig(). Mọi giá trị mà bạn đặt trên phần phụ trợ đều được tìm nạp và lưu vào bộ nhớ đệm 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:

API mô-đun web

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

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

API được đặt tên trong vùng chứa tên của web

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

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

Điều tiết

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, thì các lệnh gọi tìm nạp có thể bị điều tiết. Trong những trường hợp như vậy, SDK sẽ gửi lỗi FETCH_THROTTLE. Bạn nên phát hiện lỗi này và thử lại ở chế độ thời gian đợi luỹ thừa, 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 nên làm mới bộ nhớ đệm thật thường xuyên (nhiều lần mỗi giờ) để nhanh chóng lặp lại khi phát triển và kiểm thử ứng dụng. Để đáp ứng việc lặp lại nhanh trên một dự án có nhiều nhà phát triển, bạn có thể tạm thời thêm một thuộc tính có khoảng thời gian tìm nạp tối thiểu thấp (Settings.minimumFetchIntervalMillis) vào ứng dụng của mình.

Khoảng thời gian tìm nạp chính thức mặc định và được đề xuất cho Cấu hình từ xa là 12 giờ, tức là các cấu hình sẽ không được tìm nạp qua phần phụ trợ nhiều lần trong khoảng thời gian 12 giờ, bất kể số 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. Tham số trong Settings.minimumFetchIntervalMillis.
  2. Giá trị mặc định là 12 giờ.

Các bước tiếp theo

Hãy khám phá các trường hợp sử dụng Cấu hình từ xa (nếu bạn chưa thực hiện), đồng thời xem một số khái niệm chính và tài liệu về chiến lược nâng cao, bao gồm: