Widget 使用入门

前提条件和设置

在开始之前，请确保您的环境满足以下要求。

运行时要求

Wear Widget 需要目标设备上安装 com.google.android.wearable.protolayout.renderer APK 的版本为 1.6.1 或更高版本。

您可以通过以下任一方式获取兼容版本的渲染器：

  • Wear OS 7 模拟器：使用 Wear OS 7 模拟器映像。不适合低于 7 的版本。如需查看设置说明，请参阅设置 Wear OS 7 模拟器。
  • 实体设备：使用可从 Google Play 商店接收自动更新的实体 Wear OS 设备，或已登录 Google Play 商店的开发者设备。

如需查看设备上安装的版本，请使用以下命令：

adb shell dumpsys package com.google.android.wearable.protolayout.renderer | \
  grep -m 1 versionName | \
  awk -F= '{print $2}'

Gradle 配置

Wear Widget 库可在 Google Maven 上获取。

1. 配置 SDK 版本

确保将 compileSdk 和 targetSdk 设置为 37 或更高版本。

android {
    compileSdk = 37
    // ...
    defaultConfig {
        targetSdk = 37
        // ...
    }
}

2. 添加依赖项

在应用的 build.gradle.kts 文件中添加以下依赖项：

Groovy

dependencies {
    // Core Wear Widget and Remote Compose libraries
    implementation "androidx.compose.remote:remote-creation-compose:1.0.0-alpha010"
    implementation "androidx.compose.remote:remote-core:1.0.0-alpha010"
    implementation "androidx.glance.wear:wear:1.0.0-alpha09"
    implementation "androidx.glance.wear:wear-core:1.0.0-alpha09"
    implementation "androidx.wear.compose.remote:remote-material3:1.0.0-alpha03"

    // Tooling for previews (optional, but recommended)
    implementation "androidx.compose.remote:remote-tooling-preview:1.0.0-alpha010"
    implementation "androidx.wear.compose:compose-ui-tooling:1.6.1"
    implementation "androidx.wear.tiles:tiles-tooling-preview:1.6.0"
    debugImplementation "androidx.wear.tiles:tiles-renderer:1.6.0"
}

Kotlin

dependencies {
    // Core Wear Widget and Remote Compose libraries
    implementation("androidx.compose.remote:remote-creation-compose:1.0.0-alpha010")
    implementation("androidx.compose.remote:remote-core:1.0.0-alpha010")
    implementation("androidx.glance.wear:wear:1.0.0-alpha09")
    implementation("androidx.glance.wear:wear-core:1.0.0-alpha09")
    implementation("androidx.wear.compose.remote:remote-material3:1.0.0-alpha03")

    // Tooling for previews (optional, but recommended)
    implementation("androidx.compose.remote:remote-tooling-preview:1.0.0-alpha010")
    implementation("androidx.wear.compose:compose-ui-tooling:1.6.1")
    implementation("androidx.wear.tiles:tiles-tooling-preview:1.6.0")
    debugImplementation("androidx.wear.tiles:tiles-renderer:1.6.0")
}

构建 Hello World widget

Wear Widget 由扩展 GlanceWearWidgetService 的服务和扩展 GlanceWearWidget 的 widget 类组成。界面使用 @RemoteComposable 函数定义。@RemoteComposable 个函数。

定义服务

该服务是系统绑定的入口点。

如需定义 widget，请创建扩展 GlanceWearWidgetService 的服务。 由于此库正处于积极开发阶段，因此在最终名称和结构完善期间，某些 API 会受到限制。使用 @SuppressLint("RestrictedApi") 注释可告知编译器您有意使用这些正在不断发展的新功能。此要求是临时性的，将在未来稳定版中最终确定 API 后移除。

@SuppressLint("RestrictedApi")
class HelloWidgetService : GlanceWearWidgetService() {
    override val widget: GlanceWearWidget = HelloWidget()
}

定义 widget

widget 类提供 widget 的数据和布局。

@SuppressLint("RestrictedApi")
class HelloWidget : GlanceWearWidget() {
    override suspend fun provideWidgetData(
        context: Context,
        params: WearWidgetParams,
    ): WearWidgetData {
        return WearWidgetDocument(background = WearWidgetBrush.color(Color.Blue.rc)) {
            HelloWidgetContent()
        }
    }
}

定义内容

内容是使用远程 Compose 组件构建的。

@SuppressLint("RestrictedApi")
@RemoteComposable @Composable
fun HelloWidgetContent() {
    RemoteBox(
        modifier = RemoteModifier.fillMaxSize(),
        contentAlignment = RemoteAlignment.Center,
    ) {
        RemoteText(
            text = "Hello World",
            color = Color.White.rc
        )
    }
}

创建微件配置 XML

创建新文件 res/xml/hello_widget_info.xml 以定义 widget 的属性和支持的大小。如需查看 <wearwidget-provider> 标记中支持的 XML 属性的完整参考信息，请参阅 WearWidgetProviderInfo 文档。

<wearwidget-provider
    description="@string/hello_widget_description"
    icon="@mipmap/ic_launcher"
    label="@string/hello_widget_label"
    preferredType="SMALL">

    <container
        type="SMALL"
        previewImage="@drawable/widget_preview_small" />
    <container
        type="LARGE"
        previewImage="@drawable/widget_preview_large" />
</wearwidget-provider>

在 AndroidManifest.xml 中注册

在 AndroidManifest.xml 中注册服务，并提供所需的 intent 过滤器和元数据。

<service
    android:name=".snippets.widget.HelloWidgetService"
    android:exported="true"
    android:icon="@mipmap/ic_launcher"
    android:label="@string/hello_widget_label"
    android:permission="com.google.android.wearable.permission.BIND_TILE_PROVIDER">

    <intent-filter>
        <action android:name="androidx.glance.wear.action.BIND_WIDGET_PROVIDER" />
        <!-- If you already have a Tile, omit the following line. -->
        <action android:name="androidx.wear.tiles.action.BIND_TILE_PROVIDER" />
    </intent-filter>

    <meta-data
        android:name="androidx.glance.wear.widget.provider"
        android:resource="@xml/hello_widget_info" />

    <meta-data
        android:name="androidx.wear.tiles.PREVIEW"
        android:resource="@drawable/tile_preview" />
</service>

构建和部署

定义服务和 widget 后，您可以构建项目并将其部署到设备或模拟器。

构建和安装

构建项目并将调试 APK 安装到已连接的设备或模拟器上：

./gradlew :app:installDebug

添加并预览微件

安装应用后，使用 adb 以程序化方式将微件添加到轮播界面，并在屏幕上显示。

注意：Wear widget 使用底层功能块基础架构进行调试。因此，adb 命令需要 add-tile 和 show-tile 操作。

1. 将 widget 添加到轮播界面：

adb shell am broadcast \
  -a com.google.android.wearable.app.DEBUG_SURFACE \
  --es operation add-tile \
  --ecn component <your_package_name>/.HelloWidgetService

2. 显示 widget：

adb shell am broadcast \
  -a com.google.android.wearable.app.DEBUG_SYSUI \
  --es operation show-tile \
  --ei index 0

Android Studio 预览版还可帮助您测试布局在不同屏幕尺寸下的效果。