本頁面由 Cloud Translation API 翻譯而成。

結構化設定

結構化設定允許 C++/Rust 元件，直接在資訊清單。使用結構化設定的好處包括：

系統會在建構和組合時偵測設定錯誤。
你可以使用同一個元件和不同的設定值建立多個套件。
元件會使用靜態類型程式庫讀取設定。
元件架構只會啟動具備有效設定的元件。
您可以在執行階段使用 ffx 工具查看設定。
您可以在執行階段設定值。

如要進一步瞭解結構化設定的實作和行為，請參閱 reference：

如要在元件中使用結構化設定，您必須更新建構規則、宣告結構定義。定義值及產生用戶端程式庫

更新建構規則

如要在產生用戶端程式庫時避免產生循環依附元件，請定義編譯元件資訊清單的 fuchsia_component_manifest 規則。傳遞這個已編譯的資訊清單放入 fuchsia_component 規則中。

fuchsia_component_manifest("manifest") {
  component_name = "config_example"
  manifest = "meta/config_example.cml"
}

fuchsia_component("component") {
  cm_label = ":manifest"
  deps = [ ":bin" ]
}

宣告設定結構定義

您必須在元件的資訊清單中宣告設定結構定義：

{
    ...
    config: {
        greeting: {
            type: "string",
            max_size: 512,
        },
        delay_ms: { type: "uint64" },
    },

}

結構化設定支援下列類型：

bool
uint8、int8
uint16、int16
uint32、int32
uint64、int64
string (需要 max_size 資源)
vector (需要 element 和 max_count 屬性)

如需設定的完整語法，請參閱 CML 參考文件結構定義。

元件擁有設定結構定義後，您必須定義欄位，分別使用軟體組裝或 GN。

僅限 Google 員工：如果元件的設定方式與 eng 和 non-eng 不同建構類型，就必須請先新增結構化設定驗證，再進行結帳。

定義設定值的方法有兩種：在 JSON5 檔案上，或內嵌於 GN 中。

使用軟體組件定義設定值

如果元件設定會因產品而異，請參閱說明文件適用於組合結構化設定。對於具有設定數量之間僅有差異，例如專區。

定義 &使用 GN 的套件設定值

fuchsia_structured_config_values GN 範本會驗證已定義的值比對設定結構定義，並編譯為必須附加的 .cvf 檔案與您的元件一併封裝

有兩種方法可以定義 GN 中的設定值：JSON5 檔案或內嵌項目。

JSON5 檔案

您可以在 JSON5 檔案中寫入元件的設定值。由於 JSON5 是 JSON 的超集合，也可在結構化設定中重複使用現有的 JSON 設定檔。

JSON 物件中的每個鍵都必須對應到結構定義中的設定鍵，而且值必須相容的 JSON 類型：

{
    // Print "Hello, World!" by default.
    greeting: "World",

    // Sleep for only 100ms by default.
    delay_ms: 100,
}

請在 fuchsia_structured_config_values 規則中提供 JSON5 檔案的路徑。

fuchsia_structured_config_values("values_from_json_file") {
  cm_label = ":manifest"
  values_source = "../config_example_default_values.json5"
}

內嵌值

fuchsia_structured_config_values 範本也支援內嵌定義設定值：

C++

declare_args() {
  # Set this in args.gn to override the greeting emitted by this example.
  config_example_cpp_greeting = "World"
}

fuchsia_structured_config_values("values_from_gn") {
  cm_label = ":manifest"
  values = {
    greeting = config_example_cpp_greeting
    delay_ms = 100
  }
}

荒漠油廠

declare_args() {
  # Set this in args.gn to override the greeting emitted by this example.
  config_example_rust_greeting = "World"
}

fuchsia_structured_config_values("values_from_gn") {
  cm_label = ":manifest"
  values = {
    greeting = config_example_rust_greeting
    delay_ms = 100
  }
}

如果使用 declare_args，即可在建構期間變更指令列的設定值：

C++

$ fx set core.x64 \
  --with //examples/components/config \
  --args='config_example_cpp_greeting="C++ CLI Override"'

荒漠油廠

$ fx set core.x64 \
  --with //examples/components/config \
  --args='config_example_rust_greeting="Rust CLI Override"'

將元件和值封裝在一起

如果想將元件和一組值封裝在一起，請新增 fuchsia_component 和 fuchsia_structured_config_values 做為 fuchsia_package 依附元件的依附元件清單

C++

fuchsia_package("cpp_config_example") {
  deps = [
    ":component",
    ":values_from_gn",
  ]
}

荒漠油廠

fuchsia_package("rust_config_example") {
  deps = [
    ":component",
    ":values_from_gn",
  ]
}

建構系統會驗證元件的設定結構定義和值檔案。元件錯誤設定 (例如：欄位不符、錯誤限制、值缺漏) 因此無法建構

檢查設定

元件管理員會在元件解析後驗證元件設定。

使用 ffx component show 輸出元件設定鍵/值組合。元件不需要執行任何動作即可運作

$ ffx component show config_example
                Moniker: /core/ffx-laboratory:config_example
        Component State: Resolved
                      ...
          Configuration: greeting -> "World"
                      ...

CVF 檔案必須與元件的設定結構定義完全相符。含有部分或系統無法解析部分設定，因此不會啟動。

讀取設定

元件會使用產生的程式庫讀取其已解析的設定值。產生程式庫使用下列建構範本：

C++

executable("bin") {
  # ...
  deps = [
    ":example_config",

    # ...
  ]
}

fuchsia_structured_config_cpp_elf_lib("example_config") {
  cm_label = ":manifest"
}

荒漠油廠

rustc_binary("bin") {
  edition = "2021"

  # ...
  deps = [
    ":example_config",

    # ...
  ]
}

fuchsia_structured_config_rust_lib("example_config") {
  cm_label = ":manifest"
}

使用程式庫中的下列函式讀取設定值：

C++

// Import the header as if it's located in the same directory as BUILD.gn:
#include "examples/components/config/cpp/example_config.h"

...

// Retrieve configuration
auto c = example_config::Config::TakeFromStartupHandle();

荒漠油廠

use example_config::Config;

...

// Retrieve configuration
let config = Config::take_from_startup_handle();

匯出設定以進行檢查

您可以匯出元件設定進行檢查，以便在當機報告用戶端程式庫可以使用函式，將元件設定匯出到檢查樹狀結構：

C++

// Record configuration to inspect
inspect::ComponentInspector inspector(loop.dispatcher(), inspect::PublishOptions{});
inspect::Node config_node = inspector.root().CreateChild("config");
c.RecordInspect(&config_node);

荒漠油廠

// Record configuration to inspect
let inspector = fuchsia_inspect::component::inspector();
inspector.root().record_child("config", |config_node| config.record_inspect(config_node));

使用 ffx inspect show 列印元件的匯出設定：

$ ffx inspect show core/ffx-laboratory\*config_example
core/ffx-laboratory\:config_example:
  ...
  payload:
    root:
      config:
        greeting = World

元件外部的執行階段值

根據預設，元件只會接收來自解析器傳回的 .cvf 檔案，通常來自他們的套件。於如要將這些值替換為其他元件，其必須具有 mutability 屬性，即可選擇採用特定變異來源：

    config: {
        greeting: {
            // ...
            mutability: [ /* ... */ ],
        },
    },

提供來自父項元件的值

父項元件可針對集合中啟動的子項提供值子女已選擇接收。

首先，子項必須在適當的mutability 設定欄位：

{
    ...
    config: {
        greeting: {
            type: "string",
            max_size: 512,
            mutability: [ "parent" ],
        },
    },

}

使用 Realm 通訊協定啟動子項時，將設定值做為覆寫值：

C++

fuchsia_component_decl::Child child_decl;
child_decl.name(child_name);
child_decl.url(kChildUrl);
child_decl.startup(fuchsia_component_decl::StartupMode::kLazy);

fuchsia_component_decl::ConfigOverride greeting_override;
greeting_override.key("greeting");
greeting_override.value(fuchsia_component_decl::ConfigValue::WithSingle(
    fuchsia_component_decl::ConfigSingleValue::WithString(expected_greeting)));
child_decl.config_overrides({{greeting_override}});

fuchsia_component_decl::CollectionRef collection;
collection.name(kCollectionName);

fuchsia_component::CreateChildArgs child_args;

realm->CreateChild({collection, child_decl, std::move(child_args)})
    .ThenExactlyOnce([this](fidl::Result<fuchsia_component::Realm::CreateChild>& result) {
      if (!result.is_ok()) {
        FX_LOGS(ERROR) << "CreateChild failed: " << result.error_value();
        ZX_PANIC("%s", result.error_value().FormatDescription().c_str());
      }
      QuitLoop();
    });
RunLoop();

荒漠油廠

let child_decl = Child {
    name: Some(child_name.to_string()),
    url: Some(String::from(CHILD_URL)),
    startup: Some(StartupMode::Lazy),
    config_overrides: Some(vec![ConfigOverride {
        key: Some("greeting".to_string()),
        value: Some(ConfigValue::Single(ConfigSingleValue::String(
            expected_greeting.to_string(),
        ))),
        ..ConfigOverride::default()
    }]),
    ..Child::default()
};

let collection_ref = CollectionRef { name: COLLECTION_NAME.to_string() };
realm
    .create_child(&collection_ref, &child_decl, CreateChildArgs::default())
    .await
    .context("sending create child message")?
    .map_err(|e| anyhow::format_err!("creating child: {e:?}"))?;

詳情請參閱完整範例。

透過 `ffx component` 提供值

使用 ffx component create 建立元件或使用 ffx component run，您就能像處理事件一樣覆寫設定值做為父項元件

如果執行上述設定範例而沒有任何覆寫，就會看到並在記錄中輸出預設設定：

$ ffx component run /core/ffx-laboratory:hello-default-value fuchsia-pkg://fuchsia.com/rust_config_from_parent_example#meta/config_example.cm --follow-logs
...
[02655.273631][ffx-laboratory:hello-default-value] INFO: Hello, World! (from Rust)

傳遞 --config 即可覆寫這個問候語：

$ ffx component run /core/ffx-laboratory:hello-from-parent fuchsia-pkg://fuchsia.com/rust_config_from_parent_example#meta/config_example.cm --config 'greeting="parent component"' --follow-logs
...
[02622.752978][ffx-laboratory:hello-from-parent] INFO: Hello, parent component! (from Rust)`

每個設定欄位都會指定為 KEY=VALUE，其中 KEY 必須是欄位加入元件設定結構定義中，其中包含 mutability: [ "parent" ] 和 VALUE 是可以剖析為符合欄位類型的 JSON 字串。

使用 Realm Builder 進行測試

您可以使用 Realm Builder，以動態方式取代儲存元件，而無論設定欄位的 mutability 為何。

TODO(https://fxbug.dev/42053123) 新增包含與子封裝元件搭配使用的章節。

C++

realm_builder.SetConfigValue(child_name, "greeting", "Fuchsia");

荒漠油廠

builder.set_config_value(&config_component, "greeting", "Fuchsia".into()).await.unwrap();

Realm Builder 會根據元件的設定結構定義，驗證所取代的值。

以動態方式設定值時，Realm Builder 會要求使用者選擇是否是否要針對啟動的元件載入封裝設定值

如要在程式碼中提供部分值時，載入元件的封裝值：

C++

realm_builder.InitMutableConfigFromPackage(child_name);

荒漠油廠

builder.init_mutable_config_from_package(&config_component).await.unwrap();

如何在程式碼中設定元件的所有值，而不使用套件值：

C++

realm_builder.InitMutableConfigToEmpty(child_name);

荒漠油廠

builder.init_mutable_config_to_empty(&config_component).await.unwrap();

結構化設定

更新建構規則

宣告設定結構定義

使用軟體組件定義設定值

定義 &使用 GN 的套件設定值

JSON5 檔案

內嵌值

C++

荒漠油廠

C++

荒漠油廠

將元件和值封裝在一起

C++

荒漠油廠

檢查設定

讀取設定

C++

荒漠油廠

C++

荒漠油廠

匯出設定以進行檢查

C++

荒漠油廠

元件外部的執行階段值

提供來自父項元件的值

C++

荒漠油廠

透過 ffx component 提供值

使用 Realm Builder 進行測試

C++

荒漠油廠

C++

荒漠油廠

C++

荒漠油廠

透過 `ffx component` 提供值