组件配置机制

组件配置页面介绍了如何在 Fuchsia 上配置组件,并介绍了需要组件配置的不同情况。

本页面介绍了 Fuchsia 提供的不同配置机制,讨论了它们的优缺点,并就哪种机制在何种情况下使用提供了指导。

结构化配置

结构化配置是组件框架提供的一种现代、符合人体工程学且灵活的配置系统。结构化配置与许多 Fuchsia 工具(包括 ffx、inspect 和产品组装)集成,在大多数情况下,它应该是您的首选。

组件开发者通过在组件清单中定义配置键来使用结构化配置,每个配置键都有一个名称和数据类型。系统保证在组件启动时为所有这些配置键提供值。系统会自动生成库,以便在运行时轻松读取配置值。组件无需关心系统的哪个部分提供了结构化配置值,也无需处理缺失的配置。

结构化配置值可以通过一系列不同的路径提供,例如:

  • 打包构建规则。由 build 规则设置的配置值包含在与组件相同的软件包中。配置在构建时固定,因此可以在发布签名期间进行验证。
  • Realm 构建器。Realm 构建器集成让测试可以轻松设置配置值。两个主要应用场景是验证可配置的行为,以及更改配置以提高可测试性。
  • 产品组装。通过产品组装,平台可以定义由产品提供值的配置键。产品集成商在其产品配置中提供值,这些值会内置到组件软件包中,以便在发布签名期间进行验证。
  • 开发替换。借助此 ffx 工具,开发者可以在工程 build 上更改运行时配置,例如使用预发布功能。

RFC-0127 介绍了指定结构化配置值的其他几种方法,但这些方法尚未构建,有待近期用例。如果您的用例需要其中任何功能,请在下面链接的跟踪 bug 中发表评论:

  • Vbmeta (https://fxbug.dev/42178359). 这样,您就可以在不构建新映像的情况下,为版本修改已签名的配置。
  • 父级组件 (https://fxbug.dev/42178351)。这样,组件就可以在创建动态集合中的子级时为其指定配置。这需要两个组件之间的配置定义保持一致,因此可能仅在同一映像或软件包中的组件之间受支持。
  • 设备群和企业管理 (https://fxbug.dev/42055769)。这样,结构化配置便可用于增量发布、运行 A/B 实验和强制执行企业政策,类似于其他大型平台中的实验系统。

组件的结构化配置定义是该组件的本地定义。 没有全局“配置版本”,系统不保证组件版本之间的向前或向后兼容性,兼容性由组件开发者负责。因此,结构化配置目前不适合作为可能针对不同配置版本构建的组件之间的通信方式。

结构化配置非常灵活,适用于大多数情况,但对于某些配置问题,结构化配置并不是最佳解决方案:

  • 配置值必须在大量不同的组件中保持一致。 结构化配置键在组件的清单中本地定义。产品组装可用于在几个不同的组件中设置一致的配置值,但这会带来可维护性挑战,并且无法很好地扩缩。如果配置值必须在大量不同组件之间保持一致,则基于软件包的配置或基于服务的配置是更好的解决方案。
  • 大型配置。当配置变得非常大(例如超过几千字节)时,结构化配置提供的用于设置和查看配置值的工具会变得不方便。结构化配置的实现不会优先考虑高效处理大值。基于软件包的配置是适用于大型配置数据的更好解决方案。
  • 在运行时频繁更改的配置。组件在启动时会收到其结构化配置值,这意味着必须重启组件实例才能获取新配置。 对于必须在运行时频繁更改的配置,基于服务的配置是更好的解决方案。
  • 由最终用户设置的配置。与开发者不同,最终用户需要一个界面来控制配置。此界面意味着界面组件、正在配置的组件和本地化数据库都需要就配置的定义达成一致,因此必须在某个版本化工件中集中定义配置。基于服务的配置配置是更适合由最终用户控制的配置的解决方案。

基于软件包的配置

基于软件包的配置支持在发布时固定的配置数据,方法是将数据文件构建到 软件包 中,并让组件读取这些文件。同一软件包可以路由到多个不同的组件,并且配置文件可以任意大。

基于软件包的配置通常不如结构化配置符合人体工程学;必须手动打开和解析文件,组件可能需要处理缺失或格式错误的配置,并且无法与标准工具集成来测试、调试或内省配置。

基于软件包的配置不适用于以下问题:

  • 需要在运行时更改配置。在上述跟踪 bug 中发表评论,以在结构化配置中支持动态配置,和/或改用基于服务的配置。

基于软件包的配置有三种不同的变体,具体取决于使用哪个软件包来存储配置:

全局(也称为“config_data”)软件包配置

单个全局 config_data 软件包包含许多不同组件的配置数据。每个组件的数据都是使用“config_data”构建规则添加的。此全局软件包是在 CFv1 中使用基于软件包的配置的唯一方法,但在 CFv2 中,由于必须通过组件拓扑手动路由 config-data 目录,因此这种方法不灵活且繁琐。

config_data 的用户应迁移到结构化配置或网域/软件包内配置,这两种配置都更符合人体工程学,也更灵活。

网域软件包配置

网域中组件的开发者可以定义自己的配置数据包,并将其目录路由到他们控制的组件。与全局软件包配置不同,此机制可跨不同的构建系统和 petal 使用。

软件包内配置

配置文件也可以放置在与其配置的组件相同的软件包中。这样可以确保配置将与组件一起分发,并且不需要复杂且脆弱的路由。不过,这也意味着,如果不重新打包组件,就无法更改配置。如需了解详情,请参阅向组件提供数据文件指南。

软件包内容存储在 blobfs 中,这是一个对 blob 进行去重的内容寻址文件系统。这意味着,如果多个软件包包含相同的配置 blob,则系统只会存储一个副本。

基于服务的配置

Fuchsia 组件可以编写为通过 FIDL 收集、维护和分发网域的配置数据。一个很好的例子是 Fuchsia 平台的设置服务,该服务会维护各种用户设置(例如语言区域):设置服务会在电源循环期间维护这些用户设置的状态,并公开 fuchsia.settings FIDL 协议,其他组件可以使用这些协议来读取当前配置数据或请求更改配置数据。

基于服务的配置非常灵活且功能强大,但引入服务器组件通常比其他选项需要更多工作,并且会产生更高的运行时费用。只有当这项额外费用能带来价值时,才应使用基于服务的配置。

该组件可能会使用多个不同的输入来确定正确的配置。例如:用于验证和合并客户端请求的业务逻辑、从某个服务器收集的设置,或通过其他机制(例如结构化配置)提供的默认配置值。如果必须在各种客户端之间共享配置,则基于服务的配置非常有效,因为配置是由用于提供配置的 FIDL 接口正式定义和版本化的。当配置可能频繁更改时,基于服务的配置也能很好地发挥作用。

基于服务的配置不适用于以下问题:

  • 大型配置。配置通过 FIDL 消息传递,这些消息受 Zircon 通道写入大小的限制。虽然 FIDL 协议可以通过将配置拆分为多个块或发送 VMO 来解决此问题,但这会损害客户端的简单性和明确定义,而这正是基于服务的配置的优势。 处理大型配置时,基于软件包的配置是更好的解决方案。