Android Studio render-compose-preview

在 Android Studio 中渲染 Compose 预览。

用法

android studio render-compose-preview [-h] [--output-image-file=PARAM] [--pid=PARAM] [--print-semantics] [--project=PARAM] <path> <composable>

选项

  • -h,--help - 显示指定命令的帮助消息。
  • --output-image-file=PARAM - 要将生成的图片写入到的文件名。
  • --pid=PARAM - 要连接的 Android Studio 实例的 PID。
  • --print-semantics - 如果为 true，则输出语义树。
  • --project=PARAM - 要查询的在 Android Studio 中打开的项目的名称或路径。使用 android studio check 获取可用项目的名称。

android 个选项：

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

位置参数

  • <path> - 包含 Compose 预览的文件路径，可以是相对于当前目录的路径，也可以是绝对路径。
  • <composable> - 可组合项的名称。

说明

android studio render-compose-preview 使用 Android Studio 的布局渲染引擎渲染 Jetpack Compose @Preview 函数，并可选择性地打印其无障碍语义树。

需要 Android Studio Quail 2 或更高版本。

配置预览输出（--output-image-file 和 --print-semantics）

  • --output-image-file：将渲染的 PNG 预览保存到指定的文件路径。如果省略，则会创建临时 PNG 文件。
  • --print-semantics：以 JSON 格式打印 Compose 预览版的无障碍功能语义树，以便 AI 代理可以检查交互式节点、文本和边界以及渲染的视觉图像。

示例

将 HotelDetailScreenPreview 渲染为 preview_hotel.png 并打印其语义树：

android studio render-compose-preview \
  --output-image-file=preview_hotel.png \
  --print-semantics \
  app/src/main/java/com/example/myapp/ui/DetailScreen.kt \
  HotelDetailScreenPreview