術語
範圍
本文件說明如何定義索引,將例項 ID 對應至 和 monikers這種對應適用於使用獨立儲存空間的元件 即便沒有技術背景,也能因這些工具的功能而受益
總覽
元件執行個體 ID 的索引是指派固定 ID 元件執行個體方法是將執行個體 ID 對應至路徑名稱。 為元件執行個體指派 ID 時,其永久資源會 透過這個執行個體 ID 識別磁碟允許元件的網址或 領域一旦遭到變更,其資源仍會留存在與之前 因為這個索引會一併更新
當元件執行階段發現執行個體 ID 時 ->進行路徑名稱對應 自動將元件執行個體的現有儲存空間目錄 並位於其執行個體 ID 下
只有使用儲存空間功能的元件必須包含 索引。測試元件不應納入索引。
定義新索引
索引檔案是 JSON5 格式的檔案,可將元件的執行個體 ID 對應至 研究結果建構樹狀結構中可能會有多個索引檔案,不過 就會合併為單一索引檔案,而這個合併檔案後 提供給元件執行階段這個合併的索引檔案無法變更,且 只能透過其他系統更新進行更新。
以下範例說明索引檔案的結構定義:
// 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
索引檔
將項目新增至索引
第一步是決定元件執行個體的路徑名稱。您可以在
執行 ffx component show
,路徑名稱在特定產品 eng 版本中運作元件。
接著,使用元件的攔截器,將項目附加至 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
欄位,即可更新新增的項目。
在系統組合中加入元件 ID 索引
這個部分的目標對象,就是要設定 系統組合
本節說明如何在系統中加入元件 ID 索引
如果系統組件包含元件,則應納入元件 ID 索引
因此會使用獨立儲存空間以core
為基礎建構的任何產品
產品的組合中已經包含元件 ID 索引,因此
可能不需要提供操作說明。
系統版本中的所有 component_id_index()
都會使用
component_id_index_config()
範本。這個範本目前用於
assembled_system.gni
,如果自行定義組合就會失敗
是來自「assembled_system.gni
」的新聞
操作步驟
- 定義您想要納入系統的任何
component_id_index()
。 - 將這些目標新增為
assembled_system()
中的base_packages
依附元件 目標。