此页面由 Cloud Translation API 翻译。

使用可组合项预览来预览界面

可组合项由函数定义，并使用 @Composable 进行注解：

@Composable
fun SimpleComposable() {
    Text("Hello World")
}AndroidStudioComposeSnippets.kt

包含“Hello World”字样的简单文本元素

如需启用此可组合项的预览，请再创建一个使用 @Composable 和 @Preview 注解的可组合项。这个带注解的新可组合项现在包含您最初创建的可组合项 SimpleComposable：

@Preview
@Composable
fun SimpleComposablePreview() {
    SimpleComposable()
}AndroidStudioComposeSnippets.kt

@Preview 注解可告知 Android Studio 此可组合项应显示在此文件的设计视图中。在进行修改时，您可以看到可组合项预览的实时更新。

显示使用 Compose 预览进行实时更新的 GIF 图片

您可以在代码中手动添加参数，以自定义 Android Studio 呈现 @Preview 的方式。您甚至可以向同一函数多次添加 @Preview 注解，以预览具有不同属性的可组合项。

使用 @Preview 可组合项的一个主要好处是可以避免依赖于 Android Studio 中的模拟器。您可以省下占用大量内存的模拟器启动过程，以便进行更多最终的外观和风格更改，并使 @Preview 能够轻松进行和测试细微的代码更改。

为了最有效地利用 @Preview 注解，请务必根据接收的输入状态及其输出的事件来定义屏幕。

明确您的`@Preview`

Android Studio 提供了一些功能来扩展可组合项预览。您可以更改其容器设计，与之互动，或直接将其部署到模拟器或设备。

尺寸

默认情况下，系统会自动选择 @Preview 尺寸来封装其内容。若要手动设置尺寸，请添加 heightDp 和 widthDp 参数。这些值已被解释为 dp，因此您无需向其添加 .dp：

@Preview(widthDp = 50, heightDp = 50)
@Composable
fun SquareComposablePreview() {
    Box(Modifier.background(Color.Yellow)) {
        Text("Hello World")
    }
}AndroidStudioComposeSnippets.kt

包含“Hello World”字样的黄色方形

动态配色预览

如果您已在应用中启用了动态配色，请使用 wallpaper 属性切换壁纸，并查看界面对不同用户选择的壁纸有何反应。从 Wallpaper 类提供的不同壁纸主题中进行选择。此功能需要 Compose 1.4.0 或更高版本。

在不同设备上使用

在 Android Studio Flamingo 中，您可以修改 Preview 注解的 device 参数，以定义不同设备中可组合项的配置。

可组合函数示例

当设备参数包含空字符串 (@Preview(device = "")) 时，您可以按 Ctrl + Space 调用自动补全功能。然后，您可以设置每个参数的值。

修改示例函数

通过自动补全功能，您可以从列表中选择任意设备选项，例如 @Preview(device = "id:pixel_4")。或者，您也可以选择 spec:width=px,height=px,dpi=int… 来输入自定义设备，分别设置每个参数的值。

规格列表

如需应用，请按 Enter 或使用 Esc 取消。

如果您设置的值无效，则声明会带有红色下划线，并且或许可以进行修正（对于 macOS，可使用 Alt + Enter (保证 + ⏎) > 替换为 ...）。检查工具会尝试提供与输入内容最接近的修正项。

无效值示例

语言区域

如需测试不同的用户语言区域，请添加 locale 参数：

@Preview(locale = "fr-rFR")
@Composable
fun DifferentLocaleComposablePreview() {
    Text(text = stringResource(R.string.greeting))
}AndroidStudioComposeSnippets.kt

一个简单的文本元素，包含单词“Bonjour”和一面法国国旗

设置背景颜色

默认情况下，可组合项会以透明背景显示。如需添加背景，请添加 showBackground 和 backgroundColor 参数。请注意，backgroundColor 是 ARGB Long，而不是 Color 值：

@Preview(showBackground = true, backgroundColor = 0xFF00FF00)
@Composable
fun WithGreenBackground() {
    Text("Hello World")
}AndroidStudioComposeSnippets.kt

包含“Hello World”字样的绿色矩形

系统界面

如需在预览中显示状态栏和操作栏，请添加 showSystemUi 参数：

@Preview(showSystemUi = true)
@Composable
fun DecoratedComposablePreview() {
    Text("Hello World")
}AndroidStudioComposeSnippets.kt

界面模式

参数 uiMode 可接受任何 Configuration.UI_* 常量，并允许您相应地更改预览的行为。例如，您可以将预览设置为夜间模式，看看主题如何响应。

`LocalInspectionMode`

您可以从 LocalInspectionMode CompositionLocal 中读取数据，以查看可组合项是否在预览中（可检查的组件内）呈现。如果组合在预览中呈现，LocalInspectionMode.current 的求值结果为 true。您可以使用此信息自定义预览；例如，您可以在预览窗口中显示占位符图片，而不是显示真实数据。

这样，您还可以解决限制。例如，显示示例数据而不是调用网络请求。

@Composable
fun GreetingScreen(name: String) {
    if (LocalInspectionMode.current) {
        // Show this text in a preview window:
        Text("Hello preview user!")
    } else {
        // Show this text in the app:
        Text("Hello $name!")
    }
}AndroidStudioComposeSnippets.kt

与您的`@Preview`互动

Android Studio 提供了一些功能，可让您与定义的预览进行互动。此交互有助于您了解预览的运行时行为，并可让您通过预览更好地在界面中导航。

互动模式

通过互动模式，您可以与预览互动，类似于在运行程序的设备（例如手机或平板电脑）上互动。交互模式会被隔离在沙盒环境中（也就是说，与其他预览隔离开），在该模式下，您可以点击元素并在预览中输入用户输入。这是一种测试可组合项的不同状态、手势甚至动画的快捷方法。

用户点击预览的“互动”按钮

用户与预览互动的视频

代码导航和可组合项大纲

您可以将鼠标悬停在预览上，以查看其中包含的可组合项的大纲。点击可组合项大纲会触发您的编辑器视图，从而导航到其定义。

运行预览

您可以在模拟器或实体设备上运行特定的 @Preview。预览将作为新的 Activity 部署在同一项目应用中，因此它具有相同的上下文和权限。您无需编写样板代码来请求权限（如果已授予权限）。

点击 @Preview 注解旁边或预览顶部的 Run Preview 图标，Android Studio 就会将该 @Preview 部署到连接的设备或模拟器。

用户点击预览的“运行预览”按钮

用户将预览部署到设备的视频

复制 `@Preview` 呈现

通过右键点击呈现的每个预览，即可将其作为图像来复制。

用户点击预览以将其作为图片进行复制。

同一 `@Preview` 注解的多次预览

您可以展示同一 @Preview 可组合项的多个版本，这些版本采用不同的规范，也可以展示传递给可组合项的不同参数。这样，您就可以减少原本需要编写的样板代码。

Multipreview 模板

androidx.compose.ui:ui-tooling-preview 1.6.0-alpha01+ 引入了 Multipreview API 模板：@PreviewScreenSizes、@PreviewFontScales、@PreviewLightDark 和 @PreviewDynamicColors，这样一来，您只需一个注解，便可在常见场景中预览 Compose 界面。

使用模板预览不同字体和屏幕尺寸

创建自定义 Multipreview 注解

使用 Multipreview 时，您可以定义一个注解类，该类本身可具有多个采用不同配置的 @Preview 注解。将此注解添加到可组合函数后，系统会自动同时呈现所有不同的预览。例如，您可以使用此注解同时预览多个设备、字体大小或主题，而无需为每一个可组合项重复这些定义。

首先，创建您自己的自定义注解类：

@Preview(
    name = "small font",
    group = "font scales",
    fontScale = 0.5f
)
@Preview(
    name = "large font",
    group = "font scales",
    fontScale = 1.5f
)
annotation class FontScalePreviewsAndroidStudioComposeSnippets.kt

您可以对预览可组合项使用此自定义注解：

@FontScalePreviews
@Composable
fun HelloWorldPreview() {
    Text("Hello World")
}AndroidStudioComposeSnippets.kt

Android Studio 的“Design”标签页，显示了分别采用小号和大号字体的可组合项

您可以将多个 Multipreview 注解和普通预览注解结合使用，以创建一组更完整的预览。组合 Multipreview 注解并不意味着会显示所有不同的组合。实际上，每个 MultiPreview 注解会独立运行，并且仅会呈现自己的变体。

@Preview(
    name = "Spanish",
    group = "locale",
    locale = "es"
)
@FontScalePreviews
annotation class CombinedPreviews

@CombinedPreviews
@Composable
fun HelloWorldPreview2() {
    MaterialTheme { Surface { Text(stringResource(R.string.hello_world)) } }
}AndroidStudioComposeSnippets.kt

Android Studio 的“Design”标签页，其中显示了所有配置中的可组合项

多预览和普通预览的混合匹配特性可让您更全面地测试更大规模项目的许多属性。

`@Preview` 和大型数据集

在很多情况下，您需要向可组合项预览传递大型数据集。为此，只需使用 @PreviewParameter 注解添加参数，即可将示例数据传递给可组合项预览函数。

@Preview
@Composable
fun UserProfilePreview(
    @PreviewParameter(UserPreviewParameterProvider::class) user: User
) {
    UserProfile(user)
}
AndroidStudioComposeSnippets.kt

如需提供示例数据，请创建一个实现 PreviewParameterProvider 并以序列形式返回示例数据的类。

class UserPreviewParameterProvider : PreviewParameterProvider<User> {
    override val values = sequenceOf(
        User("Elise"),
        User("Frank"),
        User("Julia")
    )
}AndroidStudioComposeSnippets.kt

这将为序列中的每个数据元素呈现一个预览：

Elise、Frank 和 Julia 可组合项的预览

您可以为多个预览使用相同的提供程序类。如有必要，可通过设置 limit 参数来限制预览次数。

@Preview
@Composable
fun UserProfilePreview2(
    @PreviewParameter(UserPreviewParameterProvider::class, limit = 2) user: User
) {
    UserProfile(user)
}AndroidStudioComposeSnippets.kt

限制和最佳做法

Android Studio 直接在预览区域中执行预览代码。它不需要运行模拟器或实体设备，因为它利用了 Android 框架中一个名为 Layoutlib 的移植部分。Layoutlib 是专为在 Android 设备以外运行而设计的 Android 框架的自定义版本。该库的目标是在 Android Studio 中提供非常接近其在设备上渲染效果的布局预览。

预览限制

由于预览在 Android Studio 中的呈现方式，它们的体量很小，不需要整个 Android 框架来呈现它们。不过，这种方法存在以下限制：

无法访问网络
无法访问文件
有些 Context API 不一定完全可用

预览和`ViewModels`

在可组合项中使用 ViewModel 时，预览会受到限制。预览系统无法构建传递给 ViewModel 的所有参数，例如代码库、用例、管理器或类似参数。此外，如果您的 ViewModel 参与了依赖项注入（例如使用 Hilt），预览系统将无法构建整个依赖关系图来构造 ViewModel。

当您尝试使用 ViewModel 预览可组合项时，Android Studio 会在渲染特定的可组合项时显示错误：

Android Studio 问题窗格，显示“未能实例化“ViewModel”消息

如果您想预览使用 ViewModel 的可组合项，则应创建另一个可组合项，将 ViewModel 中的参数作为可组合项的参数传递。这样，您就无需预览使用 ViewModel 的可组合项。

@Composable
fun AuthorColumn(viewModel: AuthorViewModel = viewModel()) {
  AuthorColumn(
    name = viewModel.authorName,
    // ViewModel sends the network requests and makes posts available as a state
    posts = viewModel.posts
  )
}

@Preview
@Composable
fun AuthorScreenPreview(
  // You can use some sample data to preview your composable without the need to construct the ViewModel
  name: String = sampleAuthor.name,
  posts: List<Post> = samplePosts[sampleAuthor]
) {
  AuthorColumn(...) {
    name = NameLabel(name),
    posts = PostsList(posts)
  }
}

注解类 `@Preview`

您可以随时在 Android Studio 中通过按住 Ctrl 键或 ⌘ 键的同时点击 @Preview 注解来获取可在自定义预览时调整的完整参数列表。

annotation class Preview(
    val name: String = "",
    val group: String = "",
    @IntRange(from = 1) val apiLevel: Int = -1,
    val widthDp: Int = -1,
    val heightDp: Int = -1,
    val locale: String = "",
    @FloatRange(from = 0.01) val fontScale: Float = 1f,
    val showSystemUi: Boolean = false,
    val showBackground: Boolean = false,
    val backgroundColor: Long = 0,
    @UiMode val uiMode: Int = 0,
    @Device val device: String = Devices.DEFAULT,
    @Wallpaper val wallpaper: Int = Wallpapers.NONE,
)AndroidStudioComposeSnippets.kt

其他资源

如需详细了解 Android Studio 如何推广 @Preview 的易用性，并了解更多工具提示，请参阅 Compose 工具博客。

为您推荐

注意：当 JavaScript 处于关闭状态时，系统会显示链接文字
使用 CompositionLocal 将数据的作用域限定在局部
Compose 中的 Material Design 2
在 Compose 中使用 View

预览和调试动画