使用 Glance 创建应用 widget

以下部分介绍了如何使用 Glance 创建简单的应用微件。

要点 ：Glance 提供了一种使用 Compose 构建应用微件的现代方法，但受到 AppWidgets 和 RemoteViews 限制。因此，Glance 使用与 Jetpack Compose 界面不同的可组合项。

在清单中声明 AppWidget

完成设置步骤后，在应用中声明 AppWidget 及其元数据。

1. 从 GlanceAppWidgetReceiver 扩展 AppWidget 接收器：

   class MyAppWidgetReceiver : GlanceAppWidgetReceiver() {
       override val glanceAppWidget: GlanceAppWidget = TODO("Create GlanceAppWidget")
   }
   GlanceSnippets.kt

2. 在 AndroidManifest.xml 文件和关联的元数据文件中注册应用微件的提供方：

       <receiver android:name=".glance.MyReceiver"
       android:exported="true">
       <intent-filter>
           <action android:name="android.appwidget.action.APPWIDGET_UPDATE" />
       </intent-filter>
       <meta-data
           android:name="android.appwidget.provider"
           android:resource="@xml/my_app_widget_info" />
   </receiver>
   AndroidManifest.xml
   

添加 AppWidgetProviderInfo 元数据

接下来，按照创建简单 widget 指南在 @xml/my_app_widget_info 文件中创建和定义应用 widget 信息。

对于 Glance，唯一的区别是没有 initialLayout XML，但您必须定义一个。您可以使用库中提供的预定义加载布局：

<appwidget-provider xmlns:android="http://schemas.android.com/apk/res/android"
    android:initialLayout="@layout/glance_default_loading_layout">
</appwidget-provider>
my_app_widget_info.xml

定义 GlanceAppWidget

1. 创建一个从 GlanceAppWidget 扩展并替换 provideGlance 方法的新类。您可以通过此方法加载呈现 widget 所需的数据：

   注意： provideGlance 在主线程上运行。如需在 provideGlance 中执行任何长时间运行的操作，请使用 withContext 切换到另一个线程。如需详细了解如何在主线程之外运行，请参阅使用协程确保主线程安全。

   class MyAppWidget : GlanceAppWidget() {
   
       override suspend fun provideGlance(context: Context, id: GlanceId) {
   
           // In this method, load data needed to render the AppWidget.
           // Use `withContext` to switch to another thread for long running
           // operations.
   
           provideContent {
               // create your AppWidget here
               Text("Hello World")
           }
       }
   }
   GlanceSnippets.kt

2. 在 GlanceAppWidgetReceiver 上的 glanceAppWidget 中将其实例化：

   class MyAppWidgetReceiver : GlanceAppWidgetReceiver() {
   
       // Let MyAppWidgetReceiver know which GlanceAppWidget to use
       override val glanceAppWidget: GlanceAppWidget = MyAppWidget()
   }
   GlanceSnippets.kt

现在，您已使用 Glance 配置了 AppWidget。

创建界面

以下代码段演示了如何创建界面：

/* Import Glance Composables
 In the event there is a name clash with the Compose classes of the same name,
 you may rename the imports per https://kotlinlang.org/docs/packages.html#imports
 using the `as` keyword.

import androidx.glance.Button
import androidx.glance.layout.Column
import androidx.glance.layout.Row
import androidx.glance.text.Text
*/
class MyAppWidget : GlanceAppWidget() {

    override suspend fun provideGlance(context: Context, id: GlanceId) {
        // Load data needed to render the AppWidget.
        // Use `withContext` to switch to another thread for long running
        // operations.

        provideContent {
            // create your AppWidget here
            MyContent()
        }
    }

    @Composable
    private fun MyContent() {
        Column(
            modifier = GlanceModifier.fillMaxSize(),
            verticalAlignment = Alignment.Top,
            horizontalAlignment = Alignment.CenterHorizontally
        ) {
            Text(text = "Where to?", modifier = GlanceModifier.padding(12.dp))
            Row(horizontalAlignment = Alignment.CenterHorizontally) {
                Button(
                    text = "Home",
                    onClick = actionStartActivity<MyActivity>()
                )
                Button(
                    text = "Work",
                    onClick = actionStartActivity<MyActivity>()
                )
            }
        }
    }
}
GlanceSnippets.kt

上述代码示例会执行以下操作：

• 在顶级 Column 中，项会垂直排列。
• Column 会扩大其大小以匹配可用空间（通过 GlanceModifier），并将其内容对齐到顶部 (verticalAlignment) 并水平居中 (horizontalAlignment)。
• Column 的内容使用 lambda 定义。顺序很重要。
  • Column 中的第一个项是一个 Text 组件，内边距为 12.dp。
  • 第二个项是 Row，其中项水平排列，两个 Buttons 水平居中显示 (horizontalAlignment)。最终显示取决于可用空间。以下图片展示了此类问题的示例：

图 1. 界面示例。

您可以更改对齐值或应用不同的修饰符值（例如内边距），以更改组件的放置和大小。如需查看每个类的组件、参数和可用修饰符的完整列表，请参阅参考文档。