AIDL-Android接口描述语言实现跨进程通讯
在Android中, 每个应用程序都可以有自己的进程. 在写UI应用的时候, 经常要用到Service. 在不同的进程中, 怎样传递对象呢? 显然, Java中不允许跨进程内存共享. 因此传递对象, 只能把对象拆分成操作系统能理解的简单形式, 以达到跨界对象访问的目的. 在J2EE中,采用RMI的方式, 可以通过序列化传递对象. 在Android中, 则采用AIDL的方式. 理论上AIDL可以传递Bundle,实际上做起来却比较麻烦.
AIDL(AndRoid接口描述语言)是一种借口描述语言; 编译器可以通过aidl文件生成一段代码,通过预先定义的接口达到两个进程内部通信进程的目的. 如果需要在一个Activity中, 访问另一个Service中的某个对象, 需要先将对象转化成AIDL可识别的参数(可能是多个参数), 然后使用AIDL来传递这些参数, 在消息的接收端, 使用这些参数组装成自己需要的对象.
AIDL的IPC的机制和COM或CORBA类似, 是基于接口的,但它是轻量级的。它使用代理类在客户端和实现层间传递值. 如果要使用AIDL, 需要完成2件事情: 1. 引入AIDL的相关类.; 2. 调用aidl产生的class.
具体实现步骤如下:
1、创建AIDL文件, 在这个文件里面定义接口, 该接口定义了可供客户端访问的方法和属性。 如: ITaskBinder.adil
view sourceprint?
01 package net.oschina.android.aidl.demo;
02
03 interface ITaskBinder {
04
05 boolean isTaskRunning();
06 void stopRunningTask();
07 void registerCallback(ITaskCallback cb);
08 void unregisterCallback(ITaskCallback cb);
09
10 }
其中: ITaskCallback在文件ITaskCallback.aidl中定义:
view sourceprint?
1 package net.oschina.android.aidl.demo;
2
3 interface ITaskCallback {
4
5 void actionPerformed(int actionId);
6
7 }
注意: 理论上, 参数可以传递基本数据类型和String, 还有就是Bundle的派生类, 不过在Eclipse中,目前的ADT不支持Bundle做为参数, 据说用Ant编译可以, 我没做尝试.
2、编译AIDL文件, 用Ant的话, 可能需要手动, 使用Eclipse plugin的话,可以根据adil文件自动生产java文件并编译, 不需要人为介入.
3、在Java文件中, 实现AIDL中定义的接口. 编译器会根据AIDL接口, 产生一个JAVA接口。这个接口有一个名为Stub的内部抽象类,它继承扩展了接口并实现了远程调用需要的几个方法。接下来就需要自己去实现自定义的几个接口了.
ITaskBinder.aidl中接口的实现, 在MyService.java中接口以内嵌类的方式实现:
view sourceprint?
01 private final ITaskBinder.Stub mBinder = new ITaskBinder.Stub() {
02
03 public void stopRunningTask() {
04 //@TODO
05 }
06
07 public boolean isTaskRunning() {
08 //@TODO
09 return false;
10 }
11
12 public void registerCallback(ITaskCallback cb) {
13 if (cb != null) mCallbacks.register(cb);
14 }
15
16 public void unregisterCallback(ITaskCallback cb) {
17 if (cb != null) mCallbacks.unregister(cb);
18 }
19
20 };
在MyActivity.java中ITaskCallback.aidl接口实现:
view sourceprint?
1 private ITaskCallback mCallback = new ITaskCallback.Stub() {
2
3 public void actionPerformed(int id) {
4 //TODO
5 printf("callback id=" + id);
6 }
7
8 };
4、向客户端提供接口ITaskBinder, 如果写的是service,扩展该Service并重载onBind ()方法来返回一个实现上述接口的类的实例。这个地方返回的mBinder,就是上面通过内嵌了定义的那个. (MyService.java)
view sourceprint?
1 public IBinder onBind(Intent t) {
2 printf("service on bind");
3 return mBinder;
4 }
在Activity中, 可以通过Binder定义的接口, 来进行远程调用.
5、在服务器端回调客户端的函数. 前提是当客户端获取的IBinder接口的时候,要去注册回调函数, 只有这样, 服务器端才知道该调用那些函数在:MyService.java中:
view sourceprint?
01 void callback(int val) {
02 final int N = mCallbacks.beginBroadcast();
03 for (int i=0; i<N; i++) {
04 try {
05 mCallbacks.getBroadcastItem(i).actionPerformed(val);
06 } catch (RemoteException e) {
07 // The RemoteCallbackList will take care of removing
08 // the dead object for us.
09 }
10 }
11 mCallbacks.finishBroadcast();
12
13 }
AIDL的创建方法:
AIDL语法很简单,可以用来声明一个带一个或多个方法的接口,也可以传递参数和返回值。由于远程调用的需要, 这些参数和返回值并不是任何类型.下面是些AIDL支持的数据类型:
1. 不需要import声明的简单Java编程语言类型(int,boolean等)
2. String, CharSequence不需要特殊声明 3. List, Map和Parcelables类型, 这些类型内所包含的数据成员也只能是简单数据类型, String等其他比支持的类型. ((另外: 我没尝试Parcelables, 在Eclipse+ADT下编译不过, 或许以后会有所支持).下面是AIDL语法: // 文件名: SomeClass.aidl // 文件可以有注释, 跟java的一样 // 在package以前的注释, 将会被忽略. // 函数和变量以前的注释, 都会被加入到生产java代码中.
view sourceprint?
01 package net.oschina.android.aidl.demo;
02
03 interface ITaskBinder {
04
05 //函数跟java一样, 可以有0到多个参数 ,可以有一个返回值
06 boolean isTaskRunning();
07
08 void stopRunningTask();
09
10 //参数可以是另外的一个aidl定义的接口
11 void registerCallback(ITaskCallback cb);
12
13 void unregisterCallback(ITaskCallback cb);
14
15 //参数可以是String, 可以用in表入输入类型, out表示输出类型.
16
17 int getCustomerList(in String branch, out String[] customerList);
18
19 }
实现接口时有几个原则:
.抛出的异常不要返回给调用者. 跨进程抛异常处理是不可取的..IPC调用是同步的。如果你知道一个IPC服务需要超过几毫秒的时间才能完成地话,你应该避免在Activity的主线程 中调用。 也就是IPC调用会挂起应用程序导致界面失去响应. 这种情况应该考虑单起一个线程来处理..不能在AIDL接口中声明静态属性。IPC的调用步骤:
1. 声明一个接口类型的变量,该接口类型在.aidl文件中定义。
2. 实现ServiceConnection。
3. 调用ApplicationContext.bindService(),并在ServiceConnection实现中进行传递.
4. 在ServiceConnection.onServiceConnected()实现中,你会接收一个IBinder实例(被调用的Service). 调用 YourInterfaceName.Stub.asInterface((IBinder)service)将参数转换为YourInterface类 型。
5. 调用接口中定义的方法。 你总要检测到DeadObjectException异常,该异常在连接断开时被抛出。它只会被远程方法抛出。
6. 断开连接,调用接口实例中的ApplicationContext.unbindService()
下面是整个程序:
1. ITaskCallback.aidl
view sourceprint?
1 package net.oschina.android.aidl.demo;
2
3 interface ITaskCallback {
4
5 void actionPerformed(int actionId);
6
7 }
2. ITaskBinder.aidl
view sourceprint?
01 package net.oschina.android.aidl.demo;
02
03 interface ITaskBinder {
04
05 boolean isTaskRunning();
06
07 void stopRunningTask();
08
09 void registerCallback(ITaskCallback cb);
10
11 void unregisterCallback(ITaskCallback cb);
12
13 }
3. MyService.java
view sourceprint?
01 package net.oschina.android.aidl.demo;
02
03 import android.app.Service;
04 import android.content.Intent;
05 import android.os.IBinder;
06 import android.os.RemoteCallbackList;
07 import android.os.RemoteException;
08 import android.util.Log;
09
10 public class MyService extends Service {
11
12 @Override
13 public void onCreate() {
14 printf("service create");
15 }
16
17 @Override
18 public void onStart(Intent intent, int startId) {
19 printf("service start id=" + startId);
20 callback(startId);
21 }
22
23 @Override
24 public IBinder onBind(Intent t) {
25 printf("service on bind");
26 return mBinder;
27 }
28
29 @Override
30 public void onDestroy() {
31 printf("service on destroy");
32 super.onDestroy();
33 }
34
35 @Override
36 public boolean onUnbind(Intent intent) {
37 printf("service on unbind");
38 return super.onUnbind(intent);
39 }
40
41 public void onRebind(Intent intent) {
42 printf("service on rebind");
43 super.onRebind(intent);
44 }
45
46 private void printf(String str) {
47 Log.e("TAG", "###################------ " + str + "------");
48 }
49
50 void callback(int val) {
51 final int N = mCallbacks.beginBroadcast();
52 for (int i=0; i<N; i++) {
53 try {
54 mCallbacks.getBroadcastItem(i).actionPerformed(val);
55 } catch (RemoteException e) {
56 // The RemoteCallbackList will take care of removing
57 // the dead object for us.
58 }
59 }
60 mCallbacks.finishBroadcast();
61 }
62
63 private final ITaskBinder.Stub mBinder = new ITaskBinder.Stub() {
64
65 public void stopRunningTask() {
66 }
67
68 public boolean isTaskRunning() {
69 return false;
70 }
71
72 public void registerCallback(ITaskCallback cb) {
73 if (cb != null) mCallbacks.register(cb);
74 }
75
76 public void unregisterCallback(ITaskCallback cb) {
77 if (cb != null) mCallbacks.unregister(cb);
78 }
79
80 };
81
82 final RemoteCallbackList<ITaskCallback> mCallbacks
83 = new RemoteCallbackList<ITaskCallback>();
84
85 }
4. MyActivity.java
view sourceprint?001 package net.oschina.android.aidl.demo;
002
003 import android.app.Activity;
004 import android.content.ComponentName;
005 import android.content.Context;
006 import android.content.Intent;
007 import android.content.ServiceConnection;
008 import android.graphics.Color;
009 import android.os.Bundle;
010 import android.os.IBinder;
011 import android.os.RemoteException;
012 import android.util.Log;
013 import android.view.View;
014 import android.view.ViewGroup;
015 import android.view.View.OnClickListener;
016 import android.widget.AbsoluteLayout;
017 import android.widget.Button;
018 import android.widget.LinearLayout;
019 import android.widget.RelativeLayout;
020 import android.widget.TextView;
021 import java.io.BufferedReader;
022 import java.io.File;
023 import java.io.FileOutputStream;
024 import java.io.FileReader;
025 import java.io.PrintWriter;
026
027 public class MyActivity extends Activity {
028
029 private Button btnOk;
030 private Button btnCancel;
031
032 @Override
033 public void onCreate(Bundle icicle) {
034
035 super.onCreate(icicle);
036
037 setContentView(R.layout.test_service);
038
039 btnOk = (Button)findViewById(R.id.btn_ok);
040
041 btnCancel = (Button)findViewById(R.id.btn_cancel);
042
043 btnOk.setText("Start Service");
044 btnCancel.setTag("Stop Service");
045
046 btnOk.setOnClickListener(new OnClickListener() {
047 public void onClick(View v) {
048 onOkClick();
049 }
050 });
051
052 btnCancel.setOnClickListener(new OnClickListener() {
053 public void onClick(View v) {
054 onCancelClick();
055 }
056 });
057 }
058
059 void onOkClick() {
060
061 Bundle args = new Bundle();
062
063 Intent intent = new Intent(this, MyService.class);
064 intent.putExtras(args);
065
066 //printf("send intent to start");
067 //startService(intent);
068 bindService(intent, mConnection, Context.BIND_AUTO_CREATE);
069 startService(intent);
070 }
071
072 void onCancelClick() {
073 Intent intent = new Intent(this, MyService.class);
074 //printf("send intent to stop");
075 unbindService(mConnection);
076 //stopService(intent);
077 }
078
079 private void printf(String str) {
080 Log.e("TAG", "###################------ " + str + "------");
081 }
082
083 ITaskBinder mService;
084
085 private ServiceConnection mConnection = new ServiceConnection() {
086
087 public void onServiceConnected(ComponentName className,IBinder service) {
088 mService = ITaskBinder.Stub.asInterface(service);
089 try {
090 mService.registerCallback(mCallback);
091 } catch (RemoteException e) {
092 }
093 }
094
095 public void onServiceDisconnected(ComponentName className) {
096 mService = null;
097 }
098 };
099
100 private ITaskCallback mCallback = new ITaskCallback.Stub() {
101 public void actionPerformed(int id) {
102 printf("callback id=" + id);
103 }
104 };
105
106 }