上次講到簡單的AIDL程式間通訊的操作,客戶端向服務端傳送一個String型別的引數,服務端也返回一個String型別的結果,看似已經可以完成基本的需要了。不過在有的時候,簡單的資料型別並不能滿足我們的需求,我們就需要考慮怎樣向服務端傳遞複雜的資料型別。今天就來講一下如何向服務端傳遞複雜型別的問題。
首先要了解一下AIDL對Java型別的支援。
1.AIDL支援Java原始資料型別。
2.AIDL支援String和CharSequence。
3.AIDL支援傳遞其他AIDL介面,但你引用的每個AIDL介面都需要一個import語句,即使位於同一個包中。
4.AIDL支援傳遞實現了android.os.Parcelable介面的複雜型別,同樣在引用這些型別時也需要import語句。(Parcelable介面告訴Android執行時在封送(marshalling)和解封送(unmarshalling)過程中實現如何序列化和反序列化物件,你可以很容易聯想到java.io.Serializable介面。有些朋友可能會有疑問,兩種介面功能確實類似,但為什麼Android不用內建的Java序列化機制,而偏偏要搞一套新東西呢?這是因為Android團隊認為Java中的序列化太慢,難以滿足Android的程式間通訊需求,所以他們構建了Parcelable解決方案。Parcelable要求顯示序列化類的成員,但最終序列化物件的速度將快很多。另外要注意的是,Android提供了兩種機制來將資料傳遞給另一個程式,第一種是使用Intent將資料束(Bundle)傳遞給活動,第二種也就是Parcelable傳遞給服務。這兩種機制不可互換,不要混淆。也就是說,Parcelable無法傳遞給活動,只能用作AIDL定義的一部分)。
5.AIDL支援java.util.List和java.util.Map,但是有一些限制。集合中項的允許資料型別包括Java原始型別、String、CharSequence或是android.os.Parcelable。無需為List和Map提供import語句,但需要為Parcelable提供import語句。
6.非原始型別中,除了String和CharSequence以外,其餘均需要一個方向指示符。方向指示符包括in、out、和inout。in表示由客戶端設定,out表示由服務端設定,inout表示客戶端和服務端都設定了該值。
接下來就演示一下具體的流程:
我們先看一下服務端的結構:
其中,Person類是我們要在服務端和客戶端中間進行傳遞的型別,程式碼如下:
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 |
package com.scott.aidl; import android.os.Parcel; import android.os.Parcelable; public class Person implements Parcelable { private String name; private int sex; //必須提供一個名為CREATOR的static final屬性 該屬性需要實現android.os.Parcelable.Creator<T>介面 public static final Parcelable.Creator<Person> CREATOR = new Parcelable.Creator<Person>() { @Override public Person createFromParcel(Parcel source) { return new Person(source); } @Override public Person[] newArray(int size) { return new Person[size]; } }; public Person() { } private Person(Parcel source) { readFromParcel(source); } @Override public int describeContents() { return 0; } //注意寫入變數和讀取變數的順序應該一致 不然得不到正確的結果 @Override public void writeToParcel(Parcel dest, int flags) { dest.writeString(name); dest.writeInt(sex); } //注意讀取變數和寫入變數的順序應該一致 不然得不到正確的結果 public void readFromParcel(Parcel source) { name = source.readString(); sex = source.readInt(); } public String getName() { return name; } public void setName(String name) { this.name = name; } public int getSex() { return sex; } public void setSex(int sex) { this.sex = sex; } } |
然後我們需要在同一包下建立一個與包含複雜型別的Person.java檔案匹配的Person.aidl檔案,程式碼如下:
1 2 |
package com.scott.aidl; parcelable Person; |
這個Person.aidl檔案很簡單,就是定義了一個Parcelable類,告訴系統我們需要序列化和反序列化的型別。每一個實現了Parcelable的型別都需要對應的.aidl檔案。AIDL編譯器在編譯AIDL檔案時會自動查詢此類檔案。
接下來,我們需要建立一個IGreetService.aidl檔案,以接收型別為Person的輸入引數,以便客戶端可以將Person傳遞給服務。
1 2 3 4 5 6 |
package com.scott.aidl; import com.scott.aidl.Person; interface IGreetService { String greet(in Person person); } |
注意,我們需要在引數上加入方向指示符in,代表引數由客戶端設定,我們還需要為Person提供一個import語句(雖然說在同一個包下)。
此時,在eclipse外掛的幫助下,AIDL編譯器會自動編譯生成一個IGreetService.java檔案,格式化後的程式碼如下:
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 |
package com.scott.aidl; public interface IGreetService extends android.os.IInterface { /** Local-side IPC implementation stub class. */ public static abstract class Stub extends android.os.Binder implements com.scott.aidl.IGreetService { private static final java.lang.String DESCRIPTOR = "com.scott.aidl.IGreetService"; /** Construct the stub at attach it to the interface. */ public Stub() { this.attachInterface(this, DESCRIPTOR); } /** * Cast an IBinder object into an com.scott.aidl.IGreetService * interface, generating a proxy if needed. */ public static com.scott.aidl.IGreetService asInterface(android.os.IBinder obj) { if ((obj == null)) { return null; } android.os.IInterface iin = (android.os.IInterface) obj.queryLocalInterface(DESCRIPTOR); if (((iin != null) && (iin instanceof com.scott.aidl.IGreetService))) { return ((com.scott.aidl.IGreetService) iin); } return new com.scott.aidl.IGreetService.Stub.Proxy(obj); } public android.os.IBinder asBinder() { return this; } @Override public boolean onTransact(int code, android.os.Parcel data, android.os.Parcel reply, int flags) throws android.os.RemoteException { switch (code) { case INTERFACE_TRANSACTION: { reply.writeString(DESCRIPTOR); return true; } case TRANSACTION_greet: { data.enforceInterface(DESCRIPTOR); com.scott.aidl.Person _arg0; if ((0 != data.readInt())) { _arg0 = com.scott.aidl.Person.CREATOR.createFromParcel(data); } else { _arg0 = null; } java.lang.String _result = this.greet(_arg0); reply.writeNoException(); reply.writeString(_result); return true; } } return super.onTransact(code, data, reply, flags); } private static class Proxy implements com.scott.aidl.IGreetService { private android.os.IBinder mRemote; Proxy(android.os.IBinder remote) { mRemote = remote; } public android.os.IBinder asBinder() { return mRemote; } public java.lang.String getInterfaceDescriptor() { return DESCRIPTOR; } public java.lang.String greet(com.scott.aidl.Person person) throws android.os.RemoteException { android.os.Parcel _data = android.os.Parcel.obtain(); android.os.Parcel _reply = android.os.Parcel.obtain(); java.lang.String _result; try { _data.writeInterfaceToken(DESCRIPTOR); if ((person != null)) { _data.writeInt(1); person.writeToParcel(_data, 0); } else { _data.writeInt(0); } mRemote.transact(Stub.TRANSACTION_greet, _data, _reply, 0); _reply.readException(); _result = _reply.readString(); } finally { _reply.recycle(); _data.recycle(); } return _result; } } static final int TRANSACTION_greet = (android.os.IBinder.FIRST_CALL_TRANSACTION + 0); } public java.lang.String greet(com.scott.aidl.Person person) throws android.os.RemoteException; } |
該檔案的大綱檢視如下:
接下來,就該完成我們的AIDLService邏輯部分了,AIDLService.java程式碼如下:
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 |
package com.scott.server; import android.app.Service; import android.content.Intent; import android.os.IBinder; import android.os.RemoteException; import android.util.Log; import com.scott.aidl.IGreetService; import com.scott.aidl.Person; public class AIDLService extends Service { private static final String TAG = "AIDLService"; IGreetService.Stub stub = new IGreetService.Stub() { @Override public String greet(Person person) throws RemoteException { Log.i(TAG, "greet(Person person) called"); String greeting = "hello, " + person.getName(); switch (person.getSex()) { case 0: greeting = greeting + ", you're handsome."; break; case 1: greeting = greeting + ", you're beautiful."; break; } return greeting; } }; @Override public IBinder onBind(Intent intent) { Log.i(TAG, "onBind() called"); return stub; } @Override public boolean onUnbind(Intent intent) { Log.i(TAG, "onUnbind() called"); return true; } @Override public void onDestroy() { super.onDestroy(); Log.i(TAG, "onDestroy() called"); } } |
最後,在AndroidManifest.xml中配置該服務:
1 2 3 4 5 6 |
<service android:name=".AIDLService"> <intent-filter> <action android:name="android.intent.action.AIDLService" /> <category android:name="android.intent.category.DEFAULT" /> </intent-filter> </service> |
服務端就已經完成了。接下來我們來看一下客戶端的結構:
我們需要把服務端的Person.java、Person.aidl和IGreetService.aidl拷到對應的包下。我們主要來看看MainActivity.java程式碼:
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 |
package com.scott.client; import android.app.Activity; import android.content.ComponentName; import android.content.Context; import android.content.Intent; import android.content.ServiceConnection; import android.os.Bundle; import android.os.IBinder; import android.os.RemoteException; import android.util.Log; import android.view.View; import android.widget.Button; import android.widget.Toast; import com.scott.aidl.IGreetService; import com.scott.aidl.Person; public class MainActivity extends Activity { private Button bindBtn; private Button greetBtn; private Button unbindBtn; private IGreetService greetService; private ServiceConnection conn = new ServiceConnection() { @Override public void onServiceConnected(ComponentName name, IBinder service) { Log.i("ServiceConnection", "onServiceConnected() called"); greetService = IGreetService.Stub.asInterface(service); } @Override public void onServiceDisconnected(ComponentName name) { //This is called when the connection with the service has been unexpectedly disconnected, //that is, its process crashed. Because it is running in our same process, we should never see this happen. Log.i("ServiceConnection", "onServiceDisconnected() called"); } }; @Override public void onCreate(Bundle savedInstanceState) { super.onCreate(savedInstanceState); setContentView(R.layout.main); bindBtn = (Button) findViewById(R.id.bindBtn); bindBtn.setOnClickListener(new View.OnClickListener() { @Override public void onClick(View v) { Intent intent = new Intent("android.intent.action.AIDLService"); bindService(intent, conn, Context.BIND_AUTO_CREATE); bindBtn.setEnabled(false); greetBtn.setEnabled(true); unbindBtn.setEnabled(true); } }); greetBtn = (Button) findViewById(R.id.greetBtn); greetBtn.setOnClickListener(new View.OnClickListener() { @Override public void onClick(View v) { try { Person person = new Person(); person.setName("scott"); person.setSex(0); String retVal = greetService.greet(person); Toast.makeText(MainActivity.this, retVal, Toast.LENGTH_SHORT).show(); } catch (RemoteException e) { Toast.makeText(MainActivity.this, "error", Toast.LENGTH_SHORT).show(); } } }); unbindBtn = (Button) findViewById(R.id.unbindBtn); unbindBtn.setOnClickListener(new View.OnClickListener() { @Override public void onClick(View v) { unbindService(conn); bindBtn.setEnabled(true); greetBtn.setEnabled(false); unbindBtn.setEnabled(false); } }); } } |
通過這種方式,就可以將Person型別的物件傳遞到服務端,實現複雜型別的通訊傳遞。
當點選greetBtn時,截圖如下:
然後看一下整個過程的日誌資訊。點選bindBtn、greetBtn、unbindBtn的整個過程日誌如下: