android preview render

构建目标,并将其 Jetpack Compose @Preview 函数渲染为 PNG 图片和可选的组件树 JSON 文件。

用法

android preview render [-h] [--component-tree] [--daemon] [--format=PARAM] [--fqn=PARAM] [--no-image] [--output=PARAM] [<reference>] [-- <build_args>]

选项

  • --component-tree - 将组件树(边界、组件名称、源代码位置、语义、参数和修饰符)保存到配套的 JSON 文件中。
  • --daemon - 将预览渲染程序作为持久性后台守护程序运行(在闲置 10 分钟后关闭)。
  • -f,--format=PARAM - 输出格式(“text”或“json”;默认:“text”)。
  • --fqn=PARAM - 要渲染的预览的完全限定名称。可以多次指定。
  • -h,--help - 显示指定命令的帮助消息。
  • --no-image - 跳过渲染预览图片(需要 --component-tree)。
  • -o,--output=PARAM - 用于写入渲染预览输出的目录或路径(默认为临时目录)。

android 个选项:

  • --sdk=PARAM - Android SDK 的路径。
  • -v,--verbose - 启用详细输出以进行问题排查。
  • -V,--version - 输出版本信息并退出。

位置参数

  • <reference> - 构建参考 ([system://][path]?[target])。
  • -- <build_args> - 逐字传递给构建系统的参数。使用 -- 与其他参数分隔。

说明

android preview render 会编译目标并在屏幕外(默认情况下,编译到临时目录,或编译到 --output 指定的路径)渲染 Jetpack Compose @Preview 函数,并将生成的 PNG 图片和可选组件树 JSON 文件的绝对路径输出到标准输出。

传递 build 引用 ([system://][path]?[target]) 以选择要构建的工作区和目标,或省略 <reference> 以使用当前工作区中的默认目标。

过滤和配置预览输出

  • --fqn:指定要渲染的 @Preview 函数的完全限定名称(例如 com.example.app.HomeScreenKt.HomeScreenPreview)。至少需要一个 --fqn;重复 --fqn 可在单次构建中渲染多个预览,或运行 android preview list 可发现可用的预览。
  • -o, --output:写入渲染预览输出的目录或路径(.png 或 .json)(默认为临时目录)。
  • --daemon:使预览渲染程序作为后台守护程序运行,在闲置 10 分钟后关闭,从而加快后续渲染速度。
  • --component-tree:写入一个配套 JSON 文件,其中包含渲染的组件层次结构、边界、来源位置、语义、参数和修饰符。
  • --no-image:如果只需要 --component-tree JSON 输出,则跳过 PNG 图片生成。
  • -f, --format:选择 text(默认)或结构化 json 输出。

示例

在当前 Gradle 工作区中渲染 :app 中的特定 @Preview 函数:

android preview render :app --fqn=com.example.app.HomeScreenKt.HomeScreenPreview

使用后台守护程序渲染多个 @Preview 函数并导出其组件树:

android preview render :app \
  --daemon \
  --component-tree \
  --fqn=com.example.app.HomeScreenKt.HomeScreenPreview \
  --fqn=com.example.app.SettingsScreenKt.SettingsPreview