因为公司项目需求,需要实现widget 来刷新数据,稀里糊涂的做,然后踩了很多坑,写个文章来总结下widget一些实际上遇到的坑。
官方API地址:官方api(中文,最美语言)
(方便查看,中文的,比较详细)
如果widget简单实用就参考下面文章:基本使用 这篇文章更多帮你理理一些思路,或者理清楚一下
1.Widget(小组件)具体是啥
你的Widget(小组件)都需要继承AppWidgetProvider ,然后这个呢,是继承BroadcastReceiver,所以呢,也不用我多说,Widget(小组件)就是一个广播,广播呢,就会有我开发过程中的第一个坑
Widget(小组件)说没就没,数据说不刷新就不刷新,虽然系统给了个固定刷新机制,但是实际测试中,会根据你当前测试机的型号不同,得到的效果也各不相同(不得不吐槽某充电xx分钟,通话xx小时的某国产手机)。具体原因可以看下Widget无响应。个人也是直接抄答案没有细想,最后稍微带着经验猜测如下:
Widget(小组件)说白了就是个广播,广播一般都是发完就不会管后续的呢,所以如果你想一个广播一直前台更新数据挺有局限的呢,所以我开发过程中会碰到Widget(小组件)说没就没现象特别多,并且你压根找不到原因是啥。所以Widget(小组件)真就一个广播,广播保活(小弟不才,学艺不精不会),所以在onReceive 持久化数据不得行。
@Override
public void onReceive(final Context context, Intent intent) {
敲黑板了,这里处理数据很大概率会碰到无响应,或者接收不到广播
super.onReceive(context, intent);
}
解决办法:在你的自身的Provider 也就是你按照xxWidgetProvider extend AppWidgetProvider的不要做数据处理,开启个服务 按照我如下操作就行
package com.haixue.highendclass.widget;
import android.appwidget.AppWidgetManager;
import android.appwidget.AppWidgetProvider;
import android.content.Context;
import android.content.Intent;
import android.os.Build;
import android.os.Bundle;
import com.haixue.highendclass.common.Constants;
import com.haixue.highendclass.utils.Ln;
import com.haixue.yijian.BuildConfig;
public class HxWidgetProvider extends AppWidgetProvider {
// 更新 widget 的广播对应的action 这个其实是刷新所有页面的
public static final StringTAG="zzzz";
/**
* 接收窗口小部件点击时发送的广播
*/
@Override
public void onReceive(final Context context, Intent intent) {
super.onReceive(context, intent);
}
// 当 widget 被初次添加 或者 当 widget 的大小被改变时,被调用
@Override
public void onAppWidgetOptionsChanged(Context context, AppWidgetManager appWidgetManager, int appWidgetId, Bundle
newOptions) {
super.onAppWidgetOptionsChanged(context, appWidgetManager, appWidgetId, newOptions);
}
/**
* 当小部件从备份恢复时调用该方法
*/
@Override
public void onRestored(Context context, int[] oldWidgetIds, int[] newWidgetIds) {
super.onRestored(context, oldWidgetIds, newWidgetIds);
}
/**
* 每次窗口小部件被点击更新都调用一次该方法
*/
@Override
public void onUpdate(Context context, AppWidgetManager appWidgetManager, int[] appWidgetIds) {
// 每次 widget 被创建时,开启服务,后续服务处理业务逻辑
Intent intent=new Intent(context,WidgetService.class);
intent.setAction(Constants.ACTION_WIDGET_REFRESH_DATA);
intent.putExtra(Constants.TAG_WIDGET_UPDATE_DATA,appWidgetIds);
if (Build.VERSION.SDK_INT >= Build.VERSION_CODES.O) {
context.startForegroundService(intent);
}else {
context.startService(intent);
}
super.onUpdate(context, appWidgetManager, appWidgetIds);
}
/**
* 当最后一个该窗口小部件删除时调用该方法,注意是最后一个
*/
@Override
public void onDisabled(Context context) {
// 在最后一个 widget 被删除时,终止服务
Intent intent =new Intent(context, WidgetService.class);
context.stopService(intent);
super.onDisabled(context);
}
}
也就是基本上的生命周期只是做个摆设,你直接去Service处理逻辑就行,只能说这里有点不负责任,没有给代码,这里注意下
context.startForegroundService(intent);和context.startService(intent);区别,startForegroundService导致部分机型有widget更新消息一直在消息栏,这里算是没有解决的坑,所以Widget(小组件),其实也就开了个Service ,剩下都在Service中处理
我也是参考了这个时钟例子(但是并不那么完美)
一般更新widget操作:
AppWidgetManager manager = AppWidgetManager.getInstance(context);
int[] idLs = manager.getAppWidgetIds(new ComponentName(context.getPackageName(), HxWidgetProvider.class.getName()));
//用于遍历所有保存的widget的id
for (int i : idLs) {
int appID = i;
// 获取 layout_hx_widget.xml 对应的RemoteViews 只显示一条数据
RemoteViews remoteView =new RemoteViews(context.getPackageName(), R.layout.layout_hx_widget);
//widget点击刷新按钮,刷新数据
remoteView.setOnClickPendingIntent(R.id.iv_course_refresh, getRefreshIntent(context));
initViewByData(remoteView, context);
// 更新 widget
appWidgetManager.updateAppWidget(appID, remoteView);
}
踩的坑第二个:重点来了,以下代码其实在Activity和Service中也是可以执行的,也就是widget更新并不局限你的xxWidgetProvider extend AppWidgetProvider 这个广播类中,所以保持widget,其实保持个Service也是可以做到实时更新数据的,所有就xxWidgetProvider 开启个Service就能保活,Service保活应该比Broadcast简单,官方建议也是如此
踩的坑第三个:widget点击事件,上述基本使用文章已经告知你,widget只支持基础控件,并且你如果直接用个View,也是会报错的。具体为啥呢?毕竟所有的类都是它的子类,它都能支持,就不存在不支持的View类。
一般点击事件如下:
RemoteViews remoteView =new RemoteViews(context.getPackageName(), R.layout.layout_hx_widget);
//widget点击刷新按钮,刷新数据
remoteView.setOnClickPendingIntent(R.id.iv_course_refresh, getRefreshIntent(context));
initViewByData(remoteView, context);
//定义你的PendingIntent
private PendingIntent getRefreshIntent(Context context) {
Intent intent =new Intent(context, WidgetService.class);
intent.putExtra(Constants.TAG_WIDGET_UPDATE_DATA, mIds);
intent.setAction(Constants.ACTION_WIDGET_REFRESH_DATA);
PendingIntent pi;
if (Build.VERSION.SDK_INT >= Build.VERSION_CODES.O) {
pi = PendingIntent.getForegroundService(context, 0, intent, PendingIntent.FLAG_UPDATE_CURRENT);
}else {
pi = PendingIntent.getService(context, 0, intent, PendingIntent.FLAG_UPDATE_CURRENT);
}
return pi;
}
重点:PendingIntent.FLAG_UPDATE_CURRENT 这个参数很重要,决定了你的点击事件是否是可以持续点击
重点小技巧,点击widget某个地方直接开启App,或者指定App某个activity比较简单,但是有个业务场景就是你app已经开启,你得跟launcher界面点击app图标进行一样的操作的情况,你按照以下代码设置
private PendingIntentgetAppIntent(Context context) {
Intent intent =new Intent(Intent.ACTION_MAIN);
intent.addCategory(Intent.CATEGORY_LAUNCHER);
intent.putExtra(Constants.TAG_WIDGET_OPEN_APP,TYPE_OPEN_OTHER);
intent.setComponent(new ComponentName("你的包名", "你的启动activity"));
intent.setFlags(Intent.FLAG_ACTIVITY_NEW_TASK | Intent.FLAG_ACTIVITY_RESET_TASK_IF_NEEDED);
PendingIntent pi = PendingIntent.getActivity(context, 0, intent, PendingIntent.FLAG_UPDATE_CURRENT);
return pi;
}
以上就是widget一些体会吧,并没有提供太多代码,有不正确的地方还希望校正