Widget就是可以放在桌面上的組件，包括像天氣、便簽、日歷、垃圾清理、快速搜索等等，都是Widget。
Github Demo地址
AppWidgetProvider
定義允許您基于廣播事件以編程方式與應(yīng)用微件連接的基本方法。
在Android studio中創(chuàng)建Widget組件
創(chuàng)建Widget的主要3個(gè)文件：
1.得到生成的AppWidgetProvider類：
class GoogleSearchWidget : AppWidgetProvider() {
override fun onUpdate(
context: Context,
appWidgetManager: AppWidgetManager,
appWidgetIds: IntArray
) {
//此方法可以按 AppWidgetProviderInfo 中的 updatePeriodMillis 屬性定義的時(shí)間間隔來更新應(yīng)用微件
for (appWidgetId in appWidgetIds) {
updateAppWidget(context, appWidgetManager, appWidgetId)
}
}
override fun onReceive(context: Context?, intent: Intent?) {
super.onReceive(context, intent)
//接收廣播
}
override fun onEnabled(context: Context) {
// 首次創(chuàng)建應(yīng)用微件的實(shí)例時(shí)，會(huì)調(diào)用此方法。
}
override fun onDisabled(context: Context) {
// 從應(yīng)用微件托管應(yīng)用中刪除了應(yīng)用微件的最后一個(gè)實(shí)例時(shí)，會(huì)調(diào)用此方法。
}
/*
* 每刪除一次窗口小部件就調(diào)用一次
*/
@Override
public void onDeleted(Context context, int[] appWidgetIds) {
super.onDeleted(context, appWidgetIds);
}
/*
* 當(dāng)小部件大小改變時(shí)
*/
@Override
public void onAppWidgetOptionsChanged(Context context, AppWidgetManager appWidgetManager, int appWidgetId, Bundle newOptions) {
super.onAppWidgetOptionsChanged(context, appWidgetManager, appWidgetId, newOptions);
}
}
internal fun updateAppWidget(
context: Context,
appWidgetManager: AppWidgetManager,
appWidgetId: Int
) {
val views = RemoteViews(context.packageName, R.layout.google_search_widget)
appWidgetManager.updateAppWidget(appWidgetId, views)
}
Widget繼承于BroadcastReceiver，需要在manifest中注冊(cè)：
- android:name指定元數(shù)據(jù)名稱。使用 android.appwidget.provider將數(shù)據(jù)標(biāo)識(shí)為 AppWidgetProviderInfo描述符。
- android:resource`指定 AppWidgetProviderInfo資源位置。
<receiver
android:name=".GoogleSearchWidget"
android:exported="false">
<intent-filter>
<action android:name="android.appwidget.action.APPWIDGET_UPDATE" /> <!-- 用于監(jiān)聽系統(tǒng)發(fā)送廣播通知小部件刷新 -->
</intent-filter>
<meta-data
android:name="android.appwidget.provider"
android:resource="@xml/google_search_widget_info" />
</receiver>
創(chuàng)建Widget同時(shí)會(huì)創(chuàng)建AppWidgetProviderInfo文件，描述應(yīng)用微件的元數(shù)據(jù)，如應(yīng)用微件的布局、更新頻率和 AppWidgetProvider 類。
<?xml version="1.0" encoding="utf-8"?>
<appwidget-provider xmlns:android="http://schemas.android.com/apk/res/android"
android:description="@string/app_widget_description"
android:initialKeyguardLayout="@layout/google_search_widget"
android:initialLayout="@layout/google_search_widget"
android:minWidth="250dp"
android:minHeight="40dp"
android:previewImage="@drawable/example_appwidget_preview"
android:previewLayout="@layout/google_search_widget"
android:resizeMode="horizontal|vertical"
android:targetCellWidth="4"
android:targetCellHeight="1"
android:updatePeriodMillis="86400000"
android:widgetCategory="home_screen" />
屬性解釋
- minWidth 和 minHeight
屬性的值指定應(yīng)用微件默認(rèn)情況下占用的最小空間 - minResizeWidth 和 minResizeHeight
屬性指定應(yīng)用微件的絕對(duì)最小大小。 - updatePeriodMillis
屬性定義應(yīng)用微件框架通過調(diào)用 onUpdate()回調(diào)方法來從 AppWidgetProvider請(qǐng)求更新的頻率應(yīng)該是多大。不能保證實(shí)際更新按此值正好準(zhǔn)時(shí)發(fā)生，我們建議盡可能降低更新頻率 - 或許不超過每小時(shí)一次，以節(jié)省電池電量。 - initialLayout
屬性指向用于定義應(yīng)用微件布局的布局資源。 - previewImage
屬性指定預(yù)覽來描繪應(yīng)用微件經(jīng)過配置后是什么樣子的，用戶在選擇應(yīng)用微件時(shí)會(huì)看到該預(yù)覽。
創(chuàng)建Widget布局
Widget基于RemoteViews類，并不支持所有的控件跟布局，而僅僅只是支持Android布局和控件的一個(gè)子集。
1、支持布局：FrameLayout，LinearLayout，RelativeLayout，GridLayout
2、支持控件：AnalogClock，Button，Chronometer，ImageButton，ImageView，ProgressBar，TextView，ViewFlipper，ListView，GridView，StackView，AdapterViewFlipper
布局控件使用超出限制，或者使用了自定義View， 添加控件時(shí)會(huì)報(bào)"找不到布局"的錯(cuò)誤：
簡單示例布局文件：
<LinearLayout
xmlns:android="http://schemas.android.com/apk/res/android"
android:layout_width="match_parent"
android:layout_height="55dp"
android:id="@android:id/background"
android:background="@drawable/shape_corner_30_solid_white"
android:orientation="horizontal"
android:padding="10dp"
android:gravity="center_vertical">
<ImageView
android:id="@+id/iv_google_search"
android:layout_width="30dp"
android:layout_height="30dp"
android:src="@mipmap/google"
android:layout_marginStart="5dp"/>
<TextView
android:layout_width="0dp"
android:layout_weight="1"
android:layout_height="1dp"/>
<ImageView
android:layout_width="30dp"
android:layout_height="30dp"
android:src="@mipmap/voice"/>
<ImageView
android:layout_width="30dp"
android:layout_height="30dp"
android:src="@mipmap/camera"
android:layout_marginStart="10dp"
android:layout_marginEnd="5dp"/>
</LinearLayout>
從小部件庫中添加到桌面效果：
在代碼中動(dòng)態(tài)添加到桌面：
/**
* 動(dòng)態(tài)向桌面添加widget
*/
@JvmStatic
fun createDeskTopWidget() {
appContext?.let {
val serviceComponent = ComponentName(it, GoogleSearchWidget::class.java)
if (Build.VERSION.SDK_INT >= Build.VERSION_CODES.O) {
AppWidgetManager.getInstance(appContext).requestPinAppWidget(serviceComponent, null, null)
}
}
}
requestPinAppWidget: Request to pin an app widget on the current launcher. It's up to the launcher to accept this request (optionally showing a user confirmation)
點(diǎn)擊事件跳轉(zhuǎn)
點(diǎn)擊iv_google_search為id的控件，這里通過action匹配目標(biāo)activity，創(chuàng)建PendingIntent進(jìn)行跳轉(zhuǎn)，可通過給intent攜帶extra進(jìn)行傳參。
internal fun updateDeskTopWidget(
context: Context,
appWidgetManager: AppWidgetManager,
appWidgetId: Int
) {
val views = RemoteViews(context.packageName, R.layout.browser_desktop_widget)
views.setOnClickPendingIntent(R.id.iv_google_search, getPendingIntentByAction(context, R.id.iv_google_search, ACTION_SEARCH, MODE_BROWSER_SEARCH))
appWidgetManager.updateAppWidget(appWidgetId, views)
}
fun getPendingIntentByAction(context: Context, appWidgetId: Int, action: String, extra: String): PendingIntent {
val intent = Intent()
intent.action = action
intent.putExtra("extra", extra)
//使用FLAG_ACTIVITY_CLEAR_TOP會(huì)將該啟動(dòng)的activity上層activity彈出棧，確保該activity能顯示在頂層
intent.flags = Intent.FLAG_ACTIVITY_CLEAR_TOP
var flag = PendingIntent.FLAG_UPDATE_CURRENT
if (android.os.Build.VERSION.SDK_INT >= 31) {
flag = flag or PendingIntent.FLAG_MUTABLE
}
return PendingIntent.getActivity(
context,
appWidgetId,
intent,
flag
)
}
進(jìn)程初始化處理
由于Widget在子進(jìn)程中創(chuàng)建，所以在創(chuàng)建widget進(jìn)程的時(shí)候，會(huì)重復(fù)走application的oncreate方法，初始化也會(huì)走多次，所以導(dǎo)致widget進(jìn)程會(huì)初始化很多不必要的內(nèi)容，占用過多內(nèi)存。所以需要在application的onCreate方法中判斷當(dāng)前進(jìn)程是否是widget進(jìn)程，如果是widget進(jìn)程，直接return。
Widget進(jìn)行周期性更新內(nèi)容
在App中發(fā)送廣播，在widget中的onReceive() 用來接收廣播。
Intent updateIntent = new Intent(ACTION_UPDATE);
sendBroadcast(updateIntent);
AppWidgetProvider中代碼：
class GoogleSearchWidget : AppWidgetProvider() {
// 保存 widget 的id的HashSet，每新建一個(gè) widget 都會(huì)為該 widget 分配一個(gè) id。
private val idsSet = HashSet<Int>()
companion object {
const val ACTION_UPDATE = "action_update"
}
override fun onUpdate(
context: Context,
appWidgetManager: AppWidgetManager,
appWidgetIds: IntArray
) {
//此方法可以按 AppWidgetProviderInfo 中的 updatePeriodMillis 屬性定義的時(shí)間間隔來更新應(yīng)用微件
for (appWidgetId in appWidgetIds) {
updateAppWidget(context, appWidgetManager, appWidgetId)
idsSet.add(appWidgetId) //更新控件存儲(chǔ) appWidgetId
}
}
override fun onEnabled(context: Context) {
// 首次創(chuàng)建應(yīng)用微件的實(shí)例時(shí)，會(huì)調(diào)用此方法。
}
override fun onDisabled(context: Context) {
// 從應(yīng)用微件托管應(yīng)用中刪除了應(yīng)用微件的最后一個(gè)實(shí)例時(shí)，會(huì)調(diào)用此方法。
}
override fun onReceive(context: Context, intent: Intent?) {
super.onReceive(context, intent)
if (intent?.action.equals(ACTION_UPDATE)) {
updateAllAppWidgets(context, AppWidgetManager.getInstance(context))
}
}
/**
* 更新所有widget
*/
private fun updateAllAppWidgets(context: Context, appWidgetManager: AppWidgetManager) {
idsSet.forEach {
val views = RemoteViews(context.packageName, R.layout.google_search_widget)
appWidgetManager.updateAppWidget(it, views) // 更新 widget
}
}
}
最后，需要啟動(dòng)周期性任務(wù)來更新widget廣播觸發(fā)，可以選擇啟動(dòng)service，在service啟動(dòng)timer周期性發(fā)送，可以利用Alarm來周期性發(fā)送，還可以使用Workmanager做周期性任務(wù)發(fā)送廣播。
