一、概述
AIDL 意思即 Android Interface Definition Language，翻譯過來就是Android介面定義語言，是用於定義伺服器和客戶端通訊介面的一種描述語言，可以拿來生成用於IPC的程式碼。從某種意義上說AIDL其實是一個模板，因為在使用過程中，實際起作用的並不是AIDL檔案，而是據此而生成的一個IInterface的例項程式碼，AIDL其實是為了避免我們重複編寫程式碼而出現的一個模板
設計AIDL這門語言的目的就是為了實現程式間通訊。在Android系統中，每個程式都執行在一塊獨立的記憶體中，在其中完成自己的各項活動，與其他程式都分隔開來。可是有時候我們又有應用間進行互動的需求，比較傳遞資料或者任務委託等，AIDL就是為了滿足這種需求而誕生的。通過AIDL，可以在一個程式中獲取另一個程式的資料和呼叫其暴露出來的方法，從而滿足程式間通訊的需求
通常，暴露方法給其他應用進行呼叫的應用稱為服務端，呼叫其他應用的方法的應用稱為客戶端，客戶端通過繫結服務端的Service來進行互動
二、語法
AIDL的語法十分簡單，與Java語言基本保持一致，需要記住的規則有以下幾點：
- AIDL檔案以 .aidl 為字尾名
- AIDL支援的資料型別分為如下幾種：
- 八種基本資料型別：byte、char、short、int、long、float、double、boolean
- String，CharSequence
- 實現了Parcelable介面的資料型別
- List 型別。List承載的資料必須是AIDL支援的型別，或者是其它宣告的AIDL物件
- Map型別。Map承載的資料必須是AIDL支援的型別，或者是其它宣告的AIDL物件
- AIDL檔案可以分為兩類。一類用來宣告實現了Parcelable介面的資料型別，以供其他AIDL檔案使用那些非預設支援的資料型別。還有一類是用來定義介面方法，宣告要暴露哪些介面給客戶端呼叫，定向Tag就是用來標註這些方法的引數值
- 定向Tag。定向Tag表示在跨程式通訊中資料的流向，用於標註方法的引數值，分為 in、out、inout 三種。其中 in 表示資料只能由客戶端流向服務端， out 表示資料只能由服務端流向客戶端，而 inout 則表示資料可在服務端與客戶端之間雙向流通。此外，如果AIDL方法介面的引數值型別是：基本資料型別、String、CharSequence或者其他AIDL檔案定義的方法介面，那麼這些引數值的定向 Tag 預設是且只能是 in，所以除了這些型別外，其他引數值都需要明確標註使用哪種定向Tag。定向Tag具體的使用差別後邊會有介紹
- 明確導包。在AIDL檔案中需要明確標明引用到的資料型別所在的包名，即使兩個檔案處在同個包名下
三、服務端編碼
這裡來實際完成一個例子作為示範，需要實現的功能是：客戶端通過繫結服務端的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 的方案
四、客戶端編碼
客戶端需要再建立一個新的工程，包名命名為 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屬性，據此觀察客戶端和服務端資料的變化情況
首先點選獲取書籍列表，資料獲取無誤
再點選按鈕新增書籍，可以看到，服務端對資料的修改也同時同步到了客戶端這邊
到此為止，客戶端和服務端之間的通訊已經實現了，客戶端獲取到了服務端的資料，也向服務端傳送了資料
五、定向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 端工程檔案下