Join us in person and online for Firebase Summit on October 18, 2022. Learn how Firebase can help you accelerate app development, release your app with confidence, and scale with ease. Register now

Mẫu cấu hình từ xa và tạo phiên bản

Sử dụng bộ sưu tập để sắp xếp ngăn nắp các trang Lưu và phân loại nội dung dựa trên lựa chọn ưu tiên của bạn.

Mẫu Cấu hình từ xa là tập hợp các thông số và điều kiện được định dạng JSON phía máy chủ mà bạn đã tạo cho dự án Firebase của mình. Bạn có thể sửa đổi và quản lý mẫu bằng cách sử dụ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 đồ họa trong các tab Tham sốĐiều kiện . Bạn cũng có thể sử dụng các API phụ trợ Cấu hình từ xa hoặc Firebase CLI để sửa đổi và quản lý cấu hình của mình.

Đây là một ví dụ về tệp mẫu:

  {
    "conditions": [
      {
        "name": "ios",
        "expression": "device.os == 'ios'"
      }
    ],
    "parameters": {
      "welcome_message": {
        "defaultValue": {
          "value": "Welcome to this sample app"
        },
        "conditionalValues": {
          "ios": {
            "value": "Welcome to this sample iOS app"
          }
        }
      },
      "welcome_message_caps": {
        "defaultValue": {
          "value": "false"
        }
      },
      "header_text": {
        "defaultValue": {
          "useInAppDefault": true
        }
      }
    },
    "version": {
      "versionNumber": "28",
      "updateTime": "2020-05-14T18:39:38.994Z",
      "updateUser": {
        "email": "user@google.com"
      },
      "updateOrigin": "CONSOLE",
      "updateType": "INCREMENTAL_UPDATE"
    }
  }

Mỗi khi bạn cập nhật các tham số, Cấu hình từ xa sẽ tạo một mẫu Cấu hình từ xa được tạo phiên bản mới và lưu trữ mẫu trước đó dưới dạng phiên bản mà bạn có thể truy xuất hoặc khôi phục lại nếu cần. Số phiên bản được tăng tuần tự từ giá trị ban đầu được lưu trữ bởi Cấu hình từ xa. Tất cả các mẫu đều bao gồm trường version như được hiển thị, chứa siêu dữ liệu về phiên bản cụ thể đó.

Với bảng điều khiển Firebase, Firebase CLI hoặc API phụ trợ Cấu hình từ xa, bạn có thể thực hiện các tác vụ quản lý phiên bản sau:

  • Liệt kê tất cả các phiên bản mẫu được lưu trữ
  • Truy xuất một phiên bản cụ thể
  • Quay lại một phiên bản cụ thể

Khi bạn quản lý các mẫu Cấu hình từ xa, hãy lưu ý đến ngưỡng hết hạn: Mẫu Cấu hình từ xa hiện hoạt đang được ứng dụng của bạn sử dụng không hết hạn; tuy nhiên, nếu nó được thay thế bằng một bản cập nhật, thì phiên bản trước đó sẽ chỉ được lưu trữ trong 90 ngày, sau đó nó sẽ hết hạn và không thể lấy lại được. Ngoài ra còn có tổng giới hạn là 300 phiên bản được lưu trữ. Nếu bạn muốn lưu trữ hoặc quay trở lại mẫu nằm ngoài các giới hạn đó, hãy lưu và lưu trữ mẫu theo cách thủ công.

Quản lý phiên bản mẫu cấu hình từ xa

Phần này mô tả cách quản lý các phiên bản của mẫu Cấu hình từ xa của bạn. Để biết thêm chi tiết về cách tạo, sửa đổi và lưu mẫu theo chương trình, hãy xem Sửa đổi cấu hình từ xa theo lập trình .

Liệt kê tất cả các phiên bản được lưu trữ của mẫu Cấu hình Từ xa

Bạn có thể truy xuất danh sách tất cả các phiên bản được lưu trữ của mẫu Cấu hình Từ xa. Ví dụ:

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

LÊN ĐỈNH

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

Bảng điều khiển Firebase

Trong tab Tham số , chọn biểu tượng "đồng hồ" được hiển thị ở trên cùng bên phải. Thao tác này sẽ mở trang Lịch sử thay đổi liệt kê tất cả các phiên bản mẫu được lưu trữ trong menu danh sách ở bên phải.

Thông tin chi tiết được hiển thị cho từng phiên bản được lưu trữ bao gồm thông tin về việc liệu các thay đổi bắt nguồn từ Bảng điều khiển, với API REST, từ quá trình khôi phục hay liệu chúng là các thay đổi gia tăng từ việc bắt buộc lưu mẫu.

Firebase CLI

firebase remoteconfig:versions:list

Sử dụng tùy chọn --limit để giới hạn số lượng phiên bản được trả lại. Vượt qua '0' để tìm nạp tất cả các phiên bản.

Danh sách các mẫu bao gồm siêu dữ liệu cho tất cả các phiên bản được lưu trữ, bao gồm thời gian cập nhật, người dùng đã thực hiện và liệu nó được tạo thông qua bảng điều khiển hay API REST. Đây là một ví dụ về phần tử phiên bản:

{
  "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 phiên bản cụ thể của mẫu Cấu hình từ xa

Bạn có thể truy xuất bất kỳ phiên bản lưu trữ cụ thể nào của mẫu Cấu hình Từ xa. Ví dụ:

Node.js

getTemplate() mà không có bất kỳ đố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());

LÊN ĐỈNH

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 hoạt động GET ; bạn không thể sử dụng nó để chỉ định số phiên bản cho các bản cập nhật. Một yêu cầu nhận tương tự không có tham số ?version_number sẽ truy xuất mẫu đang hoạt động hiện tại.

Bảng điều khiển Firebase

Theo mặc định, ngăn chi tiết trong tab Lịch sử thay đổi hiển thị mẫu đang hoạt động hiện tại. Để xem chi tiết cho một phiên bản khác trong danh sách, hãy chọn nó từ menu bên phải.

Bạn có thể xem sự khác biệt chi tiết của phiên bản hiện được chọn và bất kỳ phiên bản được lưu trữ nào khác bằng cách di chuột qua menu ngữ cảnh cho bất kỳ phiên bản không được chọn nào và chọn So sánh với phiên bản đã chọn.

Firebase CLI

firebase remoteconfig:get -v VERSION_NUMBER

Theo tùy chọn, bạn có thể ghi đầu ra vào một tệp được chỉ định với -o, FILENAME .

Quay lại phiên bản được lưu trữ cụ thể của mẫu Cấu hình từ xa

Bạn có thể quay trở lại bất kỳ phiên bản lưu trữ nào của mẫu. Ví dụ:

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

LÊN ĐỈNH

Để quay trở lại mẫu Cấu hình từ xa được lưu trữ, hãy phát hành HTTP POST với phương thức tùy chỉnh :rollback và trong phần nội dung yêu cầu, phiên bản cụ thể để á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, với siêu dữ liệu phiên bản mới của nó.

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 tùy chọn để quay lại phiên bản đó được hiển thị ở trên cùng bên phải của trang Lịch sử thay đổi . Nhấp và xác nhận điều này chỉ khi bạn chắc chắn muốn quay trở lại phiên bản đó và sử dụng các giá trị đó ngay lập tức cho tất cả các ứng dụng và người dùng.

Firebase CLI

firebase remoteconfig:rollback -v VERSION_NUMBER

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

Tải xuống và xuất bản các mẫu Cấu hình từ xa

Tải xuống và xuất bản các mẫu Cấu hình từ xa để tích hợp chúng vào hệ thống xây dựng và kiểm soát nguồn của bạn, tự động hóa cập nhật cấu hình, đồng thời giữ các thông số và giá trị đồng bộ trên nhiều dự án.

Bạn có thể tải xuống mẫu Cấu hình từ xa hiện đang hoạt động theo chương trình hoặc từ bảng điều khiển Firebase. Sau đó, bạn có thể cập nhật tệp JSON đã xuất và xuất bản nó lên cùng một dự án hoặc xuất bản nó lên 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 của mình, chẳng hạn như môi trường phát triển, thử nghiệm, dàn dựng và sản xuất. Trong trường hợp này, bạn có thể quảng bá một mẫu đã được kiểm tra đầy đủ từ môi trường dàn dựng sang môi trường sản xuất của mình bằng cách tải xuống mẫu từ dự án dàn dựng của bạn và xuất bản nó lên dự án sản xuất của bạn.

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

Các tham số và giá trị tham số được tạo cụ thể dưới dạng các biến thể trong thử nghiệm Thử nghiệm A / B không được bao gồm trong các mẫu đã xuất.

Để xuất và nhập các mẫu Cấu hình từ xa:

  1. Tải xuống mẫu Cấu hình cấu hình từ xa hiện tại .
  2. Xác thực mẫu Cấu hình từ xa .
  3. Xuất bản mẫu cấu hình từ xa .

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

Bạn có thể tải xuống mẫu Cấu hình từ xa hiện tại và đang hoạt động theo lập trình hoặc sử dụng bảng điều khiển Firebase.

Sử dụng các lệnh sau để tải xuống mẫu Cấu hình từ xa đang hoạt động ở định dạng JSON:

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

LÊN ĐỈNH

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à các tiêu đề (bao gồm cả ETag) vào một tệp headers riêng biệt.

Bảng điều khiển Firebase

  1. Từ tab Điều kiện hoặc Tham số Cấu hình Từ xa, mở Menu và chọn Tải xuống tệp cấu hình hiện tại .
  2. Khi được nhắc, hãy bấm Tải xuống tệp cấu hình , chọn vị trí bạn muốn lưu tệp, sau đó bấm Lưu .

Firebase CLI

firebase remoteconfig:get -o filename

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

Bạn có thể xác thực các bản cập nhật mẫu của mình trước khi xuất bản bằng cách sử dụng SDK quản trị Firebase hoặc API REST. Các mẫu cũng được xác thực khi bạn cố gắng xuất bản từ bảng điều khiển Firebase CLI hoặc Firebase.

Quy trình xác thực mẫu kiểm tra các lỗi như các khóa trùng lặp cho các 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 thẻ ETag bị định dạng sai. Ví dụ: một yêu cầu chứa nhiều hơn số khóa cho phép — 2000 — sẽ trả về thông báo lỗi, số lượng tham 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());
  }
}

LÊN ĐỈNH

Xác thực các bản cập nhật mẫu bằng cách thêm thông số URL ?validate_only=true vào yêu cầu xuất bản của bạn:

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ẽ tìm thấy trạng thái HTTP / 2 200 và một ETag cập nhật có hậu tố -0 . Nếu mẫu của bạn chưa đượ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 của bạn sẽ chứa phản hồi không phải 200 (và không có ETag).

Xuất bản mẫu cấu hình từ xa

Sau khi tải xuống một mẫu, thực hiện bất kỳ thay đổi cần thiết nào đối với nội dung JSON và xác thực nó, bạn có thể xuất bản nó lên một dự án.

Việc xuất bản một 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 lên từng cái một. Vì toàn bộ cấu hình được thay thế, nếu bạn xóa một tham số khỏi tệp JSON và xuất bản nó, thì tham số đó sẽ bị xóa khỏi máy chủ và không còn khả dụng cho các máy khách.

Sau khi xuất bản, các thay đổi đối với thông số và giá trị có sẵn ngay lập tức cho ứng dụng và người dùng của bạn. 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 để xuất bản mẫu của bạn:

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

LÊN ĐỈ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 -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.

Bảng điều khiển Firebase

  1. Từ tab Điều kiện hoặc Tham số Cấu hình Từ xa, mở Menu và chọn Xuất bản từ tệp .
  2. Khi được nhắc, hãy nhấp vào Duyệt , điều hướng đến và chọn tệp Cấu hình từ xa bạn muốn xuất bản, sau đó nhấp vào Chọn .
  3. 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 cấu hình ngay lập tức cho ứng dụng và người dùng của bạn.

Các điều kiện và cá nhân hóa Cấu hình từ xa được bao gồm trong các mẫu đã tải xuống, vì vậy, điều quan trọng là phải biết các giới hạn sau khi cố gắng xuất bản lên một dự án khác:

  • Cá nhân hóa không thể được nhập từ dự án này sang dự án khác.

    Ví dụ: nếu bạn đã bật tính năng cá nhân hóa trong dự án của mình và tải xuống và chỉnh sửa một mẫu, bạn có thể xuất bản nó lên cùng một dự án, nhưng bạn không thể xuất bản nó lên một dự án khác trừ khi bạn xóa các cá nhân hóa khỏi mẫu.

  • Điều kiện có thể được nhập từ dự án này sang dự án khác, nhưng lưu ý rằng bất kỳ giá trị điều kiện cụ thể nào (như ID ứng dụng hoặc đối tượng), phải tồn tại trong dự án mục tiêu trước khi xuất bản.

    Ví dụ: nếu bạn có tham số Cấu hình từ xa sử dụng điều kiện chỉ định giá trị nền tảng của iOS , thì mẫu có thể được xuất bản cho một dự án khác, vì các giá trị nền tảng đều giống nhau đối với bất kỳ dự án nào. Tuy nhiên, nếu nó chứa một điều kiện dựa trên một ID ứng dụng cụ thể hoặc đối tượng người dùng không tồn tại trong dự án mục tiêu, thì việc xác thực sẽ không thành công.

  • Nếu mẫu bạn định xuất bản chứa các điều kiện dựa vào Google Analytics, thì Analytics phải được bật trong dự án mục tiêu.

Tải xuống mặc định mẫu Cấu hình từ xa

Vì ứng dụng của bạn có thể không phải lúc nào cũng được kết nối với Internet, 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 thông số Cấu hình từ xa. Bạn cũng nên đồng bộ hóa định kỳ các giá trị mặc định của ứng dụng khách và giá trị tham số mặc định của phần phụ trợ Cấu hình từ xa, vì chúng có thể thay đổi theo thời gian.

Như được mô tả trong các 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 của mình hoặc bạn có thể hợp lý hóa quy trình này bằng cách tải xuống các tệp chỉ chứa các cặp khóa-giá trị cho tất cả các thông số và giá trị mặc định của chúng trong mẫu cấu hình từ xa đang hoạt động. Sau đó, bạn có thể đưa tệp này vào dự án của mình và định cấu hình ứng dụng của bạn để nhập các giá trị này.

Bạn có thể tải xuống các tệp này ở đị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.

Chúng tôi khuyên bạn nên tải xuống định kỳ các mặc định của Cấu hình từ xa trước khi có bất kỳ bản phát hành ứng dụng mới nào để đảm bảo rằng ứng dụng của bạn và phần phụ trợ Cấu hình từ xa luôn đồng bộ hóa.

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

LÊN ĐỈNH

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 , tùy thuộc vào định dạng tệp bạn muốn tải xuống.

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ấm vào nút radio tương ứng với định dạng tệp bạn muốn tải xuống, sau đó bấm Tải xuống tệp .

Để biết thêm thông tin về cách nhập các giá trị mặc định của Cấu hình từ xa vào ứng dụng của bạn, hãy xem: