在 Rust 中實作 FIDL 用戶端

必要條件

本教學課程假設您熟悉編寫及執行 Fuchsia 元件，以及實作 FIDL 伺服器，這兩項內容皆已在 FIDL 伺服器教學課程中介紹。如需 FIDL 的完整教學課程，請參閱總覽。

總覽

本教學課程會實作 FIDL 通訊協定的用戶端，並針對先前教學課程中建立的伺服器執行用戶端。本教學課程中的用戶端為非同步。同步用戶端有其他教學課程。

如果您想自行編寫程式碼，請刪除下列目錄：

rm -r examples/fidl/rust/client/*

建立元件

在 examples/fidl/rust/client 中建立新的元件專案：

  1. 將 main() 函式新增至 examples/fidl/rust/client/src/main.rs：

    fn main() {
  println!("Hello, world!");
}

  2. 在 examples/fidl/rust/client/BUILD.gn 中為用戶端宣告目標：

    import("//build/components.gni")
import("//build/rust/rustc_binary.gni")


# Declare an executable for the client.
rustc_binary("bin") {
  name = "fidl_echo_rust_client"
  edition = "2021"

  sources = [ "src/main.rs" ]
}

fuchsia_component("echo-client") {
  component_name = "echo_client"
  manifest = "meta/client.cml"
  deps = [ ":bin" ]
}

  3. 在 examples/fidl/rust/client/meta/client.cml 中新增元件資訊清單：

    {
    include: [ "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/fidl_echo_rust_client",
    },

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

  4. 建立元件後，請確認您可以將其新增至建構設定：

    fx set core.x64 --with //examples/fidl/rust/client:echo-client

  5. 建構 Fuchsia 映像檔：

    fx build

編輯 GN 依附元件

  1. 將下列依附元件新增至 rustc_binary：

      deps = [
    "//examples/fidl/fuchsia.examples:fuchsia.examples_rust",
    "//src/lib/fuchsia",
    "//src/lib/fuchsia-component",
    "//third_party/rust_crates:anyhow",
    "//third_party/rust_crates:futures",
  ]

  2. 然後在 main.rs 中匯入：

    use anyhow::{Context as _, Error};
use fidl_fuchsia_examples::{EchoEvent, EchoMarker};
use fuchsia_component::client::connect_to_protocol;
use futures::prelude::*;

伺服器教學課程會說明這些依附元件。

連線至伺服器

本節的步驟說明如何在 main() 函式中新增程式碼，讓用戶端與伺服器連線並向其提出要求。

連線至伺服器

#[fuchsia::main]
async fn main() -> Result<(), Error> {
    // Connect to the Echo protocol, which is assumed to be in the component's environment
    let echo = connect_to_protocol::<EchoMarker>().context("Failed to connect to echo service")?;

    // Make an EchoString request and wait for the response
    let res = echo.echo_string("hello").await?;
    println!("response: {:?}", res);

    // Make a SendString request
    echo.send_string("hi")?;
    // Wait for a single OnString event
    let EchoEvent::OnString { response } =
        echo.take_event_stream().next().await.context("error receiving events")??;
    println!("Received OnString event for string {:?}", response);

    Ok(())
}

實際上，這個呼叫會觸發一系列事件，這些事件會在用戶端開始，並透過先前教學課程中的伺服器程式碼進行追蹤。

  • 初始化用戶端物件和管道。用戶端物件會繫結至管道的其中一端。
  • 向元件架構提出要求，其中包含要連線的服務名稱和管道的另一端。系統會使用 EchoMarker 範本引數的 SERVICE_NAME 隱含取得服務名稱，這與在伺服器端決定服務路徑的方式類似。
  • 這個用戶端物件會從 connect_to_protocol 傳回。

在背景中，系統會將對元件架構的要求轉送至伺服器：

  • 在伺服器程序中收到這項要求時，系統會喚醒 async::Executor 執行器，並告知 ServiceFs 工作現在可以取得進度，且應執行。
  • ServiceFs 會喚醒，並查看程序的啟動句柄上是否有可用的要求，然後在透過呼叫 add_service、add_fidl_service 等提供的 (service_name, service_startup_func) 清單中查詢要求服務的名稱。如果有相符的 service_name，系統會使用提供的管道呼叫 service_startup_func，以連線至新服務。
  • IncomingService::Echo 會使用 add_fidl_service 註冊的 Echo FIDL 通訊協定的 RequestStream (類型管道) 呼叫。傳入的要求管道會儲存在 IncomingService::Echo 中，並新增至傳入要求的串流。for_each_concurrent 會將 ServiceFs 轉換為 IncomingService 類型的 Stream。會為串流中的每個項目執行處理程序，該程序會比對傳入的要求，並將結果分派至 run_echo_server。當 ServiceFs 串流遭到 await 時，每個對 run_echo_server 的呼叫所產生的結果未來會同時執行。
  • 當要求透過管道傳送時，Echo 服務的管道就會變得可讀，這會喚醒 run_echo_server 主體中的非同步程式碼。

將要求傳送至伺服器

程式碼會向伺服器提出兩項要求：

  • EchoString 要求
  • SendString 要求
#[fuchsia::main]
async fn main() -> Result<(), Error> {
    // Connect to the Echo protocol, which is assumed to be in the component's environment
    let echo = connect_to_protocol::<EchoMarker>().context("Failed to connect to echo service")?;

    // Make an EchoString request and wait for the response
    let res = echo.echo_string("hello").await?;
    println!("response: {:?}", res);

    // Make a SendString request
    echo.send_string("hi")?;
    // Wait for a single OnString event
    let EchoEvent::OnString { response } =
        echo.take_event_stream().next().await.context("error receiving events")??;
    println!("Received OnString event for string {:?}", response);

    Ok(())
}

對 EchoString 的呼叫會傳回 Future，並解析為伺服器傳回的回應。如果傳送要求或接收回應時發生錯誤 (例如解碼訊息或收到碑文)，則傳回的 future 會解析為錯誤。

另一方面，呼叫 SendString 會傳回 Result，因為這是立即執行並忘記的方法。如果傳送要求時發生問題，這個方法呼叫會傳回錯誤。

繫結參考資料說明如何產生這些 Proxy 方法，而 Fuchsia rustdoc 則包含產生 FIDL Crate 的說明文件。

處理傳入事件

然後程式碼會等待伺服器傳送的單一 OnString 事件：

#[fuchsia::main]
async fn main() -> Result<(), Error> {
    // Connect to the Echo protocol, which is assumed to be in the component's environment
    let echo = connect_to_protocol::<EchoMarker>().context("Failed to connect to echo service")?;

    // Make an EchoString request and wait for the response
    let res = echo.echo_string("hello").await?;
    println!("response: {:?}", res);

    // Make a SendString request
    echo.send_string("hi")?;
    // Wait for a single OnString event
    let EchoEvent::OnString { response } =
        echo.take_event_stream().next().await.context("error receiving events")??;
    println!("Received OnString event for string {:?}", response);

    Ok(())
}

方法是從用戶端物件取得事件串流，然後等待從中取得單一事件。

執行用戶端

為了讓用戶端和伺服器使用 Echo 通訊協定進行通訊，元件架構必須將 fuchsia.examples.Echo 能力從伺服器路由至用戶端。在本教學課程中，我們會提供一個

中探索領域元件的完整來源。

  1. 設定建構作業，加入提供的套件，其中包含回音領域、伺服器和用戶端：

    fx set core.x64 --with //examples/fidl/rust:echo-rust-client

  2. 建構 Fuchsia 映像檔：

    fx build

  3. 執行 echo_realm 元件。這會建立用戶端和伺服器元件例項，並將功能路由：

    ffx component run /core/ffx-laboratory:echo_realm fuchsia-pkg://fuchsia.com/echo-rust-client#meta/echo_realm.cm

  4. 啟動 echo_client 執行個體：

    ffx component start /core/ffx-laboratory:echo_realm/echo_client

當用戶端嘗試連線至 Echo 通訊協定時，伺服器元件就會啟動。您應該會在裝置記錄 (ffx log) 中看到類似以下的輸出內容：

[echo_server][][I] Listening for incoming connections...
[echo_server][][I] Received EchoString request for string "hello"
[echo_server][][I] Response sent successfully
[echo_client][][I] response: "hello"
[echo_server][][I] Received SendString request for string "hi"
[echo_server][][I] Event sent successfully
[echo_client][][I] Received OnString event for string "hi"

終止領域元件，停止執行並清理元件例項：

ffx component destroy /core/ffx-laboratory:echo_realm