Remote Config 模板和版本控制

Firebase 控制台

在参数标签页中，选择右上角显示的时钟图标。���会������更改历史记录页面，���侧的列表菜单中会列出存储的所有模板版本。

为存储的每个版本显示的详细信息都包含更改来源的相关信息（源自控制台、REST API、回滚，还是来自强制保存模板的增量更改）。

Firebase CLI

firebase remoteconfig:versions:list

使用 --limit 选项可限制返回的版本数。传递“0”可获取所有版本。

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

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

Firebase 控制台

默认情况下，更改历史记录标签页中的“详细信息”窗格会显示当前活跃模板。如需查看列表中其他版本的详细信息，请从右侧菜单中将其选中。

您可以将鼠标悬停在任一未选版本的上下文菜单上并选择与选定版本进行比较，来查看当前所选版本与任何其他已存储版本之间的详细差异。

Firebase CLI

firebase remoteconfig:get -v VERSION_NUMBER

您可以选择使用 -o, FILENAME 将输出写入指定文件。

Node.js

传递不带任何参数的 getTemplate() 可检索最新版本的模板。如需检索特定版本，请使用 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());

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

网址参数 ?version_number 仅对 GET 操作有效；您不能使用它为更新内容指定版本号。类似的 get 请求（但不包含 ?version_number 参数）会检索当前有效的模板。

Firebase 控制台

对于支持回滚的先前模板版本，更改历史记录页面右上角会显示一个用于回滚到该版本的选项按钮。仅当您确认要回滚到该版本并立即为所有应用和用户使用这些值时，才能点击确认。

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

REST

要回滚到已存储的 Remote Config 模板，请使用自定义方法 :rollback 发出一个 HTTP POST 请求，并在请求正文中指明要应用的具体版本。例如：

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}'

结果会包含当前活跃的已存储模板的内容，及其新版本的元数据。

Firebase 控制台

1. 在 Remote Config 的“参数”或“条件”标签页中，打开 more_vert 菜单，然后选择下载当前配置文件。
2. 出现提示时，点击下载配置文件，选择保存该文件的位置，然后点击保存。

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

REST

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

此命令会将 JSON 载荷输出到一个文件中，并将标头（包括 ETag）输出到一个单独的 headers 文件中。

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

REST

将网址参数 ?validate_only=true 附加到您的发布请求，以验证模板更新：

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

如果您的模板已成功通过验证，curl 命令将返回您提交的 JSON 模板，并且在保存的 headers 文件中，您会看到一个 HTTP/2 状态 200 以及一个已更新的 ETag（带有 -0 后缀）。如果您的模板未通过验证，您将会在 JSON 响应中收到验证错误，并且您的 headers 文件将包含非 200 响应（且没有 ETag）。

Firebase 控制台

1. 在 Remote Config 的“参数”或“条件”标签页中，打开 more_vert 菜单，然后选择通过文件发布。
2. 出现提示时，点击浏览，找到并选择要发布的 Remote Config 文件，然后点击选择。
3. 系统会验证该文件，如果成功通过验证，您可以点击发布，立即将相应配置提供给您的应用和用户。

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

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

对于 curl 命令，您可以使用“@”字符后跟文件名来指定相应的内容。

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'

根据您要下载的文件格式，使用 XML、PLIST 或 JSON 作为 format 值。

Firebase 控制台

1. 在参数标签页中，打开more_vert菜单，然后选择下载默认值。
2. 收到提示时，点击与您要下载的文件格式对应的单选按钮，然后点击下载文件。