Android 桌面小组件 AppWidgetProvider

Android 桌面小组件 AppWidgetProvider

简介

小组件就是可以添加到手机桌面的窗口。点击窗口可以进入应用或者进入应用的某一个页面。

widget 组件

如需创建 widget，您需要以下基本组件：

• AppWidgetProviderInfo 对象

  描述 widget 的元数据，例如 widget 的布局、更新频率和 AppWidgetProvider 类。AppWidgetProviderInfo 是使用 XML 定义的，如本文档中所述。

• AppWidgetProvider 类

  定义可让您以编程方式与 widget 进行交互的基本方法。通过它，您可以在更新、启用、停用或删除 widget 时接收广播。您在清单中声明 AppWidgetProvider，然后实现它

主要步骤

1.声明 AppWidgetProviderInfo XML

AppWidgetProviderInfo 对象定义了 widget 的基本特性。您可以使用单个 <appwidget-provider> 元素在 XML 资源文件中定义 AppWidgetProviderInfo 对象，并将其保存在项目的 res/xml/ 文件夹中。

具体可见以下示例：

<appwidget-provider xmlns:android="http://schemas.android.com/apk/res/android"
    android:minWidth="40dp"
    android:minHeight="40dp"
    android:targetCellWidth="1"
    android:targetCellHeight="1"
    android:maxResizeWidth="250dp"
    android:maxResizeHeight="120dp"
    android:updatePeriodMillis="86400000"
    android:description="@string/example_appwidget_description"
    android:previewLayout="@layout/example_appwidget_preview"
    android:initialLayout="@layout/example_loading_appwidget"
    android:configure="com.example.android.ExampleAppWidgetConfigurationActivity"
    android:resizeMode="horizontal|vertical"
    android:widgetCategory="home_screen"
    android:widgetFeatures="reconfigurable|configuration_optional">
</appwidget-provider>

widget 大小调整属性

默认主屏幕根据已定义高度和宽度的单元格网格将 widget 放置在其窗口中。大多数主屏幕仅允许 widget 采用网格单元的整数倍的尺寸，例如水平两个单元格的尺寸，垂直方向为三个单元格。

借助 widget 大小调整属性，您可以为 widget 指定默认尺寸，并为 widget 的尺寸提供下限和上限。在此上下文中，widget 的默认大小是该 widget 首次添加到主屏幕时采用的尺寸。

下表介绍了与 widget 大小调整相关的 <appwidget-provider> 属性：

从 Android 12 开始：

使用 targetCellWidth 和 targetCellHeight 属性作为该 widget 的默认尺寸。

默认情况下，微件的大小为 2x2。该 widget 可以缩小到 2x1 或最大 4x3。

Android 11 及更低版本：

使用 minWidth 和 minHeight 属性计算 widget 的默认大小。

默认宽度 = Math.ceil(80 / 30) = 3

默认高度 = Math.ceil(80 / 50) = 2

默认情况下，微件的大小为 3x2。该 widget 可以缩小到 2x1 或最大全屏。

其他微件属性

下表介绍了与 widget 大小调整以外的质量相关的 <appwidget-provider> 属性。

组件大小的调整

2.使用 AppWidgetProvider 类处理 widget 广播

AppWidgetProvider 类会处理 widget 广播并更新 widget，以响应 widget 生命周期事件。以下部分介绍了如何在清单中声明 AppWidgetProvider，然后实现它。

2.1 在清单中声明 widget

首先，在应用的 AndroidManifest.xml 文件中声明 AppWidgetProvider 类，如以下示例所示：

<receiver android:name="ExampleAppWidgetProvider"
                 android:exported="false">
    <intent-filter>
        <action android:name="android.appwidget.action.APPWIDGET_UPDATE" />
    </intent-filter>
    <meta-data android:name="android.appwidget.provider"
               android:resource="@xml/example_appwidget_info" />
</receiver>

<receiver> 元素需要 android:name 属性，该属性指定 widget 使用的 AppWidgetProvider。不得导出该组件，除非需要一个单独的进程向您的 AppWidgetProvider 广播（通常情况并非如此）。

<intent-filter> 元素必须包含具有 android:name 属性的 <action> 元素。此属性指定 AppWidgetProvider 接受 ACTION_APPWIDGET_UPDATE 广播。这是您必须明确声明的唯一一项广播。AppWidgetManager 会根据需要自动将所有其他 widget 广播发送到 AppWidgetProvider。

<meta-data> 元素指定 AppWidgetProviderInfo 资源，并且需要以下属性：

• android:name：指定元数据名称。使用 android.appwidget.provider 将数据标识为 AppWidgetProviderInfo 描述符。
• android:resource：指定 AppWidgetProviderInfo 资源位置。

2.2 实现 AppWidgetProvider 类

AppWidgetProvider 类扩展了 BroadcastReceiver 作为处理 widget 广播的便捷类。它仅接收与 widget 相关的事件广播，例如当 widget 更新、删除、启用和停用时。当发生这些广播事件时，系统会调用以下 AppWidgetProvider 方法：

• [onUpdate()](https://developer.android.com/reference/android/appwidget/AppWidgetProvider?hl=zh-cn#onUpdate(android.content.Context, android.appwidget.AppWidgetManager, int[]))

  调用此方法可按照 AppWidgetProviderInfo 中的 updatePeriodMillis 属性定义的间隔更新 widget。如需了解详情，请参阅本页中描述其他微件属性的表。

  用户添加 widget 时也会调用此方法，因此它会执行基本的设置，例如为 View 对象定义事件处理脚本，或启动作业以加载数据以在 widget 中显示。不过，如果您声明的配置 activity 不带 configuration_optional 标志，则当用户添加 widget 时，系统不会调用此方法，但会针对后续更新调用此方法。配置 activity 应负责在配置完成后执行首次更新。如需了解详情，请参阅允许用户配置应用微件。

  最重要的回调是 onUpdate()。如需了解详情，请参阅本页中的使用 onUpdate() 类处理事件。

• [onAppWidgetOptionsChanged()](https://developer.android.com/reference/android/appwidget/AppWidgetProvider?hl=zh-cn#onAppWidgetOptionsChanged(android.content.Context, android.appwidget.AppWidgetManager, int, android.os.Bundle))

  首次放置 widget 时以及每次调整 widget 大小时，系统都会调用此方法。使用此回调可以根据 widget 的尺寸范围显示或隐藏内容。通过调用 getAppWidgetOptions() 获取尺寸范围，并且从 Android 12 开始，还可获取 widget 实例可以采用的尺寸范围列表，该方法会返回包含以下内容的 Bundle：OPTION_APPWIDGET_MIN_WIDTH：包含 widget 实例宽度的下限（以 dp 为单位）。OPTION_APPWIDGET_MIN_HEIGHT：包含 widget 实例高度的下限（以 dp 为单位）。OPTION_APPWIDGET_MAX_WIDTH：包含 widget 实例宽度的上限（以 dp 为单位）。OPTION_APPWIDGET_MAX_HEIGHT：包含 widget 实例的高度上限（以 dp 为单位）。OPTION_APPWIDGET_SIZES：包含 widget 实例可以采用的可能尺寸 (List<SizeF>) 的列表（以 dp 为单位）。在 Android 12 中引入。

• [onDeleted(Context, int[\])](https://developer.android.com/reference/android/appwidget/AppWidgetProvider?hl=zh-cn#onDeleted(android.content.Context, int[]))

  每次从 widget 托管应用中删除 widget 时，系统都会调用此方法。

• onEnabled(Context)

  首次创建 widget 实例时，系统会调用此方法。例如，如果用户添加 widget 的两个实例，则仅在第一次调用时调用此方法。如果您需要打开新数据库或执行只需要对所有 widget 实例执行一次的其他设置，则非常适合执行此操作。

• onDisabled(Context)

  当 widget 的最后一个实例从 widget 宿主中删除时，系统会调用此方法。您可以在此处清理在 onEnabled(Context) 中完成的所有工作，例如删除临时数据库。

• [onReceive(Context, Intent)](https://developer.android.com/reference/android/appwidget/AppWidgetProvider?hl=zh-cn#onReceive(android.content.Context, android.content.Intent))

  系统会针对每个广播调用此方法，它会在上述每个回调方法之前调用。您通常不需要实现此方法，因为默认的 AppWidgetProvider 实现会过滤所有 widget 广播，并视情况调用前面的方法。

您必须使用 AndroidManifest 中的 <receiver> 元素将 AppWidgetProvider 类实现声明为广播接收器。如需了解详情，请参阅本页中的在清单中声明 widget。

2.2.1 使用 onUpdate() 类处理事件

最重要的 AppWidgetProvider 回调是 onUpdate()，因为除非您使用不带 configuration_optional 标志的配置 activity，否则在将每个 widget 添加到宿主时都会调用该回调。如果您的 widget 接受任何用户互动事件，请在此回调中注册事件处理脚本。如果您的 widget 不会创建临时文件或数据库，或执行其他需要清理的工作，那么 onUpdate() 可能是您需要定义的唯一回调方法。

例如，如果您需要一个带有按钮的 widget，该按钮可在点按时启动 activity，则可以使用以下 AppWidgetProvider 实现：

KotlinJava

class ExampleAppWidgetProvider : AppWidgetProvider() {

    override fun onUpdate(
            context: Context,
            appWidgetManager: AppWidgetManager,
            appWidgetIds: IntArray
    ) {
        // Perform this loop procedure for each widget that belongs to this
        // provider.
        appWidgetIds.forEach { appWidgetId ->
            // Create an Intent to launch ExampleActivity.
            val pendingIntent: PendingIntent = PendingIntent.getActivity(
                    /* context = */ context,
                    /* requestCode = */  0,
                    /* intent = */ Intent(context, ExampleActivity::class.java),
                    /* flags = */ PendingIntent.FLAG_UPDATE_CURRENT or PendingIntent.FLAG_IMMUTABLE
            )

            // Get the layout for the widget and attach an onClick listener to
            // the button.
            val views: RemoteViews = RemoteViews(
                    context.packageName,
                    R.layout.appwidget_provider_layout
            ).apply {
                setOnClickPendingIntent(R.id.button, pendingIntent)
            }

            // Tell the AppWidgetManager to perform an update on the current
            // widget.
            appWidgetManager.updateAppWidget(appWidgetId, views)
        }
    }
}

此 AppWidgetProvider 仅定义了 onUpdate() 方法，使用该方法创建可启动 Activity 并使用 [setOnClickPendingIntent(int, PendingIntent)](https://developer.android.com/reference/android/widget/RemoteViews?hl=zh-cn#setOnClickPendingIntent(int, android.app.PendingIntent)) 将其附加到微件按钮的 PendingIntent。它包含一个循环遍历 appWidgetIds 中的每个条目，该循环是 ID 数组，用于标识此提供程序创建的每个 widget。如果用户创建多个 widget 实例，那么这些实例将全部同时更新。但是，只能为微件的所有实例管理一个 updatePeriodMillis 时间表。例如，如果将更新时间表定义为每两小时更新一次，并且在第一个实例一小时后添加了该 widget 的第二个实例，那么这两个实例都会根据第一个更新周期定义的更新周期进行更新，而忽略第二个更新周期。两者每两小时更新一次，而不是每小时更新一次。

接收 widget 广播 intent

AppWidgetProvider 是一个便捷类。如果您想直接接收 widget 广播，可以实现自己的 BroadcastReceiver 或替换 [onReceive(Context,Intent)](https://developer.android.com/reference/android/appwidget/AppWidgetProvider?hl=zh-cn#onReceive(android.content.Context, android.content.Intent)) 回调。您需要关注的 intent 如下：

• ACTION_APPWIDGET_UPDATE
• ACTION_APPWIDGET_DELETED
• ACTION_APPWIDGET_ENABLED
• ACTION_APPWIDGET_DISABLED
• ACTION_APPWIDGET_OPTIONS_CHANGED

2.3 创建 widget 布局

如果您熟悉布局，那么创建 widget 布局将非常简单。但请注意，widget 布局基于 RemoteViews，并不支持所有类型的布局或视图 widget。您无法使用自定义视图或 RemoteViews 支持的视图子类。

RemoteViews 还支持 ViewStub，这是一种不可见、零大小的 View，可用于在运行时延迟膨胀布局资源。

以下代码示例展示了如何实现这些组件。

// Check
remoteView.setCompoundButtonChecked(R.id.my_checkbox, true);

// 点击单选框
remoteView.setRadioGroupChecked(R.id.my_radio_group, R.id.radio_button_2);

// 监听选择响应
remoteView.setOnCheckedChangeResponse(
    R.id.my_checkbox,
    RemoteViews.RemoteResponse.fromPendingIntent(onCheckedChangePendingIntent));

在 res/layout-v31 中提供两个布局：一个以搭载 Android 12 或更高版本的设备为目标平台，另一个以旧版 Android 11 或更低版本在默认的 res/layout 文件夹中提供。

支持的部分view

比如说EditText组件就不支持，然后外面通过代码创建的 RemoteView 就会报错。会有错误提示的，一般都是不支持xxx的view。

示例

1.声明AppWidgetProviderInfo XML

<appwidget-provider xmlns:android="http://schemas.android.com/apk/res/android"
    android:initialLayout="@layout/desktop_layout"
    android:minWidth="110dp"
    android:minHeight="40dp"
    android:previewImage="@mipmap/ic_launcher_round"
    android:updatePeriodMillis="8640000"
    android:widgetCategory="home_screen|keyguard">

</appwidget-provider>

2.使用 AppWidgetProvider 类处理 widget 广播

<receiver
    android:name=".desktop.DeskTopWidget"
    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/appwidget_info" />
</receiver>

3.实现 AppWidgetProvider 类

import android.app.PendingIntent
import android.appwidget.AppWidgetManager
import android.appwidget.AppWidgetProvider
import android.content.Context
import android.content.Intent
import android.util.Log
import android.widget.RemoteViews
import com.example.zanglidemo.MainActivity
import com.example.zanglidemo.R


class DeskTopWidget : AppWidgetProvider() {
    var TAG = "MyWidget："
    override fun onReceive(context: Context?, intent: Intent?) {
        super.onReceive(context, intent)
        Log.i(TAG, "接受广播")
    }

    /**
     * 第一个widget被添加调用
     *
     * @param context
     */
    override fun onEnabled(context: Context) {
        super.onEnabled(context)
        Log.i(TAG, "widget  onEnabled 状态")
    }

    /**
     * widget被添加 || 更新时调用
     *
     * @param context
     */
    override fun onUpdate(
        context: Context,
        appWidgetManager: AppWidgetManager?,
        appWidgetIds: IntArray?
    ) {
        super.onUpdate(context, appWidgetManager, appWidgetIds)
        Log.i(TAG, "widget  onUpdate 状态")

        // 构建布局的 RemoteViews 对象
        // 定义布局文件 R.layout.widget_layout
        val intent = PendingIntent.getActivity(
            context,
            0,
            Intent(context, MainActivity::class.java).apply {
                putExtra("type", "0")
            },
            PendingIntent.FLAG_UPDATE_CURRENT or PendingIntent.FLAG_IMMUTABLE
        )

        val intent11 = PendingIntent.getActivity(
            context,
            1,
            Intent(context, MainActivity::class.java).apply {
                putExtra("type", "1")
                putExtra("name", "观音心咒")
            },
            PendingIntent.FLAG_UPDATE_CURRENT or PendingIntent.FLAG_IMMUTABLE
        )
        val intent12 = PendingIntent.getActivity(
            context,
            2,
            Intent(context, MainActivity::class.java).apply {
                putExtra("type", "1")
                putExtra("name", "百字明")
            },
            PendingIntent.FLAG_UPDATE_CURRENT or PendingIntent.FLAG_IMMUTABLE
        )
        val intent13 = PendingIntent.getActivity(
            context,
            3,
            Intent(context, MainActivity::class.java).apply {
                putExtra("type", "1")
                putExtra("name", "顶礼")
            },
            PendingIntent.FLAG_UPDATE_CURRENT or PendingIntent.FLAG_IMMUTABLE
        )

        val intent21 = PendingIntent.getActivity(
            context,
            4,
            Intent(context, MainActivity::class.java).apply {
                putExtra("type", "2")
                putExtra("name", "早")
            },
            PendingIntent.FLAG_UPDATE_CURRENT or PendingIntent.FLAG_IMMUTABLE
        )
        val intent22 = PendingIntent.getActivity(
            context,
            5,
            Intent(context, MainActivity::class.java).apply {
                putExtra("type", "2")
                putExtra("name", "晚")
            },
            PendingIntent.FLAG_UPDATE_CURRENT or PendingIntent.FLAG_IMMUTABLE
        )

        // 更新内容
        val remoteViews: RemoteViews =
            RemoteViews(context.packageName ?: "", R.layout.desktop_layout).apply {
                setOnClickPendingIntent(R.id.desk_bg, intent)
                setOnClickPendingIntent(R.id.desk_title, intent)

                setOnClickPendingIntent(R.id.desk_vf1, intent11)
                setOnClickPendingIntent(R.id.desk_vf2, intent12)
                setOnClickPendingIntent(R.id.desk_vf3, intent13)

                setOnClickPendingIntent(R.id.desk_fast_morn, intent21)
                setOnClickPendingIntent(R.id.desk_fast_even, intent22)
            }

        // 更新小组件 UI
        appWidgetManager?.updateAppWidget(appWidgetIds, remoteViews)
    }

    /**
     * 最后一个widget被删除时调用
     *
     * @param context
     */
    override fun onDisabled(context: Context) {
        super.onDisabled(context)
        Log.i(TAG, "widget  onDisabled 状态")
    }
}

4. widget 布局

<?xml version="1.0" encoding="utf-8"?>
<LinearLayout xmlns:android="http://schemas.android.com/apk/res/android"
    android:id="@+id/desk_bg"
    android:layout_width="match_parent"
    android:layout_height="match_parent"
    android:background="@drawable/bg_very"
    android:backgroundTint="@color/white"
    android:orientation="vertical"
    android:padding="5dp">

    <LinearLayout
        android:layout_width="match_parent"
        android:layout_height="wrap_content"
        android:layout_gravity="center"
        android:orientation="horizontal">

        <TextView
            android:id="@+id/desk_title"
            android:layout_width="wrap_content"
            android:layout_height="wrap_content"
            android:layout_marginBottom="5dp"
            android:drawableLeft="@drawable/heart_24dp"
            android:drawablePadding="2dp"
            android:drawableTint="@color/red"
            android:gravity="center"
            android:text="修行"
            android:textColor="@color/gray"
            android:textSize="18sp"
            android:textStyle="bold" />

        <TextView
            android:id="@+id/desk_fast_morn"
            android:layout_width="30dp"
            android:layout_height="30dp"
            android:layout_marginLeft="5dp"
            android:background="@drawable/bg_circle"
            android:backgroundTint="@color/blue"
            android:gravity="center"
            android:text="早"
            android:textColor="@color/white" />

        <TextView
            android:id="@+id/desk_fast_even"
            android:layout_width="30dp"
            android:layout_height="30dp"
            android:layout_marginLeft="5dp"
            android:background="@drawable/bg_circle"
            android:backgroundTint="@color/spring_green"
            android:gravity="center"
            android:text="晚"
            android:textColor="@color/white" />
    </LinearLayout>

    <ViewFlipper
        android:id="@+id/desk_vf"
        android:layout_width="140dp"
        android:layout_height="35dp"
        android:layout_marginTop="10dp"
        android:autoStart="true"
        android:background="@drawable/bg_very"
        android:backgroundTint="@color/greenyellow"
        android:inAnimation="@anim/anim_in"
        android:outAnimation="@anim/anim_out">

        <TextView
            android:id="@+id/desk_vf1"
            android:layout_width="match_parent"
            android:layout_height="match_parent"
            android:gravity="center_vertical|center"
            android:text="观音心咒"
            android:textColor="@color/gray"
            android:textSize="18sp"
            android:textStyle="bold" />

        <TextView
            android:id="@+id/desk_vf2"
            android:layout_width="match_parent"
            android:layout_height="match_parent"
            android:gravity="center_vertical|center"
            android:text="bzm"
            android:textColor="@color/gray"
            android:textSize="18sp"
            android:textStyle="bold" />

        <TextView
            android:id="@+id/desk_vf3"
            android:layout_width="match_parent"
            android:layout_height="match_parent"
            android:gravity="center_vertical|center"
            android:text="顶礼"
            android:textColor="@color/gray"
            android:textSize="18sp"
            android:textStyle="bold" />
    </ViewFlipper>

</LinearLayout>

5.activity中的处理

fun onHandlePendingIntent() {
        Log.e(TAG, "onHandlePendingIntent:type= ${intent.getStringExtra("type")}")
        Log.e(TAG, "onHandlePendingIntent:name= ${intent.getStringExtra("name")}")

        when (intent.getStringExtra("type")) {
            "0" -> {
                Log.i(TAG, "onActivityResult: 打开界面0")
                //do nothing
            }

            "1", "2" -> {
                Log.i(TAG, "onActivityResult: 打开界面1、2")
                Handler(Looper.getMainLooper()).postDelayed({
                    //同样也需要延迟
                }, 500)
            }
        }
    }

这里最好延迟处理一下，否则容易出问题

6.允许用户固定 widget

在搭载 Android 8.0（API 级别 26）及更高版本的设备上，允许用户创建固定快捷方式的启动器还可让用户将 widget 固定到主屏幕上。与固定快捷方式类似，这些固定的 widget 让用户能够访问应用中的特定任务，并且可以直接从应用添加到主屏幕

val appWidgetManager = AppWidgetManager.getInstance(context)
val myProvider = ComponentName(requireContext(), DeskTopWidget::class.java)

if (Build.VERSION.SDK_INT >= Build.VERSION_CODES.O) {
    if (appWidgetManager.isRequestPinAppWidgetSupported()){
        val successCallback = PendingIntent.getBroadcast(
            /* context = */ context,
            /* requestCode = */ 0,
            /* intent = */ Intent(),
        /* flags = */ PendingIntent.FLAG_UPDATE_CURRENT)

        appWidgetManager.requestPinAppWidget(myProvider, null, successCallback)
    }
}

注意 ：如果您的应用不需要接收系统是否成功将 widget 固定到受支持的启动器上的通知，您可以将 null 作为 requestPinAppWidget() 的第三个参数传入。

参考链接

官方文档

如何开发自己的 AppWidget 小组件程序：构建应用微件

如何开发「托管 AppWidget 小组件」的宿主应用(类似于手机桌面 Launcher 应用)：构建应用微件托管应用

如何设置 AppWidget 小组件的最小尺寸：应用微件设计指南

Android 小组件 AppWidgetProvider

Android 桌面小组件 AppWidgetProvider