Trang này được dịch bởi Cloud Translation API.

Tạo phiên bản và mẫu Cấu hình từ xa

Mẫu Remote Config là tập hợp các tham số và điều kiện có định dạng JSON mà bạn đã tạo cho dự án Firebase. Bạn có thể tạo mẫu máy khách để ứng dụng của bạn tìm nạp giá trị và mẫu máy chủ để máy khách máy chủ có thể tìm nạp giá trị.

Phần này thảo luận về mẫu ứng dụng. Để tìm hiểu về các mẫu dành riêng cho máy chủ, hãy nhấp vào Mẫu máy chủ.

Bạn sửa đổi và quản lý mẫu bằng bảng điều khiển Firebase. Bảng điều khiển này hiển thị nội dung của mẫu ở định dạng đồ hoạ trong thẻThẻ Parameters (Tham số) và Conditions (Điều kiện).

Bạn cũng có thể sử dụng API REST Remote Config và SDK dành cho quản trị viên hoặc CLI Firebase để sửa đổi và quản lý mẫu ứng dụng.

Dưới đây là ví dụ về tệp mẫu máy chủ:

{
  "parameters": {
    "preamble_prompt": {
      "defaultValue": {
        "value": "You are a helpful assistant who knows everything there is to know about Firebase! "
      },
      "description": "Add this prompt to the user's prompt",
      "valueType": "STRING"
    },
    "model_name": {
      "defaultValue": {
        "value": "gemini-pro-test"
      },
      "valueType": "STRING"
    },
    "generation_config": {
      "defaultValue": {
        "value": "{\"temperature\": 0.9, \"maxOutputTokens\": 2048, \"topP\": 0.9, \"topK\": 20}"
      },
      "valueType": "JSON"
    },
  },
  "version": {
    "versionNumber": "19",
    "isLegacy": true
  }
}

Bạn có thể thực hiện các tác vụ quản lý phiên bản này bằng bảng điều khiển Firebase:

Liệt kê tất cả phiên bản mẫu được lưu trữ
Truy xuất một phiên bản cụ thể
Khôi phục về một phiên bản ứng dụng cụ thể
Xoá mẫu Remote Config khỏi trang Nhật ký thay đổi

Tổng số phiên bản được lưu trữ trong vòng đời là 300 phiên bản cho mỗi loại mẫu (300 mẫu ứng dụng và 300 mẫu máy chủ), bao gồm cả số phiên bản được lưu trữ cho các mẫu đã xoá. Nếu bạn phát hành hơn 300 phiên bản mẫu cho mỗi loại mẫu trong suốt thời gian hoạt động của dự án, thì các phiên bản sớm nhất sẽ bị xoá, duy trì tối đa 300 phiên bản của loại đó.

Mỗi khi bạn cập nhật tham số, Remote Config sẽ tạo một mẫu Remote Config mới có phiên bản và lưu trữ mẫu trước đó dưới dạng một phiên bản mà bạn có thể truy xuất hoặc quay lại nếu cần. Số phiên bản được tăng dần theo tuần tự từ giá trị ban đầu do Remote Config lưu trữ. Tất cả các mẫu đều có trường version như minh hoạ, chứa siêu dữ liệu về phiên bản cụ thể đó.

Bạn có thể xoá các mẫu Remote Config khi cần trên trang Nhật ký thay đổi của bảng điều khiển Remote Config.

Quản lý các phiên bản mẫu Remote Config

Phần này mô tả cách quản lý các phiên bản của mẫu Remote Config.

Liệt kê tất cả phiên bản đã lưu của mẫu Remote Config

Bạn có thể truy xuất danh sách tất cả phiên bản đã lưu của mẫu Remote Config. Để thực hiện việc này:

Bảng điều khiển Firebase

Trong thẻ Parameters (Thông số), chọn biểu tượng "đồng hồ" hiển thị ở trên cùng bên phải. Thao tác này sẽ mở trang Nhật ký thay đổi liệt kê tất cả các phiên bản mẫu được lưu trữ trong trình đơn danh sách ở bên phải.

Thông tin chi tiết hiển thị cho mỗi phiên bản được lưu trữ bao gồm thông tin về việc các thay đổi có bắt nguồn từ Console, API REST, từ một thao tác khôi phục hay không, hoặc liệu đó có phải là các thay đổi gia tăng từ một thao tác lưu bắt buộc của mẫu hay không.

Firebase CLI

firebase remoteconfig:versions:list

Sử dụng tuỳ chọn --limit để giới hạn số lượng phiên bản được trả về. Truyền "0" để tìm nạp tất cả phiên bản.

Node.js

function listAllVersions() {
  admin.remoteConfig().listVersions()
    .then((listVersionsResult) => {
      console.log("Successfully fetched the list of versions");
      listVersionsResult.versions.forEach((version) => {
        console.log('version', JSON.stringify(version));
      });
    })
    .catch((error) => {
      console.log(error);
    });
}

Java

ListVersionsPage page = FirebaseRemoteConfig.getInstance().listVersionsAsync().get();
while (page != null) {
  for (Version version : page.getValues()) {
    System.out.println("Version: " + version.getVersionNumber());
  }
  page = page.getNextPage();
}

// Iterate through all versions. This will still retrieve versions in batches.
page = FirebaseRemoteConfig.getInstance().listVersionsAsync().get();
for (Version version : page.iterateAll()) {
  System.out.println("Version: " + version.getVersionNumber());
}

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

curl --compressed -D headers -H "Authorization: Bearer <var>token</var>" -X GET https://firebaseremoteconfig.googleapis.com/v1/projects/<var>my-project-id</var>/remoteConfig:listVersions

Danh sách mẫu bao gồm siêu dữ liệu cho tất cả phiên bản được lưu trữ, bao gồm cả thời gian cập nhật, người dùng đã tạo và cách tạo phiên bản. Dưới đây là ví dụ về phần tử phiên bản:

```json
{
  "versions": [{
    "version_number": "6",
    "update_time": "2022-05-12T02:38:54Z",
    "update_user": {
      "name": "Jane Smith",
      "email": "jane@developer.org",
      "imageUrl": "https://lh3.googleusercontent.com/a-/..."
    },
    "description": "One small change on the console",
    "origin": "CONSOLE",
    "update_type": "INCREMENTAL_UPDATE"
  }]
}
```

Truy xuất một phiên bản cụ thể của mẫu Remote Config

Bạn có thể truy xuất bất kỳ phiên bản cụ thể nào được lưu trữ của mẫu Remote Config. Cách truy xuất phiên bản mẫu đã lưu trữ:

Bảng điều khiển Firebase

Theo mặc định, ngăn chi tiết trong thẻ Nhật ký thay đổi sẽ hiển thị mẫu đang hoạt động. Để xem thông tin chi tiết về một phiên bản khác trong danh sách, hãy chọn phiên bản đó trong trình đơn bên phải.

Bạn có thể xem thông tin chi tiết về sự khác biệt giữa phiên bản hiện đang chọn và mọi phiên bản khác được lưu trữ bằng cách di chuột qua trình đơn theo bối cảnh cho mọi phiên bản không được chọn rồi chọn So sánh với phiên bản đã chọn.

Firebase CLI

firebase remoteconfig:get -v VERSION_NUMBER

Bạn có thể ghi kết quả vào một tệp đã chỉ định bằng -o, FILENAME (không bắt buộc).

Node.js

Truyền getTemplate() mà không có đối số nào để truy xuất phiên bản mới nhất của mẫu hoặc để truy xuất một phiên bản cụ thể, hãy sử dụng getTemplateAtVersion().

// Get template version: 6
admin.remoteConfig().getTemplateAtVersion('6')
  .then((template) => {
    console.log("Successfully fetched the template with ETag: " + template.etag);
  })
  .catch((error) => {
    console.log(error);
  });

Java

Template template = FirebaseRemoteConfig.getInstance().getTemplateAtVersionAsync(versionNumber).get();
// See the ETag of the fetched template.
System.out.println("Successfully fetched the template with ETag: " + template.getETag());

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

curl --compressed -D headers -H "Authorization: Bearer <var>token</var>" -X GET https://firebaseremoteconfig.googleapis.com/v1/projects/<var>my-project-id</var>/remoteConfig?version_number=6

Tham số URL ?version_number chỉ hợp lệ cho các thao tác GET; bạn không thể sử dụng tham số này để chỉ định số phiên bản cho bản cập nhật. Một yêu cầu get tương tự mà không có tham số ?version_number sẽ truy xuất mẫu đang hoạt động hiện tại.

Khôi phục về một phiên bản cụ thể đã lưu trữ của mẫu Remote Config

Bạn có thể quay lại bất kỳ phiên bản mẫu nào đã lưu trữ. Cách khôi phục mẫu:

Bảng điều khiển Firebase

Đối với các phiên bản mẫu trước đó đủ điều kiện để khôi phục, một nút tuỳ chọn để khôi phục về phiên bản đó sẽ xuất hiện ở trên cùng bên phải của trang Nhật ký thay đổi. Chỉ nhấp và xác nhận việc này nếu bạn chắc chắn muốn quay lại phiên bản đó và sử dụng các giá trị đó ngay lập tức cho tất cả ứng dụng và người dùng.

Firebase CLI

firebase remoteconfig:rollback -v VERSION_NUMBER

Node.js

// Roll back to template version: 6
admin.remoteConfig().rollback('6')
  .then((template) => {
    console.log("Successfully rolled back to template version 6.");
    console.log("New ETag: " + template.etag);
  })
  .catch((error) => {
    console.log('Error trying to rollback:', e);
  })

Java

try {
  Template template = FirebaseRemoteConfig.getInstance().rollbackAsync(versionNumber).get();
  System.out.println("Successfully rolled back to template version: " + versionNumber);
  System.out.println("New ETag: " + template.getETag());
} catch (ExecutionException e) {
  if (e.getCause() instanceof FirebaseRemoteConfigException) {
    FirebaseRemoteConfigException rcError = (FirebaseRemoteConfigException) e.getCause();
    System.out.println("Error trying to rollback template.");
    System.out.println(rcError.getMessage());
  }
}

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

Để quay lại mẫu Remote Config đã lưu trữ, hãy đưa ra một yêu cầu POST HTTP bằng phương thức tuỳ chỉnh :rollback và trong phần nội dung yêu cầu, phiên bản cụ thể cần áp dụng. Ví dụ:

curl --compressed -D headers -H "Authorization: Bearer <var>token</var>" -H "Content-Type: application/json" -X POST https://firebaseremoteconfig.googleapis.com/v1/projects/<var>my-project-id</var>/remoteConfig:rollback -d '{"version_number": 6}'

Phản hồi chứa nội dung của mẫu được lưu trữ hiện đang hoạt động, cùng với siêu dữ liệu phiên bản mới.

Xin lưu ý rằng thao tác khôi phục này sẽ tạo một phiên bản được đánh số mới một cách hiệu quả. Ví dụ: việc quay lại từ phiên bản 10 về phiên bản 6 sẽ tạo một bản sao mới của phiên bản 6, chỉ khác với phiên bản gốc ở chỗ số phiên bản là 11. Phiên bản gốc 6 vẫn được lưu trữ, giả sử phiên bản này chưa hết hạn và phiên bản 11 trở thành mẫu đang hoạt động.

Xoá mẫu Remote Config

Bạn có thể xoá các mẫu Remote Config khỏi bảng điều khiển Firebase. Cách xoá mẫu Remote Config:

1. Trên trang Remote Config Parameters (Thông số), hãy nhấp vào biểu tượng Change history (Nhật ký thay đổi).

Chuyển đến mẫu bạn muốn xoá, nhấp vào biểu tượng Tuỳ chọn khác, rồi chọn Xoá.
Khi được nhắc xác nhận xoá, hãy nhấp vào Xoá.

Tải xuống và phát hành mẫu Remote Config

Tải xuống và phát hành các mẫu Remote Config để tích hợp các mẫu đó vào hệ thống kiểm soát nguồn và xây dựng, tự động hoá việc cập nhật cấu hình, đồng bộ hoá các thông số và giá trị trên nhiều dự án.

Bạn có thể tải mẫu Remote Config hiện đang hoạt động xuống bằng cách lập trìnhtừ bảng điều khiển Firebase. Sau đó, bạn có thể cập nhật tệp JSON đã xuất và phát hành tệp đó cho cùng một dự án hoặc phát hành tệp đó cho một dự án mới hoặc hiện có.

Giả sử bạn có nhiều dự án đại diện cho các giai đoạn khác nhau trong vòng đời phát triển phần mềm, chẳng hạn như môi trường phát triển, kiểm thử, thử nghiệm và phát hành công khai. Trong trường hợp này, bạn có thể quảng bá một mẫu đã được kiểm thử đầy đủ từ môi trường thử nghiệm sang môi trường phát hành công khai bằng cách tải mẫu đó xuống từ dự án thử nghiệm và phát hành mẫu đó sang dự án phát hành công khai.

Bạn cũng có thể sử dụng phương thức này để di chuyển cấu hình từ dự án này sang dự án khác hoặc điền các tham số và giá trị từ một dự án đã thiết lập vào dự án mới.

Các thông số và giá trị thông số được tạo riêng dưới dạng biến thể trong thử nghiệm A/B Testing sẽ không có trong mẫu đã xuất.

Cách xuất và nhập mẫu Remote Config:

Tải mẫu Cấu hình Remote Config hiện tại xuống.
Xác thực mẫu Remote Config.
Xuất bản mẫu Remote Config.

Tải Mẫu cấu hình từ xa hiện tại xuống

Hãy sử dụng mã sau để tải mẫu Remote Config đang hoạt động xuống ở định dạng JSON:

Bảng điều khiển Firebase

Trên thẻ Remote Config Parameters or Conditions (Thông số hoặc điều kiện Remote Config), hãy mở Menu (Trình đơn) rồi chọn Download current config file (Tải tệp cấu hình hiện tại xuống).
Khi được nhắc, hãy nhấp vào Tải tệp cấu hình xuống, chọn vị trí bạn muốn lưu tệp, sau đó nhấp vào Lưu.

Firebase CLI

firebase remoteconfig:get -o filename

Node.js

function getTemplate() {
  var config = admin.remoteConfig();
  config.getTemplate()
      .then(function (template) {
        console.log('ETag from server: ' + template.etag);
        var templateStr = JSON.stringify(template);
        fs.writeFileSync('config.json', templateStr);
      })
      .catch(function (err) {
        console.error('Unable to get template');
        console.error(err);
      });
}

Java

Template template = FirebaseRemoteConfig.getInstance().getTemplateAsync().get();
// See the ETag of the fetched template.
System.out.println("ETag from server: " + template.getETag());

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 -o filename

Lệnh này xuất tải trọng JSON vào một tệp và tiêu đề (bao gồm cả ETag) vào một tệp headers riêng.

Xác thực mẫu Cấu hình từ xa

Bạn có thể xác thực nội dung cập nhật mẫu trước khi xuất bản bằng cách sử dụng Firebase Admin SDK hoặc API REST. Các mẫu cũng được xác thực khi bạn tìm cách phát hành từ bảng điều khiển Firebase CLI hoặc Firebase.

Quy trình xác thực mẫu sẽ kiểm tra các lỗi như khoá trùng lặp cho tham số và điều kiện, tên điều kiện không hợp lệ hoặc điều kiện không tồn tại hoặc ETag có định dạng không chính xác. Ví dụ: một yêu cầu chứa nhiều hơn số lượng khoá được phép (2000) sẽ trả về thông báo lỗi Param count too large.

Node.js

function validateTemplate(template) {
  admin.remoteConfig().validateTemplate(template)
      .then(function (validatedTemplate) {
        // The template is valid and safe to use.
        console.log('Template was valid and safe to use');
      })
      .catch(function (err) {
        console.error('Template is invalid and cannot be published');
        console.error(err);
      });
}

Java

try {
  Template validatedTemplate = FirebaseRemoteConfig.getInstance()
          .validateTemplateAsync(template).get();
  System.out.println("Template was valid and safe to use");
} catch (ExecutionException e) {
  if (e.getCause() instanceof FirebaseRemoteConfigException) {
    FirebaseRemoteConfigException rcError = (FirebaseRemoteConfigException) e.getCause();
    System.out.println("Template is invalid and cannot be published");
    System.out.println(rcError.getMessage());
  }
}

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

Xác thực nội dung cập nhật mẫu bằng cách thêm tham số URL ?validate_only=true vào yêu cầu phát hành:

curl --compressed -H "Content-Type: application/json; UTF8" -H "If-Match: last-returned-etag" -H "Authorization: Bearer token" -X PUT https://firebaseremoteconfig.googleapis.com/v1/projects/my-project-id/remoteConfig?validate_only=true -d @filename

Nếu mẫu của bạn đã được xác thực thành công, lệnh curl sẽ trả về mẫu JSON mà bạn đã gửi và trong tệp headers đã lưu, bạn sẽ thấy trạng thái HTTP/2 200 và ETag đã cập nhật có hậu tố -0. Nếu mẫu của bạn không được xác thực, bạn sẽ nhận được lỗi xác thực trong phản hồi JSON và tệp headers sẽ chứa phản hồi không phải 200 (và không có ETag).

Xuất bản mẫu Remote Config

Sau khi tải một mẫu xuống, thực hiện mọi thay đổi cần thiết đối với nội dung JSON và xác thực nội dung đó, bạn có thể phát hành mẫu đó cho một dự án.

Việc phát hành mẫu sẽ thay thế toàn bộ mẫu cấu hình hiện có bằng tệp đã cập nhật và tăng phiên bản mẫu thêm một. Vì toàn bộ cấu hình được thay thế, nên nếu bạn xoá một tham số khỏi tệp JSON và phát hành tham số đó, thì tham số đó sẽ bị xoá khỏi máy chủ và không còn được cung cấp cho ứng dụng nữa.

Sau khi phát hành, các thay đổi đối với thông số và giá trị sẽ ngay lập tức có sẵn cho ứng dụng và người dùng. Nếu cần, bạn có thể quay lại phiên bản trước đó.

Sử dụng các lệnh sau để phát hành mẫu:

Bảng điều khiển Firebase

Trên thẻ Remote Config Tham số hoặc điều kiện, hãy mở Trình đơn, rồi chọn Xuất bản từ tệp.
Khi được nhắc, hãy nhấp vào Duyệt qua, chuyển đến và chọn tệp Remote Config mà bạn muốn phát hành, sau đó nhấp vào Chọn.
Tệp sẽ được xác thực và nếu thành công, bạn có thể nhấp vào Xuất bản để cung cấp ngay cấu hình cho ứng dụng và người dùng.

Node.js

function publishTemplate() {
  var config = admin.remoteConfig();
  var template = config.createTemplateFromJSON(
      fs.readFileSync('config.json', 'UTF8'));
  config.publishTemplate(template)
      .then(function (updatedTemplate) {
        console.log('Template has been published');
        console.log('ETag from server: ' + updatedTemplate.etag);
      })
      .catch(function (err) {
        console.error('Unable to publish template.');
        console.error(err);
      });
}

Java

try {
  Template publishedTemplate = FirebaseRemoteConfig.getInstance()
          .publishTemplateAsync(template).get();
  System.out.println("Template has been published");
  // See the ETag of the published template.
  System.out.println("ETag from server: " + publishedTemplate.getETag());
} catch (ExecutionException e) {
  if (e.getCause() instanceof FirebaseRemoteConfigException) {
    FirebaseRemoteConfigException rcError = (FirebaseRemoteConfigException) e.getCause();
    System.out.println("Unable to publish template.");
    System.out.println(rcError.getMessage());
  }
}

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

curl --compressed -H "Content-Type: application/json; UTF8" -H "If-Match: last-returned-etag" -H "Authorization: Bearer token" -X PUT https://firebaseremoteconfig.googleapis.com/v1/projects/my-project-id/remoteConfig -d @filename

Đối với lệnh curl này, bạn có thể chỉ định nội dung bằng cách sử dụng ký tự "@", theo sau là tên tệp.

Các điều kiện và thông tin cá nhân hoá Remote Config được đưa vào các mẫu đã tải xuống. Vì vậy, bạn cần lưu ý những hạn chế sau đây khi cố gắng phát hành cho một dự án khác:

Bạn không thể nhập nội dung cá nhân hoá từ dự án này sang dự án khác.

Ví dụ: nếu đã bật tính năng cá nhân hoá trong dự án, đồng thời tải xuống và chỉnh sửa một mẫu, thì bạn có thể phát hành mẫu đó cho cùng một dự án, nhưng không thể phát hành mẫu đó cho một dự án khác, trừ phi bạn xoá tính năng cá nhân hoá khỏi mẫu.
Bạn có thể nhập các điều kiện từ dự án này sang dự án khác, nhưng lưu ý rằng mọi giá trị có điều kiện cụ thể (chẳng hạn như mã ứng dụng hoặc đối tượng) phải tồn tại trong dự án mục tiêu trước khi phát hành.

Ví dụ: nếu bạn có một tham số Remote Config sử dụng một điều kiện chỉ định giá trị nền tảng là iOS, thì mẫu có thể được phát hành cho một dự án khác, vì giá trị nền tảng giống nhau đối với mọi dự án. Tuy nhiên, nếu chứa một điều kiện dựa trên mã ứng dụng hoặc đối tượng người dùng cụ thể không tồn tại trong dự án mục tiêu, thì quá trình xác thực sẽ không thành công.
Nếu mẫu bạn dự định phát hành chứa các điều kiện dựa trên Google Analytics, thì bạn phải bật Analytics trong dự án mục tiêu.

Tải các mẫu mặc định của Remote Config xuống

Vì ứng dụng của bạn không phải lúc nào cũng kết nối với Internet, nên bạn nên định cấu hình các giá trị mặc định của ứng dụng phía máy khách cho tất cả các tham số Remote Config. Bạn cũng nên định kỳ đồng bộ hoá các giá trị mặc định của ứng dụng và giá trị tham số mặc định của phần phụ trợ Remote Config, vì các giá trị này có thể thay đổi theo thời gian.

Như mô tả trong các đường liên kết dành riêng cho nền tảng ở cuối phần này, bạn có thể đặt các giá trị mặc định này theo cách thủ công trong ứng dụng hoặc bạn có thể đơn giản hoá quy trình này bằng cách tải các tệp chứa chỉ các cặp khoá-giá trị cho tất cả các tham số và giá trị mặc định của các tham số đó trong mẫu Remote Config đang hoạt động. Sau đó, bạn có thể đưa tệp này vào dự án và định cấu hình ứng dụng để nhập các giá trị này.

Bạn có thể tải các tệp này xuống ở định dạng XML cho ứng dụng Android, định dạng danh sách thuộc tính (plist) cho ứng dụng iOS và JSON cho ứng dụng web.

Bạn nên tải các giá trị mặc định của Remote Config xuống định kỳ trước khi phát hành ứng dụng mới để đảm bảo ứng dụng và phần phụ trợ Remote Config luôn đồng bộ.

Cách tải tệp chứa các giá trị mặc định của mẫu xuống:

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=file_format'

Sử dụng XML, PLIST hoặc JSON làm giá trị format, tuỳ thuộc vào định dạng tệp bạn muốn tải xuống.

Bảng điều khiển Firebase

Trong thẻ Parameters (Thông số), hãy mở Menu (Trình đơn) rồi chọn Download default values (Tải giá trị mặc định xuống).
Khi được nhắc, hãy nhấp vào nút chọn tương ứng với định dạng tệp bạn muốn tải xuống, sau đó nhấp vào Tải tệp xuống.

Để biết thêm thông tin về cách nhập giá trị mặc định Remote Config vào ứng dụng, hãy xem: