Binder实现了IBinder接口,通常我们不会直接去实现Binder,而是通过aidl工具来定义接口,自动生成相应的Binder的子类。
从Android Framework角度来说,Binder是ServiceManager连接各种Manager(ActivityManager,WindowManager,等等)和相应ManagerService的桥梁。
从Android应用层来说,Binder是客户端和服务端进行通信的媒介,通过bindService,服务端会返回一个Binder对象。同过这个Binder对象,客户端就可以获取服务端提供的服务或数据。
我们通过一个简单的AIDL示例来学习Binder的使用。
AIDL示例:
目录结构
Book.java:
package com.weijie.aidlapplication.aidl;
import android.os.Parcel;
import android.os.Parcelable;
/**
* Created by weijie on 17-3-8.
*/
public class Book implements Parcelable {
public int bookId;
public String bookName;
@Override
public int describeContents() {
return 0;
}
@Override
public void writeToParcel(Parcel dest, int flags) {
dest.writeInt(this.bookId);
dest.writeString(this.bookName);
}
public Book(int bookId, String bookName) {
this.bookId = bookId;
this.bookName = bookName;
}
protected Book(Parcel in) {
this.bookId = in.readInt();
this.bookName = in.readString();
}
public static final Parcelable.Creator<Book> CREATOR = new Parcelable.Creator<Book>() {
@Override
public Book createFromParcel(Parcel source) {
return new Book(source);
}
@Override
public Book[] newArray(int size) {
return new Book[size];
}
};
}
Book.aidl:
package com.weijie.aidlapplication.aidl;
parcelable Book;
IBookManager.aidl
// IBookManager.aidl
package com.weijie.aidlapplication.aidl;
// Declare any non-default types here with import statements
import com.weijie.aidlapplication.aidl.Book;
interface IBookManager {
List<Book> getBookList();
void addBook(in Book book);
}
注意:
1. Android Studio中,新建AIDL文件:File->New->AIDL
2. Book.aidl和IBookManager.aidl位于相同的包中,但是在IBookManager中仍然要导入Book类。
IBookManager.java
/*
* This file is auto-generated. DO NOT MODIFY.
* Original file: /home/weijie/AndroidStudioProjects/AidlApplication/app/src/main/aidl/com/weijie/aidlapplication/aidl/IBookManager.aidl
*/
package com.weijie.aidlapplication.aidl;
public interface IBookManager extends android.os.IInterface
{
/** Local-side IPC implementation stub class. */
public static abstract class Stub extends android.os.Binder implements com.weijie.aidlapplication.aidl.IBookManager
{
private static final java.lang.String DESCRIPTOR = "com.weijie.aidlapplication.aidl.IBookManager";
/** Construct the stub at attach it to the interface. */
public Stub()
{
this.attachInterface(this, DESCRIPTOR);
}
/**
* Cast an IBinder object into an com.weijie.aidlapplication.aidl.IBookManager interface,
* generating a proxy if needed.
*/
public static com.weijie.aidlapplication.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.weijie.aidlapplication.aidl.IBookManager))) {
return ((com.weijie.aidlapplication.aidl.IBookManager)iin);
}
return new com.weijie.aidlapplication.aidl.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
{
switch (code)
{
case INTERFACE_TRANSACTION:
{
reply.writeString(DESCRIPTOR);
return true;
}
case TRANSACTION_getBookList:
{
data.enforceInterface(DESCRIPTOR);
java.util.List<com.weijie.aidlapplication.aidl.Book> _result = this.getBookList();
reply.writeNoException();
reply.writeTypedList(_result);
return true;
}
case TRANSACTION_addBook:
{
data.enforceInterface(DESCRIPTOR);
com.weijie.aidlapplication.aidl.Book _arg0;
if ((0!=data.readInt())) {
_arg0 = com.weijie.aidlapplication.aidl.Book.CREATOR.createFromParcel(data);
}
else {
_arg0 = null;
}
this.addBook(_arg0);
reply.writeNoException();
return true;
}
}
return super.onTransact(code, data, reply, flags);
}
private static class Proxy implements com.weijie.aidlapplication.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.weijie.aidlapplication.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.weijie.aidlapplication.aidl.Book> _result;
try {
_data.writeInterfaceToken(DESCRIPTOR);
mRemote.transact(Stub.TRANSACTION_getBookList, _data, _reply, 0);
_reply.readException();
_result = _reply.createTypedArrayList(com.weijie.aidlapplication.aidl.Book.CREATOR);
}
finally {
_reply.recycle();
_data.recycle();
}
return _result;
}
@Override public void addBook(com.weijie.aidlapplication.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();
}
}
}
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.weijie.aidlapplication.aidl.Book> getBookList() throws android.os.RemoteException;
public void addBook(com.weijie.aidlapplication.aidl.Book book) throws android.os.RemoteException;
}
IBookManager这个类是系统自动生成的,AS中点击”Make Project”即可生成。
IBookManager继承了IInterface接口,同时本身也是一个接口。
所有可以在Binder中传输的接口都需要继承IInterface接口。
IBookManager包括:
声明了getBookList和addBook两个方法
声明了两个整型的id分别用于标识这两个方法
声明了一个内部类Stub,这个Stub就是一个Binder类。当客户端和服务端位于不同进程时,方法需要走transact过程,这个逻辑由Stub的内部代理类Proxy完成。
DESCRIPTOR
Binder的唯一标示,一般用当前Binder的类名表示。
asInterface(android.os.IBinder obj)
用于将服务端的Binder对象转换成客户端所需的AIDL接口类型的对象。
这种转换是区分进程的,如果客户端和服务端位于同一进程,那么返回的是服务端的Stub对象本身,否则返回的是系统封装后的Stub.proxy对象。
我们来看这个示例:
public class LocalService extends Service {
public class LocalBinder extends Binder {
LocalService getService() {
return LocalService.this;
}
}
@Override
public IBinder onBind(Intent intent) {
return mBinder;
}
private final IBinder mBinder = new LocalBinder();
}
public void onServiceConnected(ComponentName name, IBinder service) {
// 1. 同一进程
mIMyService = ((LocalBinder.LocalBinder)service).getService;
// 2. 同一进程或不同进程
mIMyService = IMyService.Stub.asInterface(service);
}
当客户端和服务端在同一个进程时,可以直接将IBinder接口转型为本地自定义Binder,然后通过自定义Binder的getService方法拿到IMyService接口实例。
asInterface的方法适用性更广,如果客户端和服务端位于同一进程,那么返回的是服务端的Stub对象本身,否则返回的是系统封装后的Stub.proxy对象。推荐使用这一种方法。
asBinder
返回当前的Binder对象
onTransact(int code, android.os.Parcel data, android.os.Parcel reply,int flags)
这个方法运行在服务端的Binder线程池中,当客户端发起跨进程请求时,调用该方法。
服务端通过code判断客户端请求的方法,接着从data中取出目标方法所需的参数(if have),然后执行目标方法。
当目标方法执行完毕后,就向reply中写入返回值(if have)。
如果此方法返回false,那么客户端的请求会失败。
Proxy#getBookList
这个方法运行在客户端,它的内部实现是这样的:
Start
创建输入型Parcel对象_data
创建输出型Parcel对象_reply
创建返回值对象List
写入_data
调用transact方法发起RPC(远程过程调用),同时当前线程挂起
调用服务端的onTransact方法直到RPC过程返回后,当前线程继续执行
从_reply中取数据
End
Proxy#addBook
这个方法的执行过程和getBookList是一样的,addBook没有返回值,所以它不需要从_reply中取出返回值。
注意:
当客户端发起远程请求时,由于当前线程会被挂起直至服务端进程返回数据,所以如果一个远程方法是很耗时的,那么不能在UI线程中发起此远程请求。
由于服务端的Binder方法运行在Binder的线程池中,所以Binder方法不管是否耗时都应该采用同步的方式去实现。
AIDL支持的数据类型:
基本数据类型(int,long,char,boolean,double)
String和CharSequence
List:只支持ArrayList,里面每个元素都必须被AIDL支持
Map:只支持HashMap,里面的每个元素都必须被AIDL支持,包括key和value
Parcelabel:所有实现了Parcelable接口的对象,必须显示import进来
AIDL:必须显示import进来
如果AIDL文件中用到了自定义的Parcelable对象,那么必须新建一个和它同名的AIDL文件,并在其中声明它为Parcelable类型,如上面的Book.aidl。
AIDL中除了基本数据类型,其它类型的参数必须标上方向:in,out或者inout。
AIDL接口中只支持方法,不支持声明静态常量,这一点区别于传统的接口。
BookManagerService.java
public class BookManagerService extends Service {
private static final String TAG = "BMS";
// CopyOnWriteArrayList支持并发读/写,自动进行线程同步
private CopyOnWriteArrayList<Book> mBookList = new CopyOnWriteArrayList<Book>();
private Binder mBinder = new IBookManager.Stub() {
@Override
public List<Book> getBookList() throws RemoteException {
return mBookList;
}
@Override
public void addBook(Book book) throws RemoteException {
mBookList.add(book);
}
};
public BookManagerService() {
}
@Override
public void onCreate() {
super.onCreate();
mBookList.add(new Book(1, "Android"));
mBookList.add(new Book(2, "Ios"));
}
@Override
public IBinder onBind(Intent intent) {
// TODO: Return the communication channel to the service.
return mBinder;
}
}
虽然服务端返回的是CopyOnWriteArrayList,但是在Binder中会按照List的规范去访问数据并最终形成一个新的ArrayList传递给客户端。
AndroidManifest.xml
注册BookManagerService
<service
android:name=".aidl.BookManagerService"
android:enabled="true"
android:process=":remote"
android:exported="true"></service>
客户端实现
public class MainActivity extends AppCompatActivity {
public static final String TAG = "weijie";
private ServiceConnection mConnection = new ServiceConnection() {
@Override
public void onServiceConnected(ComponentName name, IBinder service) {
IBookManager bookManager = IBookManager.Stub.asInterface(service);
List<Book> list = bookManager.getBookList();
Log.d(TAG, "onServiceConnected: query book list, list type: " + list.getClass().getCanonicalName());
Log.d(TAG, "onServiceConnected: query book list: " + list.toString());
Book newBook = new Book(3, "Android 开发艺术探索");
Log.d(TAG, "onServiceConnected: add book: " + newBook);
bookManager.addBook(newBook);
List<Book> newList = bookManager.getBookList();
Log.d(TAG, "onServiceConnected: query book list: " + newList.toString());
} catch (RemoteException e) {
e.printStackTrace();
}
}
@Override
public void onServiceDisconnected(ComponentName name) {
}
};
@Override
protected void onCreate(Bundle savedInstanceState) {
super.onCreate(savedInstanceState);
setContentView(R.layout.activity_main);
Toolbar toolbar = (Toolbar) findViewById(R.id.toolbar);
setSupportActionBar(toolbar);
Intent intent = new Intent(this, BookManagerService.class);
bindService(intent, mConnection, Context.BIND_AUTO_CREATE);
}
@Override
protected void onDestroy() {
super.onDestroy();
unbindService(mConnection);
}
}
输出结果
01-02 09:47:15.101 5504 5504 D weijie : onServiceConnected: query book list, list type: java.util.ArrayList
01-02 09:47:15.102 5504 5504 D weijie : onServiceConnected: query book list: [Id = 1, Name = Android, Id = 2, Name = Ios]
01-02 09:47:15.102 5504 5504 D weijie : onServiceConnected: add book: Id = 3, Name = Android 开发艺术探索
01-02 09:47:15.105 5504 5504 D weijie : onServiceConnected: query book list: [Id = 1, Name = Android,
---------------------
来源:oschina
链接:https://my.oschina.net/u/920274/blog/3058585