Android AIDL使用詳解

 

1、概述

AIDL 意思即 Android Interface Definition Language，翻譯過來就是Android接口定義語言，是用於定義服務器和客戶端通訊接口的一種描述語言，能夠拿來生成用於IPC的代碼。從某種意義上說AIDL實際上是一個模板，由於在使用過程當中，實際起做用的並非AIDL文件，而是據此而生成的一個IInterface的實例代碼，AIDL實際上是爲了不咱們重複編寫代碼而出現的一個模板

設計AIDL這門語言的目的就是爲了實現進程間通訊。在Android系統中，每一個進程都運行在一塊獨立的內存中，在其中完成本身的各項活動，與其餘進程都分隔開來。但是有時候咱們又有應用間進行互動的需求，比較傳遞數據或者任務委託等，AIDL就是爲了知足這種需求而誕生的。經過AIDL，能夠在一個進程中獲取另外一個進程的數據和調用其暴露出來的方法，從而知足進程間通訊的需求

一般，暴露方法給其餘應用進行調用的應用稱爲服務端，調用其餘應用的方法的應用稱爲客戶端，客戶端經過綁定服務端的Service來進行交互

2、語法

AIDL的語法十分簡單，與Java語言基本保持一致，須要記住的規則有如下幾點：

1. AIDL文件以 .aidl 爲後綴名
2. AIDL支持的數據類型分爲以下幾種：
   • 八種基本數據類型：byte、char、short、int、long、float、double、boolean
   • String，CharSequence
   • 實現了Parcelable接口的數據類型
   • List 類型。List承載的數據必須是AIDL支持的類型，或者是其它聲明的AIDL對象
   • Map類型。Map承載的數據必須是AIDL支持的類型，或者是其它聲明的AIDL對象
3. AIDL文件能夠分爲兩類。一類用來聲明實現了Parcelable接口的數據類型，以供其餘AIDL文件使用那些非默認支持的數據類型。還有一類是用來定義接口方法，聲明要暴露哪些接口給客戶端調用，定向Tag就是用來標註這些方法的參數值
4. 定向Tag。定向Tag表示在跨進程通訊中數據的流向，用於標註方法的參數值，分爲 in、out、inout 三種。其中 in 表示數據只能由客戶端流向服務端， out 表示數據只能由服務端流向客戶端，而 inout 則表示數據可在服務端與客戶端之間雙向流通。此外，若是AIDL方法接口的參數值類型是：基本數據類型、String、CharSequence或者其餘AIDL文件定義的方法接口，那麼這些參數值的定向 Tag 默認是且只能是 in，因此除了這些類型外，其餘參數值都須要明確標註使用哪一種定向Tag。定向Tag具體的使用差異後邊會有介紹
5. 明確導包。在AIDL文件中須要明確標明引用到的數據類型所在的包名，即便兩個文件處在同個包名下

3、服務端編碼

這裏來實際完成一個例子做爲示範，須要實現的功能是：客戶端經過綁定服務端的Service的方式來調用服務端的方法，獲取服務端的書籍列表並向其添加書籍，實現應用間的數據共享

首先是服務端的代碼
新建一個工程，包名就定義爲 com.czy.server
首先，在應用中須要用到一個 Book 類，而 Book 類是兩個應用間都須要使用到的，因此也須要在AIDL文件中聲明Book類，爲了不出現類名重複致使沒法建立文件的錯誤，這裏須要先創建 Book AIDL 文件，以後再建立 Book 類

右鍵點擊新建一個AIDL文件，命名爲 Book

 

建立完成後，系統就會默認建立一個 aidl 文件夾，文件夾下的目錄結構便是工程的包名，Book.aidi 文件就在其中

Book.aidl 文件中會有一個默認方法，能夠刪除掉

 

此時就能夠來定義Book類了，Book類只包含一個 Name 屬性，並使之實現 Parcelable 接口

/** * 做者：葉應是葉 * 時間：2017/8/25 23:31 * 描述： */ public class Book implements Parcelable { private String name; public Book(String name) { this.name = name; } public String getName() { return name; } public void setName(String name) { this.name = name; } @Override public String toString() { return "book name：" + name; } @Override public int describeContents() { return 0; } @Override public void writeToParcel(Parcel dest, int flags) { dest.writeString(this.name); } public void readFromParcel(Parcel dest) { name = dest.readString(); } protected Book(Parcel in) { this.name = in.readString(); } public static final Creator<Book> CREATOR = new Creator<Book>() { @Override public Book createFromParcel(Parcel source) { return new Book(source); } @Override public Book[] newArray(int size) { return new Book[size]; } }; } 

如今再來修改 Book.aidl 文件，將之改成聲明Parcelable數據類型的AIDL文件

package com.czy.server; parcelable Book; 

此外，根據一開始的設想，服務端須要暴露給客戶端一個獲取書籍列表以及一個添加書籍的方法，這兩個方法首先要定義在AIDL文件中，命名爲 BookController.aidl，注意這裏須要明確導包

package com.czy.server; import com.czy.server.Book; interface BookController { List<Book> getBookList(); void addBookInOut(inout Book book); } 

上面說過，在進程間通訊中真正起做用的並非 AIDL 文件，而是系統據此而生成的文件，能夠在如下目錄中查看系統生成的文件。以後須要使用到當中的內部靜態抽象類 Stub

建立或修改過AIDL文件後須要clean下工程，使系統及時生成咱們須要的文件

 

如今須要來建立一個 Service 供客戶端遠程綁定了，這裏命名爲 AIDLService

/** * 做者：葉應是葉 * 時間：2017/8/26 0:07 * 描述： */ public class AIDLService extends Service { private final String TAG = "Server"; private List<Book> bookList; public AIDLService() { } @Override public void onCreate() { super.onCreate(); bookList = new ArrayList<>(); initData(); } private void initData() { Book book1 = new Book("活着"); Book book2 = new Book("或者"); Book book3 = new Book("葉應是葉"); Book book4 = new Book("https://github.com/leavesC"); Book book5 = new Book("http://www.jianshu.com/u/9df45b87cfdf"); Book book6 = new Book("http://blog.csdn.net/new_one_object"); bookList.add(book1); bookList.add(book2); bookList.add(book3); bookList.add(book4); bookList.add(book5); bookList.add(book6); } private final BookController.Stub stub = new BookController.Stub() { @Override public List<Book> getBookList() throws RemoteException { return bookList; } @Override public void addBookInOut(Book book) throws RemoteException { if (book != null) { book.setName("服務器改了新書的名字 InOut"); bookList.add(book); } else { Log.e(TAG, "接收到了一個空對象 InOut"); } } }; @Override public IBinder onBind(Intent intent) { return stub; } } 

能夠看到， onBind 方法返回的就是 BookController.Stub 對象，實現當中定義的兩個方法

最後，服務端還有一個地方須要注意，由於服務端的Service須要被客戶端來遠程綁定，因此客戶端要可以找到這個Service，能夠經過先指定包名，以後再配置Action值或者直接指定Service類名的方式來綁定Service
若是是經過指定Action值的方式來綁定Service，那還須要將Service的聲明改成以下所示：

 

本例子採用配置 Action 的方案

4、客戶端編碼

客戶端須要再建立一個新的工程，包名命名爲 com.czy.client

首先，須要把服務端的AIDL文件以及Book類複製過來，將 aidl 文件夾整個複製到和Java文件夾同個層級下，不須要改動任何代碼

 

以後，須要建立和服務端Book類所在的相同包名來存放 Book類

 

修改佈局文件，添加兩個按鈕

<?xml version="1.0" encoding="utf-8"?> <LinearLayout xmlns:android="http://schemas.android.com/apk/res/android" android:layout_width="match_parent" android:layout_height="match_parent" android:gravity="center" android:orientation="vertical"> <Button android:id="@+id/btn_getBookList" android:layout_width="match_parent" android:layout_height="wrap_content" android:text="獲取書籍列表" /> <Button android:id="@+id/btn_addBook_inOut" android:layout_width="match_parent" android:layout_height="wrap_content" android:text="InOut 添加書籍" /> </LinearLayout> 

/** * 做者：葉應是葉 * 時間：2017/8/26 0:34 * 描述： */ public class MainActivity extends AppCompatActivity { private final String TAG = "Client"; private BookController bookController; private boolean connected; private List<Book> bookList; private ServiceConnection serviceConnection = new ServiceConnection() { @Override public void onServiceConnected(ComponentName name, IBinder service) { bookController = BookController.Stub.asInterface(service); connected = true; } @Override public void onServiceDisconnected(ComponentName name) { connected = false; } }; private View.OnClickListener clickListener = new View.OnClickListener() { @Override public void onClick(View v) { switch (v.getId()) { case R.id.btn_getBookList: if (connected) { try { bookList = bookController.getBookList(); } catch (RemoteException e) { e.printStackTrace(); } log(); } break; case R.id.btn_addBook_inOut: if (connected) { Book book = new Book("這是一本新書 InOut"); try { bookController.addBookInOut(book); Log.e(TAG, "向服務器以InOut方式添加了一本新書"); Log.e(TAG, "新書名：" + book.getName()); } catch (RemoteException e) { e.printStackTrace(); } } break; } } }; @Override protected void onCreate(Bundle savedInstanceState) { super.onCreate(savedInstanceState); setContentView(R.layout.activity_main); findViewById(R.id.btn_getBookList).setOnClickListener(clickListener); findViewById(R.id.btn_addBook_inOut).setOnClickListener(clickListener); bindService(); } @Override protected void onDestroy() { super.onDestroy(); if (connected) { unbindService(serviceConnection); } } private void bindService() { Intent intent = new Intent(); intent.setPackage("com.czy.server"); intent.setAction("com.czy.server.action"); bindService(intent, serviceConnection, Context.BIND_AUTO_CREATE); } private void log() { for (Book book : bookList) { Log.e(TAG, book.toString()); } } } 

兩個按鈕分別用於獲取服務端的書籍列表和添加書籍，在添加書籍時，服務端還改變了Book對象的Name屬性，據此觀察客戶端和服務端數據的變化狀況

首先點擊獲取書籍列表，數據獲取無誤

 

再點擊按鈕添加書籍，能夠看到，服務端對數據的修改也同時同步到了客戶端這邊

 

到此爲止，客戶端和服務端之間的通訊已經實現了，客戶端獲取到了服務端的數據，也向服務端傳送了數據

5、定向Tag

最後，我再來說下三種定向Tag之間的差異。上邊使用的是 InOut 類型，服務端對數據的改變同時也同步到了客戶端，所以能夠說二者之間數據是雙向流動的

In 類型的表現形式是：數據只能由客戶端傳向服務端，服務端對數據的修改不會影響到客戶端

Out類型的表現形式是：數據只能由服務端傳向客戶端，即便客戶端向方法接口傳入了一個對象，該對象中的屬性值也是爲空的，即不包含任何數據，服務端獲取到該對象後，對該對象的任何操做，就會同步到客戶端這邊

這裏再來實際演示一下

先修改服務器端的 BookController.aidl 文件，向之添加兩個新方法

package com.czy.server; import com.czy.server.Book; interface BookController { List<Book> getBookList(); void addBookInOut(inout Book book); void addBookIn(in Book book); void addBookOut(out Book book); } 

則 AIDLService 類的 BookController.Stub 對象就須要修改成以下所示：

private final BookController.Stub stub = new BookController.Stub() { @Override public List<Book> getBookList() throws RemoteException { return bookList; } @Override public void addBookInOut(Book book) throws RemoteException { if (book != null) { book.setName("服務器改了新書的名字 InOut"); bookList.add(book); } else { Log.e(TAG, "接收到了一個空對象 InOut"); } } @Override public void addBookIn(Book book) throws RemoteException { if (book != null) { book.setName("服務器改了新書的名字 In"); bookList.add(book); } else { Log.e(TAG, "接收到了一個空對象 In"); } } @Override public void addBookOut(Book book) throws RemoteException { if (book != null) { Log.e(TAG, "客戶端傳來的書的名字：" + book.getName()); book.setName("服務器改了新書的名字 Out"); bookList.add(book); } else { Log.e(TAG, "接收到了一個空對象 Out"); } } }; 

同步修改客戶端的 BookController.aidl 文件

向佈局文件多增添兩個按鈕，分別用於添加不一樣的 定向Tag 的數據

private View.OnClickListener clickListener = new View.OnClickListener() { @Override public void onClick(View v) { switch (v.getId()) { case R.id.btn_getBookList: if (connected) { try { bookList = bookController.getBookList(); } catch (RemoteException e) { e.printStackTrace(); } log(); } break; case R.id.btn_addBook_inOut: if (connected) { Book book = new Book("這是一本新書 InOut"); try { bookController.addBookInOut(book); Log.e(TAG, "向服務器以InOut方式添加了一本新書"); Log.e(TAG, "新書名：" + book.getName()); } catch (RemoteException e) { e.printStackTrace(); } } break; case R.id.btn_addBook_in: if (connected) { Book book = new Book("這是一本新書 In"); try { bookController.addBookIn(book); Log.e(TAG, "向服務器以In方式添加了一本新書"); Log.e(TAG, "新書名：" + book.getName()); } catch (RemoteException e) { e.printStackTrace(); } } break; case R.id.btn_addBook_out: if (connected) { Book book = new Book("這是一本新書 Out"); try { bookController.addBookOut(book); Log.e(TAG, "向服務器以Out方式添加了一本新書"); Log.e(TAG, "新書名：" + book.getName()); } catch (RemoteException e) { e.printStackTrace(); } } break; } } }; 

此外，還有個地方須要修改下，即Book類。由於 Out 類型的確會使得客戶端傳一個不包含任何數據的對象回服務端，但該對象卻不是直接就等於 null ，因此說明系統仍是須要實例化 Book 類，但當前 Book 類只有一個有參構造函數，因此還須要修改 Book 類，爲之添加一個無參構造函數以供系統使用

分別點擊三個按鈕，能夠看到，服務端在獲取到客戶端以Out方式傳來的Book對象時，的確是不包含書名這個屬性值

 

關於AIDL的知識就講到這裏了，這裏也提供上述代碼下載，爲了方便，我將 Client 端的代碼保存成壓縮文件放到 Server 端工程文件下

項目地址：Android AIDL使用詳解