AppWidget

AppWidget

一AppWidget 简介

AppWidget指应用程序窗口小部件，是微小的应用程序视图，可以嵌入到其他的应用程序（通常指桌面（Home Screen））中并接收周期性的更新。AppWidgets只是应用程序窗口小部件，但在Android 4.0 中被作为一个很重要的特征充分地展现出来了，用一个Tab页单独表示所有已安装的widgets。如图1：

图1 Google内置的Widgets页面

常见的Google内置的Widgets有：Browser、Calendar、Contacts、DeskClock、Email、Gallery、Music、Settings、QuickSearchBox等。

一个已经被添加到Launcher的AppWidget如图2所示，是一个Calender加载到桌面上之后显示的画面：

图2 加载到桌面之后的Calender Widget

对于某些特定的应用来说，比如股票软件、天气、时钟，能够方便快捷地得到实时信息是很有必要的，这就是Widgets的好处：可以加载到桌面上显示，并且周期性的更新。

二与AppWidget实现相关的一些基本类

（1）AppWidgetProviderInfo

作用：为AppWidget提供元数据，包括布局、更新频率等数据，该对象定义在XML文件当中, 以做标签。xml文件存放在/res/xml/下，如/res/xml/xxxx_widget_info.xml。

通常一个widget_info.xml文件里的内容有：

与之对应，AppWidgetProviderInfo 类的属性有：

minWidth

和minHeight 属性的值指定了这个AppWidget 布局需要的最小区域。

minResizeWidth 和minResizeHeight 指定Widget 能被重新指定的最小的宽高，如果指定的值比minWidth 和minHeight 大或者指定的resizemode 不可用，这两个属性值就不起作用了。

updatePerdiodMillis 指定AppWidget 框架更新的频率，单位是毫秒，实际更新时间并不那么精确。为节省电源，建议更新频率越低越好，或许每小时不超过一次为佳。当updatePerdiodMillis 为0时，表示不定时更新。

initialLayout 属性指向定义AppWidget 布局的资源。 configure 指定添加AppWidget 时启动的Activity 。该属性是可选的。

previewImage:指定图片资源，AppWidget 指定后的显示图片。如果没被指定，则跟launcher 显示的icon 是相同的，这个属性值跟AndroidManifest.xml 里 指定的android:previewImage 相对应。

resizeMode:AppWidget 的宽高被重定义的模式。主要有RESIZE_NONE ，RESIZE_HORIZONTAL ，RESIZE_VERTICAL ，RESIZE_BOTH 。

（2）AppWidgetProvider

作用：是AppWidget 提供者需要实现的接口，定义了AppWidget 的基本生命周期函数，它实际上是一个BroadcastReceiver ，用来处理来自AppWidget 的广播，如updated ，deleted ，enabled 和disabled 。

主要方法有：

函数主要功能：

onUpdate(Context, AppWidgetManage, int[]) ;

作用：用来间隔性地更新AppWidget ，间隔时间由AppWidgetProviderInfo 类的updatePerdiodMillis 值决定。在添加一个AppWidget 时也会调用该方法，所以应在这个方法里完成一些基本的设置，比如为views 定制事件处理器，并开始一个临时的service 。但是如

果指定了AppWidgetProviderInfo的configure 值，则在添加AppWidget时不会执行onUpdate()方法，只在后续更新中调用，所以configure中指定的Activity必须主动使AppWidget做一次更新。作为AppWidgetProvider的实现者，一定要实现onUpdate函数，因为这个函数决定widget的显示方式，如果没有这个函数widget根本没办法出现。

onDeleted(Context, int[]) ;

作用：当一个AppWidget从AppWidget host中删除时都要调用该方法。

onEnabled(Context) ;

作用：当一个AppWidget实例第一次被创建时调用。比如，为一个AppWidget添加了两个实例，那么这个方法只在第一次被调用。在这个方法里适合做一些如打开数据库等只需要为所有AppWidget实例执行一次的操作。

onDisabled(Context) ;

作用：当最后一个AppWidget的实例从AppWidget host中删除时调用该方法。这个方法用于做onEnabled方法中所做工作的清理工作，比如删除一个临时的数据库。onReceive(Context, Intent):

作用：实现了BroadcastReceiver的onReceive()方法，在上述所有方法之前执行。在这里主要对收到的Broadcast进行分类，交给上述的方法去处理。所以在继承AppWidgetProvider 类后，一般不需要重写该方法。

（3）AppWidgetManager

作用：负责AppWidget视图的实际更新，获取安装的AppWidget providers的信息以及AppWidget相关状态，主要对整个AppWidget机制进行管理。AppWidgetManager主要给上层提供调用接口，具体由IAppWidgetService sService来真正实现对整个AppWidget的管理。

主要属性：

public static final String ACTION_APPWIDGET_PICK = "android.appwidget.action.APPWIDGET_PICK";

public static final String ACTION_APPWIDGET_CONFIGURE = "android.appwidget.action.APPWIDGET_CONFIGURE";

public static final String ACTION_APPWIDGET_UPDA TE = "android.appwidget.action.APPWIDGET_UPDA TE";

public static final String ACTION_APPWIDGET_DELETED = "android.appwidget.action.APPWIDGET_DELETED";

public static final String ACTION_APPWIDGET_DISABLED = "android.appwidget.action.APPWIDGET_DISABLED";

public static final String ACTION_APPWIDGET_ENABLED = "android.appwidget.action.APPWIDGET_ENABLED";

定义了一些AppWidget发生变化时的action。

主要函数：

public void updateAppWidget(int[] appWidgetIds, RemoteViews views) ;

public void updateAppWidget(int appWidgetId, RemoteViews views) ;

public void updateAppWidget(ComponentName provider, RemoteViews views) ;

public void partiallyUpdateAppWidget(int[] appWidgetIds, RemoteViews views) ;

public void partiallyUpdateAppWidget(int appWidgetId, RemoteViews views) ;

public void notifyAppWidgetViewDataChanged(int[] appWidgetIds, int viewId) ;

public void notifyAppWidgetViewDataChanged(int appWidgetId, int viewId) ;

public void bindAppWidgetId(int appWidgetId, ComponentName provider) ;

public void bindRemoteViewsService(int appWidgetId, Intent intent, IBinder connection) ;

public void unbindRemoteViewsService(int appWidgetId, Intent intent) ;

public int[] getAppWidgetIds(ComponentName provider) ;

(4)AppWidgetHost

作用：AppWidgetHost 是实际控制widget的地方，widget不是一个单独的用户界面程序，他必须寄生在某个程序（activity）中，这样如果程序要支持widget寄生就要实现AppWidgetHost，桌面程序（Launcher）就实现了这个接口。

AppWidgetHost的主要功能有两个：

1）监听来自AppWidgetService的事件。

public void startListening() ;

public void stopListening() ;

public int allocateAppWidgetId() ;

public void deleteAppWidgetId(int appWidgetId) ;

public void deleteHost() ;

public static void deleteAllHosts() ;

2）就是创建AppWidgetHostView。

public final AppWidgetHostView createView(Context context, int appWidgetId,

AppWidgetProviderInfo appWidget);

(5) AppWidgetHostView

作用：AppWidgetHostView是真正的View，但它只是一个容器，用来容纳实际的AppWidget的View。这个AppWidget的View是根据RemoteViews的描述来创建，真正实现了AppWidget的更新。

public void updateAppWidget（RemoteViews remoteViews）；

（6）AppWidgetService

作用：AppWidgetService是框架的的核心类，是系统service之一，它真正负责widgets 的管理工作。加载，删除，定时事件等都需要AppWidgetService的处理，是开机自启动的。

AppWidgetService存在的目的主要是解开AppWidgetProvider和AppWidgetHost之间的耦合。如果AppWidgetProvider和AppWidgetHost的关系固定死了，AppWidget就无法在任意进程里显示了。而有了AppWidgetService，AppWidgetProvider根本不需要知道自己的AppWidget在哪里显示了。

三开发一个用户自己的Widget所需步骤

（1）定义AppWidgetProviderInfo：

在res/xml文件夹中定义一个名为appwidget_info.xml的文件：

其中android:updatePeriodMillis定义更新频率为每86400000毫秒（24小时）更新一次，android:initialLayout定义AppWidget初始布局文件为res/layout/example_appwidget.xml。与此同时，建立layout文件example_appwidget.xml，需要注意的是AppWidget布局是基于RemoteViews，这并不支持所有类型的布局或视图小部件。

一个RemoteViews对象（以及相应的一个App Widget）可以支持下面这个布局类：

?FrameLayout

?LinearLayout

?RelativeLayout

?GridLayout

以及下面的小部件类：

为方便后面的说明，在这个layout中设置了一个按钮，id为button，用来触发事件。（2）复写AppWidgetProvider类

每一个Widget都要实现自己的AppWidgetProvider，其实是一个BroadcastReceiver，但是重点要复写的方法不是onReceive()，而是onUpdate()。需要注意的是，因为这个AppWidgetProvider是一个广播接收器BroadcastReceiver，不能保证进程在回调函数返回后仍然继续运行。所以一般应在onUpdated()方法里启动一个服务Service。从这个服务里，可以执行自己的App Widget更新，而不必担心AppWidgetProvider由于一个应用程序无响应错误Application Not Responding (ANR)而关闭。

在AndroidMenifest.xml中添加一个receiver标签，让其指向你的AppWidgetProvider 子类。内容如下：

对上面的代码进行解释：

指定该AppWidget开发的接收者是ExampleAppWidgetProvider，即建立的AppWidgetProvider子类；

元素必须包括一个含有android:name属性的元素。该元素指定AppWidgetProvider接受ACTION_APPWIDGET_UPDATE 广播。这是唯一你必须显式声明的广播。当需要的时候，AppWidgetManager会自动发送所有其他App Widget广播给AppWidgetProvider。

元素指定了AppWidgetProviderInfo资源并需要以下属性：

android:name –指定元数据名称。这里是android.appwidget.provider，这个名字是固定的，AppWidgetService根据这个值查找所有已经安装的Widgets。

android:resource–指定AppWidgetProviderInfo的资源路径。

ExampleAppWidgetProvider.java的实现如下：

这个AppWidgetProvider仅定义了onUpdated() 方法，为了定义一个PendingIntent，来启动一个活动并使用setOnClickPendingIntent(int, PendingIntent)方法把它附着到这个App Widget的按钮上。注意它包含了一个遍历appWidgetIds中所有项的循环，这是一个IDs数组，每个ID用来标识由这个Provider创建的一个App Widget。这样，如果用户创建多于一个这个App Widget的实例，那么它们将被同步更新。不过，对于所有的App Widget实例，只有一个updatePeriodMillis时间表被管理。比如，如果这个更新时间表被定义为每隔两个小时，而且App Widget的第二个实例是在第一个后面一小时添加的，那么它们将按照第一个所定义的周期来更新而第二个被忽略（它们将都是每2个小时进行更新，而不是每小时）。

上面onUpdate（）的作用就是用户在Widget上点击按钮的时候，启动ExampleActivity，并通过appWidgetManager更新Widget。ExampleActivity就是一个普通的Activity，它的创建跟其它Activity没有任何区别，这里不再多说。但是AppWidgetProviderInfo对应的配置文件appwidget_info.xml中android：configure属性指定了一个配置活动

"com.example.android.ExampleAppWidgetConfigure"，注意这个活动是用全名声明的，因为它将从你的程序包外被引用。这个Activity有一些需要特别处理的地方，单独作为一个部分介绍。

四建一个配置活动

建一个配置活动应该注意以下两点：

1）App Widget宿主调用配置活动而且配置活动应该总是返回一个结果.这个结果应该包含这个通过启动该活动的意图传递的App Widget ID(以EXTRA_APPWIDGET_ID保存在意图的附加段Intent extras中)

2）当这个App Widget 被创建时将不会调用onUpdate()方法(当一个配置活动启动时,系统将不会发送ACTION_APPWIDGET_UPDATE广播).配置活动应该在App Widget 第

一次被创建时负责从AppWidgetManager请求一个更新.不过, onUpdate() 将在后续更新中被调用——只忽略第一次.

参见下面章节的代码片断,该示例说明了如何从配置中返回一个结果并更新这个App Widget.

从配置活动中更新一个App Widget

当一个App Widget使用一个配置活动,那么当配置结束时,就应该由这个活动来更新这个App Widget.你可以直接AppWidgetManager里请求一个更新来这么做.

下面是恰当的更新App Widget 以及关闭配置活动这个过程的一个概要描述:

（1）首先，从启动这个活动的意图中获取App Widget ID：

Intent intent = getIntent();

Bundle extras = intent.getExtras();

if (extras != null) {

mAppWidgetId = extras.getInt(

AppWidgetManager.EXTRA_APPWIDGET_ID,

AppWidgetManager.INVALID_APPWIDGET_ID);

}

（2）实施你的App Widget开发配置。

（3）当配置完成后，通过调用getInstance(Context)获取一个AppWidgetManager实例:

AppWidgetManager appWidgetManager = AppWidgetManager.getInstance(context);

（4）以一个RemoteViews布局调用updateAppWidget(int, RemoteViews)更新App Widget:

RemoteViews views = new RemoteViews(context.getPackageName(),

https://www.360docs.net/doc/1e9479420.html,yout.example_appwidget);

appWidgetManager.updateAppWidget(mAppWidgetId, views);

（5）最后，创建返回意图，设置活动结果，并结束这个活动:

Intent resultValue = new Intent();

resultValue.putExtra(AppWidgetManager.EXTRA_APPWIDGET_ID, mAppWidgetId); setResult(RESULT_OK, resultValue);

finish();

提示: 当你的配置活动第一次打开时，设置活动结果为RESULT_CANCELED。这样，如果用户在结束之前从活动外返回，这个App Widget 宿主会接收到配置取消通知而不会添加这个App Widget。

五 AppWidget系统启动时的加载流程

1）Android系统启动

Android系统启动，SystemServer创建AppWidgetService，并调用systemReady()方法，在systemReady()方法中做以下三项准备工作：

（1）通过PackageManager从Android系统中查找所有已经被安装的AppWidget（包含"android.appwidget.action.APPWIDGET_UPDATE“的Action和meta-data标签），解析AppWidget的配置信息，封闭成对象，保存到List集合。

（2）从/data/system/appwidgets.xml文件读取已经被添加到Launcher的AppWidget信息，封闭成对象，保存到List集合中。

（3）注册四个广播接收器：第一、Android系统启动完成；第二、Android配置信息

改变；第三、添加删除应用；第四、sdcard的安装与缷载。

2）Android系统启动Launcher

Android系统启动Launcher应用程序,会做以下准备工作：

（1）从Launcher应用的数据库查找已经被添加到Launcher的AppWidget信息。

（2）根据查找到的appWidgetId值（整型值）创建LauncherAppWidgetHostView布局对象。

（3）根据查找到的appWidgetId值（整型值）从AppWidgetService中获取RemoteViews 对象（因为是第一次启动所以RemoteViews对象为空）。

（4）将获取到的RemoteViews对象的布局解析并设置到第（2）步中创建的LauncherAppWidgetHostView布局对象中。

（5）将LauncherAppWidgetHostView布局对象添加到Launcher的WorkSpace中（因为RemoteViews对象为空，所以只在Launcher的WorkSpace中占了一个位置）。

3）Android系统启动完成

Android系统启动完成，发出BOOT_COMPLETED广播，AppWidgetService接收到广播后，会做以下事情：

（1）获取已经添加到Launcher的AppWidget列表（在第1步的第（2）小步中提到），依次向这个Widget发出APPWIDGET_ENABLED和APPWIDGET_UPDATE更新广播，根据配置的更新间隔定时发出更新广播。

（2）每个AppWidget接收到广播后都会调用onEnabled()方法和onUpdate()方法，在onEnabled()方法中进行一些初始化操作，在onUpdate()方法中创建RemoteViews布局对象并通过AppWidgetManager的updateAppWidget(int appWidgetId, RemoteViews remoteViews)方法通知AppWidgetService对象用RemoteViews对象更新appWidgetId所对应的AppWidget。

（3）AppWidgetService接收到了appWidgetId和RemoteViews后，通过appWidgetId查找已经被添加到Launcher的LauncherAppWidgetHostView布局对象，并RemoteViews中的布局更新到LauncherAppWidgetHostView布局对象中。AppWidget显示在Launcher中。

六添加一个Widget到Launcher的加载过程

1、将屏幕切换到标有Widgets的Tab页，这时会打开一个Activity（AppWidgetPickActivity）显示系统中全部AppWidget，长按并将某一个AppWidget拖动到桌面上空闲位置后会做以下操作：

(1) 通过AppWidgetService获取一个最新的appWidgetId值。

(2) 根据获取的appWidgetId值，向单击的AppWidget组件发出

APPWIDGET_ENABLED和APPWIDGET_UPDATE更新广播。并向

/data/system/appwidgets.xml中添加此AppWidget的基本信息。

2、启动AppWidgetPickActivity(第1步中提到)时使用的是startActivityForResult()方法，

所以在向所单击的AppWidget组件发出APPWIDGET_ENABLED和

APPWIDGET_UPDATE更新广播后会执行onActivityResult()方法，做以下准备工作：

(1) 将需要被添加到Launcher的AppWidget基本信息保存到数据库中。

(2) 根据查找到的appWidgetId值(整型值)创建LauncherAppWidgetHostView布局对象。

(3) 根据查找到的appWidgetId值(整型值)从AppWidgetService中获取RemoteViews

对象（因为是第一次启动所以RemoteViews对象为空）。

(4) 将获取到的RemoteViews对象的布局解析并设置到第(2)步中创建的LauncherAppWidgetHostView布局对象中。

(5) 将LauncherAppWidgetHostView布局对象添加到Launcher的WorkSpace中（因为RemoteViews对象为空，所以只在Launcher的WorkSpace中占了一个位置）。

3、在第1步中已经向需要添加到Launcher中的AppWidget发出了更新消息（注意：第一步和第二步是异步执行的）,继续做以下事情：

(1) 每个AppWidget接收到广播后都会调用onEnabled()方法和onUpdate()方法，在onEnabled()方法中进行一些初始化操作，在onUpdate()方法中创建RemoteViews布局对象并通过AppWidgetManager的updateAppWidget(int appWidgetId, RemoteViews remoteViews)方法通知AppWidgetService对象用RemoteViews对象更新appWidgetId所对应的AppWidget.

(2) AppWidgetService接收到了appWidgetId和RemoteViews后，通过appWidgetId

查找已经被添加到Launcher的LauncherAppWidgetHostView布局对象，并将RemoteViews

中的布局更新到LauncherAppWidgetHostView布局对象中，从而AppWidget显示在Launcher 中。