编写“Hello World”会话

会话是 session_manager 可以在启动时启动的常规组件。也就是说，创建会话组件的步骤与创建任何其他组件相同。本文档讨论了如何创建在启动时启动并将“Hello World!”输出到系统日志的示例会话。

创建目录结构

组件需要特定的目录结构。fx 工具提供了一个可为您创建此结构的生成器。它接受组件名称和要用作参数的语言。例如，此组件名为 hello-world-session，使用 Rust 编写。

运行以下命令，为此示例创建目录结构：

fx create component --path hello-world-session --lang rust

此命令会使用提供服务的组件的模板创建以下目录结构：

hello-world-session
  |- meta
  |   |- hello-world-session.cml
  |
  |- src
  |   |- main.rs
  |
  |- BUILD.gn

创建组件清单

组件清单文件 (hello-world-session.cml) 向 Fuchsia 声明组件。在此示例中，默认清单已足够，但请花点时间浏览 hello-world-session.cml 中的以下代码行：

1. 如有需要，该文件首先会添加其他 Cml 文件。

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

   此 include 键允许会话组件使用 fuchsia.logger.LogSink 功能，以便其可以输出到系统日志。

2. 接下来是 program 代码块。

   // Information about the program to run.
   program: {
       // Use the built-in ELF runner to run native binaries.
       runner: "elf",
   
       // The binary to run for this component.
       binary: "bin/hello-world-session",
   },
   
   

   program 代码块用于告知 component_manager 可在何处找到会话组件的二进制文件。runner 键用于告知 component_manager 应使用 ELF 运行程序运行组件二进制文件。

3. 最后，组件清单描述了组件可以 use、offer 或 expose 的其他功能。

   // Capabilities used by this component.
   use: [
       // List your component's dependencies here, ex:
       // { protocol: "fuchsia.net.name.Lookup" }
   ],
   expose: [
       // session_manager uses this protocol to start the session.
       {
           protocol: "fuchsia.component.Binder",
           from: "framework",
       },
   ],
   
   

在 Rust 中编写会话

现在，您可以编写会话组件的实现了。在生成的 src/main.rs 文件中，有许多本示例不需要的代码。

将 src/main.rs 的内容替换为以下代码：

use anyhow::Error;

/// Creates a simple session that just prints "Hello World" to the syslog.
#[fuchsia::main(logging = true)]
async fn main() -> Result<(), Error> {
    tracing::info!("Hello World!");

    Ok(())
}

此代码会初始化系统日志，然后输出“Hello World!”。 tracing::info! 是一个宏，用于输出到日志中的 info 级别。还有适用于 error 和 warn 的类似宏。

编写 BUILD.gn

要修改的最后一个文件是 BUILD.gn。它会告知编译器如何构建会话组件。

Rust 二进制文件

下一部分将介绍实际的 Rust 二进制文件。它会告知编译器二进制文件的名称是什么，其中包含单元测试、它具有哪些依赖项以及源代码所在的位置。在此示例中，默认的依赖项集就足够了：

rustc_binary("bin") {
  edition = "2021"
  output_name = "hello-world-session"

  # Generates a GN target for unit-tests with the label `bin_test`, and
  # a binary named `hello_world_session_bin_test`.
  with_unit_tests = true

  deps = [
    "//src/lib/fuchsia",
    "//third_party/rust_crates:anyhow",
    "//third_party/rust_crates:tracing",
  ]

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

fuchsia_component() 和 fuchsia_package() 模板会告知 Fuchsia 更多关于组件的信息，包括组件的名称、在哪里可以找到清单，以及软件包和组件具有哪些依赖项：

fuchsia_component("component") {
  component_name = "hello-world-session"
  manifest = "meta/hello-world-session.cml"
  deps = [ ":bin" ]
}

fuchsia_package("hello-world-session") {
  deps = [ ":component" ]
}

确定会话网址

session_manager 需要知道在启动时启动哪个会话组件，并通过提供会话的组件网址进行配置。

组件网址采用以下格式：

fuchsia-pkg://fuchsia.com/package_name#meta/component_name.cm

请注意，该路径指向 .cm 文件。.cm 文件是运行 fx build 时生成的 .cml 文件的编译版本。因此，在这种情况下，组件网址为：

fuchsia-pkg://fuchsia.com/hello-world-session#meta/hello-world-session.cm

构建会话

如需构建会话，必须先使用 fx set 来配置构建，以将 session_manager、您的会话组件和会话配置包含在基本软件包集中。这通过使用 --with-base 标志来完成。还必须使用 --args 标志配置会话网址。

fx set core.x64 \
    --with-base //src/session/bin/session_manager \
    --with-base //path/to/your/session \
    --args=product_config.session_url = "fuchsia-pkg://fuchsia.com/<var>package_name</var>#meta/<var>component_name</var>.cm"

如果您使用的是 //src/session/examples 目录中的示例项目，则 fx set 命令为：

fx set core.x64 \
    --with-base //src/session/bin/session_manager \
    --with-base //src/session/examples/hello-world-session \
    --args=product_config.session_url = "fuchsia-pkg://fuchsia.com/hello-world-session#meta/hello-world-session.cm"

完成此操作并构建 session_manager 后，系统应该会在启动时自动启动您的会话。您应该会在系统日志中看到“Hello”消息。

$ ffx log --filter hello
[session_manager] INFO: Launching session: fuchsia-pkg://fuchsia.com/hello-world-session#meta/hello-world-session.cm
[hello_world_session] INFO: Hello World!