連結元件

本文說明如何使用父項元件的功能和其他工具，將元件連結在一起，並管理子項。

概念

繼續閱讀本指南之前，請先瞭解下列概念：

元件架構會組裝元件所需的元件宣告，元件向其他人公開的功能會組合成公開目錄。
每個元件都會收到伺服器端控點，該控點屬於名為「outgoing directory」的 Directory 管道。元件的程式會透過這個目錄，讓元件提供的任何功能都能被探索。
在執行時，元件實例樹描述了元件實例之間的父子關係。元件執行個體樹狀結構和該樹狀結構上的能力路徑，統稱為元件拓撲。
父項元件會在元件資訊清單中靜態宣告子元件，或使用元件集合動態宣告子元件。集合是動態子項的容器，可在執行階段使用 fuchsia.component.Realm 架構通訊協定建立及刪除。

如要進一步瞭解這些概念，請參閱「領域」和「功能」一文。

透過轉送功能連結功能

元件會透過功能彼此互動。元件提供的功能必須在該元件的資訊清單中宣告，並透過 expose 和 offer 宣告，路由至父項/子項元件，才能供其他元件使用。使用這項能力的其他元件也需要在資訊清單中宣告使用情況。如要讓程式在執行階段使用這項能力，必須將所用能力路徑導向該元件，也就是從父項提供或由子項公開。

功能路徑是指元件管理員執行的遞迴程序，會按照資訊清單檔案中說明的個別路徑步驟，找出服務元件。在下列情況下，系統會啟動能力轉送：

元件的程式會在 <0x0
元件的程式會在另一個元件的
開發人員會叫用 ffx component route。
啟動依附於解析器或執行器的元件，但該解析器或執行器的支援解析器或執行元件功能尚未完成路徑設定。

系統會延遲執行路由作業：雖然能力可設定為由父項或子項提供 (直接或間接透過進一步委派)，但啟動路由作業時，目標元件可能尚未解析。實際上，這表示在嘗試路由之前，可能無法得知從要求元件到最終服務元件的完整路徑。

提供能力實作方式

提供能力的元件必須在元件資訊清單中，使用 capabilities 宣告能力。

請參閱以下範例，瞭解如何在提供元件的資訊清單中宣告 FIDL通訊協定功能：

{
    include: [
        "inspect/client.shard.cml",
        "syslog/client.shard.cml",
    ],

    // Information about the program to run.
    program: {
        // Use the built-in ELF runner.
        runner: "elf",

        // The binary to run for this component.
        binary: "bin/echo_server_rust",
    },

    // Capabilities provided by this component.
    capabilities: [
        { protocol: "fidl.examples.routing.echo.Echo" },
    ],
    expose: [
        {
            protocol: "fidl.examples.routing.echo.Echo",
            from: "self",
        },
    ],
}

在執行階段，伺服器元件會使用 fuchsia.io 通訊協定，在傳出目錄中提供能力實作。產生的 FIDL 繫結會包裝這個控制代碼，並讓供應商開始接收傳入的要求：

荒漠油廠

// Wrap protocol requests being served.
enum IncomingRequest {
    Echo(EchoRequestStream),
}

#[fuchsia::main(logging = false)]
async fn main() -> Result<(), anyhow::Error> {
    let mut service_fs = ServiceFs::new_local();

    // Initialize inspect
    component::health().set_starting_up();
    let _inspect_server_task = inspect_runtime::publish(
        component::inspector(),
        inspect_runtime::PublishOptions::default(),
    );

    // Serve the Echo protocol
    service_fs.dir("svc").add_fidl_service(IncomingRequest::Echo);
    service_fs.take_and_serve_directory_handle().context("failed to serve outgoing namespace")?;

    // Component is serving and ready to handle incoming requests
    component::health().set_ok();

    // Attach request handler for incoming requests
    service_fs
        .for_each_concurrent(None, |request: IncomingRequest| async move {
            match request {
                IncomingRequest::Echo(stream) => handle_echo_request(stream).await,
            }
        })
        .await;

    Ok(())
}

// Handler for incoming service requests
async fn handle_echo_request(mut stream: EchoRequestStream) {
    while let Some(event) = stream.try_next().await.expect("failed to serve echo service") {
        let EchoRequest::EchoString { value, responder } = event;
        responder.send(value.as_ref().map(|s| &**s)).expect("failed to send echo response");
    }
}

C++

// Handler for incoming service requests
class EchoImplementation : public fidl::Server<fidl_examples_routing_echo::Echo> {
 public:
  void EchoString(EchoStringRequest& request, EchoStringCompleter::Sync& completer) override {
    completer.Reply({{.response = request.value()}});
  }
};

int main(int argc, const char** argv) {
  async::Loop loop(&kAsyncLoopConfigAttachToCurrentThread);
  async_dispatcher_t* dispatcher = loop.dispatcher();

  // Initialize inspect
  inspect::ComponentInspector inspector(loop.dispatcher(), inspect::PublishOptions{});
  inspector.Health().StartingUp();

  component::OutgoingDirectory outgoing_directory = component::OutgoingDirectory(dispatcher);
  zx::result result = outgoing_directory.ServeFromStartupInfo();
  if (result.is_error()) {
    FX_LOGS(ERROR) << "Failed to serve outgoing directory: " << result.status_string();
    return -1;
  }

  result = outgoing_directory.AddUnmanagedProtocol<fidl_examples_routing_echo::Echo>(
      [dispatcher](fidl::ServerEnd<fidl_examples_routing_echo::Echo> server_end) {
        fidl::BindServer(dispatcher, std::move(server_end), std::make_unique<EchoImplementation>());
      });
  if (result.is_error()) {
    FX_LOGS(ERROR) << "Failed to add Echo protocol: " << result.status_string();
    return -1;
  }

  // Component is serving and ready to handle incoming requests
  inspector.Health().Ok();

  return loop.Run();
}

連線至已路由的功能

用戶端元件會在元件資訊清單中，使用 use 宣告可能要求的功能。

請參閱下列用戶端元件資訊清單範例，瞭解如何使用先前元件提供的 FIDL 通訊協定：

{
    include: [
        // Enable logging on stdout
        "syslog/client.shard.cml",
    ],

    // Information about the program to run.
    program: {
        // Use the built-in ELF runner.
        runner: "elf",

        // The binary to run for this component.
        binary: "bin/echo_client_rust",

        // Program arguments
        args: [ "Hello Fuchsia!" ],
    },


    // Capabilities used by this component.
    use: [
        { protocol: "fidl.examples.routing.echo.Echo" },
    ],
}

在執行階段，用戶端元件會使用 fuchsia.io 通訊協定，開啟其命名空間中填入的路徑，以取得其他元件提供的功能。Fuchsia 元件程式庫會搭配產生的 FIDL 繫結，提供結構化介面，以便透過管道進行通訊：

荒漠油廠

#[fuchsia::main]
async fn main() -> Result<(), anyhow::Error> {
    // Parse arguments, removing binary name
    let mut args: Vec<String> = std::env::args().collect();
    args.remove(0);

    // Connect to FIDL protocol
    let echo = connect_to_protocol::<EchoMarker>().expect("error connecting to echo");

    // Send messages over FIDL interface
    for message in args {
        let out = echo.echo_string(Some(&message)).await.expect("echo_string failed");
        log::info!("Server response: {}", out.as_ref().expect("echo_string got empty result"));
    }

    Ok(())
}

C++

int main(int argc, const char* argv[], char* envp[]) {
  // Set tags for logging.
  fuchsia_logging::LogSettingsBuilder builder;
  builder.WithTags({"echo_client"}).BuildAndInitialize();

  // Connect to FIDL protocol
  zx::result client_end = component::Connect<fidl_examples_routing_echo::Echo>();
  if (client_end.is_error()) {
    FX_LOGS(ERROR) << "Failed to connect to Echo protocol: " << client_end.status_string();
    return EXIT_FAILURE;
  }
  fidl::SyncClient client(std::move(client_end.value()));

  // Send messages over FIDL interface for each argument
  fidl::StringPtr response = nullptr;
  for (int i = 1; i < argc; i++) {
    fidl::Result response = client->EchoString({argv[i]});

    if (response.is_error()) {
      FX_LOGS(ERROR) << "echo_string failed: " << response.error_value();
      return EXIT_FAILURE;
    }
    if (!response->response().has_value()) {
      FX_LOGS(ERROR) << "echo_string got empty result";
      return EXIT_FAILURE;
    }
    const std::string& response_value = response->response().value();
    FX_LOG_KV(INFO, "Server response", FX_KV("response", response_value));
  }

  return 0;
}

元件的父項有責任將所有必要功能路徑傳送至元件。

將部分已使用的功能標示為選用

元件不一定需要所有功能才能順利運作。有時即使缺少能力，元件仍可順利執行，而功能的存在只會啟用一些額外或替代行為。

如要讓元件架構瞭解元件需要哪些功能，以及哪些功能是選用功能，請使用 availability 欄位。

use: [
    {
        // It is ok if this protocol is unavailable
        protocol: "fuchsia.examples.Echo1",
        availability: "optional",
    },
    {
        // This protocol MUST be provided for the component to function correctly.
        protocol: "fuchsia.examples.Echo2",
        availability: "required",
    },
]

如果元件具有能力的required使用聲明 (預設)，但其父項提供能力為 optional，則能力會產生錯誤，且執行階段的連線嘗試一律會失敗。

使用選用功能

如果元件的父項已使用 offer 封鎖功能，則該能力可能無法在執行階段使用。availability: "optional"

無論能力是否可用，元件的如果嘗試開啟該能力的路徑，系統會關閉提供給 Directory.Open() 呼叫的控制代碼，並顯示 ZX_ERR_NOT_FOUND 墓誌銘。

使用 open() 或 stat() 等 libc 方法會傳回 ENOENT。

路線功能

元件只能存取路由至該元件的功能。只要從能力供應商到任何消費者之間，存在有效的路徑 (即下列宣告鏈)，功能就能源自元件拓撲中的任何位置：

expose：將能力向上傳送至元件的父項。
offer：將能力向下傳遞至其中一個元件的子項。

如要將能力供應器與要求這些功能的元件連結，請按照下列步驟操作：

在能力供應商元件中新增 offer 或 expose 宣告：

{
    include: [
        "inspect/client.shard.cml",
        "syslog/client.shard.cml",
    ],

    // Information about the program to run.
    program: {
        // Use the built-in ELF runner.
        runner: "elf",

        // The binary to run for this component.
        binary: "bin/echo_server_rust",
    },

    // Capabilities provided by this component.
    capabilities: [
        { protocol: "fidl.examples.routing.echo.Echo" },
    ],
    expose: [
        {
            protocol: "fidl.examples.routing.echo.Echo",
            from: "self",
        },
    ],
}

針對元件執行個體樹狀結構中的每個中介元件，加入額外的 expose 和 offer 宣告，直到抵達含有 use 宣告的取用元件為止：

{
    // Two children: a server and client.
    children: [
        {
            name: "echo_server",
            url: "#meta/echo_server.cm",
        },
        {
            name: "echo_client",
            url: "#meta/echo_client.cm",
        },
    ],
    offer: [
        // Route Echo protocol from server to client.
        {
            protocol: "fidl.examples.routing.echo.Echo",
            from: "#echo_server",
            to: "#echo_client",
        },

        // Route diagnostics protocols to both children.
        {
            dictionary: "diagnostics",
            from: "parent",
            to: [
                "#echo_client",
                "#echo_server",
            ],
        },
    ],
}

選用依附元件

如果元件對能力有選用依附元件，則由該元件的父項決定元件是否會收到該能力。提供能力時，元件可能會將 availability 欄位設為 optional、required 或 same_as_target。每個值都有下列語意：

optional：優惠目標必須聲明可處理缺少這項能力的情況，方法是將 use 聲明標示為 optional。如果目標無法執行這項操作 (即目標具有這項能力的可用性 required)，則轉送這項能力會導致錯誤。
required：目標必須具備這項能力。如果優惠來源是 parent，且元件的父項 (目標的祖父項) 提供這項功能做為選用能力，則路由傳送能力會導致錯誤，因為父項無法保證能力的可用性。
same_as_target：這項能力的可用性取決於目標的期望。如果目標對這項能力有選用依附元件，這項供應項目也會是選用項目。如果目標必須依附這項能力，則也必須提供這項優惠。

offer: [
    {
        // child-1 MUST receive the protocol 'fuchsia.logger.LogSink'.
        protocol: "fuchsia.logger.LogSink",
        to: "#child-1",
        from: "#child-2",
        availability: "required",
    },
    {
        // child-1 MUST be able to handle the absence of the protocol
        // 'fuchsia.tracing.provider.Registry'.
        protocol: "fuchsia.tracing.provider.Registry",
        to: "#child-1",
        from: "parent",
        availability: "optional",
    },
    {
        // child-1 decides if it must receive the protocol
        // 'fuchsia.posix.socket.Provider', or if it must be able to support its
        // absence.
        protocol: "fuchsia.posix.socket.Provider",
        to: "#child-1",
        from: "parent",
        availability: "same_as_target",
    },
]

與 use 宣告相同，availability 欄位可以省略，此時會預設為 required。

遞移依附元件

元件架構可讓元件軟轉換為使用及提供選用和必要功能。有了過渡期適用性標記，使用能力的元件不會導致 Scrutiny 驗證錯誤，無論父項是必要、選用或與目標相同。請注意，雖然這個欄位可啟用軟轉換，但元件最終應選擇選填或必填。

如要使用這項功能，子項元件會將可用性標示為「transitional」：

use: [
    {
        // It is ok if this protocol is offered as "required" or "optional"
        protocol: "fuchsia.examples.Echo",
        availability: "transitional",
    },
]

管理子元件

只要元件拓撲中的任何位置存在有效的能力路徑，元件就能透過功能彼此互動。還有其他方法可讓父項元件與直接子項互動。

下列範例元件會宣告名為 lifecycle 的單一靜態子項，以及名為 echo 的集合，可在執行階段建立其他子元件：

{
    // ...

    // Statically declared child components
    children: [
        {
            name: "lifecycle",
            url: "lifecycle#meta/default.cm",
        },
    ],

    // Collection to hold dynamically created child components
    collections: [
        {
            name: "echo",
            durability: "transient",
        },
    ],

    // Capabilities required by this component
    use: [
        {
            protocol: "fuchsia.component.Binder",
            from: "#lifecycle",
        },
        {
            protocol: "fuchsia.component.Realm",
            from: "framework",
        },
    ],

    // Capabilities required by child components
    offer: [
        {
            dictionary: "diagnostics",
            from: "parent",
            to: [
                "#echo",
                "#lifecycle",
            ],
        },
    ],
}

請注意，在父項元件的資訊清單中，集合的行為類似於靜態子項例項，您可以為集合命名，並提供特定功能。集合中的所有子項元件都可以存取提供給該元件的一組功能。

啟動子項元件

元件架構提供 fuchsia.component.Binder 通訊協定，供父項元件明確啟動可能不會公開任何其他功能的子項。由於這項能力是由架構提供，子項元件只需要從元件資訊清單公開這項功能即可：

{
    // ...

    // Capabilities exposed from this component to parent.
    expose: [
        {
            // Expose this protocol so that parent component can start it
            // by binding to this capability.
            protocol: "fuchsia.component.Binder",
            from: "framework",
        },
    ],
}

建立動態子項

如要在執行階段建立新的子項元件，請使用 fuchsia.component.Realm 通訊協定在現有集合中建立元件。使用下列參數呼叫 CreateChild 方法：

CollectionRef：說明要新增元件的集合。
Child：元件宣告，包括名稱和元件網址。

荒漠油廠

use fidl_fuchsia_component::{BinderMarker, CreateChildArgs, RealmMarker};
use fidl_fuchsia_component_decl::{Child, ChildRef, CollectionRef, StartupMode};

// ...

// Use the fuchsia.component.Realm protocol to create a dynamic
// child instance in the collection.
async fn create_dynamic_child() {
    let realm = client::connect_to_protocol::<RealmMarker>()
        .expect("failed to connect to fuchsia.component.Realm");

    let collection_ref = CollectionRef { name: String::from("echo") };
    let child_decl = Child {
        name: Some(String::from("lifecycle_dynamic")),
        url: Some(String::from("echo_server#meta/default.cm")),
        startup: Some(StartupMode::Lazy),
        ..Default::default()
    };

    realm
        .create_child(&collection_ref, &child_decl, CreateChildArgs::default())
        .await
        .expect("create_child failed")
        .expect("failed to create child");
}

C++

#include <fuchsia/component/cpp/fidl.h>
#include <fuchsia/component/decl/cpp/fidl.h>

// ...

// Use the fuchsia.component.Realm protocol to create a dynamic
// child instance in the collection.
void CreateDynamicChild() {
  fuchsia::component::decl::CollectionRef collection_ref = {
      .name = "echo",
  };
  fuchsia::component::decl::Child child_decl;
  child_decl.set_name("lifecycle_dynamic");
  child_decl.set_url("echo_server#meta/default.cm");
  child_decl.set_startup(fuchsia::component::decl::StartupMode::LAZY);

  realm_proxy_->CreateChild(std::move(collection_ref), std::move(child_decl),
                            fuchsia::component::CreateChildArgs(),
                            [&](fuchsia::component::Realm_CreateChild_Result result) {
                              ZX_ASSERT(!result.is_err());
                              FX_LOGS(INFO) << "Dynamic child instance created.";

                              ConnectDynamicChild();
                            });
}

連結至子功能

由於動態元件的父項在建構期間不明，因此無法在元件資訊清單中，以能力路徑表示其公開功能。

如要連線至動態子項執行個體公開的功能，請按照下列步驟操作：

使用 fuchsia.component.Realm 通訊協定開啟子項公開目錄。使用子元件名稱和集合名稱呼叫 OpenExposedDir 方法：

荒漠油廠

use fidl_fuchsia_component::{BinderMarker, CreateChildArgs, RealmMarker};
use fidl_fuchsia_component_decl::{Child, ChildRef, CollectionRef, StartupMode};

// ...
// Connect to the fidl.examples.routing.echo capability exposed by the child
// instance, and send a request.
async fn connect_dynamic_child(message: String) {
    // Open the child's exposed directory
    let exposed_dir = client::open_childs_exposed_directory(
        String::from("lifecycle_dynamic"),
        Some(String::from("echo")),
    )
    .await
    .expect("failed to open exposed directory");

    // ...
}

C++

#include <fuchsia/component/cpp/fidl.h>
#include <fuchsia/component/decl/cpp/fidl.h>

// ...

// Use the fuchsia.component.Realm protocol to open the exposed directory of
// the dynamic child instance.
void ConnectDynamicChild() {
  fuchsia::component::decl::ChildRef child_ref = {
      .name = "lifecycle_dynamic",
      .collection = "echo",
  };

  fidl::InterfaceHandle<fuchsia::io::Directory> exposed_dir;
  realm_proxy_->OpenExposedDir(
      child_ref, exposed_dir.NewRequest(),
      [this, exposed_dir = std::move(exposed_dir)](
          fuchsia::component::Realm_OpenExposedDir_Result result) mutable {
        ZX_ASSERT(!result.is_err());
        std::shared_ptr<sys::ServiceDirectory> svc = std::make_shared<sys::ServiceDirectory>(
            sys::ServiceDirectory(std::move(exposed_dir)));

        SendEchoRequest(svc);
      });
}

使用公開目錄控制代碼做為根目錄，連線至子項公開的功能：

荒漠油廠

// Access the fidl.examples.routing.echo capability provided there
let echo = client::connect_to_protocol_at_dir_root::<EchoMarker>(&exposed_dir)
    .expect("failed to connect to fidl.examples.routing.echo");

let response = echo
    .echo_string(Some(&message))
    .await
    .expect("echo_string failed")
    .expect("echo_string got empty result");
info!("Server response: {}", response);

C++

// Connect to the fidl.examples.routing.echo capability exposed by the child's
// service directory.
void SendEchoRequest(std::shared_ptr<sys::ServiceDirectory> svc_directory) {
  // Connect to the protocol inside the child's exposed directory
  svc_directory->Connect(echo_proxy_.NewRequest());

  // Send a protocol request
  echo_proxy_->EchoString(message_, [&](fidl::StringPtr response) {
    FX_LOGS(INFO) << "Server response: " << response;
    DestroyDynamicChild();
  });
}

銷毀動態子項

不再需要動態子項時，請使用 fuchsia.component.Realm 通訊協定終止元件例項。使用代表集合中子項的 ChildRef 呼叫 DestroyChild 方法。

荒漠油廠

use fidl_fuchsia_component::{BinderMarker, CreateChildArgs, RealmMarker};
use fidl_fuchsia_component_decl::{Child, ChildRef, CollectionRef, StartupMode};

// ...

// Use the fuchsia.component.Realm protocol to destroy the dynamic
// child instance running in the collection.
async fn destroy_dynamic_child() {
    let realm = client::connect_to_protocol::<RealmMarker>()
        .expect("failed to connect to fuchsia.component.Realm");

    let child_ref = ChildRef {
        name: String::from("lifecycle_dynamic"),
        collection: Some(String::from("echo")),
    };

    realm
        .destroy_child(&child_ref)
        .await
        .expect("destroy_child failed")
        .expect("failed to destroy child");
}

C++

#include <fuchsia/component/cpp/fidl.h>
#include <fuchsia/component/decl/cpp/fidl.h>

// ...

// Use the fuchsia.component.Realm protocol to destroy the dynamic
// child instance running in the collection.
void DestroyDynamicChild() {
  fuchsia::component::decl::ChildRef child_ref = {
      .name = "lifecycle_dynamic",
      .collection = "echo",
  };

  realm_proxy_->DestroyChild(std::move(child_ref),
                             [&](fuchsia::component::Realm_DestroyChild_Result result) {
                               ZX_ASSERT(!result.is_err());
                               FX_LOGS(INFO) << "Dynamic child instance destroyed.";

                               // Terminate the loop
                               loop_->Quit();
                             });
}

這會導致元件停止運作 (如果目前正在執行)。如要在元件中處理這項事件，請參閱「監聽停止事件」。

控制元件生命週期

元件架構提供多項功能，可修改元件生命週期的各個部分並與之互動。

如要進一步瞭解生命週期概念，請參閱「元件生命週期」。

生命週期通知

ELF 執行元件會使用 fuchsia.process.lifecycle.Lifecycle 通訊協定，將生命週期事件通知元件。

如要在子項元件中監聽停止通知，請按照下列步驟操作：

在元件資訊清單中訂閱生命週期事件：

荒漠油廠

// Information about the program to run.
program: {
    // Use the built-in ELF runner.
    runner: "elf",

    // The binary to run for this component.
    binary: "bin/lifecycle_example_rust",

    // Subscribe to component lifecycle events
    lifecycle: { stop_event: "notify" },
},

C++

// Information about the program to run.
program: {
    // Use the built-in ELF runner.
    runner: "elf",

    // The binary to run for this component.
    binary: "bin/lifecycle_example_cpp",

    // Subscribe to component lifecycle events
    lifecycle: { stop_event: "notify" },
},

使用執行元件提供的啟動控制代碼，註冊生命週期處理常式：

荒漠油廠

use fidl_fuchsia_process_lifecycle::{LifecycleRequest, LifecycleRequestStream};

// ...

#[fuchsia::main(logging_tags = ["lifecycle", "example"])]
async fn main() {
    // Take the lifecycle handle provided by the runner
    match fuchsia_runtime::take_startup_handle(HandleInfo::new(HandleType::Lifecycle, 0)) {
        Some(lifecycle_handle) => {
            info!("Lifecycle channel received.");
            // Begin listening for lifecycle requests on this channel
            let x: zx::Channel = lifecycle_handle.into();
            let async_x = AsyncChannel::from(fuchsia_async::Channel::from_channel(x));
            let mut req_stream = LifecycleRequestStream::from_channel(async_x);
            info!("Awaiting request to close...");
            if let Some(request) =
                req_stream.try_next().await.expect("Failure receiving lifecycle FIDL message")
            {
                match request {
                    LifecycleRequest::Stop { control_handle: c } => {
                        info!("Received request to stop. Shutting down.");
                        c.shutdown();
                        process::exit(0);
                    }
                }
            }

            // We only arrive here if the lifecycle channel closed without
            // first sending the shutdown event, which is unexpected.
            process::abort();
        }
        None => {
            // We did not receive a lifecycle channel, exit abnormally.
            error!("No lifecycle channel received, exiting.");
            process::abort();
        }
    }
}

C++

#include <fuchsia/process/lifecycle/cpp/fidl.h>

// ...

// Implementation of the fuchsia.process.lifecycle FIDL protocol
class LifecycleHandler : public fuchsia::process::lifecycle::Lifecycle {
 public:
  explicit LifecycleHandler(async::Loop* loop) : loop_(loop) {
    // Get the PA_LIFECYCLE handle, and instantiate the channel with it
    zx::channel channel = zx::channel(zx_take_startup_handle(PA_LIFECYCLE));
    // Bind to the channel and start listening for events
    bindings_.AddBinding(
        this, fidl::InterfaceRequest<fuchsia::process::lifecycle::Lifecycle>(std::move(channel)),
        loop_->dispatcher());
    FX_LOGS(INFO) << "Lifecycle channel received.";
  }

  // This is the Stop event we must override - see the pure virtual function we
  // need to override at the declaration of fuchsia::process::lifecycle::Lifecycle
  void Stop() override {
    FX_LOGS(INFO) << "Received request to stop. Shutting down.";
    // Shut down our loop - it's important to call Shutdown() here vs. Quit()
    loop_->Shutdown();
    // Close the binding
    bindings_.CloseAll();
  }

 private:
  async::Loop* loop_;
  fidl::BindingSet<fuchsia::process::lifecycle::Lifecycle> bindings_;
};

從父項開始

元件資訊清單可讓您將子項標示為 eager，這會導致元件架構隱含地啟動該子項和父項。

如果急切子項因任何原因 (例如缺少元件) 無法啟動，元件管理員會出現下列行為：

如果父項不是根元件，父項會啟動，但繫結至父項的元件會觀察到連線中斷 (就像任何其他繫結失敗的情況一樣)。

如果父項是根元件，元件管理工具就會當機，並顯示類似下列內容的錯誤訊息：

[component_manager] ERROR: protocol `fuchsia.component.CoreBinder` was not available for target `startup`:
    failed to resolve `fuchsia-pkg://fuchsia.com/your_component#meta/your_component.cm`:
    package not found: remote resolver responded with PackageNotFound
    For more, run `ffx component doctor `startup`

如果祖先也標示為 eager，直到根元件為止，標示為 eager 的元件可能會在不存在時導致系統當機。這點非常重要，因為許多建構設定會建立含有可用元件子集的系統映像檔。為避免這個問題，請使用核心領域分片宣告這些元件，確保這些元件能安全地從測試版本和產品映像檔中排除。

eager 元件也應與父項位於相同的套件組合，因為元件會與父項同時啟動。一般來說，eager 元件應位於產品的基礎套件組合中。

如要判斷套件是否位於基本套件集中，請執行下列指令：

fx list-packages --verbose my-package

這項指令會輸出找到相符套件的套件集清單。舉例來說，system-update-checker 位於 base 和 universe 套件組合中：

$ fx list-packages --verbose system-update-checker
system-update-checker [base universe]

您也可以使用 --base 選項，查看基本套件組合中的所有套件：

fx list-packages --base

終止時重新啟動

元件資訊清單可讓您使用 on_terminate 控制元件的終止政策。如果元件因成功結束以外的任何原因終止，系統會因設有「reboot-on-terminate」政策的元件而正常重新啟動。

如要啟用這項功能，請按照下列步驟操作：

在父項的元件資訊清單中，將子項標示為 on_terminate: "reboot"：

// core.cml
{
    children: [
        ...
        {
            name: "system-update-checker",
            url: "fuchsia-pkg://fuchsia.com/system-update-checker#meta/system-update-checker.cm",
            startup: "eager",
            on_terminate: "reboot",
        },
    ],
}

將元件的路徑名稱新增至元件管理員的安全政策允許清單： //src/security/policy/component_manager_policy.json5：

// //src/security/policy/component_manager_policy.json5
{
    security_policy: {
        ...
        child_policy: {
            reboot_on_terminate: [
                ...
                "/core/system-update-checker",
            ],
        },
    },
}

錯誤

信號機制

當要求用戶端在其命名空間或 <0x0Directory.Open()發生錯誤時，該控制代碼的物件會以墓誌銘關閉。墓誌銘酬載內容一律為 Zircon 狀態碼。

由於路由是延遲且非同步的，因此在啟動路由作業後，這則訊息可能會在任何時間送達。

注意：路由成功後，服務元件也可以關閉相同物件，並選擇狀態碼。用戶端無法判斷物件是由元件管理員、服務元件還是之後委派的其他對象關閉。

libc 類型的呼叫 (例如 open()) 會使用相同的錯誤信號機制。

如需實用範例，請參閱「疑難排解」一節。

錯誤狀態碼

元件管理員可能會傳送下列錯誤代碼，指出路由作業失敗：

ZX_ERR_NOT_FOUND：由於下列其中一項原因，能力無法順利傳送：
- 這項設定未提供選用能力。
- 路徑中任一元件的設定錯誤。
- 服務元件與這個版本的 Fuchsia 不相容。
- 放送元件程式中的錯誤。
- 完成路由作業時，任何解析器或執行器發生錯誤。
ZX_ERR_ACCESS_DENIED：要求元件無法存取這項能力，因此無法轉送。例如：
- 能力有政策允許清單，但清單中不含要求元件。
- 要求元件要求的權限大於系統提供給該元件的權限 (例如，要求對以唯讀形式提供的目錄進行讀取/寫入)。
ZX_ERR_TIMED_OUT：其中一個轉送步驟逾時。
ZX_ERR_INTERNAL：元件管理員本身發生非預期的錯誤，表示平台有錯誤。

只要平台上的軟體未更新，NOT_FOUND、ACCESS_DENIED 和 INTERNAL 錯誤就會針對相同能力重現。軟體更新 (即使是單一元件) 可能會變更能力的路徑，進而影響該能力的可用性。

轉送錯誤語意原則

極簡：由於元件管理工具和服務元件共用錯誤信號路徑，元件管理工具會將大部分的錯誤空間留給服務元件使用。
用戶端觀點：雖然轉送作業取決於許多個別的子作業，且每個子作業都可能因各種原因 (包括其他元件作者的錯誤) 而失敗，但錯誤語意會根據要求用戶端和要求用戶端的需求進行調整。舉例來說，即使中介元件作者發生使用者錯誤，要求用戶端仍會收到 NOT_FOUND。

疑難排解

本節列出您嘗試use時可能會遇到的常見問題，以及建議的解決方法，協助您從元件連線至功能。

能力轉送失敗

當元件嘗試存取能力時，元件管理員會執行功能路徑，找出指定能力來源。如果轉送路徑中的某個元件資訊清單設定有誤，轉送作業可能會失敗。舉例來說，路徑中某個元件缺少 offer 或 expose 宣告，或是鏈結中的某個元件無法解析。

如要檢查管道關閉是否是由路由失敗所致，請執行下列操作：

使用 ffx component route 檢查元件的路由。這項功能可搭配元件的路徑名稱或元件的網址使用。例如：

# check with the moniker
ffx component route /core/ffx-laboratory:echo_realm/echo_client

# check with a partial URL
ffx component route echo_client.cm

使用 ffx component capability 找出使用或公開特定能力的元件。這有助於您確認元件拓撲中是否提供某項能力。
```
ffx component capability fuchsia.example.Echo
```
使用 ffx component explore 在元件的命名空間內開啟互動式殼層。您可以列出 /svc (或其他已路由的目錄) 的內容，確認命名空間中是否確實提供這項能力。

在互動式殼層中，您可以檢查能力：
```
ls /svc
```

使用 ffx log 檢查元件記錄，找出以 Failed to route 開頭的訊息，瞭解路由鏈失敗的原因。例如：

[echo_client][][W] protocol `fidl.examples.routing.echo.Echo` was not available for target `/core/ffx-laboratory:echo_realm/echo_client`:
    `fidl.examples.routing.echo.Echo` was not offered to `/core/ffx-laboratory:echo_realm/echo_client` by parent
    For more, run `ffx component doctor /core/ffx-laboratory:echo_realm/echo_client`

查看已關閉頻道的墓誌銘。最常見的路由失敗設定墓誌銘為 ZX_ERR_NOT_FOUND：

[echo_client][][I] Connecting to Echo protocol failed with error
"A FIDL client's channel to the service fidl.examples.routing.echo.Echo was closed: NOT_FOUND"

詳情請參閱路由錯誤。

如需能力轉送失敗的獨立範例，請參閱 //examples/components/routing_failed。

收到來自轉送的錯誤

如果能力轉送失敗，底層 FIDL 管道就會關閉。如果管道已關閉，FIDL 通訊協定繫結會傳回錯誤狀態。請參考以下範例：

荒漠油廠

let echo = connect_to_protocol::<EchoMarker>()
    .context("Failed to connect to echo service")?;
let res = echo.echo_string(Some("Hippos rule!")).await;
match res {
    Ok(_) => { info!("Call succeeded!"); }
    Err(fidl::Error::ClientChannelClosed { status, service_name } => { 
        error!("Channel to service {} was closed with status: {}", service_name, status); 
    } 
    Err(e) => {
        error!("Unexpected error: {}", e);
    }
};

C++

fuchsia::examples::EchoPtr echo_proxy;
auto context = sys::ComponentContext::Create();
context->svc()->Connect(echo_proxy.NewRequest());

// Sets an error handler that will be called if an error causes the underlying 
// channel to be closed. 
echo_proxy.set_error_handler([&loop](zx_status_t status) { 
  printf("Channel was closed with status: %d\n", status); 
  // ... 
}); 

echo_proxy->EchoString("Hippos rule!", [&](std::string response) {
  // ...
});

如要判斷管道關閉的根本原因，可以檢查管道上設定的選用墓誌銘。如要擷取已關閉管道的墓誌銘，請按照下列步驟操作：

荒漠油廠

let stream = echo.take_event_stream();
match stream.next().await {
    Some(Err(fidl::Error::ClientChannelClosed { status, .. })) => {
        info!("Channel was closed with epitaph: {}", status);
    }
    Some(m) => {
        info!("Received message other than epitaph or peer closed: {:?}", m);
    }
    None => {
        info!("Component failed to start or channel was closed by server");
    }
}

C++

echo_proxy.set_error_handler([&loop](zx_status_t status) {
  // If an Epitaph was present on the channel, its error value will be passed as
  // the parameter.
  printf("Channel was closed with epitaph: %d\n", status);
});

元件無法啟動

如果能力轉送設定成功，但解析或啟動元件時發生問題，您可能會遇到錯誤。錯誤訊息的形式取決於元件執行器：

如果是 ELF 執行元件，請使用 ffx log --filter component_manager 檢查元件管理員記錄。找出開頭為 Failed to start component 的訊息。例如：

[component_manager] WARN: Failed to start component
`fuchsia-pkg://fuchsia.com/components-routing-failed-example#meta/echo_server_bad.cm`:
unable to load component with url "fuchsia-pkg://fuchsia.com/components-routing-failed-example#meta/echo_server_bad.cm":
error loading executable: "reading object at \"bin/routing_failed_echo_server_oops\" failed:
A FIDL client's channel to the service fuchsia.io.File was closed: PEER_CLOSED"

如果是其他執行器，請檢查執行元件元件的記錄。如要執行這項操作，請執行下列指令：
```
ffx log --tags runner-name
```

如要解決這個問題，請確認下列事項：

元件資訊清單中的 program 宣告已正確設定。舉例來說，請確認二進位檔的路徑拼寫正確無誤。
啟動元件所需的二進位檔和其他所有資源都包含在套件中。

如要查看因元件資訊清單設定錯誤而無法啟動的元件範例，請參閱//examples/components/routing_failed。

元件終止或關閉管道

如果已確認路由成功，且元件已順利啟動，則可能是來源元件自行關閉管道所致。這可能發生在元件執行期間，也可能是元件終止的副作用。

如果元件因當機而終止，您可以在 ffx log 中尋找當機報告，其中包含傾印中的元件名稱：

[33860.645][klog][klog][I] crashsvc: exception received, processing
[33860.645][klog][klog][I] <== fatal : process echo_client.cm[21090] thread initial-thread[21092]
<stack trace follows...>

如果來源元件自行關閉管道，請參考下列提示，進一步排解原因：

請參閱來源元件的記錄，瞭解錯誤訊息。
使用 ffx debug fidl 搭配 fidlcat 檢查 FIDL 連線流量是否有錯誤或非預期行為。