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 trên đám mây, cho phép bạn sửa đổi giao diện và hoạt động 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ẽ hướng dẫn 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 của 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ó, hãy cài đặt SDK Firebase JS và khởi chạy Firebase .

  2. Thêm SDK JS cấu hình từ xa và khởi tạo 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 không gian tên 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ữ các giá trị tham số mặc định trong ứng dụng, tìm nạp các giá trị tham số được 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 các giá trị được 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. Xem Điều tiết để biết thêm thông tin.

Web modular API

remoteConfig.settings.minimumFetchIntervalMillis = 3600000;

Web namespaced API

remoteConfig.settings.minimumFetchIntervalMillis = 3600000;

Bước 3: Đặt giá trị tham 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ự định 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ợ.

Web modular API

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

Web namespaced API

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

Nếu đã định cấu hình các giá trị tham số phụ trợ Cấu hình từ xa, 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 nó vào gói ứng dụng của mình:

NGHỈ NGƠI

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 Firebase

  1. Trong tab Tham số , mở Menu và chọn Tải xuống các giá trị mặc định .
  2. Khi được nhắc, hãy bật .json cho web , sau đó nhấp vào Tải xuống tệp .

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 , thao tác này sẽ thực hiện 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 , để tổng hợp 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ể nhận các giá trị tham số từ đối tượng Remote Config. Nếu sau này bạn đặt các giá trị trong phần phụ trợ, tìm nạp 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. Để 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ố.

Web modular API

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

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

Web namespaced API

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

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 có điều kiện hoặc nhắm mục tiêu theo 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 trong 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 thông tin 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 tham số, bạn có thể đặt giá trị mặc định (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à thông 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() . Mọi giá trị bạn đặt trên chương trình phụ trợ đều được tìm nạp và lưu vào bộ đệm trong đối tượng Cấu hình từ xa.
  2. Để cung cấp các giá trị tham số được 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ụ này:

Web modular API

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

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

Web namespaced API

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

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 tại thời điểm đảm bảo trải nghiệm mượt mà cho người dùng, 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 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ì lệnh gọi tìm nạp có thể bị hạn chế. 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ế độ chờ 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 thường xuyên (nhiều lần mỗi giờ) để cho phép bạn lặp lại nhanh chóng khi phát triển và thử nghiệm ứng dụng của mình. Để phù hợp với việc 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 đề xuất cho Cấu hình từ xa là 12 giờ, nghĩa là 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ể thực tế có bao nhiêu lệnh gọi tìm nạp đượ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

Nếu bạn chưa có, hãy khám phá các trường hợp sử dụng cấu hình từ xa và xem xét một số khái niệm chính và tài liệu chiến lược nâng cao, bao gồm: