Binder主要用于Service中,包括AIDL和Messenger,其中普通Service中的Binder不涉及进程间通信,所以较为简单,无法触及Binder的核心,而Messenger的底层其实是AIDL,所以这儿选择用AIDL来分析Binder的工作原理
思维导图
一、AIDL的生成
//Book.java
package com.aidl.aidltest;
import android.os.Parcel;
import android.os.Parcelable;
public class Book implements Parcelable {
public int bookId;
public String bookName;
public Book(int bookId, String bookName){
this.bookId = bookId;
this.bookName = bookName;
}
public int describeContents(){
return 0;
}
public void writeToParcel(Parcel out, int flags){
out.writeInt(bookId);
out.writeString(bookName);
}
public static final Parcelable.Creator<Book> CREATOR = new Parcelable.Creator<Book>(){
public Book createFromParcel(Parcel in){
return new Book(in);
}
public Book[] newArray(int size){
return new Book[size];
}
};
private Book(Parcel in){
bookId = in.readInt();
bookName = in.readString();
}
@Override
public String toString(){
return "[bookId = " + bookId + ", bookName = " + bookName + "]";
}
}
// Book.aidl
package com.aidl.aidltest;
parcelable Book;
// IBookManager.aidl
package com.aidl.aidltest;
import com.aidl.aidltest.Book;
interface IBookManager {
List<Book> getBookList();
void addBook(in Book book);
} 完成上述操作后,通过点击clean Project,再点击Rebuild Project即可自动生成IBookManager.java 文件(Android Studio版本不同,可能步骤不一样)
二、自动生成的IBookManager.java
/*
* This file is auto-generated. DO NOT MODIFY.
*/
package com.aidl.aidltest;
public interface IBookManager extends android.os.IInterface
{
/** Default implementation for IBookManager. */
public static class Default implements com.aidl.aidltest.IBookManager
{
@Override public java.util.List<com.aidl.aidltest.Book> getBookList()
throws android.os.RemoteException
{
return null;
}
@Override public void addBook(com.aidl.aidltest.Book book) throws android.os.RemoteException
{
}
@Override
public android.os.IBinder asBinder() {
return null;
}
}
/** Local-side IPC implementation stub class. */
public static abstract class Stub extends android.os.Binder implements com.aidl.aidltest.IBookManager
{
private static final java.lang.String DESCRIPTOR = "com.aidl.aidltest.IBookManager";
/** Construct the stub at attach it to the interface. */
public Stub()
{
this.attachInterface(this, DESCRIPTOR);
}
/**
* Cast an IBinder object into an com.aidl.aidltest.IBookManager interface,
* generating a proxy if needed.
*/
public static com.aidl.aidltest.IBookManager asInterface(android.os.IBinder obj)
{
if ((obj==null)) {
return null;
}
android.os.IInterface iin = obj.queryLocalInterface(DESCRIPTOR);
if (((iin!=null)&&(iin instanceof com.aidl.aidltest.IBookManager))) {
return ((com.aidl.aidltest.IBookManager)iin);
}
return new com.aidl.aidltest.IBookManager.Stub.Proxy(obj);
}
@Override public android.os.IBinder asBinder()
{
return this;
}
@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.aidl.aidltest.Book> _result = this.getBookList();
reply.writeNoException();
reply.writeTypedList(_result);
return true;
}
case TRANSACTION_addBook:
{
data.enforceInterface(descriptor);
com.aidl.aidltest.Book _arg0;
if ((0!=data.readInt())) {
_arg0 = com.aidl.aidltest.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.aidl.aidltest.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.aidl.aidltest.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.aidl.aidltest.Book> _result;
try {
_data.writeInterfaceToken(DESCRIPTOR);
boolean _status = mRemote.transact(Stub.TRANSACTION_getBookList, _data, _reply, 0);
if (!_status && getDefaultImpl() != null) {
return getDefaultImpl().getBookList();
}
_reply.readException();
_result = _reply.createTypedArrayList(com.aidl.aidltest.Book.CREATOR);
}
finally {
_reply.recycle();
_data.recycle();
}
return _result;
}
@Override public void addBook(com.aidl.aidltest.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);
}
boolean _status = mRemote.transact(Stub.TRANSACTION_addBook, _data, _reply, 0);
if (!_status && getDefaultImpl() != null) {
getDefaultImpl().addBook(book);
return;
}
_reply.readException();
}
finally {
_reply.recycle();
_data.recycle();
}
}
public static com.aidl.aidltest.IBookManager sDefaultImpl;
}
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 static boolean setDefaultImpl(com.aidl.aidltest.IBookManager impl) {
if (Stub.Proxy.sDefaultImpl == null && impl != null) {
Stub.Proxy.sDefaultImpl = impl;
return true;
}
return false;
}
public static com.aidl.aidltest.IBookManager getDefaultImpl() {
return Stub.Proxy.sDefaultImpl;
}
}
public java.util.List<com.aidl.aidltest.Book> getBookList() throws android.os.RemoteException;
public void addBook(com.aidl.aidltest.Book book) throws android.os.RemoteException;
}
三、具体分析
IBookManager.java类,继承IInterface接口。通过这个类我们可以清楚地了解到Binder的工作机制。
- 首先,它声明了两个方法
getBookList()和addBook(),显然这就是我们在IBookManager.aidl中所声明的方法。
public java.util.List<com.aidl.aidltest.Book> getBookList() throws android.os.RemoteException;
public void addBook(com.aidl.aidltest.Book book) throws android.os.RemoteException;
- 同时它还声明了两个整型的id(
TRANSACTION_getBookList和TRANSACTION_addBook)分别用于标识这两个方法,这两个id用于标识在transact过程中客户端所请求的到底是哪个方法。
static final int TRANSACTION_getBookList = (android.os.IBinder.FIRST_CALL_TRANSACTION + 0);
static final int TRANSACTION_addBook = (android.os.IBinder.FIRST_CALL_TRANSACTION + 1);
- 接着它声明了一个
内部类Stub,这个Stub就是一个Binder类,当客户端和服务端都位于同一个进程时,方法调用不会走跨进程的transact过程,而当两者位于不同进程时,方法调用需要走transact过程,这个逻辑是由Stub的内部代理类Proxy来完成。
public static abstract class Stub extends android.os.Binder
implements com.aidl.aidltest.IBookManager
{
......
private static class Proxy implements com.aidl.aidltest.IBookManager
{
......
}
1、DESCRIPTOR
Binder的唯一标识,一般用当前Binder的类名表示,比如本例汇总的“com.aidl.aidltest.IBookManager”
private static final java.lang.String DESCRIPTOR = "com.aidl.aidltest.IBookManager";
2、asInterface(android.os.IBinder obj)
用于将服务器的Binder对象转换成客户端所需的AIDL接口类型的对象,这种转换过程时区别进程的,如果客户端和服务器位于同一进程,那么此方法返回的就是服务端的Stub对象本身,否则返回的就是系统封装后的Stub.proxy对象。
/**
* Cast an IBinder object into an com.aidl.aidltest.IBookManager interface,
* generating a proxy if needed.
*/
public static com.aidl.aidltest.IBookManager asInterface(android.os.IBinder obj)
{
if ((obj==null)) {
return null;
}
android.os.IInterface iin = obj.queryLocalInterface(DESCRIPTOR);
if (((iin!=null)&&(iin instanceof com.aidl.aidltest.IBookManager))) {
return ((com.aidl.aidltest.IBookManager)iin);
}
return new com.aidl.aidltest.IBookManager.Stub.Proxy(obj);
}
3、asBinder()
此方法用于返回当前Binder对象
@Override public android.os.IBinder asBinder()
{
return this;
}
4、onTransact()
这个方法运行在服务端中的Binder线程池中,当客户端发起跨进程请求时,远程请求会通过系统底层封装后交由该方法来处理。该方法的原型是public Boolean onTransact (int code, android.os.Parcel data, android.os.Parcel reply, int flags)。服务端通过code可以确定客户端所请求的目标方法是什么,接着从data中取出目标方法所需的参数,然后执行目标方法。当目标方法执行完毕后,就向reply中写入返回值(如果目标方法有返回值的话),并返回true。
@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 TRANSACTION_getBookList:
{
data.enforceInterface(descriptor);
java.util.List<com.aidl.aidltest.Book> _result = this.getBookList();
reply.writeNoException();
reply.writeTypedList(_result);
return true;
}
case TRANSACTION_addBook:
{
data.enforceInterface(descriptor);
com.aidl.aidltest.Book _arg0;
if ((0!=data.readInt())) {
_arg0 = com.aidl.aidltest.Book.CREATOR.createFromParcel(data);
}
else {
_arg0 = null;
}
this.addBook(_arg0);
reply.writeNoException();
return true;
}
default:
{
return super.onTransact(code, data, reply, flags);
}
}
}
注意:如果此方法返回false,那么客户端的请求会失败,因此我们可以利用这个特性来做权限验证,毕竟我们也不希望随便一个进程都能远程调用我们的服务。
5、Proxy#getBookList()
@Override public java.util.List<com.aidl.aidltest.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.aidl.aidltest.Book> _result;
try {
_data.writeInterfaceToken(DESCRIPTOR);
boolean _status = mRemote.transact(Stub.TRANSACTION_getBookList, _data, _reply, 0);
if (!_status && getDefaultImpl() != null) {
return getDefaultImpl().getBookList();
}
_reply.readException();
_result = _reply.createTypedArrayList(com.aidl.aidltest.Book.CREATOR);
}
finally {
_reply.recycle();
_data.recycle();
}
return _result;
}
这个方法运行在客户端,当客户端远程调用此方法时,它的内部实现是这样的:
- 首先创建该方法所需要的输入型
Parcel对象_data、输出型Parcel对象_reply和返回值对象List; - 然后把该方法的参数信息写入
_data中(如果有参数的话); - 接着调用
transact()方法来发起RPC(远程过程调用)请求,同时当前线程挂起; - 然后服务端的
onTransact()方法会被调用,直到RPC过程返回后,当前线程继续执行,并从_reply中取出RPC过程的返回结果; - 最后返回
_reply中的数据。
6、Proxy#addBook()
这个方法运行在客户端,它的执行过程和getBookList()是一样的,addBook()没有返回值,所以它不需要从_reply中取出返回值。
@Override
public void addBook(com.aidl.aidltest.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);
}
boolean _status = mRemote.transact(Stub.TRANSACTION_addBook, _data, _reply, 0);
if (!_status && getDefaultImpl() != null) {
getDefaultImpl().addBook(book);
return;
}
_reply.readException();
}
finally {
_reply.recycle();
_data.recycle();
}
}注意:
- 当客户端发起远程请求时,由于当前线程会被挂起直到服务端进程返回数据,所以如果一个远程方法时很耗时的,那么不能再UI线程中发起此远程请求;
- 由于服务端的Binder()方法运行在Binder线程池中,所以Binder()方法不管是否耗时都应该采用同步的方法去实现,因为它已经运行在一个线程中。
四、手动实现一个Binder
- 声明一个AIDL性质的接口,只需要继承IInterface接口即可,IInterface接口中只有一个asBinder()方法。这个接口的实现如下:
public interface IBookManager_ extends IInterface {
static final String DESCRIPTOR = "com.aidl.aidltest.IBookManager_";
static final int TRANSACTION_getBookList = IBinder.FIRST_CALL_TRANSACTION + 0;
static final int TRANSACTION_addBook = IBinder.FIRST_CALL_TRANSACTION + 1;
public List<Book> getBookLst() throws RemoteException;
public void addBook(Book book) throws RemoteException;
}
可以看出,在接口中声明了一个Binder描述符和另外两个id,这两个id分别表示的是getBookList()和addBook()方法,这段代码原来也是系统生成的,我们仿照系统生成的规则去手动书写这部分代码。
如果我们有三个方法,应该怎么做呢?很显然,我们要再声明一个id,然后按照固定模式声明这个新方法即可。
- 实现Stub类和Stub类中的Proxy代理类,这段diamante我们可以自己写,但是写出来会发现和系统自动生成的代码是一样的,因此这个Stub类我们只需要参考系统生成的代码即可,只是结构上做一下调整,调整后的代码如下:
public class BookManagerImpl extends Binder implements IBookManager_ {
/** Construct the stub at attach it to the interface */
public BookManagerImpl(){
this.attachInterface(this, DESCRIPTOR);
}
/**
* Cast an IBinder object into an IBookManager interface, generating a proxy
* if needed.
*/
public static IBookManager_ asInterface(IBinder obj){
if(obj == null){
return null;
}
android.os.IInterface iin = obj.queryLocalInterface(DESCRIPTOR);
if((iin != null) && (iin instanceof IBookManager_)){
return (IBookManager_)iin;
}
return new BookManagerImpl.Proxy(obj);
}
@Override
public IBinder asBinder(){
return this;
}
@Override
public boolean onTransact(int code, Parcel data, Parcel reply, int flags) throws RemoteException{
switch (code){
case INTERFACE_TRANSACTION:{
reply.writeString(DESCRIPTOR);
return true;
}
case TRANSACTION_getBookList:{
data.enforceInterface(DESCRIPTOR);
List<Book> result = this.getBookList();
reply.writeNoException();
reply.writeTypedList(result);
return true;
}
case TRANSACTION_addBook:{
data.enforceInterface(DESCRIPTOR);
Book arg0;
if(0 != data.readInt()){
arg0 = Book.CREATOR.createFromParcel(data);
}else {
arg0 = null;
}
this.addBook(arg0);
reply.writeNoException();
return true;
}
}
return super.onTransact(code, data, reply, flags);
}
@Override
public List<Book> getBookList() throws RemoteException{
//TODO 待实现
return null;
}
@Override
public void addBook(Book book) throws RemoteException{
//TODO 待实现
}
private static class Proxy implements IBookManager_{
private IBinder mRemote;
Proxy(IBinder remote){
mRemote = remote;
}
@Override
public IBinder asBinder(){
return mRemote;
}
public java.lang.String getInterfaceDescriptor(){
return DESCRIPTOR;
}
@Override
public List<Book> getBookList() throws RemoteException{
Parcel data = Parcel.obtain();
Parcel reply = Parcel.obtain();
List<Book> result;
try{
data.writeInterfaceToken(DESCRIPTOR);
mRemote.transact(TRANSACTION_getBookList, data, reply, 0);
reply.readException();
result = reply.createTypedArrayList(Book.CREATOR);
}finally {
reply.recycle();
data.recycle();
}
return result;
}
@Override
public void addBook(Book book) throws RemoteException{
Parcel data = Parcel.obtain();
Parcel reply = Parcel.obtain();
try{
data.writeInterfaceToken(DESCRIPTOR);
if(book != null){
data.writeInt(1);
book.writeToParcel(data, 0);
} else{
data.writeInt(0);
}
mRemote.transact(TRANSACTION_addBook, data, reply, 0);
}finally {
reply.recycle();
data.recycle();
}
}
}
}
注意:
手动实现的Binder机制,没有写Stub类,而是将Stub类单独分离出来,即上面的BookManagerImpl类。
手动实现Binder的过程可以让我们更加理解Binder的工作原理,同时也提供了一种不通过AIDL来实现Binder的新方式。
对应的demo:源程序
本文内容来源于:任玉刚的《Android开发艺术探索》