このページでは、ユーザー エクスペリエンスを向上させるために、より高度なウィジェットを作成する際のおすすめの方法について説明します。
ウィジェット コンテンツの更新の最適化
ウィジェットのコンテンツを更新すると、計算コストが高くなることがあります。バッテリー消費を抑えるには、更新タイプ、頻度、タイミングを最適化します。
ウィジェットの更新の種類
ウィジェットを更新するには、完全な更新、部分的な更新、コレクション ウィジェットの場合はデータ更新の 3 つの方法があります。それぞれ計算コストと影響が異なります。
以下に、各更新タイプについて説明し、それぞれのコード スニペットを示します。
完全更新:
AppWidgetManager.updateAppWidget(int, android.widget.RemoteViews)を呼び出して、ウィジェットを完全に更新します。これにより、以前に提供されたRemoteViewsが新しいRemoteViewsに置き換えられます。これは最も計算コストの高い更新です。Kotlin
val appWidgetManager = AppWidgetManager.getInstance(context) val remoteViews = RemoteViews(context.getPackageName(), R.layout.widgetlayout).also { setTextViewText(R.id.textview_widget_layout1, "Updated text1") setTextViewText(R.id.textview_widget_layout2, "Updated text2") } appWidgetManager.updateAppWidget(appWidgetId, remoteViews)
Java
AppWidgetManager appWidgetManager = AppWidgetManager.getInstance(context); RemoteViews remoteViews = new RemoteViews(context.getPackageName(), R.layout.widgetlayout); remoteViews.setTextViewText(R.id.textview_widget_layout1, "Updated text1"); remoteViews.setTextViewText(R.id.textview_widget_layout2, "Updated text2"); appWidgetManager.updateAppWidget(appWidgetId, remoteViews);
部分更新:
AppWidgetManager.partiallyUpdateAppWidgetを呼び出して、ウィジェットの一部を更新します。これにより、新しいRemoteViewsが以前に提供されたRemoteViewsと統合されます。ウィジェットがupdateAppWidget(int[], RemoteViews)を介して少なくとも 1 回の完全な更新を受信していない場合、このメソッドは無視されます。Kotlin
val appWidgetManager = AppWidgetManager.getInstance(context) val remoteViews = RemoteViews(context.getPackageName(), R.layout.widgetlayout).also { setTextViewText(R.id.textview_widget_layout, "Updated text") } appWidgetManager.partiallyUpdateAppWidget(appWidgetId, remoteViews)
Java
AppWidgetManager appWidgetManager = AppWidgetManager.getInstance(context); RemoteViews remoteViews = new RemoteViews(context.getPackageName(), R.layout.widgetlayout); remoteViews.setTextViewText(R.id.textview_widget_layout, "Updated text"); appWidgetManager.partiallyUpdateAppWidget(appWidgetId, remoteViews);
コレクション データの更新:
AppWidgetManager.notifyAppWidgetViewDataChangedを呼び出して、ウィジェットのコレクション ビューのデータを無効にします。これにより、RemoteViewsFactory.onDataSetChangedがトリガーされます。それまでの間、古いデータがウィジェットに表示されます。このメソッドを使用すると、コストのかかるタスクを安全に同期的に実行できます。Kotlin
val appWidgetManager = AppWidgetManager.getInstance(context) appWidgetManager.notifyAppWidgetViewDataChanged(appWidgetId, R.id.widget_listview)
Java
AppWidgetManager appWidgetManager = AppWidgetManager.getInstance(context); appWidgetManager.notifyAppWidgetViewDataChanged(appWidgetId, R.id.widget_listview);
アプリが対応する AppWidgetProvider クラスと同じ UID を持っている限り、アプリ内のどこからでもこれらのメソッドを呼び出すことができます。
ウィジェットの更新頻度を決定する
ウィジェットは、updatePeriodMillis 属性に指定された値に応じて定期的に更新されます。ウィジェットは、ユーザー操作、ブロードキャスト更新、またはその両方に応じて更新できます。
定期的に更新する
定期的な更新の頻度は、appwidget-provider XML で AppWidgetProviderInfo.updatePeriodMillis の値を指定することで制御できます。更新ごとに AppWidgetProvider.onUpdate() メソッドがトリガーされます。このメソッドに、ウィジェットを更新するコードを配置できます。ただし、ウィジェットがデータを非同期で読み込む必要がある場合や、更新に 10 秒以上かかる場合は、次のセクションで説明するブロードキャスト レシーバの更新の代替手段を検討してください。10 秒を超えると、システムは BroadcastReceiver が応答しないとみなします。
updatePeriodMillis は 30 分未満の値をサポートしていません。ただし、定期的な更新を無効にする場合は、0 を指定できます。
ユーザーが構成で更新の頻度を調整できるようにすることができます。たとえば、株価情報を 15 分おきに更新する、1 日 4 回のみ更新する、といった設定ができます。この場合は、updatePeriodMillis を 0 に設定し、代わりに WorkManager を使用します。
ユーザーの操作に応じて更新する
ユーザー操作に基づいてウィジェットを更新するおすすめの方法を以下に示します。
アプリのアクティビティから: ユーザーのタップなどのユーザー操作に応じて、
AppWidgetManager.updateAppWidgetを直接呼び出します。通知やアプリ ウィジェットなどのリモート インタラクションから:
PendingIntentを構築し、呼び出されたActivity、Broadcast、またはServiceからウィジェットを更新します。優先度はご自身で選択できます。たとえば、PendingIntentにBroadcastを選択した場合、フォアグラウンド ブロードキャストを選択してBroadcastReceiverに優先度を付与できます。
ブロードキャスト イベントに応答して更新する
ウィジェットの更新が必要なブロードキャスト イベントの例としては、ユーザーが写真を撮ったときなどがあります。この場合、新しい写真が検出されたときにウィジェットを更新します。
JobScheduler でジョブをスケジュールし、JobInfo.Builder.addTriggerContentUri メソッドを使用してブロードキャストをトリガーとして指定できます。
ブロードキャストの BroadcastReceiver を登録することもできます（ACTION_LOCALE_CHANGED をリッスンするなど）。ただし、この処理はデバイスのリソースを消費するため、慎重に使用し、特定のブロードキャストのみをリッスンしてください。Android 7.0（API レベル 24）と Android 8.0（API レベル 26）でブロードキャスト制限が導入されたため、アプリはマニフェストで暗黙的ブロードキャストを登録できなくなりました（例外あり）。
BroadcastReceiver からウィジェットを更新する際の考慮事項
BroadcastReceiver（AppWidgetProvider を含む）からウィジェットを更新する場合は、ウィジェットの更新の期間と優先度に関する次の考慮事項に注意してください。
更新の所要時間
原則として、システムは、通常アプリのメインスレッドで実行されるブロードキャスト レシーバが 10 秒間実行されるまで待機し、その後、応答なしと判断して Application Not Responding（ANR）エラーをトリガーします。ブロードキャストの処理中にメインスレッドがブロックされないようにするには、goAsync メソッドを使用します。ウィジェットの更新に時間がかかる場合は、WorkManager を使用してタスクをスケジュール設定することを検討してください。
Caution: Any work you do here blocks further broadcasts until it completes,
so it can slow the receiving of later events.
詳細については、セキュリティに関する考慮事項とベスト プラクティスをご覧ください。
アップデートの優先度
デフォルトでは、AppWidgetProvider.onUpdate を使用して作成されたブロードキャストを含め、ブロードキャストはバックグラウンド プロセスとして実行されます。つまり、システム リソースが過負荷になると、ブロードキャスト レシーバの呼び出しが遅延する可能性があります。ブロードキャストの優先度を上げるには、フォアグラウンド プロセスにします。
たとえば、ユーザーがウィジェットの特定の部分をタップしたときに、PendingIntent.getBroadcast に渡される Intent に Intent.FLAG_RECEIVER_FOREGROUND フラグを追加します。
動的アイテムを含む正確なプレビューを作成する
このセクションでは、コレクション ビュー（ListView、GridView、StackView を使用するウィジェット）を含むウィジェットのウィジェット プレビューで複数のアイテムを表示するための推奨アプローチについて説明します。
ウィジェットでこれらのビューのいずれかを使用している場合、実際のウィジェット レイアウトを直接提供することでスケーラブルなプレビューを作成すると、ウィジェット プレビューにアイテムが表示されない場合にエクスペリエンスが低下します。これは、コレクション ビューのデータが実行時に動的に設定されるためです。図 1 に示す画像と似たような表示になります。
コレクション ビューを含むウィジェットのプレビューをウィジェット ピッカーで正しく表示するには、プレビュー専用の個別のレイアウト ファイルを維持することをおすすめします。この別のレイアウト ファイルには、実際のウィジェット レイアウトと、偽のアイテムを含むプレースホルダ コレクション ビューが含まれています。たとえば、複数の偽のリスト項目を含むプレースホルダ LinearLayout を指定することで、ListView を模倣できます。
ListView の例を示すため、別のレイアウト ファイルから始めます。
// res/layout/widget_preview.xml
<LinearLayout xmlns:android="http://schemas.android.com/apk/res/android"
android:layout_width="match_parent"
android:layout_height="wrap_content"
android:background="@drawable/widget_background"
android:orientation="vertical">
// Include the actual widget layout that contains ListView.
<include
layout="@layout/widget_view"
android:layout_width="match_parent"
android:layout_height="wrap_content" />
// The number of fake items you include depends on the values you provide
// for minHeight or targetCellHeight in the AppWidgetProviderInfo
// definition.
<TextView android:text="@string/fake_item1"
android:layout_width="match_parent"
android:layout_height="wrap_content"
android:layout_marginVertical="?attr/appWidgetInternalPadding" />
<TextView android:text="@string/fake_item2"
android:layout_width="match_parent"
android:layout_height="wrap_content"
android:layout_marginVertical="?attr/appWidgetInternalPadding" />
</LinearLayout>
AppWidgetProviderInfo メタデータの previewLayout 属性を指定するときに、プレビュー レイアウト ファイルを指定します。initialLayout 属性の実際のウィジェット レイアウトは指定し、実行時に RemoteViews を構築するときに実際のウィジェット レイアウトを使用します。
<appwidget-provider
previewLayout="@layout/widget_previe"
initialLayout="@layout/widget_view" />
複雑なリストアイテム
前のセクションの例では、リストアイテムが TextView オブジェクトであるため、偽のリストアイテムが提供されます。アイテムが複雑なレイアウトの場合、偽のアイテムを提供するのはより複雑になる可能性があります。
widget_list_item.xml で定義され、2 つの TextView オブジェクトで構成されるリストアイテムについて考えてみましょう。
<LinearLayout xmlns:android="http://schemas.android.com/apk/res/android"
android:layout_width="match_parent"
android:layout_height="wrap_content">
<TextView android:id="@id/title"
android:layout_width="match_parent"
android:layout_height="wrap_content"
android:text="@string/fake_title" />
<TextView android:id="@id/content"
android:layout_width="match_parent"
android:layout_height="wrap_content"
android:text="@string/fake_content" />
</LinearLayout>
偽のリスト項目を提供するには、レイアウトを複数回含めることができますが、これにより各リスト項目が同一になります。一意のリスト項目を提供するには、次の手順を行います。
テキスト値の属性のセットを作成します。
<resources> <attr name="widgetTitle" format="string" /> <attr name="widgetContent" format="string" /> </resources>次の属性を使用してテキストを設定します。
<LinearLayout xmlns:android="http://schemas.android.com/apk/res/android" android:layout_width="match_parent" android:layout_height="wrap_content"> <TextView android:id="@id/title" android:layout_width="match_parent" android:layout_height="wrap_content" android:text="?widgetTitle" /> <TextView android:id="@id/content" android:layout_width="match_parent" android:layout_height="wrap_content" android:text="?widgetContent" /> </LinearLayout>プレビューに必要な数のスタイルを作成します。各スタイルの値を再定義します。
<resources> <style name="Theme.Widget.ListItem"> <item name="widgetTitle"></item> <item name="widgetContent"></item> </style> <style name="Theme.Widget.ListItem.Preview1"> <item name="widgetTitle">Fake Title 1</item> <item name="widgetContent">Fake content 1</item> </style> <style name="Theme.Widget.ListItem.Preview2"> <item name="widgetTitle">Fake title 2</item> <item name="widgetContent">Fake content 2</item> </style> </resources>プレビュー レイアウトのフェイク アイテムにスタイルを適用します。
<LinearLayout xmlns:android="http://schemas.android.com/apk/res/android" android:layout_width="match_parent" android:layout_height="wrap_content" ...> <include layout="@layout/widget_view" ... /> <include layout="@layout/widget_list_item" android:theme="@style/Theme.Widget.ListItem.Preview1" /> <include layout="@layout/widget_list_item" android:theme="@style/Theme.Widget.ListItem.Preview2" /> </LinearLayout>