Android AIDL 使用詳解

一斗幼、概述

AIDL 意思即 Android Interface Definition Language澎蛛，翻譯過來就是Android接口定義語言，是用于定義服務(wù)器和客戶端通信接口的一種描述語言蜕窿，可以拿來生成用于IPC的代碼谋逻。從某種意義上說AIDL其實是一個模板，因為在使用過程中桐经，實際起作用的并不是AIDL文件毁兆，而是據(jù)此而生成的一個IInterface的實例代碼，AIDL其實是為了避免我們重復(fù)編寫代碼而出現(xiàn)的一個模板

設(shè)計AIDL這門語言的目的就是為了實現(xiàn)進程間通信阴挣。在Android系統(tǒng)中人弓，每個進程都運行在一塊獨立的內(nèi)存中脸侥，在其中完成自己的各項活動，與其他進程都分隔開來∪糁可是有時候我們又有應(yīng)用間進行互動的需求猪贪，比較傳遞數(shù)據(jù)或者任務(wù)委托等诸迟，AIDL就是為了滿足這種需求而誕生的塔鳍。通過AIDL，可以在一個進程中獲取另一個進程的數(shù)據(jù)和調(diào)用其暴露出來的方法拜隧，從而滿足進程間通信的需求

通常宿百，暴露方法給其他應(yīng)用進行調(diào)用的應(yīng)用稱為服務(wù)端，調(diào)用其他應(yīng)用的方法的應(yīng)用稱為客戶端洪添，客戶端通過綁定服務(wù)端的Service來進行交互

二犀呼、語法

AIDL的語法十分簡單，與Java語言基本保持一致薇组，需要記住的規(guī)則有以下幾點：

  1. AIDL文件以 .aidl 為后綴名
  2. AIDL支持的數(shù)據(jù)類型分為如下幾種：
    • 八種基本數(shù)據(jù)類型：byte、char坐儿、short律胀、int、long貌矿、float炭菌、double、boolean
    • String逛漫，CharSequence
    • 實現(xiàn)了Parcelable接口的數(shù)據(jù)類型
    • List 類型黑低。List承載的數(shù)據(jù)必須是AIDL支持的類型，或者是其它聲明的AIDL對象
    • Map類型。Map承載的數(shù)據(jù)必須是AIDL支持的類型克握，或者是其它聲明的AIDL對象
  3. AIDL文件可以分為兩類蕾管。一類用來聲明實現(xiàn)了Parcelable接口的數(shù)據(jù)類型，以供其他AIDL文件使用那些非默認(rèn)支持的數(shù)據(jù)類型菩暗。還有一類是用來定義接口方法掰曾，聲明要暴露哪些接口給客戶端調(diào)用，定向Tag就是用來標(biāo)注這些方法的參數(shù)值
  4. 定向Tag停团。定向Tag表示在跨進程通信中數(shù)據(jù)的流向旷坦，用于標(biāo)注方法的參數(shù)值，分為 in佑稠、out秒梅、inout 三種。其中 in 表示數(shù)據(jù)只能由客戶端流向服務(wù)端舌胶， out 表示數(shù)據(jù)只能由服務(wù)端流向客戶端捆蜀，而 inout 則表示數(shù)據(jù)可在服務(wù)端與客戶端之間雙向流通。此外辆琅，如果AIDL方法接口的參數(shù)值類型是：基本數(shù)據(jù)類型漱办、String、CharSequence或者其他AIDL文件定義的方法接口婉烟，那么這些參數(shù)值的定向 Tag 默認(rèn)是且只能是 in娩井，所以除了這些類型外，其他參數(shù)值都需要明確標(biāo)注使用哪種定向Tag似袁。定向Tag具體的使用差別后邊會有介紹
  5. 明確導(dǎo)包洞辣。在AIDL文件中需要明確標(biāo)明引用到的數(shù)據(jù)類型所在的包名，即使兩個文件處在同個包名下

三昙衅、服務(wù)端編碼

這里來實際完成一個例子作為示范扬霜，需要實現(xiàn)的功能是：客戶端通過綁定服務(wù)端的Service的方式來調(diào)用服務(wù)端的方法，獲取服務(wù)端的書籍列表并向其添加書籍而涉，實現(xiàn)應(yīng)用間的數(shù)據(jù)共享

首先是服務(wù)端的代碼
新建一個工程著瓶，包名就定義為 com.czy.server
首先，在應(yīng)用中需要用到一個 Book 類啼县，而 Book 類是兩個應(yīng)用間都需要使用到的材原，所以也需要在AIDL文件中聲明Book類，為了避免出現(xiàn)類名重復(fù)導(dǎo)致無法創(chuàng)建文件的錯誤季眷，這里需要先建立 Book AIDL 文件余蟹，之后再創(chuàng)建 Book 類

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

image

創(chuàng)建完成后子刮，系統(tǒng)就會默認(rèn)創(chuàng)建一個 aidl 文件夾威酒，文件夾下的目錄結(jié)構(gòu)即是工程的包名，Book.aidi 文件就在其中

Book.aidl 文件中會有一個默認(rèn)方法，可以刪除掉

image

此時就可以來定義Book類了葵孤，Book類只包含一個 Name 屬性担钮，并使之實現(xiàn) Parcelable 接口

/**
 * 作者：葉應(yīng)是葉
 * 時間：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];
        }
    };
}

現(xiàn)在再來修改 Book.aidl 文件，將之改為聲明Parcelable數(shù)據(jù)類型的AIDL文件

package com.czy.server;

parcelable Book;

此外佛呻，根據(jù)一開始的設(shè)想裳朋，服務(wù)端需要暴露給客戶端一個獲取書籍列表以及一個添加書籍的方法，這兩個方法首先要定義在AIDL文件中吓著，命名為 BookController.aidl鲤嫡，注意這里需要明確導(dǎo)包

package com.czy.server;
import com.czy.server.Book;

interface BookController {

    List<Book> getBookList();

    void addBookInOut(inout Book book);

}

上面說過，在進程間通信中真正起作用的并不是 AIDL 文件绑莺，而是系統(tǒng)據(jù)此而生成的文件暖眼，可以在以下目錄中查看系統(tǒng)生成的文件。之后需要使用到當(dāng)中的內(nèi)部靜態(tài)抽象類 Stub

創(chuàng)建或修改過AIDL文件后需要clean下工程纺裁，使系統(tǒng)及時生成我們需要的文件

image

現(xiàn)在需要來創(chuàng)建一個 Service 供客戶端遠(yuǎn)程綁定了诫肠，這里命名為 AIDLService

/**
 * 作者：葉應(yīng)是葉
 * 時間：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("葉應(yīng)是葉");
        Book book4 = new Book("https://github.com/leavesC");
        Book book5 = new Book("http://www.reibang.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("服務(wù)器改了新書的名字 InOut");
                bookList.add(book);
            } else {
                Log.e(TAG, "接收到了一個空對象 InOut");
            }
        }

    };

    @Override
    public IBinder onBind(Intent intent) {
        return stub;
    }

}

可以看到， onBind 方法返回的就是 BookController.Stub 對象欺缘，實現(xiàn)當(dāng)中定義的兩個方法

最后栋豫，服務(wù)端還有一個地方需要注意，因為服務(wù)端的Service需要被客戶端來遠(yuǎn)程綁定谚殊，所以客戶端要能夠找到這個Service丧鸯，可以通過先指定包名，之后再配置Action值或者直接指定Service類名的方式來綁定Service
如果是通過指定Action值的方式來綁定Service嫩絮，那還需要將Service的聲明改為如下所示：

image

本例子采用配置 Action 的方案

四丛肢、客戶端編碼

客戶端需要再創(chuàng)建一個新的工程，包名命名為 com.czy.client

首先剿干，需要把服務(wù)端的AIDL文件以及Book類復(fù)制過來蜂怎，將 aidl 文件夾整個復(fù)制到和Java文件夾同個層級下，不需要改動任何代碼

image

之后置尔，需要創(chuàng)建和服務(wù)端Book類所在的相同包名來存放 Book類

image

修改布局文件杠步，添加兩個按鈕

<?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>


/**
 * 作者：葉應(yīng)是葉
 * 時間：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, "向服務(wù)器以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());
        }
    }

}

兩個按鈕分別用于獲取服務(wù)端的書籍列表和添加書籍，在添加書籍時榜轿，服務(wù)端還改變了Book對象的Name屬性幽歼，據(jù)此觀察客戶端和服務(wù)端數(shù)據(jù)的變化情況

首先點擊獲取書籍列表，數(shù)據(jù)獲取無誤

image

再點擊按鈕添加書籍差导，可以看到，服務(wù)端對數(shù)據(jù)的修改也同時同步到了客戶端這邊

image

到此為止猪勇，客戶端和服務(wù)端之間的通信已經(jīng)實現(xiàn)了设褐，客戶端獲取到了服務(wù)端的數(shù)據(jù)，也向服務(wù)端傳送了數(shù)據(jù)

五、定向Tag

最后助析，我再來講下三種定向Tag之間的差別犀被。上邊使用的是 InOut 類型，服務(wù)端對數(shù)據(jù)的改變同時也同步到了客戶端外冀，因此可以說兩者之間數(shù)據(jù)是雙向流動的

In 類型的表現(xiàn)形式是：數(shù)據(jù)只能由客戶端傳向服務(wù)端寡键，服務(wù)端對數(shù)據(jù)的修改不會影響到客戶端

Out類型的表現(xiàn)形式是：數(shù)據(jù)只能由服務(wù)端傳向客戶端，即使客戶端向方法接口傳入了一個對象雪隧，該對象中的屬性值也是為空的西轩，即不包含任何數(shù)據(jù)，服務(wù)端獲取到該對象后脑沿，對該對象的任何操作藕畔，就會同步到客戶端這邊

這里再來實際演示一下

先修改服務(wù)器端的 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("服務(wù)器改了新書的名字 InOut");
                bookList.add(book);
            } else {
                Log.e(TAG, "接收到了一個空對象 InOut");
            }
        }

        @Override
        public void addBookIn(Book book) throws RemoteException {
            if (book != null) {
                book.setName("服務(wù)器改了新書的名字 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("服務(wù)器改了新書的名字 Out");
                bookList.add(book);
            } else {
                Log.e(TAG, "接收到了一個空對象 Out");
            }
        }

    };

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

向布局文件多增添兩個按鈕庄拇，分別用于添加不同的 定向Tag 的數(shù)據(jù)

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, "向服務(wù)器以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, "向服務(wù)器以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, "向服務(wù)器以O(shè)ut方式添加了一本新書");
                            Log.e(TAG, "新書名：" + book.getName());
                        } catch (RemoteException e) {
                            e.printStackTrace();
                        }
                    }
                    break;
            }
        }
    };

此外注服，還有個地方需要修改下，即Book類措近。因為 Out 類型的確會使得客戶端傳一個不包含任何數(shù)據(jù)的對象回服務(wù)端溶弟，但該對象卻不是直接就等于 null ，所以說明系統(tǒng)還是需要實例化 Book 類瞭郑，但當(dāng)前 Book 類只有一個有參構(gòu)造函數(shù)辜御，所以還需要修改 Book 類，為之添加一個無參構(gòu)造函數(shù)以供系統(tǒng)使用

分別點擊三個按鈕凰浮，可以看到我抠，服務(wù)端在獲取到客戶端以O(shè)ut方式傳來的Book對象時，的確是不包含書名這個屬性值

image

關(guān)于AIDL的知識就講到這里了袜茧，這里也提供上述代碼下載菜拓，為了方便，我將 Client 端的代碼保存成壓縮文件放到 Server 端工程文件下

Demo 下載：Android AIDL使用詳解

最后編輯于 ：
?著作權(quán)歸作者所有,轉(zhuǎn)載或內(nèi)容合作請聯(lián)系作者
  • 人面猴
    序言：七十年代末笛厦，一起剝皮案震驚了整個濱河市纳鼎，隨后出現(xiàn)的幾起案子，更是在濱河造成了極大的恐慌裳凸，老刑警劉巖贱鄙，帶你破解...
    沈念sama閱讀 216,372評論 6贊 498
  • 死咒
    序言：濱河連續(xù)發(fā)生了三起死亡事件，死亡現(xiàn)場離奇詭異姨谷，居然都是意外死亡逗宁，警方通過查閱死者的電腦和手機，發(fā)現(xiàn)死者居然都...
    沈念sama閱讀 92,368評論 3贊 392
  • 救了他兩次的神仙讓他今天三更去死
    文/潘曉璐 我一進店門梦湘，熙熙樓的掌柜王于貴愁眉苦臉地迎上來瞎颗，“玉大人件甥，你說我怎么就攤上這事『甙危” “怎么了引有？”我有些...
    開封第一講書人閱讀 162,415評論 0贊 353
  • 道士緝兇錄：失蹤的賣姜人
    文/不壞的土叔 我叫張陵，是天一觀的道長倦逐。 經(jīng)常有香客問我譬正，道長，這世上最難降的妖魔是什么檬姥？ 我笑而不...
    開封第一講書人閱讀 58,157評論 1贊 292
  • ?港島之戀（遺憾婚禮）
    正文 為了忘掉前任曾我，我火速辦了婚禮，結(jié)果婚禮上穿铆，老公的妹妹穿的比我還像新娘您单。我一直安慰自己，他們只是感情好荞雏，可當(dāng)我...
    茶點故事閱讀 67,171評論 6贊 388
  • 惡毒庶女頂嫁案：這布局不是一般人想出來的
    文/花漫 我一把揭開白布虐秦。 她就那樣靜靜地躺著，像睡著了一般凤优。 火紅的嫁衣襯著肌膚如雪悦陋。 梳的紋絲不亂的頭發(fā)上，一...
    開封第一講書人閱讀 51,125評論 1贊 297
  • 城市分裂傳說
    那天筑辨，我揣著相機與錄音俺驶，去河邊找鬼。 笑死棍辕，一個胖子當(dāng)著我的面吹牛暮现，可吹牛的內(nèi)容都是我干的。 我是一名探鬼主播楚昭，決...
    沈念sama閱讀 40,028評論 3贊 417
  • 雙鴛鴦連環(huán)套：你想象不到人心有多黑
    文/蒼蘭香墨 我猛地睜開眼栖袋，長吁一口氣：“原來是場噩夢啊……” “哼！你這毒婦竟也來了抚太？” 一聲冷哼從身側(cè)響起塘幅，我...
    開封第一講書人閱讀 38,887評論 0贊 274
  • 萬榮殺人案實錄
    序言：老撾萬榮一對情侶失蹤，失蹤者是張志新（化名）和其女友劉穎尿贫，沒想到半個月后电媳，有當(dāng)?shù)厝嗽跇淞掷锇l(fā)現(xiàn)了一具尸體，經(jīng)...
    沈念sama閱讀 45,310評論 1贊 310
  • ?護林員之死
    正文 獨居荒郊野嶺守林人離奇死亡庆亡，尸身上長有42處帶血的膿包…… 初始之章·張勛 以下內(nèi)容為張勛視角 年9月15日...
    茶點故事閱讀 37,533評論 2贊 332
  • ?白月光啟示錄
    正文 我和宋清朗相戀三年匾乓，在試婚紗的時候發(fā)現(xiàn)自己被綠了。 大學(xué)時的朋友給我發(fā)了我未婚夫和他白月光在一起吃飯的照片又谋。...
    茶點故事閱讀 39,690評論 1贊 348
  • 活死人
    序言：一個原本活蹦亂跳的男人離奇死亡拼缝，死狀恐怖括享，靈堂內(nèi)的尸體忽然破棺而出，到底是詐尸還是另有隱情珍促，我是刑警寧澤，帶...
    沈念sama閱讀 35,411評論 5贊 343
  • ?日本核電站爆炸內(nèi)幕
    正文 年R本政府宣布剩愧，位于F島的核電站猪叙，受9級特大地震影響，放射性物質(zhì)發(fā)生泄漏仁卷。R本人自食惡果不足惜穴翩，卻給世界環(huán)境...
    茶點故事閱讀 41,004評論 3贊 325
  • 男人毒藥：我在死后第九天來索命
    文/蒙蒙 一、第九天 我趴在偏房一處隱蔽的房頂上張望锦积。 院中可真熱鬧芒帕，春花似錦、人聲如沸丰介。這莊子的主人今日做“春日...
    開封第一講書人閱讀 31,659評論 0贊 22
  • 一樁弒父案，背后竟有這般陰謀
    文/蒼蘭香墨 我抬頭看了看天上的太陽哮幢。三九已至带膀，卻和暖如春，著一層夾襖步出監(jiān)牢的瞬間橙垢，已是汗流浹背垛叨。 一陣腳步聲響...
    開封第一講書人閱讀 32,812評論 1贊 268
  • 情欲美人皮
    我被黑心中介騙來泰國打工， 沒想到剛下飛機就差點兒被人妖公主榨干…… 1. 我叫王不留柜某，地道東北人嗽元。 一個月前我還...
    沈念sama閱讀 47,693評論 2贊 368
  • 代替公主和親
    正文 我出身青樓，卻偏偏與公主長得像喂击，于是被迫代替她去往敵國和親剂癌。 傳聞我的和親對象是個殘疾皇子，可洞房花燭夜當(dāng)晚...
    茶點故事閱讀 44,577評論 2贊 353