AppWidget et le risque d'ANR

ANR sur AppWidget

Bon, vous devez commencer à connaître maintenant ce problème d'ANR que nous n'avons pas cessé de croiser avec les activités d'une application.

Et bien, là, c'est pareil. L'application ici n'est pas la notre, puisque les app widgets sont gérés sur l'écran d'accueil. Vous obtiendrez donc un message demandant s'il faut arrêter ou non l'application, voire celui qui gère l'écran d'accueil lui-même !

Heu...pas bon du tout là !

Il faudra donc à tout prix éviter les traitements longs (encore une fois) lorsque la méthode updateAppWidget est lancée !

Essayez avec un simple Thread.sleep (20000) pour simuler un traitement long avec l'exemple donné pour les bases d'un appWidget, vous verrez, mais ne fermer rien, attendez que cela se termine ! De plus, pendant ce long laps de temps, votre écran d'accueil ne répondra plus à vos solicitations !

static void updateAppWidget(Context context, AppWidgetManager appWidgetManager, int appWidgetId) { // Preparation du widget views Log.d ("Widget","updateAppWidget..."); RemoteViews views = new RemoteViews(context.getPackageName(), R.layout.mon_widget_layout); // Nous pourrons modifier le contenu de nos widgets comme dans une application traditionnelle // views.setTextViewText(R.id.texte_info, "Hello world !!!"); try { Thread.sleep (20000); } catch (InterruptedException e) { // TODO Auto-generated catch block e.printStackTrace(); } appWidgetManager.updateAppWidget(appWidgetId, views); }

Voici ce que vous pouvez obtienir:

Alors comment faire pour éviter cela ?

Lancer un service pour mettre à jour toutes les instances AppWidget d'un coup

Besoin d'un service ? Et oui, la création d'un service va nous permettre de nous sortir de ce problème !

Vous allez lancer un service depuis votre app widget afin qu'il prenne en charge ces traitements longs. Mais lui aussi ne pourra pas traiter directement ces traitements longs, car lui aussi risquerait un ANR. Par contre, il sera en mesure de lancer un thread qui pourra prendre son temps pour effectuer ces traitements.

Reste un problème, qui n'en sera évidemment plus en quelques secondes: remonter les majs de l'app widget suivant les résultats des traitements longs. En effet, si ces traitements sont lancés pour un appWidget, c'est certainement que celui-ci va devoir afficher des informations en rapport avec les résultats de ces traitements, sinon, cela ne servirait à rien !

Pour pouvoir modifier "à distance" l'appWidget, vous aurez besoin d'une instance du manager d'appWidget sur votre contexte actuel:

static AppWidgetManager getInstance(Context context), qui donne:

AppWidgetManager manager = AppWidgetManager.getInstance(this);

C'est en effet lui qui va gérer la maj à l'écran du contenu de l'appWidget grâce à l'une de ces méthodes updateAppWidget (avec l'une d'elles déjà vue).

void updateAppWidget(ComponentName provider, RemoteViews views)

Ici, nous indiquerons que nous voulons que le manager d'appWidget maj toutes les vues des instances de notre AppWidget.

Pour y parvenir, nous lui indiquerons le package et le nom de la classe de notre AppWidget sous forme de ComponentName, donc en lui passant :

// Récupération d'une instance ComponentName sur le package et la classe MonAppWidget
componentNameSurAppWidget = new ComponentName(this, MonAppWidget.class);

// Récupération du layout utilisé dans l'appWidget

views = new RemoteViews(context.getPackageName(), R.layout.widget_layout);

// Mettre à jour les vues de toutes les instances de notre AppWidget
appWidgetManager.updateAppWidget(componentNameSurAppWidget, views);

Evidemment, avant de mettre à jour les vues, il faudra positionner les nouvelles informations dans les widgets ! Sinon, rien ne changera dans les vues !

Exemple de code

L'AppWidget MonWidget maj pour gérer le service:

package fr.free.supertos; import android.app.PendingIntent; import android.appwidget.AppWidgetManager; import android.appwidget.AppWidgetProvider; import android.content.Context; import android.content.Intent; import android.util.Log; import android.widget.RemoteViews; import fr.free.supertos.appwidget.R; public class MonWidget extends AppWidgetProvider { public static final String ACTION_MAJ_TEXTVIEW = "fr.free.supertos.MAJ_TEXTVIEW"; @Override public void onUpdate(Context context, AppWidgetManager appWidgetManager, int[] appWidgetIds) { final int n = appWidgetIds.length; Log.d ("Widget","onUpdate pour " + n + " App Widget !"); // On boucle ici sur toutes les instances de notre app widget pour une première mise en forme éventuelle ! for (int i = 0; i < n; i++) { int appWidgetId = appWidgetIds[i]; updateAppWidget(context, appWidgetManager, appWidgetId); } // Lancement du service permettant de lire la base afin de mettre à jour les appWidgets... context.startService(new Intent(context, ServiceUpdateAppWidget.class)); } /** * Maj du widget * * @param context * @param appWidgetManager * @param appWidgetId */ static void updateAppWidget(Context context, AppWidgetManager appWidgetManager, int appWidgetId) { // Preparation du widget views Log.d ("Widget","updateAppWidget..."); RemoteViews views = new RemoteViews(context.getPackageName(), R.layout.mon_widget_layout); // Un exemple montrant que l'on peut maj le champ texte depuis AppWidget views.setTextViewText(R.id.texte_info_fin, "Blabla..."); appWidgetManager.updateAppWidget(appWidgetId, views); } }

Le service nommé ServiceUpdateAppWidget

package fr.free.supertos; import android.app.Service; import android.appwidget.AppWidgetManager; import android.content.ComponentName; import android.content.Intent; import android.os.AsyncTask; import android.os.IBinder; import android.util.Log; import android.widget.RemoteViews; import fr.free.supertos.appwidget.R; public class ServiceUpdateAppWidget extends Service { private RemoteViews views; private ThreadTraitementLong maTache; private ComponentName componentNameSurAppWidget; private AppWidgetManager appWidgetManager; private final static String CLASSE = ServiceUpdateAppWidget.class.getName(); @Override public void onCreate () { Log.d (CLASSE,"Création du service pour AppWidget."); // Récupération d'une instance AppWidgetManager pour notre contexte... appWidgetManager = AppWidgetManager.getInstance(this); // Récupération d'une instance ComponentName sur le package et la classe AnniversaireWidget componentNameSurAppWidget = new ComponentName(this, MonWidget.class); // Cette instance sera fournie plus tard à l'appWidgetManager pour maj de toutes les instances de notre appWidget de la classe indiquée // dans ComponentName super.onCreate(); } @Override public int onStartCommand(Intent intent, int flags, int startId) { Log.d(CLASSE, "onStartCommand()"); // Récupération de la view contenant les widgets que l'on veut raffraichir par la suite views = new RemoteViews(this.getPackageName(), R.layout.mon_widget_layout); // Lancement d'un thread pour les traitements long... maTache=new ThreadTraitementLong(); maTache.execute(); return START_NOT_STICKY; } @Override public IBinder onBind(Intent intent) { return null; } class ThreadTraitementLong extends AsyncTask<Integer, Long, Void> { @Override protected void onPreExecute() { views.setTextViewText(R.id.texte_info, "Lancement de l'initialisation !"); views.setTextViewText(R.id.texte_info_suite, ""); // Maj tous les appWidgets correspondant à componentNameSurAppWidget appWidgetManager.updateAppWidget(componentNameSurAppWidget, views); } @Override protected void onProgressUpdate(Long... values){ // Rien à faire... } @Override protected Void doInBackground(Integer... arg0) { try { Log.d(CLASSE, "Avant Sleep"); Thread.sleep(15000); Log.d(CLASSE, "Apres Sleep"); } catch (InterruptedException e) { // TODO Auto-generated catch block e.printStackTrace(); } return null; } @Override protected void onPostExecute(Void result) { views.setTextViewText(R.id.texte_info, "Traitement terminé:"); views.setTextViewText(R.id.texte_info_suite, "...le résultat..."); appWidgetManager.updateAppWidget(componentNameSurAppWidget, views); stopSelf(); // Fin du service ! } } }

Le service utilisant AsyncTask pour lancer le traitement long...

La méthode updateAppWidget de la classe AppWidget MonWidget ne met pas à jour les mêmes views que celui du service. Donc tout fonctionne. Mais si le service et cette méthode devait mettre à jour les mêmes views, seules les maj updateAppWidget de la classe AppWidget MonWidget seraient prises en compte. En effet, le service demande au manager d'AppWidget de mettre à jour les views. Celui-ci va donc redéclencher la méthode updateAppWidget !

Le layout

<?xml version="1.0" encoding="utf-8"?> <LinearLayout xmlns:android="http://schemas.android.com/apk/res/android" android:id="@+id/anniversaire_widget" android:layout_width="match_parent" android:layout_height="match_parent" android:orientation="vertical" android:layout_margin="4dp" android:padding="16dp"> <TextView android:id="@+id/texte_info" android:layout_width="wrap_content" android:layout_height="wrap_content" android:text="Mon premier layout !" /> <TextView android:id="@+id/texte_info_suite" android:layout_width="wrap_content" android:layout_height="wrap_content" android:text="Il est beau non ?" /> <TextView android:id="@+id/texte_info_fin" android:layout_width="wrap_content" android:layout_height="wrap_content" android:text="" /> </LinearLayout>

et AndroidManifest maj pour inclure le nouveau service

<?xml version="1.0" encoding="utf-8"?> <manifest xmlns:android="http://schemas.android.com/apk/res/android" package="fr.free.supertos.appwidget" android:versionCode="1" android:versionName="1.0" > <uses-sdk android:minSdkVersion="8" android:targetSdkVersion="17" /> <application android:allowBackup="true" android:icon="@drawable/ic_launcher" android:label="@string/app_name" android:theme="@style/AppTheme" > <receiver android:name="fr.free.supertos.MonWidget"> <intent-filter> <action android:name="android.appwidget.action.APPWIDGET_UPDATE" /> </intent-filter> <meta-data android:name="android.appwidget.provider" android:resource="@xml/mon_widget_meta" /> </receiver> <service android:name="fr.free.supertos.ServiceUpdateAppWidget" /> <activity android:name="fr.free.supertos.WidgetConfigureActivity" android:theme="@android:style/Theme.Dialog"> <intent-filter> <action android:name="android.appwidget.action.APPWIDGET_CONFIGURE" /> </intent-filter> </activity> </application> </manifest>

Pour le reste, les codes sont inchangés...

pour mon_widget_meta.xml et WidgetConfigureActivity.

Lancement d'un service pour cibler les maj sur certains AppWidget

Avec l'exemple précédent, les traitements longs étaient lancés une fois, le service ordonnait ensuite la maj de toutes les instances avec le résultat obtenu des traitements longs.

Mais il peut aussi arriver que vous ayez besoin de personnaliser les résultats. Dans ce cas, lors du lancement de la méthode startCommande du service, il faudra passer des informations via les extra/data de l'intention. Au moins une information sera nécessaire, l'ID de l'AppWidget pour qu'il soit ensuite le seul à recevoir les informations !

Voici un exemple

MonAppWidget:

package fr.free.supertos; import android.app.PendingIntent; import android.appwidget.AppWidgetManager; import android.appwidget.AppWidgetProvider; import android.content.Context; import android.content.Intent; import android.util.Log; import android.widget.RemoteViews; import fr.free.supertos.appwidget.R; public class MonWidget extends AppWidgetProvider { public static final String ACTION_MAJ_TEXTVIEW = "fr.free.supertos.MAJ_TEXTVIEW"; @Override public void onUpdate(Context context, AppWidgetManager appWidgetManager, int[] appWidgetIds) { final int n = appWidgetIds.length; Log.d ("Widget","onUpdate pour " + n + " App Widget !"); // On boucle ici sur toutes les instances de notre app widget pour une première mise en forme éventuelle ! for (int i = 0; i < n; i++) { int appWidgetId = appWidgetIds[i]; updateAppWidget(context, appWidgetManager, appWidgetId); } } /** * Maj du widget * * @param context * @param appWidgetManager * @param appWidgetId */ static void updateAppWidget(Context context, AppWidgetManager appWidgetManager, int appWidgetId) { // Preparation du widget views Log.d ("Widget","updateAppWidget..."); RemoteViews views = new RemoteViews(context.getPackageName(), R.layout.mon_widget_layout); // Un exemple montrant que l'on peut maj le champ texte depuis AppWidget views.setTextViewText(R.id.texte_info_fin, "Blabla..."); appWidgetManager.updateAppWidget(appWidgetId, views); // Lancement du service permettant de lire la base afin de mettre à jour un appWidget precis... Intent intent=new Intent(context, ServiceUpdateAppWidget.class); intent.putExtra("id", appWidgetId); context.startService(intent); } }

La différence par rapport au précédent exemple étant que le service sera déclenchée dans la boucle for du traitement des instances d'AppWidget. Vous en profiterez ainsi pour transmettre l'id de l'appWidget au service.

Puis le service:

package fr.free.supertos; import android.app.Service; import android.appwidget.AppWidgetManager; import android.content.Intent; import android.os.AsyncTask; import android.os.IBinder; import android.util.Log; import android.widget.RemoteViews; import fr.free.supertos.appwidget.R; public class ServiceUpdateAppWidget extends Service { private RemoteViews views; private ThreadTraitementLong maTache; private AppWidgetManager appWidgetManager; private final static String CLASSE = ServiceUpdateAppWidget.class.getName(); @Override public void onCreate () { Log.d (CLASSE,"Création du service pour AppWidget."); // Récupération d'une instance AppWidgetManager pour notre contexte... appWidgetManager = AppWidgetManager.getInstance(this); super.onCreate(); } @Override public int onStartCommand(Intent intent, int flags, int startId) { Log.d(CLASSE, "onStartCommand()"); // Récupération de la view contenant les widgets que l'on veut raffraichir par la suite views = new RemoteViews(this.getPackageName(), R.layout.mon_widget_layout); // Lancement d'un thread pour les traitements long... maTache=new ThreadTraitementLong(); maTache.setIDAppWidget(intent.getIntExtra("id", -1)); maTache.execute(); return START_NOT_STICKY; } @Override public IBinder onBind(Intent intent) { return null; } class ThreadTraitementLong extends AsyncTask<Integer, Long, Void> { int id; @Override protected void onPreExecute() { views.setTextViewText(R.id.texte_info, "Lancement de l'initialisation !"); views.setTextViewText(R.id.texte_info_suite, ""); // Maj del' appWidget correspondant... appWidgetManager.updateAppWidget(id, views); } public void setIDAppWidget(int id) { this.id=id; } @Override protected void onProgressUpdate(Long... values){ // Rien à faire... } @Override protected Void doInBackground(Integer... arg0) { try { Log.d(CLASSE, "Avant Sleep"); Thread.sleep(15000); Log.d(CLASSE, "Apres Sleep"); } catch (InterruptedException e) { // TODO Auto-generated catch block e.printStackTrace(); } return null; } @Override protected void onPostExecute(Void result) { views.setTextViewText(R.id.texte_info, "Traitement terminé:"); views.setTextViewText(R.id.texte_info_suite, "appWidget n°" + id); appWidgetManager.updateAppWidget(id, views); stopSelf(); // Fin du service ! } } }

Ici, disparaissent les références à ComponentName qui ne servent en effet plus, puisque l'on connait la cible !

De plus, utilisation de la méthodes updateAppWidget (déjà vue) avec l'id de l'appWidget cette fois-ci.

Bien sûr, vous profiterez dans votre cas de l'Id et d'autres informations pour personnaliser aussi le traitement à lancer.

Pour le reste, aucun changement...