此页面由 Cloud Translation API 翻译。

组件 ID 索引

术语

范围

本文档介绍了如何定义将实例 ID 映射到名称。此映射对于使用隔离存储的组件很重要功能。

概览

组件实例 ID 索引的目标是分配稳定的标识符组件实例。这是通过将实例 ID 映射到名称来实现的。为组件实例分配 ID 后，其永久性资源使用此实例 ID 在磁盘上进行标识。这样，组件的网址或但其资源仍归属于该域，因为此索引也会更新。

当组件运行时发现实例 ID ->名称映射自动将组件实例的现有存储目录移至键控于其实例 ID 下。

只有使用存储功能的组件必须包括在索引中。测试组件不应包含在索引中。

定义新索引

索引文件是 JSON5 格式的文件，将组件的实例 ID 映射到其名称build 树中可能有多个索引文件，但它们合并为一个索引文件对组件运行时可用这个合并的索引文件不可变，并且只能通过其他系统更新进行更新。

以下示例介绍了索引文件的架构：

// Index files are written in JSON5, so you may use comments!
{
  // A list of entries, where each entry maps an instance ID to a moniker.
  instances: [
    // An entry, mapping an instance ID to a moniker.
    {
      // Instance IDs are randomly generated, 256-bits of base-16 encoded
      // strings (in lower case). To generate a new instance ID, set this to
      // an empty string (or other invalid value) and run the build; the build
      // will fail and suggest a new instance ID which you can copy-paste here.
      instance_id: "2bd6cc2bd10243354b873a4ddb8a188b1d29171e26eebac06567bcdc36614af6",
      // The `instance_id` above is associated to the following moniker:
      moniker: "/core/account/credential_manager",
    },

    // More than one entry can be included. However, all entries must be distinct:
    // * Two entries cannot reference the same `instance_id`
    // * Two entries cannot reference the same `moniker`
    {
      instance_id: "7db7e88479772e241229682b47f1794e12ac5d692f8d67421acd9d7ff318a975",
      moniker: "/core/account/password_authenticator",
    }
  ]
}

如需为构建提供索引文件，请使用 component_id_index() GN 模板：

component_id_index("my_component_id_index") {
  source = "my_component_id_index.json5"
}

向索引添加组成部分

找到相应的索引文件

要向索引中添加组件，必须在适当的索引文件。目前，fuchsia.git 的组件列在 core_component_id_index.json5 索引文件。

向索引中添加条目

第一步是确定组件实例的名称。您可以特定产品的 eng build 中组件的名称（通过运行 ffx component show）。

然后，向 instances 列表附加一个包含组件名称的条目。将 instance_id 字段设置为无效值（例如，空字符串），以获取构建失败，并建议一个您可以使用的新代码。

示例

在本示例中，组件将 fuchsia-pkg://example.com/my_other_package#meta/my_other_component.cm 添加到索引中。

要确定组件实例的名称，您可以运行 ffx component show fuchsia-pkg://example.com/my_other_package#meta/my_other_component.cm:

$ ffx component show fuchsia-pkg://example.com/my_other_package#meta/my_other_component.cm
               Moniker:  /core/my_other_component
                   URL:  fuchsia-pkg://example.com/my_other_package#meta/my_other_component.cm
                      ...

上面的输出显示此实例的别名为 /core/my_other_component

将此条目附加到 /core/my_other_component，以将其添加到索引中 core_component_id_index.json5's instances 列表包含无效的空 instance_id：

  {
    instance_id: "",
    moniker: "/core/my_other_component"
  }

现在运行构建。构建将失败，并建议应用新的实例 ID：

$ fx build
.
.
Product Assembly Failed
    ...
    4.  parsing obj/bundles/assembly/resources/core_component_id_index.json5
    5.  Invalid instance ID: invalid length; must be 64 characters

Here is a valid, randomly generated ID: 4251833a8d2e47b473732a23de84437e0b346a151ec1e7bdfd43b91e02f894a7

复制建议的 instance_id 字段，更新您添加的条目。通过 build 现在应该会通过。

在系统组件中添加组件 ID 索引

此部分的目标受众是设置系统组装

本部分介绍如何在系统中添加组件 ID 索引程序集

如果系统组件包含组件，则应包含组件 ID 索引它们使用隔离存储空间任何基于 core 构建的产品产品的组件中已包含组件 ID 索引，因此以下说明可能不需要。

系统 build 中的所有 component_id_index() 均使用 component_id_index_config()模板。此模板目前用于 assembled_system.gni，如果您同时定义自己的属性和属性，则组装将失败来自assembled_system.gni的那封邮件。

步骤

定义您希望包含在系统中的任何 component_id_index()。
将这些目标添加为 assembled_system() 中 base_packages 的依赖项目标。