Android Publish/Subscribe, GCM, Google Cloud Messaging : une introduction

Transcription

1 Android Publish/Subscribe, GCM, Google Cloud Messaging : une introduction jean-michel Douin, douin au cnam point fr version : 8 Décembre 2014 Notes de cours 1

2 Sommaire Le socle, les fondements Le patron publish-subscribe L entité Android de base : Receiver Publication sendbroadcast(intent i), sendorderedbroadcast Souscription onreceive, (BroadcastReceiver) Exemples: Abonnement à un évènement Batterie, réception de SMS Abonnement à une alarme Service déjà installé sur le mobile GCM, Google Cloud Messaging Google/Cloud s occupe de tout Compte gmail dédié Abonnement de plusieurs mobiles Librairies, BroadcastReceiver et service, prêts à l emploi Ce qui reste à faire: Une classe dérivée, 4 redéfinitions de méthodes et c est tout Une architecture logicielle possible, pour discussions 2

3 Principale bibliographie Le tutorial indispensable Avant il y avait c2dm Vogella

4 Le patron publish/subscribe Les fondements Publication à l occurrence d un évènement Un sms entrant, la batterie déchargée, Un évènement engendré par l utilisateur Souscription à un évènement Agir en conséquence Un médiateur se charge De la réception des évènements, de leur filtrage De la diffusion auprès des souscripteurs sélectionnés Diffusion aléatoire ou ordonnée 4

5 Publish-Subscribe,cf NSY102 source: 5

6 Publish-subscribe/ pull-push Les news d internet, ou le forum de jfod Enregistrement d un «client» à un sujet de discussion, Un des «clients» décide de poster un message, Les utilisateurs à leur initiative vont chercher l information, Publish-subscribe, mode pull Les listes de diffusion, logiciels de causerie, («chat») Abonnement d un «client» à une liste de diffusion, Un des «clients» décide de poster un message, Tous les abonnés reçoivent ce message, Publish-subscribe, mode push 6

7 Un exemple, mode push p1 : Publisher mediator : Mediator s1 : Subscriber publish(p1,meteo,"sun") publish(p1,meteo,"rain") p2 : Publisher publish(p2,sensor,"25 ") addsubscriber(s1,meteo) update(p1,meteo,"sun") update(p1,meteo,"rain") s2 : Subscriber publish(p1,meteo,"sun") publish(p2,sensor,"27 ") publish(p1,meteo,"sun") addsubscriber(s2,sensor) update(p1,meteo,"sun") addsubscriber(s2,meteo) update(p2,sensor,"27 ") update(p1,meteo,"sun") update(p1,meteo,"sun") 7

8 En Java/ notation UML/BlueJ 8

9 Android et le patron Publish/Subscribe Une application Android peut : Souscrire à un thème de publication, réception de SMS, niveau de batterie, Publier un évènement une alarme à son échéance, un évènement interne à l application, Google Cloud Messaging une API prête à l emploi plusieurs mobiles peuvent souscrire et être notifiés «Over the Air» 9

10 Android/Publish-Subscribe : les bases souscription publication Source : 10

11 Publish-Subscribe/Intent & Context Context BroadcastReceiver X,Y Intent 11

12 Souscription : schéma de programme Basée sur les Intent (Topic), Context (Mediator), BroadcastReceiver (Subscriber). import android.content.intent; import android.content.context; import android.content.broadcastreceiver; import android.util.log; public class ReceiverTemplate extends BroadcastReceiver { public void onreceive(context context, Intent intent) { Log.i(TAG, "onreceive action: "+intent.getaction() ); } } 12

13 Souscription effective Déclarative, AndroidManifest.xml Au sein d une application <receiver android:name=".receivertemplate"> <intent-filter> <action android:name=" android.intent.action.sms_received_action " /> </intent-filter> </receiver> Par programme getapplicationcontext().registerreceiver( new ReceiverTemplate(), new IntentFilter(Intent.SMS_RECEIVED_ACTION)); 13

14 Par programme Cf. le cycle de vie d une activité onresume registerreceiver( onpause unregisterreceiver( 14

15 Les acteurs classe Context, le Mediator classe BroadcastReceiver, le Subscriber classe Intent + IntentFilter, X,Y les thèmes À suivre: 3 exemples avec le système Android 1. Le niveau de la batterie vient d être réactualisé, 2. Un sms vient d arriver, 3. Un évènement de l utilisateur. 15

16 Exemple 1 : la batterie a changé d état public class LowBatteryActivity extends Activity { private BroadcastReceiver receiver; public void oncreate(bundle savedinstancestate) { } public void onresume() { IntentFilter filter = new IntentFilter(Intent.ACTION_BATTERY_CHANGED); this.receiver = new BatteryChangedReceiver(); // Souscription registerreceiver(this.receiver, filter); } public void onpause() { // Dé-souscription unregisterreceiver(this.receiver); } 16

17 Le souscripteur // le Souscripteur private static class BatteryChangedReceiver extends BroadcastReceiver { public void onreceive(context context, Intent intent) { Toast.makeText(context, "battery changed", Toast.LENGTH_SHORT).show(); Log.d(TAG, "onreceive action: "+intent.getaction() ); } } } 17

18 La publication par Android ressemblerait à android.os.batterymanager Intent broadcastintent = new Intent(); broadcastintent.setaction("action_battery_changed"); broadcastintent.putextra("level", 3567); // // // context.sendbroadcast(broadcastintent); 18

19 Exemple 2 : réception d un SMS // le souscripteur public class SMSReceiver extends public void onreceive(context context, Intent intent) { Toast.makeText(context, "sms received", Toast.LENGTH_SHORT).show(); } } 19

20 Configuration du souscripteur, <receiver /> // AndroidManifest.xml // La souscription <receiver android:name=".smsreceiver"> <intent-filter> <action android:name="android.intent.action.sms_received_action"/> </intent-filter> </receiver> Souscription effectuée (appel implicite de registerreceiver) au chargement de l application (unregisterreceiver lorsque l application est détruite) 20

21 Exemple 3: «un évènement utilisateur» Ajout, retrait d un «contrôleur» cf. public void onresume(){ super.onresume(); IntentFilter intentfilter = new IntentFilter(); intentfilter.addaction(controller.action); registerreceiver(this.controller, public void onpause(){ super.onpause(); unregisterreceiver(this.controller); Avec Controller.ACTION public static final String ACTION = "fr.cnam.list.items"; 21

22 La classe «Controller», ici gestion d une liste Le contrôleur agit sur le modèle, ici une liste (classe Items) public class ItemsController extends BroadcastReceiver { public static final String ACTION = "fr.cnam.list.items"; public static final String ADD public static final String REMOVE = "add"; // valeurs = "remove"; private Items items; // le modèle private Context context; // Android framework public ItemsController(Context context, final Items items){ this.context = context; this.items = items; // le modèle } public void onreceive(final Context context, final Intent intent) { String operation = intent.getstringextra(operation_key); if(operation.equals(add)) items.ajouter(intent.getstringextra(data_key)); else if(operation.equals(remove)) items.retirer(integer.parseint(intent.getstringextra(data_key))); } 22

23 Démonstration Un des trois exemples Le contrôleur Optionnels: Intent.ACTION_BATTERY_CHANGED android.intent.action.sms_received_action 23

24 Autre façon de souscrire PendingIntent Intent à effet immédiat PendingIntent à effet retardé Destiné à un tiers A destination d un service existant AlarmManager, NotificationManager Souscription auprès du service Exécution de l intent passé en paramètre, à l aide d un PendingIntent 24

25 Souscription auprès d un service existant Intent intent = new Intent(this, ReceiverTemplate.class); PendingIntent appintent = PendingIntent.getBroadcast(this, 0, intent, 0); Calendar calendar = Calendar.getInstance(); calendar.settimeinmillis(system.currenttimemillis()); calendar.add(calendar.second, 3); AlarmManager am = (AlarmManager)getSystemService(ALARM_SERVICE); am.set(alarmmanager.rtc, calendar.gettimeinmillis(), appintent); // sendbroadcast(intent) par le service d alarme 25

26 Variante de l écriture précédente PendingIntent appintent = PendingIntent.getBroadcast (this, 0, new Intent(), 0); Calendar calendar = Calendar.getInstance(); // idem diapositive précédente am.set(alarmmanager.rtc, calendar.gettimeinmillis(), appintent); // Ce sont les receveurs déclarés dans AndroidManifest.xml // qui seront déclenchés, (méthode onreceive) // puis sendbroadcast(intent) par le service d alarme 26

27 Notification Souvent associée à la réception d un évènement Déclenchée par le souscripteur Un «Receiver», un service, Exemple: Une notification à la réception d un message sms» telnet localhost 5554» send 1234 SMS test message 27

28 Notification : affichage private static void generatenotification(context context, String message) { long when = System.currentTimeMillis(); NotificationManager notificationmanager = null; notificationmanager(notificationmanager) context.getsystemservice(context.notification_service); Notification notification = new Notification(R.drawable.ic_launcher,message, when); String title = context.getstring(r.string.app_name); Intent intent = // page suivante notification.setlatesteventinfo(context, title, message, intent); notification.flags = Notification.FLAG_AUTO_CANCEL; notificationmanager.notify(0, notification); } 28

29 Autre exemple : une notification Au clic sur la notification une application est déclenchée private static void generatenotification(context context, String message) { long when = System.currentTimeMillis(); NotificationManager notificationmanager = null; notificationmanager(notificationmanager) context.getsystemservice(context.notification_service); Notification notification = new Notification(R.drawable.ic_launcher,message, when); String title = context.getstring(r.string.app_name); Intent notificationintent = new Intent(context,GCMClientActivity.class); // afin que l intent retardée démarre une nouvelle activité notificationintent.setflags(intent.flag_activity_clear_top Intent.FLAG_ACTIVITY_SINGLE_TOP); PendingIntent intent = PendingIntent.getActivity(context, 0, notificationintent, 0); notification.setlatesteventinfo(context, title, message, intent); notification.flags = Notification.FLAG_AUTO_CANCEL; notificationmanager.notify(0, notification); } Source: 29

30 Autre usage : une notification, sans effet au clic Au clic sur la notification rien ne se passe private static void generatenotification(context context, String message) { long when = System.currentTimeMillis(); NotificationManager notificationmanager = null; notificationmanager(notificationmanager) context.getsystemservice(context.notification_service); Notification notification = new Notification(R.drawable.ic_launcher,message, when); String title = context.getstring(r.string.app_name); PendingIntent intent = PendingIntent.getActivity(context, 0, null, 0); notification.setlatesteventinfo(context, title, message, intent); notification.flags = Notification.FLAG_AUTO_CANCEL; notificationmanager.notify(0, notification); } Source: 30

31 Démonstration 31

32 GCM Google Cloud Messaging Anciennement c2dm, Cloud to Delivering Message >= Android 2.2 Message <= 4ko Trafic illimité Nécessite une inscription auprès de Google Avec de préférence un compte gmail que l on dédiera à cet usage 32

33 Architecture : Objectifs Un client, tout système connecté S adresse au serveur Google qui se chargera de publier auprès des mobiles Mobiles ayant préalablement souscrits Mise en œuvre : une librairie toute prête, un appel de méthode suffit 33

34 Architecture : Mise en œuvre, inscription 1)inscription 2)identifiant GCM 3) dépôt de l identifiant Chaque participant Doit avoir un compte google gmail S inscrit auprès de GCM, en retour un identifiant lui est attribué Un serveur mémorise, l identifiant retourné par GCM Un serveur au protocole HTTP de préférence Ces serveur contient les abonnés 34

35 Architecture : Mise en œuvre, inscriptions id1 id2 id3 Le serveur contient une liste des identifiants Un identifiant par application Application : un service sous Android Exemple : Une liste d identifiants accessible depuis le web 35

36 Architecture : Mise en œuvre, publications 1) Demande de la liste 2) [id1, id2, id3, ] 3) Demande de publication [id1, id2, id3, ] + message message id1 message id2 message id3 Publication par tout système connecté 1,2) Obtention de la liste des identifiants, des abonnés 3) Envoi de cette liste au serveur Google/GCM accompagnée du message à transmettre GCM se charge de publier le message, de le ré-émettre, de le conserver 36

37 Architecture : publications message id1 message id2 message id3 Chaque mobile de la liste [id1, id2, id3, ] est notifié C est un «Receiver» prêt à l emploi qui est déclenché sur chaque mobile Un service prêt à l emploi est créé afin de prendre en compte cette notification Une de ses méthodes est appelée (onmessage) 37

38 Le tutorial que l on se doit de lire

39 Comment? Création d un projet auprès des serveurs Google En retour : un numéro_de_projet (ProjectId) Une API key est nécessaire 1. Exemple ProjectId: , API_KEY: AIzaSyC60sIgG-fB3JSW47X2zGrOqJHGzV1jh0g 1. Un mobile s inscrit auprès du serveur Google (ProjectId) 1. En retour un jeton d identification lui est attribué Chaque participant doit posséder un compte gmail 2. Cet identifiant est déposé sur un serveur, qui est connu de tous les participants 2. Envoi d un message aux participants(api_key) 1. Obtention de la liste des identifiants auprès du serveur 2. Publication du message Librairies toutes prêtes 39

40 Création du projet ProjectId API_Key 40

41 Inscription, mise en oeuvre 1)inscription GCM 2)identifiant 3) dépôt de l identifiant Depuis une activity 1) Inscription auprès du cloud GCMRegistrar.register(this, " "); GCMRegistrar, une classe toute prête Démarrage du service Attente asynchrone de la réponse de GCM 41

42 Le service hérite d une classe toute prête 1)inscription GCM 4 méthodes à redéfinir, public class GCMIntentService extends GCMBaseIntentService { 2)identifiant 3) dépôt de l identifiant Méthode déclenchée à la suite de la demande d inscription au GCM 2) onregistered(context context, String identifiant) 3) Dépôt de l identifiant sur un serveur onmessage(context context, Intent intent) onerror. onunregistered 42

43 Liste des indentifiants id1 id2 id3 1)inscription GCM 2)identifiant 3) dépôt de l identifiant Service web, servlette, php 43

44 Publication API_KEY + Message + id1 id1 id2 id3 message message message id2 id3 Envoi de la liste des identifiants au GCM + un message + API_KEY Et se charge de tout 44

45 Librairie toute prête \android-sdk\extras\google\gcm\gcm-client\dist\ gcm.jar Souscription, abonnement Un service qu il suffit de dériver public class GCMIntentService extends GCMBaseIntentService { Réception d un message : un Receiver + un service Un Receiver prêt à l emploi Une classe GCMIntentBaseService qu il suffit de dériver 45

46 Démonstration, Obtention du jeton GCMRegistrar: Classe interface avec le service GCM ProjectId: GCMRegistrar.getRegistrationId(this, " "); Une demande est faite auprès de Google 2. onregistered(context context, String regid) En retour cette méthode du service est déclenchée Un exemple d identifiant reçu par le mobile: APA91bGy- GWQqqrgyFc652jghpTPygBsKyDHNFPWqzJDCMvtcIx7rtVecmxAYkDItfgztJcEJhyA Rnx0fmmp6FtqrFKNXqftmGXhRIGM5eObyLY67YkT_Aez3RJeOZFVkOpjv- _FRNASI0ZJL6VQk95Y925MQ9Wihw 46

47 Souscription suite Souscription du mobile Permissions <uses-permission android:name="com.google.android.c2dm.permission.registration" /> <uses-permission android:name="android.permission.internet" /> Le receveur, un extrait de AndroiManifest.xml <receiver android:name=".c2dmregistrationreceiver" android:permission="com.google.android.c2dm.permission.send" > <intent-filter > <action android:name="com.google.android.c2dm.intent.registration" > </action> </intent-filter> </receiver> 47

48 Le service public class GCMIntentService extends GCMBaseIntentService onregistered(context context, String regid) Déclenchée par le Receiver pré-installé à la suite de l abonnement Mémorisation de regid onmessage(context context, Intent intent) Déclenchée par le Receiver pré-installé à la suite de la réception d un message String msg = intent.get("message"); 48

49 Publication : le message Par tout système connecté, \android-sdk-new\extras\google\gcm\gcm-server\dist\ gcm-server.jar Sender sender = new Sender(API_KEY); String msg = "un message"; Message message = new Message.Builder() //.collapsekey("1").timetolive(60*60*24) // 24 heures //.timetolive(0) // maintenant ou jamais.delaywhileidle(true).adddata("message",msg).build(); 49

50 Publication : Envoi de message Publication d un message Send devices : une liste de regid MulticastResult result = sender.send(message, devices, 5); // 5 essais en cas d indisponibilité des serveurs google Ensuite le cloud s occupe de tout 50

51 Une architecture possible, publication De type MVC un essai pour discussions Rappels: Hypothèse Un receveur et un service prêts à l emploi» Ce service est appelé à chaque publication par le cloud» onmessage, onregistered, onunregistered, onerror A chaque réception d un message, envoi de celui-ci vers le receveur concerné Un champ du message contient l ACTION à déclencher Les receveurs peuvent être locaux à une activité, un service publish onmessage( ) receveurs 51

52 Réalisation, onmessage Émis directement au receveur concerné intenttoancontroler(intentfromcloud.getstringextra(operation_key)); 52

53 Réalisation, une variante onmessage Un contrôleur dédié au cloud est installé Il est chargé de générer un journal, d effectuer des statistiques, de contrôler Receveur dédié au cloud publish onmessage( ) Receveur associé à l ACTION 53

54 Publication, le contrôleur dédié au cloud pourrait s en charger Receveur dédié au cloud PUBLISH ACTION publish Publication vers le GCM via le contrôleur 54

55 Une Application Une liste partagée 55

56 Architecture MVC, rappel Application: Une liste d item : le modèle, du java standard, portable ListView + ListActivity : la Vue Un Receiver : le Contrôleur 56

57 Android Les outils nécessaires Intent IntentFilter BroadcastReceiver registerreceiver 57

58 La vue, une liste d items Affichage Opérations d ajout et de suppression 58

59 La liste d items le modèle Items extends Observable la vue MainActivity extends ListActivity implements Observer ItemsControler ItemsController le contrôleur extends BroadcastReceiver Items : le modèle MainActivity : la vue ItemsController : le contrôleur 59

60 La classe Items : le modèle Java J2SE portable synchronized(this) par précaution (plusieurs contrôleurs) 60

61 Architecture suite Items : le modèle extends java.util.observable MainActivity : la vue extends android.app.listactivity implements java.util.observer ItemsController : le contrôleur extends android.content.broadcastreceiver 61

62 Le contrôleur est un BroadcastReceiver Items extends Observable MainActivity extends ListActivity implements Observer sendbroadcast ItemsControler ItemsController extends BroadcastReceiver A chaque Click sendbroadcast Intent intent = new Intent(); intent.setaction(itemscontroller.action); sendbroadcast( 62

63 Action de l utilisateur, gérée par le contrôleur MainActivity extends ListActivity implements Observer sendbroadcast ItemsControler ItemsController extends BroadcastReceiver sendbroadcast 63

64 ItemsController A chaque «clic» la méthode onreceive est exécutée abortbroadcast(); si non cumul du comportement 64

65 Contrôleur -> Modèle Items extends Observable ItemsControler ItemsController extends BroadcastReceiver Appel de la méthode ajouter du modèle 65

66 Modèle -> Vue Items extends Observable MainActivity extends ListActivity implements Observer La méthode update est déclenchée au sein de l activité 66

67 La Vue 1/4 initialisation oncreate de l activité Création du modèle et du contrôleur 67

68 La Vue 2/4 enregistrement du contrôleur onresume de l activité (ou oncreate, dépend de l application) enregistrement du contrôleur onpause (ou ondestroy) 68

69 La Vue 3/4 A chaque clic! onclickajouter 69

70 La Vue 4/4 update update appelée par le modèle (extends Observable) La vue est un observateur( implements java.util.observer) 70

71 CloudController Généralisation, discussions 71

72 MVC MVC respecté Couplage faible conservé Items extends Observable Au sein de la même application MainActivity extends ListActivity implements AnotherActivity Observer extends Activity implements Observer ItemsController ItemsController extends BroadcastReceiver extends BroadcastReceiver web, cloud CloudController 72

73 Généralisation MVC respecté Couplage faible conservé Items extends Observable MainActivity extends ListActivity implements AnotherActivity Observer extends Activity implements Observer ItemsController extends BroadcastReceiver web, cloud GenericController Le champ Action sélectionne le contrôleur ad hoc 73

74 GenericController GenericController ItemsController extends BroadcastReceiver L ACTION_KEY est redirigée vers le «bon» contrôleur Discussion 74

75 Cumul du comportement ItemsController extends BroadcastReceiver ItemsControllerPlus extends ItemsController Avec une sous classe de ItemsController: onreceive(context context, Intent intent){ super.onreceive(context, intent); 75

76 Démonstration Démonstration 76

77 Mise en œuvre Répertoire du projet eclipse du client souscripteur Depuis l explorateur windows, (eclipse n est pas démarré) créer un répertoire libs dans lequel vous copiez gcm.jar libs>copy D:\android-sdk\extras\google\gcm\gcm-client\dist\gcm.jar. Répertoire du projet eclipse du client «publieur» Depuis l explorateur windows, (eclipse n est pas démarré) créer un répertoire libs dans lequel vous copiez gcm-server.jar libs>copy D:\android-sdk\extras\google\gcm\gcm-server\dist\gcm-server.jar.. Si bluej, installez gcm-server.jar dans le répertoire +libs A l exécution json est requis D:\android-sdk\extras\google\gcm\gcm-server\lib\json_simple-1.1.jar 77

78 Conclusion Simple Push/polling (voir en annexe) Indispensable Note: Sous eclipse dans le projet créez un dossier libs Dans lequel sont copiés : gcm.jar pour souscrire gcm-server.jar et json-simple-1.1.jar pour publier 78

79 Annexe consommation en «polling» 79