Android：學習AIDL，這一篇文章就夠了(上)
前言
在決定用這個標題之前甚是忐忑，主要是擔心自己對AIDL的理解不夠深入，到時候大家看了之後說——你這是什麼玩意兒，就這麼點東西就敢說夠了？簡直是坐井觀天不知所謂——那樣就很尷尬了。不過又轉念一想，我輩年輕人自當有一種一往無前的銳氣，標題大氣一點豈不更好？並且大家都是文明人，總歸更多的是理解與補充而不是侮辱與謾罵？所以最終還是厚顏用了這麼一個不怎麼有恥的標題。
好了，接下來進入正題，談談我對AIDL的理解和認識。
1、概述
AIDL是一個縮寫，全稱是Android Interface Definition Language，也就是Android介面定義語言。是的，首先我們知道的第一點就是：AIDL是一種語言。既然是一種語言，那麼相應的就很自然的衍生出了一些問題：
- 為什麼要設計出這麼一門語言？
- 它有哪些語法？
- 我們應該如何使用它？
- 再深入一點，我們可以思考，我們是如何通過它來達到我們的目的的？
- 更深入一點，為什麼要這麼設計這門語言？會不會有更好的方式來實現我們的目的？
接下來，我們就一步步的來解答上面的這些問題。
ps： 1， 在研究AIDL相關的東西之前，一些必要的知識儲備是要有的。一方面是關於Android中service相關的知識，要了解的比較通透才行，關於這方面的東西可以參考 Android中的Service：默默的奉獻者 (1) ， Android中的Service：Binder，Messenger，AIDL（2） 這兩篇博文。另一方面是關於Android中序列化的相關知識，這方面的東西文中會簡單提及，但是如果想要深入的研究一下的話最好還是去找一些這方面的資料看一下。 2，
2、為什麼要設計這門語言？
設計這門語言的目的是為了實現 程序間通訊 。
每一個程序都有自己的Dalvik VM例項，都有自己的一塊獨立的記憶體，都在自己的記憶體上儲存自己的資料，執行著自己的操作，都在自己的那片狹小的空間裡過完自己的一生。每個程序之間都你不知我，我不知你，就像是隔江相望的兩座小島一樣，都在同一個世界裡，但又各自有著自己的世界。而AIDL，就是兩座小島之間溝通的橋樑。相對於它們而言，我們就好像造物主一樣，我們可以通過AIDL來制定一些規則，規定它們能進行哪些交流——比如，它們可以在我們制定的規則下傳輸一些特定規格的資料。
總之，通過這門語言，我們可以愉快的在一個程序訪問另一個程序的資料，甚至呼叫它的一些方法，當然，只能是特定的方法。
3、它有哪些語法？
其實AIDL這門語言非常的簡單，基本上它的語法和 Java 是一樣的，只是在一些細微處有些許差別——畢竟它只是被創造出來簡化Android程式設計師工作的，太複雜不好——所以在這裡我就著重的說一下它和 Java 不一樣的地方。主要有下面這些點：
- 檔案型別：用AIDL書寫的檔案的字尾是 .aidl，而不是 .java。
- 資料型別：AIDL預設支援一些資料型別，在使用這些資料型別的時候是不需要導包的，但是除了這些型別之外的資料型別，在使用之前必須導包， 就算目標檔案與當前正在編寫的 .aidl 檔案在同一個包下 ——在 Java 中，這種情況是不需要導包的。比如，現在我們編寫了兩個檔案，一個叫做 Book.java ，另一個叫做 BookManager.aidl ，它們都在 com.lypeer.aidldemo 包下
，現在我們需要在 .aidl 檔案裡使用 Book 物件，那麼我們就必須在 .aidl 檔案裡面寫上 import com.lypeer.aidldemo.Book; 哪怕 .java 檔案和 .aidl 檔案就在一個包下。
預設支援的資料型別包括：- Java中的八種基本資料型別，包括 byte，short，int，long，float，double，boolean，char。
- String 型別。
- CharSequence型別。
- List型別：List中的所有元素必須是AIDL支援的型別之一，或者是一個其他AIDL生成的介面，或者是定義的parcelable（下文關於這個會有詳解）。List可以使用泛型。
- Map型別：Map中的所有元素必須是AIDL支援的型別之一，或者是一個其他AIDL生成的介面，或者是定義的parcelable。Map是不支援泛型的。
- 定向tag：這是一個極易被忽略的點——這裡的“被忽略”指的不是大家都不知道，而是很少人會正確的使用它。在我的理解裡，定向 tag 是這樣的： AIDL中的定向 tag 表示了在跨程序通訊中資料的流向，其中 in 表示資料只能由客戶端流向服務端， out 表示資料只能由服務端流向客戶端，而 inout 則表示資料可在服務端與客戶端之間雙向流通。其中，資料流向是針對在客戶端中的那個傳入方法的物件而言的。in 為定向 tag 的話表現為服務端將會接收到一個那個物件的完整資料，但是客戶端的那個物件不會因為服務端對傳參的修改而發生變動；out
的話表現為服務端將會接收到那個物件的的空物件，但是在服務端對接收到的空物件有任何修改之後客戶端將會同步變動；inout 為定向 tag 的情況下，服務端將會接收到客戶端傳來物件的完整資訊，並且客戶端將會同步服務端對該物件的任何變動。 具體的分析大家可以移步我的另一篇博文：
另外，Java 中的基本型別和 String ，CharSequence 的定向 tag 預設且只能是 in 。還有，請注意， 請不要濫用定向 tag ，而是要根據需要選取合適的——要是不管三七二十一，全都一上來就用 inout ，等工程大了系統的開銷就會大很多——因為排列整理引數的開銷是很昂貴的。 - 兩種AIDL檔案：在我的理解裡，所有的AIDL檔案大致可以分為兩類。一類是用來定義parcelable物件，以供其他AIDL檔案使用AIDL中非預設支援的資料型別的。一類是用來定義方法介面，以供系統使用來完成跨程序通訊的。可以看到，兩類檔案都是在“定義”些什麼，而不涉及具體的實現，這就是為什麼它叫做“Android介面定義語言”。
注： 所有的非預設支援資料型別必須通過第一類AIDL檔案定義才能被使用。
下面是兩個例子，對於常見的AIDL檔案都有所涉及：
// Book.aidl
//第一類AIDL檔案的例子
//這個檔案的作用是引入了一個序列化物件 Book 供其他的AIDL檔案使用
//注意：Book.aidl與Book.java的包名應當是一樣的
package com.lypeer.ipcclient;
//注意parcelable是小寫
parcelable Book;// BookManager.aidl
//第二類AIDL檔案的例子
package com.lypeer.ipcclient;
//匯入所需要使用的非預設支援資料型別的包
import com.lypeer.ipcclient.Book;
interface BookManager {
//所有的返回值前都不需要加任何東西，不管是什麼資料型別
List<Book> getBooks();
Book getBook();
int getBookCount();
//傳參時除了Java基本型別以及String，CharSequence之外的型別
//都需要在前面加上定向tag，具體加什麼量需而定
void setBookPrice(in Book book , int price)
void setBookName(in Book book , String name)
void addBookIn(in Book book);
void addBookOut(out Book book);
void addBookInout(inout Book book);
}4、如何使用AIDL檔案來完成跨程序通訊？
在進行跨程序通訊的時候，在AIDL中定義的方法裡包含非預設支援的資料型別與否，我們要進行的操作是不一樣的。如果不包含，那麼我們只需要編寫一個AIDL檔案，如果包含，那麼我們通常需要寫 n+1 個AIDL檔案（ n 為非預設支援的資料型別的種類數）——顯然，包含的情況要複雜一些。所以我接下來將只介紹AIDL檔案中包含非預設支援的資料型別的情況，至於另一種簡單些的情況相信大家是很容易從中觸類旁通的。
4.1、使資料類實現 Parcelable 介面
由於不同的程序有著不同的記憶體區域，並且它們只能訪問自己的那一塊記憶體區域，所以我們不能像平時那樣，傳一個控制代碼過去就完事了——控制代碼指向的是一個記憶體區域，現在目標程序根本不能訪問源程序的記憶體，那把它傳過去又有什麼用呢？ 所以我們必須將要傳輸的資料轉化為能夠在記憶體之間流通的形式。 這個轉化的過程就叫做序列化與反序列化。簡單來說是這樣的：比如現在我們要將一個物件的資料從客戶端傳到服務端去，我們就可以在客戶端對這個物件進行序列化的操作，將其中包含的資料轉化為序列化流，然後將這個序列化流傳輸到服務端的記憶體中去，再在服務端對這個資料流進行反序列化的操作，從而還原其中包含的資料——通過這種方式，我們就達到了在一個程序中訪問另一個程序的資料的目的。
而通常，在我們通過AIDL進行跨程序通訊的時候，選擇的序列化方式是實現 Parcelable 介面。關於實現 Parcelable 介面之後裡面具體有那些方法啦，每個方法是幹嘛的啦，這些我就不展開來講了，那並非這篇文章的重點，我下面主要講一下如何快速的生成一個合格的可序列化的類（以Book.java為例）。
注：若AIDL檔案中涉及到的所有資料型別均為預設支援的資料型別，則無此步驟。因為預設支援的那些資料型別都是可序列化的。
4.1.1、編譯器自動生成
我當前用的編譯器是Android Studio 2.1.2，它是自帶了 Parcelable 介面的模板的，只需要我們敲幾下鍵盤就可以輕鬆的生成一個可序列化的 Parcelable 實現類。
首先，建立一個類，正常的書寫其成員變數，建立getter和setter並新增一個無參構造，比如：
public class Book{
public String getName() {
return name;
}
public void setName(String name) {
this.name = name;
}
public int getPrice() {
return price;
}
public void setPrice(int price) {
this.price = price;
}
private String name;
private int price;
public Book() {}
}然後 implements Parcelable ，接著 as 就會報錯，將滑鼠移到那裡，按下 alt+enter（as預設的自動解決錯誤的快捷鍵，如果你們的as有修改過快捷鍵的話以修改後的為準） 讓它自動解決錯誤，這個時候它會幫你完成一部分的工作：
Parcelable實現第一步
在彈出來的框裡選擇所有的成員變數，然後確定。你會發現類裡多了一些程式碼，但是現在還是會報錯，Book下面仍然有一條小橫線，再次將滑鼠移到那裡，按下 alt+enter 讓它自動解決錯誤：
Parcelable實現第二步
這次解決完錯誤之後就不會報錯了，這個 Book 類也基本上實現了 Parcelable 介面，可以執行序列化操作了。
但是請注意，這裡有一個坑： 預設生成的模板類的物件只支援為 in 的定向 tag 。 為什麼呢？因為預設生成的類裡面只有 writeToParcel() 方法，而如果要支援為 out 或者 inout 的定向 tag 的話，還需要實現 readFromParcel() 方法——而這個方法其實並沒有在 Parcelable 接口裡面，所以需要我們從頭寫。具體為什麼大家可以去看看：
那麼這個 readFromParcel() 方法應當怎麼寫呢？這樣寫：
@Override
public void writeToParcel(Parcel dest, int flags) {
dest.writeString(name);
dest.writeInt(price);
}
/**
* 引數是一個Parcel,用它來儲存與傳輸資料
* @param dest
*/
public void readFromParcel(Parcel dest) {
//注意，此處的讀值順序應當是和writeToParcel()方法中一致的
name = dest.readString();
price = dest.readInt();
}像上面這樣添加了 readFromParcel() 方法之後，我們的 Book 類的物件在AIDL檔案裡就可以用 out 或者 inout 來作為它的定向 tag 了。
此時，完整的 Book 類的程式碼是這樣的：
package com.lypeer.ipcclient;
import android.os.Parcel;
import android.os.Parcelable;
/**
* Book.java
*
* Created by lypeer on 2016/7/16.
*/
public class Book implements Parcelable{
public String getName() {
return name;
}
public void setName(String name) {
this.name = name;
}
public int getPrice() {
return price;
}
public void setPrice(int price) {
this.price = price;
}
private String name;
private int price;
public Book(){}
public Book(Parcel in) {
name = in.readString();
price = in.readInt();
}
public static final Creator<Book> CREATOR = new Creator<Book>() {
@Override
public Book createFromParcel(Parcel in) {
return new Book(in);
}
@Override
public Book[] newArray(int size) {
return new Book[size];
}
};
@Override
public int describeContents() {
return 0;
}
@Override
public void writeToParcel(Parcel dest, int flags) {
dest.writeString(name);
dest.writeInt(price);
}
/**
* 引數是一個Parcel,用它來儲存與傳輸資料
* @param dest
*/
public void readFromParcel(Parcel dest) {
//注意，此處的讀值順序應當是和writeToParcel()方法中一致的
name = dest.readString();
price = dest.readInt();
}
//方便列印資料
@Override
public String toString() {
return "name : " + name + " , price : " + price;
}
}至此，關於AIDL中非預設支援資料型別的序列化操作就完成了。
4.1.2、外掛生成
我不是很清楚 Eclipse 或者較低版本的 as 上會不會像 as 2.1.2 這樣幫我們在實現 Parcelable 介面的過程中做如此多的操作，但是就算不會，我們還有其他的招數——通過外掛來幫我們實現 Parcelable 介面。
具體的實現方式和實現過程大家可以參見這篇文章：
4.2、書寫AIDL檔案
首先我們需要一個 Book.aidl 檔案來將 Book 類引入使得其他的 AIDL 檔案其中可以使用 Book 物件。那麼第一步，如何新建一個 AIDL 檔案呢？Android Studio已經幫我們把這個整合進去了：
新建AIDL檔案
滑鼠移到app上面去，點選右鍵，然後 new->AIDL->AIDL File，按下滑鼠左鍵就會彈出一個框提示生成AIDL檔案了。生成AIDL檔案之後，專案的目錄會變成這樣的：
建立AIDL檔案後的專案目錄
比起以前多了一個叫做 aidl 的包，而且他的層級是和 java 包相同的，並且 aidl 包裡預設有著和 java 包裡預設的包結構。那麼如果你用的是 Eclipse 或者較低版本的 as ，編譯器沒有這個選項怎麼辦呢？沒關係，我們也可以自己寫。開啟專案資料夾，依次進入 app->src->main，在 main 包下新建一個和 java 資料夾平級的 aidl 資料夾，然後我們手動在這個資料夾裡面新建和 java 資料夾裡面的預設結構一樣的資料夾結構，再在最裡層新建 .aidl 檔案就可以了：
自己新建AIDL檔案的目錄
注意看圖中的檔案目錄。
Ok，如何新建AIDL檔案說的差不多了，接下來就該寫AIDL檔案的內容了。內容的話如果上一節有認真看的話基本上是沒什麼問題的。在這裡，我們需要兩個AIDL檔案，我是這樣寫的：
// Book.aidl
//第一類AIDL檔案
//這個檔案的作用是引入了一個序列化物件 Book 供其他的AIDL檔案使用
//注意：Book.aidl與Book.java的包名應當是一樣的
package com.lypeer.ipcclient;
//注意parcelable是小寫
parcelable Book;// BookManager.aidl
//第二類AIDL檔案
//作用是定義方法介面
package com.lypeer.ipcclient;
//匯入所需要使用的非預設支援資料型別的包
import com.lypeer.ipcclient.Book;
interface BookManager {
//所有的返回值前都不需要加任何東西，不管是什麼資料型別
List<Book> getBooks();
//傳參時除了Java基本型別以及String，CharSequence之外的型別
//都需要在前面加上定向tag，具體加什麼量需而定
void addBook(in Book book);
}注意： 這裡又有一個坑！ 大家可能注意到了，在 Book.aidl 檔案中，我一直在強調： Book.aidl與Book.java的包名應當是一樣的。 這似乎理所當然的意味著這兩個檔案應當是在同一個包裡面的——事實上，很多比較老的文章裡就是這樣說的，他們說最好都在 aidl 包裡同一個包下，方便移植——然而在 Android Studio 裡並不是這樣。如果這樣做的話，系統根本就找不到 Book.java 檔案，從而在其他的AIDL檔案裡面使用 Book 物件的時候會報 Symbol not found 的錯誤。為什麼會這樣呢？因為 Gradle 。大家都知道，Android Studio 是預設使用 Gradle 來構建 Android 專案的，而 Gradle 在構建專案的時候會通過 sourceSets 來配置不同檔案的訪問路徑，從而加快查詢速度——問題就出在這裡。Gradle 預設是將 java 程式碼的訪問路徑設定在 java 包下的，這樣一來，如果 java 檔案是放在 aidl 包下的話那麼理所當然系統是找不到這個 java 檔案的。那應該怎麼辦呢？
又要 java檔案和 aidl 檔案的包名是一樣的，又要能找到這個 java 檔案——那麼仔細想一下的話，其實解決方法是很顯而易見的。首先我們可以把問題轉化成：如何在保證兩個檔案包名一樣的情況下，讓系統能夠找到我們的 java 檔案？這樣一來思路就很明確了：要麼讓系統來 aidl 包裡面來找 java 檔案，要麼把 java 檔案放到系統能找到的地方去，也即放到 java 包裡面去。接下來我詳細的講一下這兩種方式具體應該怎麼做：
- 修改 build.gradle 檔案：在 android{} 中間加上下面的內容：
sourceSets { main { java.srcDirs = ['src/main/java', 'src/main/aidl'] } } - 把 java 檔案放到 java 包下去：把 Book.java 放到 java 包裡任意一個包下，保持其包名不變，與 Book.aidl 一致。只要它的包名不變，Book.aidl 就能找到 Book.java ，而只要 Book.java 在 java 包下，那麼系統也是能找到它的。但是這樣做的話也有一個問題，就是在移植相關 .aidl 檔案和 .java 檔案的時候沒那麼方便，不能直接把整個 aidl 資料夾拿過去完事兒了，還要單獨將 .java 檔案放到 java 資料夾裡去。
我們可以用上面兩個方法之一來解決找不到 .java 檔案的坑，具體用哪個就看大家怎麼選了，反正都挺簡單的。
到這裡我們就已經將AIDL檔案新建並且書寫完畢了，clean 一下專案，如果沒有報錯，這一塊就算是大功告成了。
4.3、移植相關檔案
我們需要保證，在客戶端和服務端中都有我們需要用到的 .aidl 檔案和其中涉及到的 .java 檔案，因此不管在哪一端寫的這些東西，寫完之後我們都要把這些檔案複製到另一端去。如果是用的上面兩個方法中的第一個解決的找不到 .java 檔案的問題，那麼直接將 aidl 包複製到另一端的 main 目錄下就可以了；如果是使用第二個方法的話，就除了把把整個 aidl 資料夾拿過去，還要單獨將 .java 檔案放到 java 資料夾裡去。
4.4、編寫服務端程式碼
通過上面幾步，我們已經完成了AIDL及其相關檔案的全部內容，那麼我們究竟應該如何利用這些東西來進行跨程序通訊呢？其實，在我們寫完AIDL檔案並 clean 或者 rebuild 專案之後，編譯器會根據AIDL檔案為我們生成一個與AIDL檔案同名的 .java 檔案，這個 .java 檔案才是與我們的跨程序通訊密切相關的東西。事實上，基本的操作流程就是：在服務端實現AIDL中定義的方法介面的具體邏輯，然後在客戶端呼叫這些方法介面，從而達到跨程序通訊的目的。
接下來我直接貼上我寫的服務端程式碼：
/**
* 服務端的AIDLService.java
* <p/>
* Created by lypeer on 2016/7/17.
*/
public class AIDLService extends Service {
public final String TAG = this.getClass().getSimpleName();
//包含Book物件的list
private List<Book> mBooks = new ArrayList<>();
//由AIDL檔案生成的BookManager
private final BookManager.Stub mBookManager = new BookManager.Stub() {
@Override
public List<Book> getBooks() throws RemoteException {
synchronized (this) {
Log.e(TAG, "invoking getBooks() method , now the list is : " + mBooks.toString());
if (mBooks != null) {
return mBooks;
}
return new ArrayList<>();
}
}
@Override
public void addBook(Book book) throws RemoteException {
synchronized (this) {
if (mBooks == null) {
mBooks = new ArrayList<>();
}
if (book == null) {
Log.e(TAG, "Book is null in In");
book = new Book();
}
//嘗試修改book的引數，主要是為了觀察其到客戶端的反饋
book.setPrice(2333);
if (!mBooks.contains(book)) {
mBooks.add(book);
}
//列印mBooks列表，觀察客戶端傳過來的值
Log.e(TAG, "invoking addBooks() method , now the list is : " + mBooks.toString());
}
}
};
@Override
public void onCreate() {
super.onCreate();
Book book = new Book();
book.setName("Android開發藝術探索");
book.setPrice(28);
mBooks.add(book);
}
@Nullable
@Override
public IBinder onBind(Intent intent) {
Log.e(getClass().getSimpleName(), String.format("on bind,intent = %s", intent.toString()));
return mBookManager;
}
}整體的程式碼結構很清晰，大致可以分為三塊：第一塊是 初始化 。在 onCreate() 方法裡面我進行了一些資料的初始化操作。第二塊是 重寫 BookManager.Stub 中的方法 。在這裡面提供AIDL裡面定義的方法介面的具體實現邏輯。第三塊是 重寫 onBind() 方法 。在裡面返回寫好的 BookManager.Stub 。
接下來在 Manefest 檔案裡面註冊這個我們寫好的 Service ，這個不寫的話我們前面做的工作都是無用功：
<service
android:name=".service.AIDLService"
android:exported="true">
<intent-filter>
<action android:name="com.lypeer.aidl"/>
<category android:name="android.intent.category.DEFAULT"/>
</intent-filter>
</service>4.5、編寫客戶端程式碼
前面說過，在客戶端我們要完成的工作主要是呼叫服務端的方法，但是在那之前，我們首先要連線上服務端，完整的客戶端程式碼是這樣的：
/**
* 客戶端的AIDLActivity.java
* 由於測試機的無用debug資訊太多，故log都是用的e
* <p/>
* Created by lypeer on 2016/7/17.
*/
public class AIDLActivity extends AppCompatActivity {
//由AIDL檔案生成的Java類
private BookManager mBookManag