utiliser des IntentService pour la gestion de requêtes asynchrones

Android2ee

| Florian Fournier | Mathias Seguy |

Des notions de base sur les Intents, Service et BroadCastReceiver sont nécessaires pour ce tutoriel. Que sont les IntentService ? Pourquoi les utiliser ? Ce sont peut-être des questions que vous vous êtes posées, et nous allons essayer d'y répondre dans ce tutoriel.

Pour réagir à ce tutoriel, un espace de dialogue vous est proposé sur le forum : Commentez .

- Titre : utiliser des IntentService pour la gestion de requêtes asynchrones

- Auteurs : Florian Fournier, Mathias Seguy

- Parution : 11 décembre 2014

- Mise à jour : 6 janvier 2016

- Licence : Les sources présentées sur cette page sont libres de droits et vous pouvez les utiliser à votre convenance. Par contre, la page de présentation constitue une œuvre intellectuelle protégée par les droits d'auteur. Copyright ® 201 Florian Fournier. Aucune reproduction, même partielle, ne peut être faite de ce site et de l'ensemble de son contenu : textes, documents, images, etc. sans l'autorisation expresse de l'auteur. Sinon vous encourez selon la loi jusqu'à trois ans de prison et jusqu'à 300 000 € de dommages et intérêts.

Sommaire

- I. Description

- II. Implémentation d'un IntentService

- III. Exemple d'un IntentService

- IV. Conclusion

- V. Approfondissons le sujet

- VI. Remerciements

I - Description

Tout d'abord les IntentService sont un type de service Android qui permet de gérer les requêtes asynchrones. Ici, le mot requête doit être considéré comme une action ou une demande de traitement.

Ces requêtes sont exécutées dans un « worker », par conséquent les traitements sont exécutés les uns après les autres au sein de ce thread (qui n'est pas le Thread U.I.). Les IntentService vous permettent de décharger le Thread UI de traitements lourds tout en ayant les avantages des services qui sont indépendants du cycle de vie des activités, ou bien lancer ces traitements qui pourront être exécutés dans un autre processus (c'est la notion de RemoteService).

Les IntentService s'arrêtent d'eux-mêmes à la fin des traitements demandés. Pour rajouter un nouveau traitement, il vous suffit de le rajouter dans la liste d'attente de l'IntentService.

Par contre pour récupérer les résultats du traitement, il vous faudra transférer le résultat par message (intent, broadcast, handler, etc.) au(x) destinataire(s) voulu(s). C'est l'inconvénient de l'IntentService qui n'a pas accès directement au Thread UI, contrairement aux AsyncTask.

Si nous résumons rapidement, les IntentService sont utiles pour gérer des requêtes multiples de manière asynchrone (bien que leur exécution soit synchrone dans le worker). Ainsi, nous avons l'avantage du cycle de vie des Services, de l'arrêt automatique de celui-ci quand l'action est terminée et de l'exécution du traitement en tâche de fond dans un seul concept. L'inconvénient est l'absence d'accès direct à l'interface graphique.

II - Implémentation d'un IntentService

Prenons l'exemple d'implémentation fourni par la documentation de Google :

1. public class HelloIntentService extends IntentService {

2. /**

3. * Un constructeur est requis, et doit appeler la méthode

4. * superIntentService(String)

5. * constructeur avec un nom pour le « worker thread »

6. */

7. public HelloIntentService() {

8. super("HelloIntentService");

9. }

10. /**

11. * L'IntentService appelle la méthode par défaut du « worker thread » avec

12. * l'intent passé en paramètre de la méthode. Quand cette méthode est terminée

13. * le service s'arrête de lui-même

14. */

15. @Override

16. protected void onHandleIntent(Intent intent) {

17. // Normalement le traitement lourd se fait ici, comme télécharger un fichier

18. // À ne pas faire mais dans cet exemple une attente de 5 secondes est

19. // faite, ceci ne bloque pas le « thread UI » puisque nous sommes dans le       // « worker thread »

20. long endTime = System.currentTimeMillis() + 5*1000;

21. while (System.currentTimeMillis() < endTime) {

22. synchronized (this) {

23. try {

24. wait(endTime - System.currentTimeMillis());

25. } catch (Exception e) {

26. }

27. }

28. }

29. }

30. }

On a un peu de mal à savoir comment le Service fonctionne ainsi. Où se trouve notre file d'attente d'intention ? Comment le « worker thread » est lancé ?

Regardons alors directement dans le code des IntentService :

1. private final class ServiceHandler extends Handler {

2. public ServiceHandler(Looper looper) {

3. super(looper) ;

4. }

6. @Override

7. public void handleMessage(Message msg) {

8. onHandleIntent((Intent)msg.obj) ;

9. stopSelf() ; // arrêt du service

10. }

11. }

Premièrement, une classe interne ServiceHandler est créée avec comme paramètre de son constructeur un Looper (qui est une gestion de queue de message). Cette classe hérite d'un Handler qui permet de recevoir des messages et les traiter. Lors de la réception d'un de ces messages (dans la fonction handleMessage), nous pouvons voir que la fonction onHandleIntent est invoquée, le traitement se fera au sein de cette méthode. L'appel à la fonction stopSelf arrête ensuite le service (StopSelf est une fonction de la classe Service Android).

On comprend comment le Service s'arrête de lui-même. Mais qui lui passe ce Looper et comment gère-t-il sa file d'attente ? Regardons dans la fonction onCreate de la classe IntentService.

1. public abstract class IntentService extends Service {

2. //blabla

3. @Override

4. public void onCreate() {

5. super.onCreate();

6. HandlerThread thread = new HandlerThread(HandlerThread("IntentService[" + mName + "]");

7. thread.start(); // notre « worker thread »

8. mServiceLooper = thread.getLooper();// son Looper

9. mServiceHandler = new ServiceHandler(mServiceLooper);// passage du Looper au ServiceHandler

10. }

11. }

Un nouveau thread est créé à partir de la classe HandlerThread et son Looper est passé à la classe ServiceHandler que nous venons de voir. Nous avons trouvé notre « worker thread ».

Depuis la fonction onStart, le service gère la file d'attente via les intentions par l'envoi de messages à notre « worker thread ».

1. public abstract class IntentService extends Service {

2. //blabla

3. @Override

4. public void onStart(Intent intent, int startId) {

5. Message msg = mServiceHandler.obtainMessage();// Créer un message prérempli

6. msg.arg1 = startId;//affecte un identifiant au message (utilisé pour arrêter ou pas le service)

7. msg.obj = intent;// l'action associée au message

8. mServiceHandler.sendMessage(msg); // ajoute le message dans la file d'attente du Looper

9. }

11. // Start Service

12. @Override

13. public int onStartCommand(Intent intent, int flags, int startId) {

14. onStart(intent, startId);

15. return mRedelivery ? START_REDELIVER_INTENT : START_NOT_STICKY;

16. }

17. }

La méthode onStart est appelée depuis la méthode onStartCommand. Cette fonction est invoquée automatiquement à chaque appel lors du démarrage d'un service par la méthode startService (cf. le cycle de vie des Services Android). Par conséquent, pour ajouter une nouvelle demande, il vous suffit d'appeler la fonction startService appartenant à la classe Context en lui passant l'Intent qui porte les paramètres du traitement.

L'envoi du message au ServiceHandler est effectué au sein de la méthode onStart de l'IntentService par l'appel à la fonction sendMessage. Dans ce message nous trouvons l'Intent passé en paramètre et le startId, qui identifiera ce service lors de l'appel du stopSelf.

Une option permet de redémarrer le service lorsque celui-ci a été détruit par le système pour des questions de place mémoire. Ce redémarrage (cette restitution de l'Intent d'où la notion de Redelivery) renverra seulement l'Intent le plus récent. Il suffit d'appeler la fonction setIntentRedelivery(true) dans le onCreate ou le constructeur de l'IntentService. Cette option peut être utile si vous avez une seule action à réaliser. Il est tout de même plus pertinent de connaître l'état des actions non effectuées pour pouvoir les relancer, plutôt que de s'appuyer sur ce flag.

Dans la fonction onDestroy, on nettoie le Looper ce qui permet de vider et d'arrêter la queue de messages en cours pour terminer le thread proprement.

1. public abstract class IntentService extends Service {

2. //blabla

3. @Override

4. public void onDestroy() {

5. mServiceLooper.quit(); // nettoie la queue de messages et stoppe le Thread

6. }

7. }

Pour résumer, les IntentService fournissent :

- un « worker thread » qui exécute tous les Intent passés à la fonction onStartCommand (via la méthode Context.StartService(Intent intent)) ;

- une file d'attente sur les Intent passés, qui est gérée par la fonction sendMessage (du ServiceHandler) ;

- le traitement des Intent qui se fait depuis la fonction onHandleIntent de votre classe qui hérite d'IntentService. Cette méthode s'exécute dans le « worker thread », pas de souci de multithreading (synchronised et autre mutex) ;

- l'arrêt du service quand le traitement est terminé ;

- le retour de la valeur null sur la fonction onBind par défaut (par défaut on n'a pas besoin de s'abonner au Service).

Nous avons vu comment les IntentService fonctionnent, mais pourrait-on avoir un exemple concret ?

III - Exemple d'un IntentService

Essayons de mettre en place un IntentService permettant de pouvoir récupérer le contenu d'une page web (code source) et l'afficher depuis une TextView prévue à cet effet.

Pour la communication entre votre IntentService et l'activité nous passerons par un BroadcastReceiver. Ce principe est la manière naturelle sous Android pour effectuer ce dialogue et permettra de s'adapter aux envois multiples.

Voici l'IntentService :

1. package com.android2ee.tutorial.intentservice.;

3. import java.io.BufferedReader;

4. import java.io.IOException;

5. import java.io.InputStream;

6. import java.io.InputStreamReader;

7. import java.net.URLConnection;

8. import java.net.URL;

10. import com.android2ee.tutorial.intentservice.MainActivity.MyReceiver;

12. import android.app.IntentService;

13. import android.content.Intent;

15. public class DownloadSourceService extends IntentService {

17. public static final String URL = "urlpath";

18. public static final String SOURCE_URL = "destination_source";

20. public DownloadSourceService() {

21. super("DownloadService");

22. }

24. @Override

25. protected void onHandleIntent(Intent intent) {

26. String urlPath = intent.getStringExtra(URL);

27. InputStream is = null;

28. BufferedReader r = null;

29. StringBuilder result = null;

30. // on récupère les données depuis l'url

31. try {

32. URL aURL = new URL(urlPath);

33. URLConnection conn = aURL.openConnection();

34. conn.connect();

35. is = conn.getInputStream();

36. r = new BufferedReader(new     InputStreamReader(is));

37. result = new StringBuilder();

38. String line;

39. while ((line = r.readLine()) != null) {

40. result.append(line);

41. }

42. } catch (IOException e) {

43. // message d'erreur

45. } finally {

46. // on ferme bien tous les flux

47. if ( r != null) {

48. try {

49. r.close();

50. } catch (IOException e) {

51. // message d'erreur

52. }

53. }

54. }

55. // maintenant on transmet le résultat

56. // on pourrait avoir un Handler, BroadCast, Notification, etc.

57. Intent broadcastIntent = new Intent();

58. broadcastIntent.setAction(MyReceiver.ACTION_RESP);

59. broadcastIntent.addCategory(Intent.CATEGORY_DEFAULT);

60. broadcastIntent.putExtra(SOURCE_URL, result.toString());

61. sendBroadcast(broadcastIntent);

63. }

64. }

Finalement, l'implémentation est très simple. Il suffit de développer son traitement depuis la fonction onHandleIntent et ensuite de choisir une méthode de diffusion du résultat à la fin de celle-ci.

Il existe plusieurs méthodes de diffusion, parmi celles-ci vous pouvez avoir :

- un broadcast : permet d'avoir une diffusion au sens large ;

- un handler : permet d'avoir une diffusion vers un correspondant unique ;

- une notification : permet d'avoir une diffusion vers le centre de notification du téléphone ;

- un intent : permet de lancer une action en fin de traitement ;

- un listener : permet d'avoir une diffusion sur l'ensemble des personnes abonnées ;

- etc.

Voici l'Activité qui lancera le service, récupérera le message répondu par celui-ci et l'affichera sur sa vue.

1. package com.android2ee.tutorial.intentservice.;

3. import android.os.Bundle;

4. import android.app.Activity;

5. import android.content.BroadcastReceiver;

6. import android.content.Context;

7. import android.content.Intent;

8. import android.content.IntentFilter;

9. import android.widget.TextView;

11. public class IntentServiceActivity extends Activity {

13. public class MyReceiver extends BroadcastReceiver {

14. public static final String ACTION_RESP ="com.myapp.intent.action.TEXT_TO_DISPLAY";

16. @Override

17. public void onReceive(Context context, Intent intent) {

18. String text = intent.getStringExtra(DownloadSourceService.SOURCE_URL);

19. // send text to display

20. TextView result = (TextView) findViewById(R.id.text_result);

21. result.setText(text);

23. }

24. }

26. private MyReceiver receiver;

28. @Override

29. public void onCreate(Bundle savedInstanceState) {

30. super.onCreate(savedInstanceState);

31. setContentView(R.layout.activity_main);

33. // on initialise notre broadcast

34. receiver = new MyReceiver();

35. // on lance le service

36. Intent msgIntent = new Intent(this, DownloadSourceService.class);

37. msgIntent.putExtra(DownloadSourceService.URL,"http://api.openweathermap.org/data/2.5/weather?q=London&mode=xml");

38. startService(msgIntent);

39. }

41. @Override

42. protected void onResume() {

43. super.onResume();

44. // on déclare notre Broadcast Receiver

45. IntentFilter filter = new IntentFilter(MyReceiver.ACTION_RESP);

46. filter.addCategory(Intent.CATEGORY_DEFAULT);

47. registerReceiver(receiver, filter);

48. }

50. @Override

51. protected void onPause() {

52. super.onPause ();

53. // on désenregistre notre broadcast

54. unregisterReceiver(receiver);

55. }

Ne pas oublier de déclarer l'IntentService dans le manifest comme un Service classique.

<?xml version="1.0" encoding="utf-8"?>
<manifest xmlns:android="http://schemas.android.com/apk/res/android"
package="com.android2ee.tutorial.intentservice."
android:versionCode="1"
android:versionName="1.0" >

<uses-sdk
android:minSdkVersion="8"
android:targetSdkVersion="19" />

<!-- Internet permission, as we are accessing to url -->
<uses-permission android:name="android.permission.INTERNET" />

<application
android:allowBackup="true"
android:icon="@drawable/ic_launcher"
android:label="@string/app_name"
android:theme="@style/AppTheme" >
<activity
android:name="com.android2ee.tutorial.intentservice.MainActivity"
android:label="@string/app_name" >
<intent-filter>
<action android:name="android.intent.action.MAIN" />
<category android:name="android.intent.category.LAUNCHER" />
</intent-filter>
</activity>
<!-- Declaring Service in Manifest -->
<service
android:name=".DownloadSourceService"
android:exported="false" />
</application>

</manifest>

Enfin le fichier activity_main qui reste très simple :

<RelativeLayout xmlns:android="http://schemas.android.com/apk/res/android"
xmlns:tools="http://schemas.android.com/tools"
android:layout_width="match_parent"
android:layout_height="match_parent"
android:paddingBottom="@dimen/activity_vertical_margin"
android:paddingLeft="@dimen/activity_horizontal_margin"
android:paddingRight="@dimen/activity_horizontal_margin"
android:paddingTop="@dimen/activity_vertical_margin"
tools:context=".MainActivity" >

<TextView
android:id="@+id/text_result"
android:layout_width="wrap_content"
android:layout_height="wrap_content" />

</RelativeLayout>

IV - Conclusion

Les IntentService sont intéressants lorsque vous avez une tâche de fond régulière au sein de la vie de votre application. Par exemple :

- flux RSS ;

- mise à jour de la base de données ;

- téléchargement d'images à partir d'un ensemble d'URL ;

- etc.

Avec les IntentService, le développement de ces tâches sera simple comparé aux autres moyens que nous avons, dû à la simplicité de ce pattern. Cette méthode vous donne les avantages des services Android qui peuvent être disponibles depuis votre application (ou depuis les autres applications, si celui-ci a été exporté depuis le manifest).

Utilisez réellement les IntentService quand vous avez des requêtes multiples, ceux-ci vous simplifieront vraiment la tâche sur le cycle de vie de ce traitement ainsi que sur la gestion de sa file d'attente. Vous pouvez passer des paramètres par les Intent pour différencier le fonctionnement à réaliser du traitement en tâche de fond.

Mais surtout, ce DesignPattern est excellent pour mettre en place une architecture simple qui vous permet d'enchaîner des traitements dans un autre Thread que le ThreadUI. Cela vous permet d'éviter de mettre en place une architecture complexe (un PoolExecutor, des Services, des Threads de traitements) pour un traitement qui ne l'est pas. À noter que si vous effectuez une application complexe, vous ne pourrez pas vous appuyer exclusivement sur ce pattern et vous devrez mettre en place une véritable architecture robuste.

V - Approfondissons le sujet

Et si nous prenions du temps à regarder réellement l'enchaînement des actions de bas niveau, pour comprendre au mieux ce pattern ?

Voici le diagramme de séquence que l'on obtiendrait :

Illustration: Diagramme de séquence

Le fonctionnement de l'IntentService est basé sur l'envoi et la réception de message en nous permettant d'avoir un traitement asynchrone. Tout traitement de fond se réalise dans le « worker thread » (HandlerThread), donc dans le même thread. Par conséquent nous aurons une exécution séquentielle des traitements.

Pour comprendre le fonctionnement, voici un schéma sur les traitements par Thread :

Illustration: Traitements par Thread

Note : le ThreadService est le Thread UI pour ceux qui ne le savent pas !

Le traitement est réalisé depuis le « worker thread », la gestion asynchrone des messages est réalisée par le biais de la « message queue » et du Looper qui ira lire périodiquement les messages présents dans la « message queue ».

Le service ne s'arrêtera de lui-même que si aucune intention n'est en cours (startId).

VI - Remerciements

Nous remercions FRANOUCH pour sa relecture orthographique.