最近项目上用到widget桌面小部件，所以抽空来简单总结学习一下。
1、widget是什么？
widget小部件，在桌面显示，运行在systemServer，独立于app存在，即使app未启动或者在后台，小部件仍然存在。‘
2、widget原理？
widget原理其实是广播。我们需要一个广播接收者接收widget发出的广播，与之交互。
android中提供了一个appWidgetProvier类,继承了BroadCastReceiver来处理应用的widget广播。并提供了remoteViews，让view在其他进程显示。
3、简单开发实例及详解：
1、创建一个widget布局
2、创建appwidget_info.xml文件
3、使用AppWidgetProvider类实现具体业务代码
4、在清单文件中进行声明配置
3.1创建widget布局
创建布局其实和在应用内layout中创建布局一样，需要注意的是这里的布局和组件只支持一下几种。
布局类：
布局类：
FrameLayout
LinearLayout
RelativeLayout
GridLayout
小部件类：
AnalogClock
Button
Chronometer
ImageButton
ImageView
ProgressBar
TextView
ViewFlipper
ListView
GridView
StackView
AdapterViewFlipper
widgte并不是运行在应用的进程上，所以对于widget布局显示和平常也有不同，widget的布局是基于remoteView的。
简单说下remoteView，remoteView翻译就是远程的view，可以让我们的view在其他进程显示，remoteView提供了一组基础的操作可以让我们跨进程更新它的界面。
创建的layout_widget_card.xml文件
<?xml version="1.0" encoding="utf-8"?>
<LinearLayout
android:orientation="vertical"
android:background="@drawable/img_4"
xmlns:android="http://schemas.android.com/apk/res/android"
android:layout_width="match_parent"
android:layout_height="match_parent">
<TextView
android:textSize="16dp"
android:layout_marginTop="40dp"
android:layout_gravity="center_horizontal"
android:text="@string/app_name"
android:id="@+id/text_widget_one"
android:layout_width="wrap_content"
android:layout_height="wrap_content"/>
<Button
android:text="点击按钮"
android:layout_marginTop="10dp"
android:layout_gravity="center"
android:background="#0659FA"
android:id="@+id/btn_widget_one"
android:layout_width="wrap_content"
android:layout_height="wrap_content"/>
</LinearLayout>
3.2创建appwidget_info.xml文件
文件如下，参数下面说明
<?xml version="1.0" encoding="utf-8"?>
<appwidget-provider xmlns:android="http://schemas.android.com/apk/res/android"
android:initialLayout="@layout/layout_widget_card"
android:minWidth="110dp"
android:minHeight="110dp"
android:previewImage="@drawable/img_4"
android:resizeMode="horizontal|vertical"
android:updatePeriodMillis="86400000"
android:widgetCategory="home_screen"/>
说下参数：
minWidth和minHeight：定义了AppWidget在桌面显示的最小宽高,单位dp。并且这两个属性的定义是有讲究的，在桌面上其实是按照“单元格”来排列的
每个小部件必须定义minWidth和minHeight，表示默认情况下它应该使用的最小空间量。当用户将一个小部件添加到他们的主屏幕时，它通常会超过您指定的最小宽度和高度。Android主屏幕为用户提供了一个可用空间网格，用户可以在其中放置小工具和图标。这个网格可以根据设备的不同而变化;例如，许多手机提供4x4网格，而平板电脑可以提供更大的8x7网格。当添加小部件时，它将被拉伸，以在水平和垂直方向上占用最小数量的单元格来满足需求.
虽然单元格的宽度和高度以及应用于小部件的自动边距的数量可能因设备而异，但您可以使用下面的表格来粗略估计小部件的最小尺寸(给定所占用的网格单元格的期望数量)
1、minResizeWidth 和 minResizeHeight：这两个属性上面没写，但还是介绍下，minWidth 和 minHeight相当于窗口小部件的默认大小，而这两个属性则是当小部件大小少于多少将模糊或不可见，一般用于ListView和GridView小部件
2、updatePeriodMillis：App Widget更新频率,单位毫秒,通过调用AppWidgetProvider类的onUpate()实现数据更新,为了节省电量默认建议一小时更新一次,系统默认最低30分钟(低于30会自动设为30)
3、previewImage：Widget预览页的图标
4、initialLayout：给Widget设置布局文件
5、resizeMode：指定调整小部件大小的规则，包括“水平”、“垂直”和“无”，上面设置的就是可以水平和垂直调整大小。
widgetCategory：设置AppWidget能够显示的屏幕,home_scree(主屏),keyguard(锁屏)或者同时显示
3.3使用AppWidgetProvider类实现具体业务代码
package com.example.viewpage2activity.widget;
import android.app.PendingIntent;
import android.appwidget.AppWidgetManager;
import android.appwidget.AppWidgetProvider;
import android.content.ComponentName;
import android.content.Context;
import android.content.Intent;
import android.os.Bundle;
import android.widget.RemoteViews;
import android.widget.Toast;
import com.example.viewpage2activity.R;
/**
* widget开发
* 桌面widget上文字及btn，点击btn，文字变化
*
* @author 62724
* @since 2022-10-10
*/
public class WidgetCard extends AppWidgetProvider {
/**
* 需要在maifest中声明此action
*/
private static final String WIDGET_CLICK_ACTION = "com.example.viewpager2activity.widget.CLICK";
private int clickTimes = 0;
/**
* 不属于widget生命周期方法
*
* @param context
* @param intent
*/
@Override
public void onReceive(Context context, Intent intent) {
super.onReceive(context, intent);
AppWidgetManager appWidgetManager = AppWidgetManager.getInstance(context);
/**
* 当桌面上的widget按钮（已在update中设置了监听），widget就会发送广播
* 这个广播我们在onUpdate中设置了intent、action。在这里我们接收到对应的action并做处理
*/
if (intent.getAction().equals(WIDGET_CLICK_ACTION)) {
/**
* 因为点击之后view的文字变化，所以需要实例化个remoteView
*/
RemoteViews remoteViews = new RemoteViews(context.getPackageName(), R.layout.layout_widget_card);
clickTimes++;
remoteViews.setTextViewText(R.id.text_widget_one, "按钮点击: " + clickTimes);
appWidgetManager.updateAppWidget(new ComponentName(context, WidgetCard.class), remoteViews); // 更新
}
}
/**
* widget更新时回调
*
* @param context
* @param appWidgetManager
* @param appWidgetIds 存放已创建的widget实例
*/
@Override
public void onUpdate(Context context, AppWidgetManager appWidgetManager, int[] appWidgetIds) {
super.onUpdate(context, appWidgetManager, appWidgetIds);
for (int widgetId :
appWidgetIds) { // 创建多个，都需要更新
RemoteViews remoteViews = new RemoteViews(context.getPackageName(), R.layout.layout_widget_card);
Intent clickIntent = new Intent();
clickIntent.setClass(context, WidgetCard.class);
clickIntent.setAction(WIDGET_CLICK_ACTION);
Toast.makeText(context, "widget按钮点击", Toast.LENGTH_SHORT).show();
/**
* pendingIntent表示的是即将发生的意图，区别于intent是立即发生的
*/
PendingIntent pendingIntent = PendingIntent.getBroadcast(context, 0, clickIntent, PendingIntent.FLAG_UPDATE_CURRENT);
remoteViews.setOnClickPendingIntent(R.id.btn_widget_one, pendingIntent);
appWidgetManager.updateAppWidget(widgetId, remoteViews); // 更新
}
}
@Override
public void onAppWidgetOptionsChanged(Context context, AppWidgetManager appWidgetManager, int appWidgetId, Bundle newOptions) {
super.onAppWidgetOptionsChanged(context, appWidgetManager, appWidgetId, newOptions);
}
//当 widget 被删除时回调
@Override
public void onDeleted(Context context, int[] appWidgetIds) {
super.onDeleted(context, appWidgetIds);
}
//当widget第一次添加到桌面的时候回调，可添加多次widget，但该方法只回调一次
@Override
public void onEnabled(Context context) {
super.onEnabled(context);
}
//当最后一个widget实例被删除时回调.
@Override
public void onDisabled(Context context) {
super.onDisabled(context);
}
@Override
public void onRestored(Context context, int[] oldWidgetIds, int[] newWidgetIds) {
super.onRestored(context, oldWidgetIds, newWidgetIds);
}
}
AppWidgetProvider类本质就是一个广播接收者，通过源码我们可以看它继承了BroadcastReceiver类。它是用来处理App Widget的广播。
AppWidgetProvider 仅接收与 App Widget 相关的事件广播，例如 App Widget 创建、更新、删除、启用和禁用。当这些广播事件发生时，AppWidgetProvider 会有相应的回调。
主要讲下 onUpdate 这个方法。它其实和我们在上面创建AppWidgetProviderInfo中的一个属性updatePeriodMillis是对应的。根据updatePeriodMillis设置的时长，当到达相应的时长，就会调用onUpdate方法。还有当每个 App Widget 添加到屏幕时也会调用它（除非创建的是App Widget Configuration Activity）。
如果你的App Widget 需要接收用户交互事件，需要在此回调中注册事件处理程序。像上面因为我要实现点击界面按钮，然后监听响应对应的事件。就需要先创建一个RemoteViews来让我们可以操控到widget布局，需要传入两个参数，第一个参数是包名，第二个参数是布局文件。RemoteViews创建后会被传递到SystemServer进程中，系统会根据RemoteViews中的包名等信息取得到该应用的资源，然后再通过LayoutInflater去加载RemoteViews中的布局文件。RemoteViews提供了一系列set方法，让我们为对应的控件设置属性或点击事件。
setOnClickPendingIntent(int viewId,PendingIntent pendingIntent)
setTextViewText(int viewId,CharSequence text)
setTextColor(int viewId,int color)
setImageViewResourse(int viewId,int srcId)
上面列举了部分的set方法，讲一下第一个方法，因为在上面代码中也有用到，为button设置点击事件。第一个参数不用讲，就是对应的控件id，第二参数 PendingIntent 可能会有些同学不是很清楚，简单解释下，他其实和Intent一样也是一种意图，但不同于Intent它多了个Pending，意思时即将发生、待定的。也就是说与Intent的区别就是，Intent是立即发生的，而PendingIntent是在一个之后的一个不确定的时刻发生。我们知道，RemoteViews是运行在其他进程中的，所以无法直接为控件设置setOnClickListener，所以只能通过PendingIntent来发送和取消待定的Intent。上面代码使用了 getBroadcast 方法来获取PendingIntent，并且传入了一个Intent的对象，这个对象设置了Action。那么当这个PendingIntent发生的时候，效果就相当于发送了一个广播（ Context.sendBroadcast(Intent) ），然后在onReceive中接收到这个Intent，判断是否为对应的Action，是的话就叫进行对应的操作。
为控件设置好属性或点击事件后，还需要告诉AppWidgetManager对当前应用程序小部件执行更新。因为可能有多个widget，所以要对它们全部更新，可以看到上面onUpdate方法参数中有个用来存储已经创建的widget的id的数组，我们需要遍历这个数组，实现对所有的widget进行更新。
3.4创建widget布局
代码：
<receiver android:name=".widget.WidgetCard">
<intent-filter>
<!--必须声明-->
<action android:name="android.appwidget.action.APPWIDGET_UPDATE" />
<action android:name="com.example.viewpager2activity.widget.CLICK" />
</intent-filter>
<meta-data
android:name="android.appwidget.provider"
android:resource="@xml/appwidget_info" />
</receiver>
上面就是widget的简单使用,还有一个就是remoteView的使用了，学习了后再上传wiki。
170
被折叠的 条评论
为什么被折叠?
到【灌水乐园】发言
