Interface De Service AIDL. Android Interface Definition Language

Transcription

1 Client Interface De Service Serviteur AIDL Android Interface Definition Language

2 Client Serviteur Service Process Process IPC IPC Inter Process Communication... mais sur une même machine. pas entre plusieurs machines

3 <<package>> android.content <<interface>> ServiceConnection <<package>> android.os Spécification AIDL (.aidl) package com.example.aidl2kristof.api; interface InterfaceDeService { int premierservice(); int secondservice(); <<class>> Parcel <<interface>> IInterface <<class>> Binder <<interface>> IBinder <<package>> com.example.aidl2kristof.api Type Interne <<interface>> InterfaceDeService int premierservice(); int secondservice(); <<class>> Stub int premierservice(); int secondservice(); <<class>> Proxy

4 <<class>> Proxy <<interface>> InterfaceDeService int premierservice(); int secondservice(); <<class>> Stub int premierservice(); int secondservice(); Android Middleware Android IPC

5 Client Serviteur Process <<class>> Proxy <<interface>> InterfaceDeService int premierservice(); int secondservice(); Process <<class>> Stub int premierservice(); int secondservice(); Android Middleware Android IPC

6 <<interface>> InterfaceDeService int premierservice(); int secondservice(); <<class>> Proxy <<class>> Stub int premierservice(); int secondservice(); Android Middleware Android IPC

7 Exemple Complet 1ière Etape : Spécification de l'interface IDL package com.kristofaidldemo.api; import com.kristofaidldemo.api.monparcelable; interface InterfaceDeService { Fichier InterfaceDeService.aidl Il faut packager On peut importer int unservice(); Un Paramètre = ModeParam + TypeParam + NomParam MonParcelable mode1( in MonParcelable inparam); MonParcelable mode2( out MonParcelable outparam); MonParcelable mode3( inout MonParcelable inoutparam); Exemple simple 3 modes de passage de paramètres ( Parcelable! ): - in - out - inout Client Serveur Client Serveur Client Serveur

8 Exemple Complet 1ière Etape : Spécification des Parcelables (si nécessaire) Fichier MonParcelable.aidl package com.kristofaidldemo.api; Il faut packager parcelable MonParcelable; Ce parcelable a un intérêt seulement dans le cas d'utilisation de paramètres en mode in, out et inout. Les paramètres de type primitifs ne peuvent être passé qu'en mode in (par défaut).

9 Exemple Complet 1ière Etape : Implementation des Parcelables (si nécessaire) Fichier MonParcelable.java package com.kristofaidldemo.api; import android.os.parcel; import android.os.parcelable; public class MonParcelable implements Parcelable { Données "utiles" du Parcelable... private int d1; private String d2;

10 Constructeur Facultatif public MonParcelable(int d1, String d2) { this.d1 = d1; this.d2 = d2; Exemple Complet 1ière Etape : Implementation des Parcelables (si nécessaire) Fichier MonParcelable.java MonParcelable.suite Il faut fournir un constructeur par defaut! Utilisé par l'infrastructure sous-jascente public MonParcelable() { this.d1 = 0; this.d2 = "";

11 Exemple Complet 1ière Etape : Implementation des Parcelables (si nécessaire) Fichier MonParcelable.java MonParcelable.suite Getter/Setter en fonction de vos besoins......mais c'est mieux! public int getd1() { return d1; public void setd1(int d1) { this.d1 = d1; public String getd2() { return d2; public void setd2(string d2) { this.d2 = d2;

12 MonParcelable.suite describecontents() il la faut, c'est comme ca! cf JavaDoc: Describe the kinds of special objects contained in this Parcelable's marshalled representation. Returns : a bitmask indicating the set of special object types marshalled by the Parcelable.??? Il la public int describecontents() { TODO Auto-generated method stub return 0; Exemple Complet 1ière Etape : Implementation des Parcelables (si nécessaire) Fichier MonParcelable.java

13 Exemple Complet 1ière Etape : Implementation des Parcelables (si nécessaire) Fichier MonParcelable.java MonParcelable.suite /** Factory... * *... le nom " CREATOR "...doit être ainsi... */ public static final Parcelable.Creator<MonParcelable> CREATOR = new Parcelable.Creator<MonParcelable>() { ; public MonParcelable createfromparcel(parcel in) { int v1 = in.readint(); String v2 = in.readstring(); return new MonParcelable(v1, v2); public MonParcelable[] newarray(int size) { return new MonParcelable[size];

14 Exemple Complet 1ière Etape : Implementation des Parcelables (si nécessaire) Fichier MonParcelable.java MonParcelable.suite public void writetoparcel(parcel outparcel, int arg1) { Pour les paramètre en mode out et inout outparcel.writeint(d1); outparcel.writestring(d2); public void readfromparcel(parcel in) { Pour les paramètre en mode in d1 = in.readint(); d2 = in.readstring(); public String tostring() { return "MonParcelable [d1=" + d1 + ", d2=" + d2 + "]";

15 Exemple Complet Le compilateur AIDL. va traduire ces AIDL en java.

16 2nde Etape : Le coté Serveur... Exemple Complet package com.kristofaidldemo.coteserveur.lib; import... Implémentation du "Serviteur"... Objet qui rend effectivement les services... Premiere Etape : On "fabrique" une classe d implémentation qui dérive de la classe android.app.service En conséquence de cette dérivation, cela implique l implémentation de la méthode : public abstract Ibinder onbind (Intent intent) public class InterfaceDeServiceImpl extends Service {

17 2nde Etape : Le coté Serveur... private static final String Exemple Complet TAG=com.kristofaidldemo.coteserveur.lib.InterfaceDeServiceImpl. class.getname(); Variable compteur... pour illustrer le code métier.. private int compteur=0;

18 2nde Etape : Le coté Serveur... Exemple Complet Seconde Etape : En conséquence de la dérivation de la classe Service par la classe InterfaceDeServiceImpl, on implémenté la méthode onbind (Intent intent) Comme on illustre ici l'offre d'un service AIDL, cette méthode onbind doit retourner un Binder de type InterfaceDeService.Stub (nommé ici monbinder... cf ensuite) et implémentant les services apparaissant dans l'interface InterfaceDeService(.aidl). public IBinder onbind(intent intent) { return monbinder;

19 2nde Etape : Le coté Serveur... Exemple Complet private InterfaceDeService.Stub monbinder = new InterfaceDeService.Stub() { Notez ici l implémentation des services apparaissant dans l'interface InterfaceDeService(.aidl).... c'est ici qu apparaît le " code métier " du fournisseur de service... public int unservice() throws RemoteException { Log.d(TAG, "Execution de 'unservice'."); compteur++; return compteur;

20 2nde Etape : Le coté Serveur... Exemple public MonParcelable mode1( Illustation du mode in MonParcelable inparam)throws RemoteException { int v1=inparam.getd1(); String v2=inparam.getd2(); Log.d(TAG, " inparam (avant modif)= "+inparam); inparam.setd1(compteur); inparam.setd2("from mode1="+v2); Log.d(TAG, " inparam (apres modif)= "+inparam); MonParcelable res = new MonParcelable(666, "in parameter"); Log.d(TAG, " resultat = "+res); return res;

21 2nde Etape : Le coté Serveur... Exemple public MonParcelable mode2( Illustation du mode out MonParcelable outparam)throws RemoteException { int v1=outparam.getd1(); String v2=outparam.getd2(); outparam.setd1(compteur); outparam.setd2("from mode2="+v2); Log.d(TAG, " outparam (apres modif)= "+outparam); MonParcelable res = new MonParcelable(667, "out parameter"); Log.d(TAG, " resultat = "+res); return res;

22 2nde Etape : Le coté Serveur... Exemple public MonParcelable mode3( Illustation du mode outin MonParcelable inoutparam) throws RemoteException { int v1=inoutparam.getd1(); String v2=inoutparam.getd2(); inoutparam.setd1(compteur); inoutparam.setd2("from mode3="+v2); MonParcelable res = new MonParcelable(668, "inout parameter"); return res; fin de private InterfaceDeService.Stub monbinder =...

23 2nde Etape : Le coté Serveur... Exemple Complet public void oncreate() { Création du service super.oncreate(); Log.d(TAG, "unservice..."); Utils.listRunningService(getApplicationContext()); Utils.showShortToast(this, "oncreate()... Création du service..."); new MonThread().start();

24 2nde Etape : Le coté Serveur... Exemple Complet public void ondestroy() { super.ondestroy(); Destruction du service Log.d(TAG, "unservice..."); Utils.listRunningService(getApplicationContext()); Utils.showShortToast(this, "ondestroy()... Destruction du service...");

25 2nde Etape : Le coté Serveur... Exemple Complet public int onstartcommand( Intent intent, int flags, int startid) { Log.d(TAG, "unservice..."); Utils.listRunningService(getApplicationContext()); Utils.showShortToast(this, "onstartcommand()..."); return super.onstartcommand(intent, flags, startid);

26 Exemple Complet 2nde Etape : Le coté Serveur pour être complet : package com.kristofaidldemo.coteserveur.lib; import android.util.log; public class MonThread extends Thread { private static final String TAG=... private int pause=1000; private int compteur=0 ;

27 Exemple Complet 2nde Etape : Le coté Serveur pour être complet public void run() { while(compteur<200){ compteur++; Log.d(TAG, "MonThread["+compteur+"]"); try { Thread.sleep(pause); catch (InterruptedException e) {

28 Exemple Complet 2nde Etape : Le coté Serveur Concernant l'androidmanifest <?xml version="1.0" encoding="utf-8"?> <manifest xmlns:android=" package="com.kristofaidldemo.coteserveur.lib" android:versioncode="1" android:versionname="1.0" > <uses-sdk android:minsdkversion="16" android:targetsdkversion="16" /> <application android:icon="@drawable/ic_launcher" android:label="@string/app_name" <service android:name="interfacedeserviceimpl" android:enabled="true" android:exported="true" > <intent-filter> <action android:name="com.kristofaidldemo.intent.service.zeserviteur" /> </intent-filter> </service> </application> </manifest>

29 Exemple Complet 2nde Etape : Le coté Serveur Concernant l'androidmanifest <service android:name=the name of the Service subclass that implements the service. This should be a fully qualified class name (such as, "com.example.project.roomservice"). However, as a shorthand, if the first character of the name is a period (for example, ".RoomService"), it is appended to the package name specified in the <manifest> element. android:enabled=whether or not the service can be instantiated by the system "true" if it can be, and "false" if not. The default value is "true". > android:exported=whether or not components of other applications can invoke the service or interact with it "true" if they can, and "false" if not. When the value is "false", only components of the same application or applications with the same user ID can start the service or bind to it.

30 Exemple Complet 2nde Etape : Le coté Serveur Concernant l'androidmanifest <intent-filter> <action android:name="com.kristofaidldemo.intent.service.zeserviteur" /> </intent-filter> Le nom de l'intent dont devra disposer tout composant souhaitant se conencter au Serveur

31 Exemple Complet 3nde Étape : Le coté Client Le Client doit disposer d'une référence sur le Serveur : private InterfaceDeService monserviteur;

32 3nde Étape : Le coté Client Exemple Complet Le Client doit disposer d'une «connexion» sur le Serveur : L'interface ServiceConnection appartient à l'api private ServiceConnection maconnection = new ServiceConnection() { public void onserviceconnected (ComponentName arg0, IBinder arg1) { public void onservicedisconnected (ComponentName arg0) {

33 3nde Étape : Le coté Client Exemple Complet Le Client doit disposer d'une «connexion» sur le Serveur avec : La Méthode onserviceconnected (...) de l'interface android.content.serviceconnection Called when a connection to the Service has been established, with the IBinder of the communication channel to the Service. cf API Docs public void onserviceconnected (ComponentName arg0, IBinder arg1) { monserviteur = InterfaceDeService.Stub.asInterface(arg1);

34 3nde Étape : Le coté Client Exemple Complet Le Client doit disposer d'une «connexion» sur le Serveur avec : La Methode onservicedisconnected (...) de l'interface android.content.serviceconnection Called when a connection to the Service has been lost. This typically happens when the process hosting the service has crashed or been killed. cf API Docs public void onservicedisconnected (ComponentName arg0) { monserviteur = null;

35 3nde Étape : Le coté Client Exemple Complet Une fois que le Client se sera lié au Serveur : String intentstring = "com.kristofaidldemo.intent.service.zeserviteur"; Nom de l'intent-filter du service apparaissant dans l'androidmanifest.xml coté serveur Intent intent = new Intent(intentString) ; boolean res = BindService( intent, maconnection, Context.BIND_AUTO_CREATE); Il n'aura plus qu'à «naturellement» interagir avec : int res = monserviteur.unservice();

36 3nde Étape : Le coté Client Exemple Complet Le Client doit disposer d'une «connexion» sur le Serveur avec : La Methode onservicedisconnected (...) de l'interface android.content.serviceconnection Called when a connection to the Service has been lost. This typically happens when the process hosting the service has crashed or been killed. cf API Docs public void onservicedisconnected (ComponentName arg0) { monserviteur = null;