天天看點

Android AIDL 遠端service

轉自:http://android.blog.51cto.com/268543/537684/ AIDL的作用

    由于每個應用程式都運作在自己的程序空間,并且可以從應用程式UI運作另一個服務程序,而且經常會在不同的程序間傳遞對象。在Android平台,一個程序通常不能通路另一個程序的記憶體空間,是以要想對話,需要将對象分解成作業系統可以了解的基本單元,并且有序的通過程序邊界。

    通過代碼來實作這個資料傳輸過程是冗長乏味的,Android提供了AIDL工具來處理這項工作。

      AIDL (Android Interface Definition Language) 是一種IDL 語言,用于生成可以在Android裝置上兩個程序之間進行程序間通信(interprocess communication, IPC)的代碼。如果在一個程序中(例如Activity)要調用另一個程序中(例如Service)對象的操作,就可以使用AIDL生成可序列化的參數。

    AIDL IPC機制是面向接口的,像COM或Corba一樣,但是更加輕量級。它是使用代理類在用戶端和實作端傳遞資料。

   選擇AIDL的使用場合     官方文檔特别提醒我們何時使用AIDL是必要的: 隻有你允許用戶端從不同的應用程式為了程序間的通信而去通路你的service,以及想在你的service處理多線程。

      如果不需要進行不同應用程式間的并發通信(IPC),you should create your interface by implementing a Binder;或者你想進行IPC,但不需要處理多線程的,則implement your interface using a Messenger。無論如何,在使用AIDL前,必須要了解如何綁定service——bindService。       在設計AIDL接口前,要提醒的是,調用AIDL接口是直接的方法調用的,不是我們所想象的調用是發生線上程裡。而調用(call)來自local程序或者remote程序,有什麼差別呢?尤其是以下情況(引用原文,不作翻譯了,以免翻譯有誤):

  • Calls made from the local process are executed in the same thread that is making the call. If this is your main UI thread, that thread continues to execute in the AIDL interface. If it is another thread, that is the one that executes your code in the service. Thus, if only local threads are accessing the service, you can completely control which threads are executing in it (but if that is the case, then you shouldn't be using AIDL at all, but should instead create the interface byimplementing a Binder).
  • Calls from a remote process are dispatched from a thread pool the platform maintains inside of your own process. You must be prepared for incoming calls from unknown threads, with multiple calls happening at the same time. In other words, an implementation of an AIDL interface must be completely thread-safe.
  • The 

    oneway

     keyword modifies the behavior of remote calls. When used, a remote call does not block; it simply sends the transaction data and immediately returns. The implementation of the interface eventually receives this as a regular call from the 

    Binder

     thread pool as a normal remote call. If

    oneway

     is used with a local call, there is no impact and the call is still synchronous.

定義AIDL接口     AIDL接口檔案,和普通的接口内容沒有什麼特别,隻是它的擴充名為.aidl。儲存在src目錄下。 如果其他應用程式需要IPC,則那些應用程式的src也要帶有這個檔案。Android SDK tools就會在gen目錄自動生成一個IBinder接口檔案。service必須适當地實作這個IBinder接口。那麼用戶端程式就能綁定這個service并在IPC時從IBinder調用方法。     每個aidl檔案隻能定義一個接口,而且隻能是接口的聲明和方法的聲明。   1.建立.aidl檔案

     AIDL使用簡單的文法來聲明接口,描述其方法以及方法的參數和傳回值。這些參數和傳回值可以是任何類型,甚至是其他AIDL生成的接口。     其中對于Java程式設計語言的基本資料類型 (int, long, char, boolean等),String和CharSequence,集合接口類型List和Map,不需要import 語句。     而如果需要在AIDL中使用其他AIDL接口類型,需要import,即使是在相同包結構下。AIDL允許傳遞實作Parcelable接口的類,需要import.

    需要特别注意的是, 對于非基本資料類型,也不是String和CharSequence類型的,需要有方向訓示,包括in、out和inout,in表示由用戶端設定,out表示由服務端設定,inout是兩者均可設定。     AIDL隻支援接口方法,不能公開static變量。

  例如 (IMyService.aidl):  package com.demo; 

import com.demo.Person; 

interface IMyService { 

         void savePersonInfo(in Person person); 

        List<Person> getAllPerson(); 

}

2.實作接口     建立一個類實作剛才那個aidl的接口: public  class RemoteService  extends Service { 

         private LinkedList<Person> personList =  new LinkedList<Person>(); 

        @Override 

         public IBinder onBind(Intent intent) { 

                 return mBinder; 

        } 

        private final IMyService.Stub mBinder = new IMyService.Stub(){ 

                @Override 

                 public  void savePersonInfo(Person person)  throws RemoteException { 

                         if (person !=  null){ 

                                personList.add(person); 

                        } 

                } 

                @Override 

                 public List<Person> getAllPerson()  throws RemoteException { 

                         return personList; 

                } 

        }; 

}       這裡會看到有一個名為IMyService.Stub類,檢視aidl檔案生成的Java檔案源代碼就能發現有這麼一段代碼:  

public  static  abstract  class Stub  extends android.os.Binder  implements com.demo.IMyService     原來Stub類就是繼承于Binder類,也就是說RemoteService類和普通的Service類沒什麼不同,隻是所傳回的IBinder對象比較特别,是一個實作了AIDL接口的Binder。       接下來就是關于所傳遞的資料Bean——Person類,是一個序列化的類,這裡使用Parcelable 接口來序列化,是Android提供的一個比Serializable 效率更高的序列化類。     Parcelable需要實作三個函數:

    1)  void writeToParcel(Parcel dest, int flags) 将需要序列化存儲的資料寫入外部提供的Parcel對象dest。而看了網上的代碼例子,個人猜測,讀取Parcel資料的次序要和這裡的write次序一緻,否則可能會讀錯資料。具體情況我沒試驗過!

    2)  describeContents() 沒搞懂有什麼用,反正直接傳回0也可以

    3)  static final Parcelable.Creator對象CREATOR  這個CREATOR命名是固定的,而它對應的接口有兩個方法:

    createFromParcel(Parcel source) 實作從source建立出JavaBean執行個體的功能

    newArray(int size) 建立一個類型為T,長度為size的數組,僅一句話(return new T[size])即可。估計本方法是供外部類反序列化本類數組使用。

   仔細觀察Person類的代碼和上面所說的内容: public  class Person  implements Parcelable { 

         private String name; 

         private String telNumber; 

         private  int age; 

         public Person() {} 

        public Person(Parcel pl){ 

                name = pl.readString(); 

                telNumber = pl.readString(); 

                age = pl.readInt(); 

        } 

         public String getName() { 

                 return name; 

        } 

         public  void setName(String name) { 

                 this.name = name; 

        } 

         public String getTelNumber() { 

                 return telNumber; 

        } 

         public  void setTelNumber(String telNumber) { 

                 this.telNumber = telNumber; 

        } 

         public  int getAge() { 

                 return age; 

        } 

         public  void setAge( int age) { 

                 this.age = age; 

        } 

        @Override 

        public int describeContents() { 

                return 0; 

        } 

        @Override 

        public void writeToParcel(Parcel dest, int flags) { 

                dest.writeString(name); 

                dest.writeString(telNumber); 

                dest.writeInt(age); 

        } 

        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]; 

                } 

        }; 

}

然後建立Person.aidl檔案,注意這裡的parcelable和原來實作的Parcelable 接口,開頭的字母p一個小寫一個大寫: package com.demo; 

parcelable Person;        對于實作AIDL接口,官方還提醒我們:     1. 調用者是不能保證在主線程執行的,是以從一調用的開始就需要考慮多線程處理,以及確定線程安全;     2. IPC調用是同步的。如果你知道一個IPC服務需要超過幾毫秒的時間才能完成地話,你應該避免在Activity的主線程中調用。也就是IPC調用會挂起應用程式導緻界面失去響應,這種情況應該考慮單獨開啟一個線程來處理。

    3. 抛出的異常是不能傳回給調用者(跨程序抛異常處理是不可取的)。

3. 用戶端擷取接口     用戶端如何擷取AIDL接口呢?通過IMyService.Stub.asInterface(service)來得到IMyService對象: private IMyService mRemoteService; 

private ServiceConnection mRemoteConnection =  new ServiceConnection() {    

         public  void onServiceConnected(ComponentName className, IBinder service) {    

                 mRemoteService = IMyService.Stub.asInterface(service);    

        }    

         public  void onServiceDisconnected(ComponentName className) {    

                mRemoteService =  null;    

        }    

};  在生成的IMyService.java裡面會找到這樣的代碼:  

public  static com.demo.IMyService asInterface(android.os.IBinder obj) {...}   而service的綁定沒有什麼不同: if (mIsRemoteBound) { 

        unbindService(mRemoteConnection); 

} else{ 

        bindService( new Intent( "com.demo.IMyService"), 

                                mRemoteConnection, Context.BIND_AUTO_CREATE); 

mIsRemoteBound = !mIsRemoteBound;   通過IPC調用/傳遞資料     用戶端綁定service後就能通過IPC來調用/傳遞資料了,直接調用service對象的接口方法:

addPersonButton.setOnClickListener( 

                 new View.OnClickListener(){ 

                         private  int index = 0; 

                        @Override 

                         public  void onClick(View view) { 

                                Person person =  new Person(); 

                                index = index + 1; 

                                person.setName( "Person" + index); 

                                person.setAge(20); 

                                person.setTelNumber( "123456"); 

                                try { 

                                        mRemoteService.savePersonInfo(person); 

                                } catch (RemoteException e) { 

                                        e.printStackTrace(); 

                                } 

                        } 

                }); 

listPersonButton.setOnClickListener( 

                 new View.OnClickListener(){ 

                        @Override 

                         public  void onClick(View view) { 

                                List<Person> list =  null; 

                                try { 

                                        list = mRemoteService.getAllPerson(); 

                                } catch (RemoteException e) { 

                                        e.printStackTrace(); 

                                } 

                                 if (list !=  null){ 

                                        StringBuilder text =  new StringBuilder(); 

                                         for(Person person : list){ 

                                                text.append( "\nPerson name:"); 

                                                text.append(person.getName()); 

                                                text.append( "\n             age :"); 

                                                text.append(person.getAge()); 

                                                text.append( "\n tel number:"); 

                                                text.append(person.getTelNumber()); 

                                        } 

                                        inputPersonEdit.setText(text); 

                                } else { 

                                        Toast.makeText(ServiceActivity. this,  "get data error", 

                                                        Toast.LENGTH_SHORT).show(); 

                                } 

                        } 

                });

  Permission權限

    如果Service在AndroidManifest.xml中聲明了全局的強制的通路權限,其他引用必須聲明權限才能來start,stop或bind這個service.

     另外,service可以通過權限來保護她的IPC方法調用,通過調用checkCallingPermission(String)方法來確定可以執行這個操作。

  AndroidManifest.xml的Service元素 < service  android:name =".RemoteService"  android:process=":remote" > 

         < intent-filter > 

                 < action  android:name ="com.demo.IMyService"  /> 

         </ intent-filter > 

</ service >     這裡的android:process=":remote",一開始我沒有添加的,在同一個程式裡使用IPC,即同一個程式作為用戶端/伺服器端,結果運作mRemoteService = IMyService.Stub.asInterface(service);時提示空指針異常。觀察了人家的在不同程式裡進行IPC的代碼,也是沒有這個android:process=":remote"的。後來在官方文檔 http://androidappdocs.appspot.com/guide/topics/manifest/service-element.html裡了解到(留意第二段文字): android:process

The name of the process where the service is to run. Normally, all components of an application run in the default process created for the application. It has the same name as the application package. The <application> element's process attribute can set a different default for all components. But component can override the default with its own process attribute, allowing you to spread your application across multiple processes.   If the name assigned to this attribute begins with a colon (':'), a new process, private to the application, is created when it's needed and the service runs in that process.  If the process name begins with a lowercase character, the service will run in a global process of that name, provided that it has permission to do so. This allows components in different applications to share a process, reducing resource usage.  也就是說android:process=":remote",代表在應用程式裡,當需要該service時,會自動建立新的程序。而如果是android:process="remote",沒有“:”分号的,則建立全局程序,不同的應用程式共享該程序。   以上内容結合了不少網絡文章,包括來自 http://blog.csdn.net/caowenbin的譯文, http://terryblog.blog.51cto.com/1764499/382457, http://4225953-163-com.iteye.com/blog/792997以及Android的官方網站文檔。