1.前言

AppWidget即桌面小部件，也叫桌面控件，就是能直接显示在Android系统桌面上的小程序，并且可以接收定期更新。AppWidget是Android系统应用开发层面的一部分，它的工作原理是把一个进程的控件嵌入到别外一个进程的窗口里的一种方法。

局限性：不适合太复杂的应用。

优点：可以在用户屏幕上一目了然地显示应用程序最及时或相关的信息。

结构:典型的Android应用小部件有三个主要组件：边界框，框架，小部件的图形控件和其它元素。应用小部件可以包含Android中View小部件的子集；支持的控件包括文本标签，按钮和图像。

2.使用方法

2.1 创建AppWidget

• 首先创建一个AppWidget

  
  image

/**
 * Implementation of App Widget functionality.
 * @author wydnn
 */
public class MyNewAppWidget extends AppWidgetProvider {

    static void updateAppWidget(Context context, AppWidgetManager appWidgetManager,
                                int appWidgetId) {

        CharSequence widgetText = context.getString(R.string.appwidget_text);
        // Construct the RemoteViews object
        RemoteViews views = new RemoteViews(context.getPackageName(), R.layout.my_new_app_widget);
        views.setTextViewText(R.id.appwidget_text, widgetText);

        // Instruct the widget manager to update the widget
        appWidgetManager.updateAppWidget(appWidgetId, views);
    }

    @Override
    public void onUpdate(Context context, AppWidgetManager appWidgetManager, int[] appWidgetIds) {
        // There may be multiple widgets active, so update all of them
        for (int appWidgetId : appWidgetIds) {
            updateAppWidget(context, appWidgetManager, appWidgetId);
        }
    }

    @Override
    public void onEnabled(Context context) {
        // Enter relevant functionality for when the first widget is created
    }

    @Override
    public void onDisabled(Context context) {
        // Enter relevant functionality for when the last widget is disabled
    }
}

说明

该类继承AppWidgetProvider，而AppWidgetProvider继承自BroadcastReceive,AS默认帮我们重写onUpdate()方法，遍历appWidgetIds，调用了updateAppWidget()方法。同时需要在清单文件中注册<receive>标签，小部件之所以有附着在桌面，跨进程更新View的能力，主要是因为AppWidgetProvider是一个广播接收者。该类的布局视图可以根据需要设计。

回调方法：

onEnable()
当该窗口小部件第一次被添加到桌面时调用该方法，可添加多次但只在第一次调用。对应广播的Action为ACTION_APPWIDGET_ENABLE。

onUpdate()
小部件添加时或者每次小部件更新时都会调用此方法，小部件的更新时机由updatePeriodMillis来指定，每个周期的小部件都会自动更新一次。对应广播 Action为:ACTION_APPWIDGET_UPDATE和ACTION_APPWIDGET_RESTORED.

onDelete()
每删除一个小部件就调用一次。对应的广播Action为:ACTION_APPWIDGET_UPDATE和ACTION_APPWIDGET_RESTORED

onDisable()
当最后一个该类型的桌面小部件被删除时调用该方法。
所以在我们自定义小部件时需要重写public void onUpdate(Context context,AppWidgetManager appWidgetManager,int[] appWidgets)来更新小部件。
这里在更新的时候我们根据布局文件创建出来一个remoteViews。

onRestored()
当小部件从备份中还原，或者恢复设置的时候，会调用，实际用的比较少。对应广播的Action为ACTION_APPWIDGET_RESTORED.

RemoteViews
从字面意思理解为它是一个远程视图。是一种远程的View，它在其它进程中显示，却可以在另一个进程中更新。RemoteViews在Android中的使用场景主要有:自定义通知栏和桌面小部件。
在RemoteViews的构造函数中，第二个参数接收一个layout文件来确定RemoteViews的视图；然后，我们调用RemoteView中的set方法对layout中的各个组件进行设置，例如，可以调用setTextViewText()来设置TextView组件的文本。小部件的布局文件可以添加的组件是有限制的，它可以支持的View类型包括四种布局：FrameLayout、LinearLayout、RelativeLayout、GridLayout和13种View:Analog、Button、Chronometer、ImageButton、ImageView、ProgressBar、TextView、ViewFlipper、ListView、GridView、StackView、AdapterViewFlipper、ViewSub。但值得注意的是RemoteViews也并不支持上述View的子类。

onReceived()

AppWidgetProvider重写该方法，用于接收由于点击事件所产生的广播。

@Override
    public void onReceive(Context context, Intent intent) {

        String action = intent.getAction();
        /**
         * appWidgetManager
         */
        AppWidgetManager appWidgetManager = AppWidgetManager.getInstance(context);

        int [] appIds = appWidgetManager.getAppWidgetIds(new ComponentName(context,CarInformationWidget.class));


        if(action.equals(APPONCLICK_ACTION)){

            RemoteViews  remoteViews = new RemoteViews(context.getPackageName(), R.layout.activity_main);
            remoteViews.setViewVisibility(R.id.rl_tips_line1,View.VISIBLE);
            appWidgetManager.updateAppWidget(appIds, remoteViews);

        }

        if(action.equals(APP_AROUTER)){

              Intent intent1 = new Intent(context,MainActivity.class);
              Bundle bundle = new Bundle();
              bundle.putString("mile",Constant.mileAge+"");
              bundle.putString("vehicle_humidity",Constant.vehicle_humidity+"");
              bundle.putString("voltage",Constant.voltage+"");
              bundle.putString("speed",Constant.speed+"");
              intent1.putExtras(bundle);
              context.startActivity(intent1);

        }
        super.onReceive(context, intent);

    }

my_new_app_widget.xml

<RelativeLayout xmlns:android="http://schemas.android.com/apk/res/android"
    android:layout_width="match_parent"
    android:layout_height="match_parent"
    android:background="#09C"
    android:padding="@dimen/widget_margin">

    <TextView
        android:id="@+id/appwidget_text"
        android:layout_width="wrap_content"
        android:layout_height="wrap_content"
        android:layout_centerHorizontal="true"
        android:layout_centerVertical="true"
        android:layout_margin="8dp"
        android:background="#09C"
        android:contentDescription="@string/appwidget_text"
        android:text="@string/appwidget_text"
        android:textColor="#ffffff"
        android:textSize="24sp"
        android:textStyle="bold|italic" />

</RelativeLayout>

该布局文件主要是桌面插件的点击图标。

appwidget-provider

<appwidget-provider xmlns:android="http://schemas.android.com/apk/res/android"
    android:initialKeyguardLayout="@layout/car_information_widget"
    android:initialLayout="@layout/car_information_widget"
    android:minHeight="300dp"
    android:minWidth="300dp"
    android:previewImage="@drawable/example_appwidget_preview"
    android:resizeMode="horizontal|vertical"
    android:updatePeriodMillis="86400000"
    android:widgetCategory="home_screen">

</appwidget-provider>

这个主要是小部件的配置信息。

minWidth和minHeight

指定了App Widget布局需要的最小区域。

minResizeWidth和minResizeHeight

指定了widget的最小尺寸。

updatePeriodMillis

它定义了widget的更新频率。实际的更新时机不一定是精确的按照这个时间发生的。建议更新尽量不要太频繁，最好是低于1小时一次。或者可以在配置Activity里面供用户对更新频率进行配置。实际上，当updatePeriodMillis的值小于30分钟时，系统会自动将更新频率设为30分钟！

initialLayout

指向widget的布局资源文件

configure

可选属性，定义了widget的配置Activity。如果定义了该项，那么当widget创建时，会自动启动该Activity。

previewImage

指定预览图，该预览图在用户选择widget时出现，如果没有提供，则会显示应用的图标。该字段对应在AndroidManifest.xml中receive的android:previewImage字段。

autoAdvanceViewId

指定一个子View ID，表明该子View会自动更新。

resizeMode

指定了widget的调整尺寸的规则。可取的值有:"horizontal","vertical","none"."horizontal"意味着widget可以水平拉伸，"vertical"意味着widget可以竖直拉伸，"none"意味着widget不能拉伸;默认值是"none"

widgetCategory
指定了widget能显示的地方：能否显示在home Screen或lock screen或两者都可以。它的取值包括:"home_screen"和 "keyguard"

initialKeyguardLayout

指向widget位于locksscreen中的布局文件。

2.2 编辑manifest

修改AndroidManifest.xml，示例代码如下:

  <receiver android:name=".CarInformationWidget">
           <intent-filter>
               <action android:name="android.appwidget.action.APPWIDGET_UPDATE" />
               <action android:name="android.appwidget.action.APPONCLICK" />
               <action android:name="android.appwidget.action.AROUTER" />
           </intent-filter>

           <meta-data
               android:name="android.appwidget.provider"
               android:resource="@xml/car_information_widget_info" />
       </receiver>

说明

1. CarInformationWidget 是继承于的AppWidgetProvider类，用来响应widget的添加、删除、更新等操作。

2. android.appwidget.action.APPWIDGET_UPDATE，这是一个必须要显示声明的action!因为所有的widget的广播都是通过它来发送的；要接收widget的添加、删除等广播，就必须包含它。除此之外还可以定义其它事件的ACTION。用于过滤出我们需要的广播。

3. action android:name="com.skywang.widget.UPDATE_ALL"，这是我自己添加的，是为了接收服务所发送的更新图片的广播。

4. <meta-data>指定了AppWidgetProviderInfo对应的资源路径。即xml/example_appwidget_info.xml

3.总结

• 1、每个AppWidget都有一个AppWidgetProviderInfo对象，该对象描述了每个AppWidget的基本数据(meta-data)信息，其定义在节点信息。
• 2、每个AppWidget都对应一个RemoteViews视图对象，该RemoteViews提供了特定AppWidget的展示(View视图)和操作。
• 3、AppWidgetManager类维护了应用程序中所有的AppWidget，并且为每个AppWidget特定的Id去标识他们(一般我们用appWidget去标识)。通过给定的appWidgetId,AppWidgetManager可以管理对应的AppWidget，例如：更新该AppWidgetId的remoteView视图，删除AppWidget对象等。

• 4、AppWidgetProvider广播类从来说是一个监听器，系统把对AppWidget的操作(例如，创建和更新等)分发给AppWidgetProvider类去处理。对每个AppWidget，我们可以创建其多个实例，当然这些实例对应于不同的appWidgetId。假设存在这么个MyAppWidgetProvider广播类，以及对应的MyAppWidgetProviderInfo对象。MyAppWidgetProvider.class代表了由该MyAppWidgetProvider创建的窗口小部件(AppWidget)的类型，一般用CompontentName对象形式表示。

  
  image
  

  从上图可知，每个appWidget都对应于一个MyAppWidgetProvider类，于是当任何一个appWidgetId发生变化时，我们需要同步其他实例，保持同步性。

Demo展示

image

项目地址

AppWidgetDemo