日历数据变更时如何兼容全Android版本自动更新AppWidget

目标是实现日历提供程序数据变更时自动更新AppWidget的能力。原有基于静态广播监听ACTION_PROVIDER_CHANGED的实现，在Android 10设备可正常运行，Android 12及以上版本完全无法收到广播、触发更新。

原有Manifest配置：

<receiver
    android:name="my.package.name.WidgetProvider"
    android:exported="true"
    android:label="@string/label_period" >
    <intent-filter>
        <action android:name="android.intent.action.PROVIDER_CHANGED" />
        <data android:scheme="content" />
        <data android:host="com.android.calendar" />
    </intent-filter>
    
    <meta-data
        android:name="android.appwidget.provider"
        android:resource="@xml/widget_period_info" />
</receiver>

原有AppWidgetProvider逻辑：

override fun onReceive(context: Context, intent: Intent) {
    if (intent.action.equals(Intent.ACTION_PROVIDER_CHANGED)) {
        val thisAppWidget = ComponentName(
            context.packageName, javaClass.name
        )
        val appWidgetManager = AppWidgetManager.getInstance(context)
        val ids = appWidgetManager.getAppWidgetIds(thisAppWidget)
        // Update widgets
        for (appWidgetId in ids) {
                updateWidget(
                    context,
                    appWidgetManager,
                    appWidgetId
                )
        }
    }
    super.onReceive(context, intent)
}

从Android 8.0（API 26）开始，系统对静态注册的隐式广播做了严格限制，到Android 12进一步收紧了后台应用的广播接收权限，ACTION_PROVIDER_CHANGED属于受限制的系统广播，静态注册的接收器在高版本系统中默认无法接收到该广播，因此方案失效。

最优实现方案为ContentObserver + WorkManager，相比常驻Service、JobScheduler方案，该方案功耗更低、兼容性更强、系统托管任务存活率更高，可覆盖API 21及以上所有主流Android版本。

实现步骤 #

1. 移除Manifest中WidgetProvider对应的ACTION_PROVIDER_CHANGED静态广播过滤器，该配置在高版本无实际作用。
2. 添加所需权限到Manifest：

<!-- 读取日历数据权限，需动态申请 -->
<uses-permission android:name="android.permission.READ_CALENDAR" />
<!-- 接收开机广播，用于重启后恢复监听 -->
<uses-permission android:name="android.permission.RECEIVE_BOOT_COMPLETED" />

3. 实现日历数据变更监听器ContentObserver：

class CalendarContentObserver(
    private val context: Context,
    handler: Handler
) : ContentObserver(handler) {
    // 防抖标记，避免短时间多次触发刷新
    private var lastUpdateTime = 0L

    override fun onChange(selfChange: Boolean) {
        super.onChange(selfChange)
        val currentTime = System.currentTimeMillis()
        // 300ms内的重复变更只触发一次刷新
        if (currentTime - lastUpdateTime < 300) return
        lastUpdateTime = currentTime

        // 触发所有桌面组件更新
        val appWidgetManager = AppWidgetManager.getInstance(context)
        val widgetComponent = ComponentName(context, WidgetProvider::class.java)
        val widgetIds = appWidgetManager.getAppWidgetIds(widgetComponent)
        widgetIds.forEach { widgetId ->
            updateWidget(context, appWidgetManager, widgetId)
        }
    }
}

4. 基于WorkManager实现监听器的托管注册，避免应用被后台杀死后监听失效：

class CalendarObserverWorker(
    context: Context,
    params: WorkerParameters
) : Worker(context, params) {
    override fun doWork(): Result {
        val contentResolver = applicationContext.contentResolver
        val observer = CalendarContentObserver(
            applicationContext,
            Handler(Looper.getMainLooper())
        )
        // 监听日历事件表变更
        contentResolver.registerContentObserver(
            CalendarContract.Events.CONTENT_URI,
            true, // 递归监听所有子路径变更
            observer
        )
        // 监听日历实例表变更（包含重复事件、日程时间调整类变更）
        contentResolver.registerContentObserver(
            CalendarContract.Instances.CONTENT_URI,
            true,
            observer
        )
        return Result.success()
    }

    companion object {
        fun start(context: Context) {
            val observerWork = PeriodicWorkRequestBuilder<CalendarObserverWorker>(
                15, TimeUnit.MINUTES, // 系统允许的最短周期任务间隔，定期重注册保证监听存活
                5, TimeUnit.MINUTES
            ).setConstraints(
                Constraints.Builder()
                    .setRequiresBatteryNotLow(true)
                    .build()
            ).build()

            WorkManager.getInstance(context).enqueueUniquePeriodicWork(
                "calendar_widget_observer",
                ExistingPeriodicWorkPolicy.UPDATE,
                observerWork
            )
        }
    }
}

5. 在关键节点触发监听器注册，保证全场景下监听生效：
   • 在AppWidgetProvider的onEnabled方法中调用CalendarObserverWorker.start(context)：第一个桌面组件被添加时启动监听
   • 在AppWidgetProvider的onUpdate方法中调用CalendarObserverWorker.start(context)：组件更新时重注册，避免监听被系统回收
   • 静态注册BOOT_COMPLETED广播接收器，设备开机完成后调用CalendarObserverWorker.start(context)：重启后自动恢复监听

方案优势 #

• 全版本兼容：覆盖API 21到最新Android版本，无系统版本适配问题
• 低功耗：不需要常驻前台服务，ContentObserver为系统级事件回调，无轮询开销
• 高存活率：WorkManager为系统托管任务，即使应用被后台杀死、内存不足被回收，也会在合适时机自动恢复任务
• 实时性强：日历数据发生增删改时会立刻收到回调，无轮询延迟

注意事项 #

• READ_CALENDAR为运行时权限，需要在应用内主动向用户申请，未获得权限时ContentObserver无法收到数据变更回调
• 如果需要兼容API 21以下版本，可将WorkManager替换为原生JobScheduler，核心注册逻辑完全一致
• 不要使用常驻前台Service注册ContentObserver，会增加功耗、引发用户反感，且高版本系统对前台服务的启动限制非常严格

内容的提问来源于stack exchange，提问作者bic55