Android 应用小部件的实现

有些时候，我们需要为自己的应用添加一个桌面小部件来显示一些简单但是关键的信息方便用户使用。应用小部件的视图是靠RemoteViews来展现的，而RemoteViews内只能放置一些简单的ViewGroup和Widget。文章内容基本上是看官方Guide，如果英文较好的话，还是阅读原文比较靠谱。

声明你的应用里有个小部件

首先，你需要在你的Manifest文件中声明一个receiver，可能会有人问：为什么是一个receiver而不是一个其他什么的比如appwidget这样的标签（如果有的话）。别着急，等下就明白了。
来看下官网的例子吧

<receiver android:name=".ExampleAppWidgetProvider" >
    <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>

AppWidgetProvider初探

其中android:name属性指定了一个类叫做ExampleAppWidgetProvider，那么这个类到底是干什么的，来看下ExampleAppWidgetProvider类的代码吧

public class ExampleAppWidgetProvider extends AppWidgetProvider {

    public void onUpdate(Context context, AppWidgetManager appWidgetManager, int[] appWidgetIds) {
        final int N = appWidgetIds.length;

        // Perform this loop procedure for each App Widget that belongs to this provider
        for (int i=0; i<N; i++) {
            int appWidgetId = appWidgetIds[i];

            // Create an Intent to launch ExampleActivity
            Intent intent = new Intent(context, ExampleActivity.class);
            PendingIntent pendingIntent = PendingIntent.getActivity(context, 0, intent, 0);

            // Get the layout for the App Widget and attach an on-click listener
            // to the button
            RemoteViews views = new RemoteViews(context.getPackageName(), R.layout.appwidget_provider_layout);
            views.setOnClickPendingIntent(R.id.button, pendingIntent);

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

可以很清楚的看到，它继承了AppWidgetProvider这个类，这个类又是干什么呢，让我们来看看它的继承关系

AppWidgetProvider的继承关系

这下就很清楚了，实际上它就是个BroadcastReceiver，所以之前在Manifest文件里我们用的tag是receiver。它复写了onReceive方法来处理收到广播时分别调用哪个回调方法。AppWidgetProvider的回调方法有以下

1. onUpdate()
   这个方法会周期性的被调用，时间值由AppWidgetInfo中的updatePeriodMillis值决定，可能你现在对这个属性很陌生，别慌，我们下面会讲到这个东西，现在知道有这么个东西即可。onUpdate还会在每次小部件被添加到桌面时被调用，所以我们需要在这个回调方法里做一些初始化的工作，比如设置remoteviews里一些控件的事件处理方法，如果你指定了configuration Activity，那么onUpdate在小控件被初次添加时不会被回调，因为指定了configuration Activity之后，初始化的工作应该在configuration中完成，但是onUpdate方法还是会响应之后的一些更新操作。
2. onAppWidgetOptionsChanged()
   这个方法看名字就很简单明了，当小部件的选项改变时被调用。
   说的更具体点，就是部件被第一次添加到屏幕上及控件的大小被改变时该方法会被调用。我们可以通过getAppWidgetOptions()方法来获取一个Bundle对象，bundle中存了四个配置值

• OPTION_APPWIDGET_MIN_WIDTH
• OPTION_APPWIDGET_MIN_HEIGHT
• OPTION_APPWIDGET_MAX_WIDTH
• OPTION_APPWIDGET_MAX_HEIGHT
  作用看名字就知道了，我就不赘述了。

3. onDelete(Context, int[])
   小部件被从桌面上移除时被调用
4. onEnable(Context)
   小部件第一次创建时被调用，如果同时向桌面添加了两个相同的小部件，这个方法只会在第一个小部件创建时被调用。
5. onDisabled(Context)
   最后一个小部件从App Widget Host里移除时被调用，在这个方法里可以做一些清理工作
6. onReceive(Context, Intent)
   这个方法上面也提到过了，跟一般BroadcastReceiver一样，如果我们想要发送自定义的广播，我们就需要复写这个方法，在这个方法里接收。

有这个多方法，但是通常情况下，需要复写的方法只有onUpdate，回到上面的代码，可以看到这里有一个for循环，官网的解释是因为一个小部件可以添加多个实例，而这些实例的appWidgetId都存在appWidgetIds这个数组里，因此通过这个循环，我们可以将所有的控件同步。之后的代码跟通知一样，是为了设置remoteviews上的控件的事件处理，如果你的小部件不需要响应点击事件，只需要简单的new一个RemoteViews然后调用appWidgetManager的updateAppWidget方法就可以了。

AppWidgetProviderInfo初探

AppWidgetProviderInfo定义了一些对小部件来说很重要的属性，我们需要在res/xml目录下新建一个xml文件

<appwidget-provider xmlns:android="http://schemas.android.com/apk/res/android"
    android:minWidth="40dp"
    android:minHeight="40dp"
    android:updatePeriodMillis="86400000"
    android:previewImage="@drawable/preview"
    android:initialLayout="@layout/example_appwidget"
    android:configure="com.example.android.ExampleAppWidgetConfigure"
    android:resizeMode="horizontal|vertical"
    android:widgetCategory="home_screen">
</appwidget-provider>

下面来对这个xml里的属性进行讲解

1. minWidth：小部件的最小宽度
2. minHeight：小部件的最小高度
3. updatePeriodMilllis：控件更新时间
4. previewImage：在小部件列表里显示的略缩图
5. initialLayout：自定义布局的xml文件
6. configure：前文提到的configration Activity文件资源
7. resizeMode：定义了小部件可以被横向或纵向拉伸或压缩，可选值为vertial或horizontal
8. widgetCategory：定义了小部件可以被添加的地方，可选值为home_screen和keyguard，前者是桌面，后者是锁屏界面，锁屏界面的小部件需要在设置里开启启用锁屏小部件的选项（测试手机为L39h 系统4.4）

这里需要注意一些地方：Android的桌面被分为4x4的方格，如果minWidth和minHeight不等于整数个方格的边长，系统会对小部件的长和宽进行向上取整；忘了哪篇博客上看的，好像说系统为了省电，最小的更新时间为30分钟，也就是updatePeriod属性设置成比30分钟小的值并不会提早触发onUpdate，guide中也说了并不保证时间的准确性，guide里建议不要太频繁更新，更新的频率最好不要超过1小时/次，这样可以节省电量。而且因为不同的小控件对于更新的需求不一致，最好是让用户自己去调整更新时间。

如果在update的时间到来时，手机正处在休眠的状态，那么手机将会被唤醒来进行一次更新。如果更新的频率不要超过1小时/次，对电池不会造成太大损耗，如果需要经常地更新小部件或者不需要在手机休眠时更新小部件的话，可以采用AlarmManager来定时，AlarmManager中有两种方法：ELAPSED_REALTIME和RTC是不会将手机唤醒的，这样只有手机在正常使用时才会收到alarm的通知。此时updatePeriodMillis应该设置为0

一点小遗憾

看完本文，你就可以写一个简单的小部件添加到桌面啦。不过还有很多没解决的问题，比如想添加Edittext但发现remoteviews不支持这个控件，想尝试通过代码实现添加小部件到桌面，但是不知道如何获取launcher的appWidgetHost，只好暂时放弃。如果有同学对这方面有了解，可以留言交流一下。