Android AIDL原理

时间 2019-12-07

原文原文链接

前言

本文参考自Android开发艺术探索第二章，AIDL(Android接口定义语言)是Android提供的一种进程间通讯机制，咱们能够利用它定义客户端与服务端相互通讯都承认的编程接口。先来看看AIDL的用法，而后经过源码理解下AIDL生成的java类文件java

1、基本用法

下面我以一个简单的跨进程进行添加Book，查看BookList。这里使用两个App为例，首先编写一个Book类该类实现了Parcelable接口，代码以下android

public class Book implements Parcelable {

    public int bookId;
    public String bookName;

    private Book(Parcel in) {
        bookId = in.readInt();
        bookName = in.readString();
    }
    public Book(int id, String name) {
        bookId = id;
        bookName = name;
    }
    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.writeInt(bookId);
        dest.writeString(bookName);
    }
}
复制代码

而后在新建一个Book.aidl，IBookManager.aidl源码以下编程

// Book.aidl
parcelable Book;

// IBookManager.aidl
interface IBookManager {
    List<Book> getBookList();
    void addBook(in Book book);
}
复制代码

而后把Book.java、Book.aidl、IBookManager.aidl分别复制到client、server两个module，接着在server这个module里面新建一个BookService，再在清单文件中配置IntentFilter，代码以下数组

class BookService : Service() {

    // 因为addBook方法运行在Binder线程中并发调用可能会出问题所以使用CopyOnWriteArrayList
    private val mBookList = CopyOnWriteArrayList<Book>()

    override fun onBind(intent: Intent?): IBinder? {
        return object : IBookManager.Stub() {
            override fun registerListener(listener: IOnNewBookArrivedListener?) {
                // listener 为IOnNewBookArrivedListener.Stub.Proxy实例
                mListener.register(listener)
            }
            override fun unregisterListener(listener: IOnNewBookArrivedListener?) {
                mListener.unregister(listener)
            }
            override fun getBookList(): MutableList<Book> {
                return mBookList
            }
            override fun addBook(book: Book?) {
                mBookList.add(book)
            }
        }
    }
}
<service android:name=".BookService" android:exported="true" android:enabled="true">
    <intent-filter>
        <action android:name="com.hefuwei.testaidl.bookService" />
        <category android:name="android.intent.category.DEFAULT" />
    </intent-filter>
</service>
复制代码

最后在client这个module的MainActivity与BookService进行通讯，MainActivity代码以下，须要注意的是Intent得设置将要启动的应用程序的包名这里就是Server这个module的包名并发

// 这里不须要使用DeathRecipient由于onServiceConnected其实就是使用DeathRecipient实现的，二者
// 的区别是onServiceDisconnected运行在主线程中，而DeathRecipient.binderDied运行在Binder线程池中
class MainActivity : AppCompatActivity() {
    private lateinit var mListener: IOnNewBookArrivedListener
    private var mManager: IBookManager? = null
    private var mBookID = 0
    override fun onCreate(savedInstanceState: Bundle?) {
        super.onCreate(savedInstanceState)
        setContentView(R.layout.activity_main)
        mConnection = object : ServiceConnection {
            override fun onServiceDisconnected(name: ComponentName?) {
                mManager = null
            }
            override fun onServiceConnected(name: ComponentName?, service: IBinder?) {
                mManager = IBookManager.Stub.asInterface(service)
            }
        }
        val intent = Intent()
        intent.action = "com.hefuwei.aidl.BookService"
        intent.setPackage(packageName)
        bindService(intent, mConnection, Context.BIND_AUTO_CREATE)
    }
    fun addBook(v: View) {
        mManager?.addBook(Book(++mBookID, "第${mBookID}本书"))
    }
    fun allBooks(v: View) {
        Log.d("AIDL", mManager?.bookList?.toString())
    }
    override fun onDestroy() {
        super.onDestroy()
        unbindService(mConnection)
    }
}
复制代码

至此每当点击Client就能够与Server进行通讯了，来总结下用法ide

建立AIDL文件 IBookManager.aidl
将 IBookManager.aidl拷贝到Client和Server下
Server建立一个服务，在onBind的时候返回一个IBookManager.Stub的实例
Server的清单文件中配置该服务(IntentFilter)
Client经过建立Intent(须要设置Server的包名)调用bindService进行绑定
ServerConnection的onServiceConnected回调中调用IBookManager.Stub.asInterface拿到IBookManager.Stub.Proxy对象
调用IBookManager.Stub.Proxy的指定方法，便可完成与Server的通讯

接下来看看系统为咱们生成的IBookManager.java的源码源码分析

2、源码分析

生成的代码以下所示this

public interface IBookManager extends android.os.IInterface {
    public static abstract class Stub extends android.os.Binder implements com.hefuwei.testaidl.aidl.IBookManager {
        // 1
        private static final java.lang.String DESCRIPTOR = "com.hefuwei.testaidl.aidl.IBookManager";
        // 2
        public Stub() {
            this.attachInterface(this, DESCRIPTOR); 
        }
        // 3
        public static com.hefuwei.testaidl.aidl.IBookManager asInterface(android.os.IBinder obj) {
            if ((obj == null)) {
                return null;
            }
            android.os.IInterface iin = obj.queryLocalInterface(DESCRIPTOR);
            if (((iin != null) && (iin instanceof com.hefuwei.testaidl.aidl.IBookManager))) {
                return ((com.hefuwei.testaidl.aidl.IBookManager) iin);
            }
            return new com.hefuwei.testaidl.aidl.IBookManager.Stub.Proxy(obj);
        }

        @Override
        public android.os.IBinder asBinder() {
            return this;
        }
        // 6
        @Override
        public boolean onTransact(int code, android.os.Parcel data, android.os.Parcel reply, int flags) throws android.os.RemoteException {
            java.lang.String descriptor = DESCRIPTOR;
            switch (code) {
                case INTERFACE_TRANSACTION: {
                    reply.writeString(descriptor);
                    return true;
                }
                case TRANSACTION_getBookList: {
                    data.enforceInterface(descriptor);
                    java.util.List<com.hefuwei.testaidl.aidl.Book> _result = this.getBookList();
                    reply.writeNoException();
                    reply.writeTypedList(_result);
                    return true;
                }
                case TRANSACTION_addBook: {
                    data.enforceInterface(descriptor);
                    com.hefuwei.testaidl.aidl.Book _arg0;
                    if ((0 != data.readInt())) {
                        _arg0 = com.hefuwei.testaidl.aidl.Book.CREATOR.createFromParcel(data);
                    } else {
                        _arg0 = null;
                    }
                    this.addBook(_arg0);
                    reply.writeNoException();
                    return true;
                }
                default: {
                    return super.onTransact(code, data, reply, flags);
                }
            }
        }

        private static class Proxy implements com.hefuwei.testaidl.aidl.IBookManager {
            private android.os.IBinder mRemote;

            Proxy(android.os.IBinder remote) {
                mRemote = remote;
            }

            @Override
            public android.os.IBinder asBinder() {
                return mRemote;
            }

            public java.lang.String getInterfaceDescriptor() {
                return DESCRIPTOR;
            }

            @Override
            public java.util.List<com.hefuwei.testaidl.aidl.Book> getBookList() throws android.os.RemoteException {
                android.os.Parcel _data = android.os.Parcel.obtain();
                android.os.Parcel _reply = android.os.Parcel.obtain();
                java.util.List<com.hefuwei.testaidl.aidl.Book> _result;
                try {
                    _data.writeInterfaceToken(DESCRIPTOR);
                    mRemote.transact(Stub.TRANSACTION_getBookList, _data, _reply, 0);
                    _reply.readException();
                    _result = _reply.createTypedArrayList(com.hefuwei.testaidl.aidl.Book.CREATOR);
                } finally {
                    _reply.recycle();
                    _data.recycle();
                }
                return _result;
            }
            // 4
            @Override
            public void addBook(com.hefuwei.testaidl.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.writeToParcel(_data, 0);
                    } else {
                        _data.writeInt(0);
                    }
                    mRemote.transact(Stub.TRANSACTION_addBook, _data, _reply, 0);
                    _reply.readException();
                } finally {
                    _reply.recycle();
                    _data.recycle();
                }
            }
        }
        // 7
        static final int TRANSACTION_getBookList = (android.os.IBinder.FIRST_CALL_TRANSACTION + 0);
        static final int TRANSACTION_addBook = (android.os.IBinder.FIRST_CALL_TRANSACTION + 1);
    }

    public java.util.List<com.hefuwei.testaidl.aidl.Book> getBookList() throws android.os.RemoteException;
    public void addBook(com.hefuwei.testaidl.aidl.Book book) throws android.os.RemoteException;
}
复制代码

重点代码解释以下spa

描述符，该值为IBookManager的全类名
根据AIDL的使用流程，Server会在onBind的时候返回一个IBookManager.Stub实例，调用了Stub的构造器内部调用Binder的attachInterface方法将当前实例以及描述符存到Binder实例中
Client在onServiceConnect回调中会调用IBookManager.asInterface，该方法内部调用queryLocalInterface若是该方法返回不为null，那么就能证实Server和Client属于同一个进程，那么就直接强转，否则就返回一个IBookManager.Stub.Proxy对象
Client调用asInterface方法后拿到了一个IBookManager.Stub.Proxy实例，而后会调用addBook方法，若是相同进程会直接调用，不一样进程就会调用到注释5处
先获取两个Parcel实例一个用于存储参数另外一个存储返回值(Parcel内部维护了一个Parcel数组，数组中有元素时会取数组中的没有会建立一个)，而后在_data中先写入当前的描述符，接着若是book不为null在_data中写入1和book其中1表示数据为一个，若是为null就写入0表示没有数据，而后调用transact方法将_data、_reply传入，该方法会挂起当前的线程(若是方法没有被设置为oneWay)，而后系统会在Binder线程池中调用Server端对应的Binder实例的onTransact方法，也就是注释6的地方
方法内部从data这个Parcel实例中读取一个int，若是为0那么表示没有参数直接调用Server端实现类的addBook将null传入，若是不是0就根据data建立一个Book实例，而后调用addBook将建立的实例传入，而后调用reply.writeNoExceptio指明没有异常发生，因为addBook没有返回值全部就直接结束了。getBookList其实流程也差很少就不解释了
常量，用来标志调用的是哪一个方法

3、注册监听

上面只说到了客户端调用服务端的方法，可是假设客户端想要监听服务端书籍数量的变化，一种作法是一直不停的轮询去请求，另外一种作法是使用观察者模式注册监听，这里讲讲怎么注册观察者，首先建立IOnNewBookArrivedListener.aidl文件，代码以下线程

interface IOnNewBookArrivedListener {
    void onBookArrived(in Book book);
}
复制代码

而后修改下IBookManager.aidl添加注册和解除注册两个方法

interface IBookManager {
    List<Book> getBookList();
    void addBook(in Book book);
    void registerListener(IOnNewBookArrivedListener listener);
    void unregisterListener(IOnNewBookArrivedListener listener);
}
复制代码

接着将这两个aidl文件同步给Server和Client，而后修改Client的MainActivity的代码

class MainActivity : AppCompatActivity() {
    private lateinit var mConnection: ServiceConnection
    private lateinit var mListener: IOnNewBookArrivedListener
    private var mManager: IBookManager? = null
    private var mBookID = 0
    override fun onCreate(savedInstanceState: Bundle?) {
        super.onCreate(savedInstanceState)
        setContentView(R.layout.activity_main)
        mConnection = object : ServiceConnection {
            override fun onServiceDisconnected(name: ComponentName?) {
                mManager = null
            }
            override fun onServiceConnected(name: ComponentName?, service: IBinder?) {
                mManager = IBookManager.Stub.asInterface(service)
            }
        }
        mListener = object : IOnNewBookArrivedListener.Stub() {
            override fun onBookArrived(book: Book?) {
                // 运行在客户端的Binder线程池中
                runOnUiThread {
                    Toast.makeText(this@MainActivity, "${book?.id}", Toast.LENGTH_SHORT).show()
                }
            }
        }
        val intent = Intent()
        intent.action = "com.hefuwei.aidl.BookService"
        intent.setPackage(packageName)
        bindService(intent, mConnection, Context.BIND_AUTO_CREATE)
    }
    fun addBook(v: View) {
        mManager?.addBook(Book(++mBookID, "第${mBookID}本书"))
    }
    fun allBooks(v: View) {
        Log.d("AIDL", mManager?.bookList?.toString())
    }
    fun register(v: View) {
        mManager?.registerListener(mListener)
        Toast.makeText(this, "注册", Toast.LENGTH_SHORT).show()
    }
    fun unregister(v: View) {
        mManager?.unregisterListener(mListener)
        Toast.makeText(this, "解除注册", Toast.LENGTH_SHORT).show()
    }
    override fun onDestroy() {
        super.onDestroy()
        unbindService(mConnection)
    }
}
复制代码

最后修改下服务端的BookService代码

class BookService : Service() {
    private val mBookList = CopyOnWriteArrayList<Book>()
    private val mListener = RemoteCallbackList<IOnNewBookArrivedListener>()
    override fun onBind(intent: Intent?): IBinder? {
        return object : IBookManager.Stub() {
            override fun registerListener(listener: IOnNewBookArrivedListener?) {
                // listener 为IOnNewBookArrivedListener.Stub.Proxy实例
                mListener.register(listener)
            }
            override fun unregisterListener(listener: IOnNewBookArrivedListener?) {
                mListener.unregister(listener)
            }
            override fun getBookList(): MutableList<Book> {
                return mBookList
            }
            override fun addBook(book: Book?) {
                mBookList.add(book)
            }
        }
    }
    override fun onCreate() {
        super.onCreate()
        Executors.newScheduledThreadPool(1).scheduleWithFixedDelay({
            val n = mListener.beginBroadcast()
            for (i in 0 until n) {
                mListener.getBroadcastItem(i).onBookArrived(Book(12, "12书"))
            }
            mListener.finishBroadcast()
        }, 0, 3, TimeUnit.SECONDS)
    }
}
复制代码

注意这里须要使用RemoteCallbackList来存储listener，由于registerListener的入参是一个IOnNewBookArrivedListener.Stub.Proxy对象，每次IPC都会建立一个新的对象，这样就无法解除注册了。RemoteCallbackList内部维护了一个Key为Binder实例的Map，虽然每次会建立一个新的Proxy对象，可是这个Proxy对象的mRemote成员一直是同一个所以能够进行区分。而当服务端的数据发送变化后就能够从RemoteCallbackList取出Proxy对象调用客户端的方法

注意：若是经过AIDL传递一个Binder对象会先调用Parcel.writeStrongBinder将Binder写入，而后在目标线程取出时会调用Parcel.readStrongBinder将Binder读出，若是写入端和读出端位于两个进程，读取到的时候会是一个BinderProxy对象而不是原先的Binder对象

1. AIDL原理分析
2. AIDL通讯原理
3. AIDL原理解析
4. 借助 AIDL 理解 Android Binder 机制——AIDL 的使用和原理分析
5. Android AIDL
6. 换个角度理解Android的AIDL原理
7. AIDL使用及原理浅析
8. Android AIDL进阶
9. android service & AIDL
10. Android IPC之AIDL
更多相关文章...
• MyBatis的工作原理 - MyBatis教程
• BASE原理与最终一致性 - NoSQL教程
• ☆技术问答集锦（13）Java Instrument原理
• Java Agent入门实战（三）-JVM Attach原理与使用