android widget简单开发一之创建一个小部件

今天学习了一下小部件，记录下学习的内容。

一、如何创建一个简单的小部件

1.先新建一个小部件类AppWidget 继承 AppWidgetProvider,其实AppWidgetProvider，就是一个BroadcastReceiver广播接收器。不过他多了好几个重写的方法。

public class AppWidget1 extends AppWidgetProvider {
    private static String TAG = "执行过程";

    @Override
    public void onReceive(Context context, Intent intent) {
        // 接收到任意广播时触发，在其他方法之前被调用。
        Log.i(TAG, "onReceive: 执行");
        super.onReceive(context, intent);
    }

    @Override
    public void onUpdate(Context context, AppWidgetManager appWidgetManager, int[] appWidgetIds) {
        Log.i(TAG, "onUpdate: 执行");//在widget更新的时候执行
        super.onUpdate(context, appWidgetManager, appWidgetIds);
    }

    @Override
    public void onEnabled(Context context) {
        Log.i(TAG, "onEnabled: 执行");
        //当第1个 widget 的实例被创建时触发。
        // 也就是说，如果用户对同一个 widget 增加了两次（两个实例），那么onEnabled()只会在第一次增加widget时触发。
        super.onEnabled(context);
    }

    @Override
    public void onAppWidgetOptionsChanged(Context context, AppWidgetManager appWidgetManager, int appWidgetId, Bundle newOptions) {
        //android 4.1引入该方法
        //当widget改变大小的时候或者每次添加执行
        //可以根据widget 的大小来显示/隐藏某些内容
        //可以通过 getAppWidgetOptions() 来返回 Bundle 对象以读取 widget 的大小信息
        Log.i(TAG, "onAppWidgetOptionsChanged: 执行");
        super.onAppWidgetOptionsChanged(context, appWidgetManager, appWidgetId, newOptions);
    }

    @Override
    public void onDisabled(Context context) {
        Log.i(TAG, "onDisabled: 执行");
        //当最后一个widget被删除的时候执行
        super.onDisabled(context);
    }

    @Override
    public void onDeleted(Context context, int[] appWidgetIds) {
        //当widget被删除的时候执行
        Log.i(TAG, "onDeleted: 执行");
        super.onDeleted(context, appWidgetIds);
    }

    @Override
    public void onRestored(Context context, int[] oldWidgetIds, int[] newWidgetIds) {
        super.onRestored(context, oldWidgetIds, newWidgetIds);
        //暂时不知道干嘛用的
    }
}

经过测试，生命周期如下

/**
     * 测试以下几种情况结果:
     *  将Log.i放在super之前的顺序
     * 创建第一个widget的时候执行顺序：
     * onReceive->onEnabled->onReceive->onUpdate->onReceive->onAppWidgetOptionsChanged
     * 创建第二个以后的widget的时候执行顺序：
     * onReceive->onUpdate->onReceive->onAppWidgetOptionsChanged
     * 删除widget的时候（不是最后一个）
     * onReceive->onDeleted
     * 删除最后一个widget的时候
     * onReceive->onDeleted->onReceive->onDisabled
     *
     * 根据以上日志发现，onReceive会在其他方法执行之前先执行一遍，每次都会
     * 如果widget设置了configure属性，onUpdate方法在首次添加的时候还是会执行,不过onAppWidgetOptionsChanged却不会执行了
     * */

2.在res目录下新建xml文件夹（有就不用了），在xml目录下，新建widget参数配置appwdiget_config.xml文件

<?xml version="1.0" encoding="utf-8"?>
<appwidget-provider xmlns:android="http://schemas.android.com/apk/res/android"
    android:minWidth="50dp"
    android:minHeight="50dp"
    android:updatePeriodMillis="10"
    android:previewImage="@drawable/logo"
    android:initialLayout="@layout/widget_layout"
    android:resizeMode="horizontal|vertical"
    android:widgetCategory="home_screen|keyguard"
    android:initialKeyguardLayout="@layout/widget_layout"
    >
</appwidget-provider>

 <!--说明：
        android:minWidth : 最小宽度
        android:minHeight ： 最小高度
        android:updatePeriodMillis ： 更新widget的时间间隔(ms)，"86400000"为1个小时
        android:previewImage ： 预览图片
        android:initialLayout ： 加载到桌面时对应的布局文件
        android:resizeMode ： widget可以被拉伸的方向。horizontal表示可以水平拉伸，vertical表示可以竖直拉伸
        android:widgetCategory ： widget可以被显示的位置。home_screen表示可以将widget添加到桌面，keyguard表示widget可以被添加到锁屏界面。
        android:initialKeyguardLayout ： 加载到锁屏界面时对应的布局文件
        android:configure：当 widget 创建时，会自动启动该 Activity
         -->

以上参数中initialLayout布局widget_layout.xml，如下，就是单纯的显示一个TextView

<?xml version="1.0" encoding="utf-8"?>
<LinearLayout xmlns:android="http://schemas.android.com/apk/res/android"
    android:orientation="vertical" android:layout_width="match_parent"
    android:layout_height="match_parent">
    <TextView
        android:id="@+id/txt"
        android:layout_width="wrap_content"
        android:layout_height="wrap_content"
        android:gravity="center"
        android:layout_gravity="center"
        android:text="展示文字"/>
</LinearLayout>

3.因为AppWidgetProvider其实是一个广播接收器，所以在清单文件中去注册

 

<!--静态注册广播接收器，这边也就是指小部件-->
        <receiver android:name=".AppWidget">
            <intent-filter>
                <action android:name="android.appwidget.action.APPWIDGET_UPDATE"></action>
                <action android:name="btn.text.com"></action>
            </intent-filter>
            <meta-data android:name="android.appwidget.provider"
                android:resource="@xml/appwidget_config" /><!--指定资源文件（配置的文件）-->
        </receiver>

以上，就三个步骤就能够实现一个简单的android widget了。

小部件支持的控件和布局还是有限的，详情见

Android 之窗口小部件详解--App Widget