迭代代码开发

作为移动开发者,您通常需要逐步开发应用界面,而不是一次性开发所有内容。Android Studio 通过提供无需完整 build 即可检查、修改值和验证最终结果的工具,支持在 Jetpack Compose 中采用这种方法。

实时编辑

借助实时编辑功能,您可以实时更新模拟器和实体设备中的可组合项。此功能可最大限度地减少编写应用与构建应用之间的上下文切换,从而减少中断,让您有更多时间专注于代码编写。

实时编辑有两种模式:

  • 手动:当您使用 Ctrl+S(在 macOS 中,使用 Command+S)手动保存代码时,系统会应用代码更改。
  • 自动:当您更新可组合函数时,所做更改会应用到设备或模拟器中。

实时编辑侧重于界面和用户体验方面的代码更改,而不支持进行方法签名更新、新方法添加或类层次结构变更等方面的更改。如需了解详情,请参阅实时编辑的限制列表。

此功能不能代替构建和运行应用或 Apply Changes,而旨在优化 Compose 界面开发过程中的构建、部署和迭代工作流程。

最佳实践工作流程如下:

  1. 设置应用,使其能够运行。
  2. 尽可能多地进行实时编辑,直到您需要进行实时编辑功能不支持的更改,例如,在应用运行时添加新方法。
  3. 进行不受支持的更改后,点击 Run 图标 “Run”图标 以重启应用并恢复实时编辑。

图 3. 在自动模式下,每次进行实时编辑功能支持的修改时,设备或模拟器上正在运行的应用都会实时更新。

开始使用实时编辑功能

如需开始使用,请按照以下步骤创建空的 Compose activity,为项目启用实时编辑功能,并使用实时编辑功能进行更改。

设置新项目

  1. 在开始之前,请确保您已安装 Android Studio Giraffe 或更高版本,并且实体设备或模拟器的 API 级别不低于 30。

  2. 打开 Android Studio,然后在 Welcome to Android Studio 对话框中选择 New Project。如果已经打开了一个项目,则可以依次转到 File > New > New Project 来创建一个新项目。

  3. 对于 Phone and Tablet,选择 Empty Compose Activity 模板,然后点击 Next

    Android Studio 中的模板选择 图 4. 可供选择的模板。为实时编辑选择 Empty Compose Activity

  4. 使用所需信息填写 New Project 对话框,其中包含名称、软件包名称、保存位置、最低 SDK 和 build 配置语言。

    第 4 步中在 AS 中输入的项目设置示例 图 5. 项目设置示例。

  5. 点击 Finish

启用实时编辑功能

  1. 前往设置以启用实时编辑功能。

    • 在 Windows 或 Linux 上,依次前往 File > Settings > Editor > Live Edit
    • 在 macOS 上,依次前往 Android Studio > Settings > Editor > Live Edit
  2. 从设置中选择 Live Edit 选项和要运行的模式。

    在手动模式下,您的代码更改会在您每次使用 Ctrl + S(在 macOS 上,则使用 Command+S)手动保存时应用。在自动模式下,所做的代码更改会即时应用到设备或模拟器中。

    Android Studio 设置中的“Live Edit”复选框界面 图 6. 实时编辑设置。

  3. 在编辑器中,打开 MainActivity 文件,这是应用的入口点。

  4. 点击 Run 图标 界面按钮 以部署应用。

  5. 开启实时编辑功能后,Running Devices 工具窗口的右上角会显示 Up-to-date 绿色对勾标记:

    实时编辑功能的绿色对勾标记界面

进行更改并查看更改效果

当您在编辑器中做出支持的更改时,虚拟或实体测试设备会自动更新。

例如,将 MainActivity 中的现有 Greeting 方法修改为以下代码:

@Composable
fun Greeting(name: String) {
    Text(
        text = "Hello $name!",
        Modifier
            .padding(80.dp) // Outer padding; outside background
            .background(color = Color.Cyan) // Solid element background color
            .padding(16.dp) // Inner padding; inside background, around text)
    )
}

您所做的更改会立即显示在测试设备上,如图 7 所示。

对应用于设备的 Greeting 方法的更改

图 7. 一台测试设备,其中显示了对 Greeting 方法的实时编辑更改。

排查实时编辑问题

如果在测试设备上没有看到修改效果,则说明 Android Studio 可能未能更新您的修改。请检查实时编辑指示器是否显示 Out Of Date(如图 8 所示),这表示发生了编译错误。如需了解有关错误的信息以及有关如何解决该错误的建议,请点击指示器。

实时编辑已过期图标

图 8. 实时编辑状态指示器。

实时编辑功能的限制

以下是现有限制的列表。

  • [仅适用于 Android Studio Giraffe 及更高版本] 实时编辑需要 Compose Runtime 1.3.0 或更高版本。如果您的项目使用较低版本的 Compose,系统会停用实时编辑功能。

  • [仅适用于 Android Studio Giraffe 及更高版本] 实时编辑功能需要 AGP 8.1 或更高版本。如果您的项目使用较低版本的 AGP,系统会停用实时编辑功能。

  • 实时编辑功能要求实体设备或模拟器搭载 API 级别为 30 或更高版本。

  • 实时编辑功能仅支持修改函数正文,也就是说,您无法进行下列操作:更改函数名称或签名、添加或移除函数、更改非函数字段。

  • 当您首次在文件中更改 Compose 函数时,实时编辑功能会重置应用的状态。这仅在第一次代码更改后发生,应用状态不会因您对该文件中的 Compose 函数进行的后续代码更改而重置。

  • 使用实时编辑功能修改过的类可能会导致性能下降。如果要评估应用的性能,请使用干净的发布 build 运行应用。

  • 您必须执行完整的运行,以便调试程序在使用实时编辑修改过的类上运行。

  • 使用实时编辑修改正在运行的应用,可能会导致应用崩溃。如果发生这种情况,可以使用 Run 按钮 界面按钮 重新部署应用。

  • 实时编辑不会执行项目 build 文件中定义的任何字节码处理,例如,使用 Build 菜单中的选项或点击 BuildRun 按钮构建项目时要应用的字节码处理。

  • 非可组合函数会在设备或模拟器上实时更新,并且会触发完全重组。完全重组可能不会调用更新后的函数。对于非可组合函数,您必须触发新更新的函数或再次运行应用。

  • 应用重启后,实时编辑不会自动恢复。您必须再次运行应用。

  • 实时编辑功能仅支持可调试的进程。

  • 实时编辑不支持在 build 配置中的 kotlinOptions 下为 moduleName 使用自定义值的项目。

  • 实时编辑功能不适用于多部署部署。这意味着,您不能先部署到一台设备,然后再部署到另一个设备。实时编辑功能仅在应用部署到的最后一组设备上有效。

  • 实时编辑功能支持多设备部署(部署到通过目标设备下拉菜单中的 Select multiple devices 创建的多台设备)。不过,该功能并非官方支持的功能,因此可能会出现问题。如果您遇到问题,请报告

关于实时编辑功能的常见问题解答

  • 实时编辑功能目前处于什么状态?

    Android Studio Giraffe 中支持实时编辑。如需开启此功能,请依次前往 File > Settings > Editor > Live Edit(在 macOS 中,依次选择 Android Studio > Settings > Editor > Live Edit)。

  • 何时应使用实时编辑功能?

    如果您想快速查看用户体验元素更新(例如,修饰符更新和动画更新)对整体应用体验的影响,就可以使用实时编辑功能。

  • 何时应避免使用实时编辑功能?

    实时编辑侧重于界面和用户体验方面的代码更改,而不支持进行方法签名更新、新方法添加或类层次结构变更等方面的更改。如需了解详情,请参阅实时编辑的限制

  • 何时应使用 Compose 预览?

    开发单个可组合项时,请使用 Compose 预览。预览会直观呈现 Compose 元素,并会自动刷新以显示代码更改的效果。预览还支持在不同的配置和状态(例如深色主题、语言区域和字体大小)下查看界面元素。

实时编辑字面量(已废弃)

Android Studio 可以实时更新在预览、模拟器和实体设备中的可组合项中使用的一些常量字面量。下面是一些受支持的类型:

  • Int
  • String
  • Color
  • Dp
  • Boolean

用户在源代码中更改字面量并且预览动态更新的视频

通过“实时编辑字面量”界面指示器启用字面量装饰,您无需执行编译步骤即可查看触发实时更新的常量字面量:

启用文字的实时编辑

Apply Changes

借助 Apply Changes,您可以更新代码和资源,而无需将应用重新部署到模拟器或实体设备(存在一些限制)。

每当添加、修改或删除可组合项时,您都可以通过点击 Apply Code Changes 按钮来更新应用,而无需重新部署应用:

用户点击“应用更改”按钮