会话是 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
中的以下代码行:
该文件首先会根据需要添加其他 cml 文件。
include: [ "inspect/client.shard.cml", "syslog/client.shard.cml", ],
借助此
include
键,会话组件可以使用fuchsia.logger.LogSink
功能,以便将内容输出到系统日志。接下来是
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 运行程序运行组件二进制文件。最后,组件清单描述了组件可以执行的其他功能。
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
构建会话
如需构建会话,必须先使用 //local/BUILD.gn
替换汇编配置值,以便将 session_manager
、会话组件和会话配置包含在基本软件包集中。这可以使用 assembly_developer_overrides
模板完成。
import("//build/assembly/developer_overrides.gni")
assembly_developer_overrides("custom_session") {
base_packages = [
"//path/to/your/session"
]
platform = {
session = {
enabled = true
}
}
product = {
session = {
url = "fuchsia-pkg://fuchsia.com/pkg-name#meta/your_session.cm"
}
}
}
然后,必须使用 fx set
命令将自定义会话配置添加到 build 中。
fx set minimal.x64 --assembly-override=//local:<var>custom_session</var>
如果您使用的是 //src/session/examples
目录中的示例项目,assembly_developer_overrides
将为:
assembly_developer_overrides("hello-world-session") {
platform = {
session = {
enabled = true
}
}
product = {
session = {
url = "fuchsia-pkg://fuchsia.com/hello-world-session#meta/hello-world-session.cm"
}
}
}
并在 fx set
参数中添加 build 目标:
fx set minimal.x64 --assembly-override=//local:hello-world-session
完成并构建后,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!