IPC机制 -- IPC方式 -- AIDL（2）

工作过程

在写完AIDL文件后，编译器会帮我们自动生成一个同名的 .java 文件，在我们实际编写客户端和服务端代码的过程中，真正协助我们工作的其实是这个 .java 文件，而 .aidl 文件从头到尾都没有出现过。事实上，就算我们不写AIDL文件，直接按照它生成的 .java 文件那样写一个 .java 文件出来，在服务端和客户端中也可以照常使用这个 .java 类来进行跨进程通信。所以说AIDL语言只是在简化我们写这个 .java 文件的工作而已，而要研究AIDL是如何帮助我们进行跨进程通信的，其实就是研究这个生成的 .java 文件是如何工作的。

//BookManager.java
//接口，继承接口
public interface BookManager extends android.os.IInterface { 
    //抽象类，继承Binder、实现接口
    public static abstract class Stub extends android.os.Binder implements com.tomorrow.androidtest7.aidl.BookManager {
        //静态内部类，实现接口
        private static class Proxy implements com.tomorrow.androidtest7.aidl.BookManager {
        }
    }
}

当客户端和服务端都位于同一进程时，方法调用不会走跨进程的transact过程，由Stub类负责；
而当两者位于不同进程时，方法调用需要走transact过程，由Stub的内部代理类Proxy来完成。

一、通过AIDL生成的 .java 文件位置

完整路径是：app==>build==>generated==>source==>aidl==>debug==>com==>tomorrow==>androidtest7==>aidl==>BookManager.java（其中 com.tomorrow.androidtest7是包名，相对应的AIDL文件为 BookManager.aidl ）。在Android Studio里面目录组织方式由默认的 Android 改为 Project 就可以直接按照文件夹结构访问到它。

二、从应用看原理

先不看冗杂的源码，从实际的应用着手，辅以思考分析，试图寻找突破点。
从服务端开始，去掉其他无关的东西，从宏观上分析：

//AIDLService.java
//由AIDL文件生成的BookManager
private final BookManager.Stub mBookManager = new BookManager.Stub() {
    @Override
    public List<Book> getBooks() throws RemoteException {
        //省略
    }

    @Override
    public void addBookWithTagIn(Book book) throws RemoteException {
        //省略
    }

    @Override
    public void addBookWithTagOut(Book book) throws RemoteException {
        //省略
    }

    @Override
    public void addBookWithTagInOut(Book book) throws RemoteException {
        //省略
    }
};

对 BookManagerStub 里面的方法进行了重写，这些方法是在 AIDL 文件里面定义的。也就是说，在这里为之前定义的方法提供了具体实现。接着，在 onBind() 方法里将这个 BookManagerStub 作为返回值传递过去。

接着看客户端：

//AIDLActivity.java
private BookManager mBookManager = null;
private ServiceConnection mServiceConnection = new ServiceConnection() {
    @Override
    public void onServiceConnected(ComponentName name, IBinder service) {
        mBookManager = BookManager.Stub.asInterface(service);
        //省略
        mBooks = mBookManager.getBooks();
        //省略
    }

    @Override
    public void onServiceDisconnected(ComponentName name) {
        //省略
    }
};

获取 BookManager 对象，然后调用它里面的方法。

三、从客户端开始

//客户端获取 BookManager 对象：
//AIDLActivity.java
@Override
public void onServiceConnected(ComponentName name, IBinder service) { //IBinder service 为 BookManager$Stub 对象
    mBookManager = BookManager.Stub.asInterface(service);
}

//BookManager$Stub#asInterface：
public static com.tomorrow.androidtest7.aidl.BookManager asInterface(android.os.IBinder obj)
{
if ((obj==null)) {
return null;
}
android.os.IInterface iin = obj.queryLocalInterface(DESCRIPTOR); //搜索本地是否已经有可用的对象
if (((iin!=null)&&(iin instanceof com.tomorrow.androidtest7.aidl.BookManager))) {
return ((com.tomorrow.androidtest7.aidl.BookManager)iin); //如果本地有就将其返回
}
return new com.tomorrow.androidtest7.aidl.BookManager.Stub.Proxy(obj); //如果本地没有就重新创建一个并返回
}

//BookManager$Stub$Proxy：客户端最终通过这个类与服务端进行通信
private static class Proxy implements com.tomorrow.androidtest7.aidl.BookManager {
private android.os.IBinder mRemote;
}

Proxy(android.os.IBinder remote) //此处的 remote 正是前面我们提到的 IBinder service，即 BookManager$Stub 对象
{
    mRemote = remote;
}

@Override public java.util.List<com.tomorrow.androidtest7.aidl.Book> getBooks() throws android.os.RemoteException
{
    //省略
}

@Override public void addBookWithTagIn(com.tomorrow.androidtest7.aidl.Book book) throws android.os.RemoteException
{
    //省略
}

@Override public void addBookWithTagOut(com.tomorrow.androidtest7.aidl.Book book) throws android.os.RemoteException
{
    //省略
}

@Override public void addBookWithTagInOut(com.tomorrow.androidtest7.aidl.Book book) throws android.os.RemoteException
{
    //省略
}

//客户端调用服务端的方法：
//BookManager$Stub$Proxy#getBooks：
@Override public java.util.List<com.tomorrow.androidtest7.aidl.Book> getBooks() throws android.os.RemoteException
{
android.os.Parcel _data = android.os.Parcel.obtain(); //_data用来存储客户端流向服务端的数据流（参数）
android.os.Parcel _reply = android.os.Parcel.obtain(); //_reply用来存储服务端流回客户端的数据流（参数及返回值）
java.util.List<com.tomorrow.androidtest7.aidl.Book> _result;
try {
_data.writeInterfaceToken(DESCRIPTOR);
//调用 transact() 方法将方法id和两个 Parcel 容器传过去
mRemote.transact(Stub.TRANSACTION_getBooks, _data, _reply, 0);
_reply.readException();
//从_reply中取出服务端执行方法的结果
_result = _reply.createTypedArrayList(com.tomorrow.androidtest7.aidl.Book.CREATOR);
}
finally {
_reply.recycle();
_data.recycle();
}
//将结果返回
return _result;
}

关于 transact() 方法：这是客户端和服务端通信的核心方法。
调用这个方法之后，客户端将会挂起当前线程，等待服务端执行完相关任务后的通知并接收返回的 _reply 数据流。关于这个方法的参数有两点需要说明：
(1)第一个参数：是一个方法 ID ，这个是客户端与服务端约定好的给方法的编码，彼此一一对应。在AIDL文件转化为 .java 文件的时候，系统将会自动给AIDL文件里面的每一个方法自动分配一个方法 ID。
(2)第四个参数：是一个 int 值，它的作用是设置进行 IPC 的模式，为 0 表示数据可以双向流通，即 _reply 流可以正常的携带数据回来；为 1 表示数据将只能单向流通，从服务端回来的 _reply 流将不携带任何数据。 AIDL生成的 .java 文件的这个参数均为 0。

BookManagerStubProxy的工作过程：
(1)生成 _data 和 _reply 数据流，并向 _data 中存入客户端的数据；
(2)通过 transact() 方法将它们传递给服务端，并请求服务端调用指定方法；
(3)接收 _reply 数据流，并从中取出服务端传回来的数据。

四、接着看服务端

//客户端调用 transact() 方法，服务端回调 onTransact() 方法：
//BookManager$Stub#onTransact：
@Override public boolean onTransact(int code, android.os.Parcel data, android.os.Parcel reply, int flags) throws android.os.RemoteException
{
switch (code)
{
case INTERFACE_TRANSACTION:
    //省略
case TRANSACTION_getBooks:
    //省略
case TRANSACTION_addBookWithTagIn:
    //省略
case TRANSACTION_addBookWithTagOut:
    //省略
case TRANSACTION_addBookWithTagInOut:
    //省略
}
return super.onTransact(code, data, reply, flags);
}

//服务端响应客户端的调用：
case TRANSACTION_getBooks:
{
data.enforceInterface(DESCRIPTOR);
//调用 this.getBooks() 方法，在这里开始执行具体的业务逻辑
//result 列表为调用 getBooks() 方法的返回值
java.util.List _result = this.getBooks();
reply.writeNoException();
//将方法执行的结果写入 reply
reply.writeTypedList(_result);
return true;
}

BookManager$Stub的工作过程：
(1)获取客户端传过来的数据，根据方法 ID 执行相应操作；
(2)将传过来的数据取出来，调用本地写好的对应方法；
(3)将需要回传的数据写入 reply 流，传回客户端。

五、AIDL方法参数有定向tag的情况

1.定向tag为 in 的情况

//BookManager$Stub$Proxy#addBookWithTagIn：
@Override public void addBookWithTagIn(com.tomorrow.androidtest7.aidl.Book book) throws android.os.RemoteException
{
android.os.Parcel _data = android.os.Parcel.obtain();
android.os.Parcel _reply = android.os.Parcel.obtain();
try {
_data.writeInterfaceToken(DESCRIPTOR);
if ((book!=null)) {
_data.writeInt(1);
//将book对象写入_data流，传递给服务端
book.writeToParcel(_data, 0);
}
else {
_data.writeInt(0);
}
//调用transact方法
mRemote.transact(Stub.TRANSACTION_addBookWithTagIn, _data, _reply, 0);
_reply.readException();
//在执行transact方法之后没有针对_reply的操作
}
finally {
_reply.recycle();
_data.recycle();
}
}

//BookManager$Stub#onTransact：
case TRANSACTION_addBookWithTagIn:
{
data.enforceInterface(DESCRIPTOR);
com.tomorrow.androidtest7.aidl.Book _arg0; 
if ((0!=data.readInt())) {
//从输入的data流中读取book数据，并将其赋值给_arg0
_arg0 = com.tomorrow.androidtest7.aidl.Book.CREATOR.createFromParcel(data); 
}
else {
_arg0 = null;
}
//调用服务端写好的实现
this.addBookWithTagIn(_arg0); 
reply.writeNoException();
//执行完方法之后就结束了，没有针对reply流的操作，因此客户端不会同步服务端的变化
return true;
}

2.定向tag为 out 的情况

//BookManager$Stub$Proxy#addBookWithTagOut：
@Override public void addBookWithTagOut(com.tomorrow.androidtest7.aidl.Book book) throws android.os.RemoteException
{
android.os.Parcel _data = android.os.Parcel.obtain();
android.os.Parcel _reply = android.os.Parcel.obtain();
try {
_data.writeInterfaceToken(DESCRIPTOR);
//没有将book对象写入_data流，因此服务端接收不到客户端传过来的数据
//调用transact方法
mRemote.transact(Stub.TRANSACTION_addBookWithTagOut, _data, _reply, 0);
_reply.readException();
if ((0!=_reply.readInt())) {
//在执行transact方法之后还有针对_reply的操作，并且将book赋值为_reply流中的数据
book.readFromParcel(_reply);
}
}
finally {
_reply.recycle();
_data.recycle();
}
}

//BookManager$Stub#onTransact：
case TRANSACTION_addBookWithTagOut:
{
data.enforceInterface(DESCRIPTOR);
com.tomorrow.androidtest7.aidl.Book _arg0;
//没有从data流读取book对象，而是直接new一个book对象
_arg0 = new com.tomorrow.androidtest7.aidl.Book();
//调用服务端写好的实现
this.addBookWithTagOut(_arg0); 
reply.writeNoException();
if ((_arg0!=null)) {
reply.writeInt(1);
//执行完方法之后还有针对reply的操作，并且将参数_arg0写入reply流，因此客户端可以接收到服务端传过来的数据
_arg0.writeToParcel(reply, android.os.Parcelable.PARCELABLE_WRITE_RETURN_VALUE);
}
else {
reply.writeInt(0);
}
return true;
}

3.定向tag为 inout 的情况

//BookManager$Stub$Proxy#addBookWithTagInOut：
@Override public void addBookWithTagInOut(com.tomorrow.androidtest7.aidl.Book book) throws android.os.RemoteException
{
android.os.Parcel _data = android.os.Parcel.obtain();
android.os.Parcel _reply = android.os.Parcel.obtain();
try {
_data.writeInterfaceToken(DESCRIPTOR);
if ((book!=null)) {
_data.writeInt(1);
//将book对象写入_data流，传递给服务端
book.writeToParcel(_data, 0);
}
else {
_data.writeInt(0);
}
//调用transact方法
mRemote.transact(Stub.TRANSACTION_addBookWithTagInOut, _data, _reply, 0);
_reply.readException();
if ((0!=_reply.readInt())) {
//在执行transact方法之后还有针对_reply的操作，并且将book赋值为_reply流中的数据
book.readFromParcel(_reply);
}
}
finally {
_reply.recycle();
_data.recycle();
}
}

//BookManager$Stub#onTransact：
case TRANSACTION_addBookWithTagInOut:
{
data.enforceInterface(DESCRIPTOR);
com.tomorrow.androidtest7.aidl.Book _arg0;
if ((0!=data.readInt())) {
//从输入的data流中读取book数据，并将其赋值给_arg0
_arg0 = com.tomorrow.androidtest7.aidl.Book.CREATOR.createFromParcel(data); 
}
else {
_arg0 = null;
}
//调用服务端写好的实现
this.addBookWithTagInOut(_arg0);
reply.writeNoException();
if ((_arg0!=null)) {
reply.writeInt(1);
//执行完方法之后还有针对reply的操作，并且将参数_arg0写入reply流，因此客户端可以接收到服务端传过来的数据
_arg0.writeToParcel(reply, android.os.Parcelable.PARCELABLE_WRITE_RETURN_VALUE);
}
else {
reply.writeInt(0);
}
return true;
}

六、Stub及Proxy方法介绍

1.DESCRIPTOR：
Binder的唯一标识，一般用当前Binder的类名表示，比如"com.tomorrow.androidtest7.aidl.BookManager"。
2.asInterface(android.os.IBinder obj)：
用于将服务端的Binder对象转换成客户端所需的AIDL接口类型的对象，这种转换过程是区分进程的，如果客户端和服务端位于同一进程，那么此方法返回的就是服务端的Stub对象本身，否则返回的是系统封装后的Stub$proxy对象。
3.asBinder：
此方法用于返回当前Binder对象。
4.onTransact：
这个方法运行在服务端中的Binder线程池中，当客户端发起跨进程请求时，远程请求会通过系统底层封装后交由此方法来处理。该方法的原型是：

public boolean onTransact(int code, android.os.Parcel data, android.os.Parcel reply, int flags)

执行过程为：
(1)服务端通过code可以确定客户端所请求的目标方法是什么，接着从data中取出目标方法所需的参数（如果目标方法有参数的话）；
(2)执行目标方法；
(3)当目标方法执行完毕后，就向reply中写入返回值（情况1：目标方法有返回值；情况2：目标方法参数的定向tag为 out 或者 inout）。
需要注意的是，如果此方法返回false，那么客户端的请求会失败，因此我们可以利用这个特性来做权限验证。
5.Proxy#getBooks：
这个方法运行在客户端，执行过程为：
(1)创建该方法所需要的输入型Parcel对象_data、输出型Parcel对象_reply和返回值对象List，然后把该方法的参数信息写入_data中（如果有参数的话）；
(2)调用transact方法来发起RPC（远程过程调用）请求，同时当前线程挂起；
(3)服务端的onTransact方法会被调用，直到RPC过程返回后，当前线程继续执行，并从_reply中取出RPC过程的返回结果，返回_reply中的数据。
6.注意：
(1)当客户端发起远程请求时，由于当前线程会被挂起直至服务端进程返回数据，所以如果一个远程方法是很耗时的，那么不能在UI线程中发起此远程请求；
(2)由于服务端的Binder方法运行在Binder的线程池中，所以Binder方法不管是否耗时都应该采用同步的方式去实现，因为它已经运行在一个线程中了。

相关链接

Binder工作原理

最后编辑于 ：
©著作权归作者所有,转载或内容合作请联系作者
  • 人面猴
    序言：七十年代末，一起剥皮案震惊了整个滨河市，随后出现的几起案子，更是在滨河造成了极大的恐慌，老刑警刘岩，带你破解...
    沈念sama阅读 194,911评论 5赞 460
  • 死咒
    序言：滨河连续发生了三起死亡事件，死亡现场离奇诡异，居然都是意外死亡，警方通过查阅死者的电脑和手机，发现死者居然都...
    沈念sama阅读 82,014评论 2赞 371
  • 救了他两次的神仙让他今天三更去死
    文/潘晓璐 我一进店门，熙熙楼的掌柜王于贵愁眉苦脸地迎上来，“玉大人，你说我怎么就摊上这事。” “怎么了？”我有些...
    开封第一讲书人阅读 142,129评论 0赞 320
  • 道士缉凶录：失踪的卖姜人
    文/不坏的土叔 我叫张陵，是天一观的道长。 经常有香客问我，道长，这世上最难降的妖魔是什么？ 我笑而不...
    开封第一讲书人阅读 52,283评论 1赞 264
  • 港岛之恋（遗憾婚礼）
    正文 为了忘掉前任，我火速办了婚礼，结果婚礼上，老公的妹妹穿的比我还像新娘。我一直安慰自己，他们只是感情好，可当我...
    茶点故事阅读 61,159评论 4赞 357
  • 恶毒庶女顶嫁案：这布局不是一般人想出来的
    文/花漫 我一把揭开白布。 她就那样静静地躺着，像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上，一...
    开封第一讲书人阅读 46,161评论 1赞 272
  • 城市分裂传说
    那天，我揣着相机与录音，去河边找鬼。 笑死，一个胖子当着我的面吹牛，可吹牛的内容都是我干的。 我是一名探鬼主播，决...
    沈念sama阅读 36,565评论 3赞 382
  • 双鸳鸯连环套：你想象不到人心有多黑
    文/苍兰香墨 我猛地睁开眼，长吁一口气：“原来是场噩梦啊……” “哼！你这毒妇竟也来了？” 一声冷哼从身侧响起，我...
    开封第一讲书人阅读 35,251评论 0赞 253
  • 万荣杀人案实录
    序言：老挝万荣一对情侣失踪，失踪者是张志新（化名）和其女友刘颖，没想到半个月后，有当地人在树林里发现了一具尸体，经...
    沈念sama阅读 39,531评论 1赞 292
  • 护林员之死
    正文 独居荒郊野岭守林人离奇死亡，尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 34,619评论 2赞 310
  • 白月光启示录
    正文 我和宋清朗相恋三年，在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 36,383评论 1赞 326
  • 活死人
    序言：一个原本活蹦乱跳的男人离奇死亡，死状恐怖，灵堂内的尸体忽然破棺而出，到底是诈尸还是另有隐情，我是刑警宁泽，带...
    沈念sama阅读 32,255评论 3赞 313
  • 日本核电站爆炸内幕
    正文 年R本政府宣布，位于F岛的核电站，受9级特大地震影响，放射性物质发生泄漏。R本人自食恶果不足惜，却给世界环境...
    茶点故事阅读 37,624评论 3赞 299
  • 男人毒药：我在死后第九天来索命
    文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹，春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 28,916评论 0赞 17
  • 一桩弑父案，背后竟有这般阴谋
    文/苍兰香墨 我抬头看了看天上的太阳。三九已至，却和暖如春，着一层夹袄步出监牢的瞬间，已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 30,199评论 1赞 250
  • 情欲美人皮
    我被黑心中介骗来泰国打工， 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留，地道东北人。 一个月前我还...
    沈念sama阅读 41,553评论 2赞 342
  • 代替公主和亲
    正文 我出身青楼，却偏偏与公主长得像，于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子，可洞房花烛夜当晚...
    茶点故事阅读 40,756评论 2赞 335