一 AIDL作用
AIDL (Android Interface Definition Language) 是一种IDL 语言,用于生成可以在Android设备上两个进程之间进行进程间通信(interprocess communication, IPC)的代码。如果在一个进程中(例如Activity)要调用另一个进程中(例如Service)对象的操作,就可以使用AIDL生成可序列化的参数,AIDL IPC机制是面向接口的,像COM或Corba一样,但是更加轻量级。它是使用代理类在客户端和实现端传递数据。
二 AIDL的使用场景的选择
只有你允许客户端从不同的应用程序为了进程间的通信而去访问你的service,以及想在你的service处理多线程。如果不需要进行不同应用程序间的并发通信(IPC),you should create your interface by implementing a Binder;或者你想进行IPC,但不需要处理多线程的,则implement your interface using a Messenger。无论如何,在使用AIDL前,必须要理解如何绑定service——bindService,如何绑定服务。
三 如何使用AIDL工程,下面我们进行列子来详细的说明
1 首先创建一个Android工程来当aidl进程间通信的服务端,创建一个包名来com.android.aidl.keran,在这个包名下存放aidl文件,如果需要访问自定义对象还需要创建自定义对象,在这个我们就来创建一个自定义对象,用来说明问题。
IMyService.aidl代码如下:
package com.android.aidl.keran;
import com.android.aidl.keran.Student;
interface IMyService {
List<Student> getStudent();
void addStudent(in Student student);
}
这样服务器端的aidl文件就定义好了,说明:
aidl中支持的参数类型为:基本类型(int,long,char,boolean等),String,CharSequence,List,Map,其他类型必须使用import导入,即使它们可能在同一个包里,比如上面的Student,尽管它和IMyService在同一个包中,但是还是需要显示的import进来。
另外,接口中的参数除了aidl支持的类型,其他类型必须标识其方向:到底是输入还是输出抑或两者兼之,用in,out或者inout来表示,上面的代码我们用in标记,因为它是输入型参数。
在gen下面可以看到,eclipse为我们自动生成了一个代理类
public static abstract class Stub extends android.os.Binder implements com.android.aidl.keran.IMyService
可见这个Stub类就是一个普通的Binder,只不过它实现了我们定义的aidl接口。它还有一个静态方法
public static com.android.aidl.keran.IMyService asInterface(android.os.IBinder obj)
这个方法很有用,通过它,我们就可以在客户端中得到IMyService的实例,进而通过实例来调用其方法。
parcelable Student;
- package com.ryg.sayhi.aidl;
- import java.util.Locale;
- import android.os.Parcel;
- import android.os.Parcelable;
- public final class Student implements Parcelable {
- public static final int SEX_MALE = 1;
- public static final int SEX_FEMALE = 2;
- public int sno;
- public String name;
- public int sex;
- public int age;
- public Student() {
- }
- public static final Parcelable.Creator<Student> CREATOR = new
- Parcelable.Creator<Student>() {
- public Student createFromParcel(Parcel in) {
- return new Student(in);
- }
- public Student[] newArray(int size) {
- return new Student[size];
- }
- };
- private Student(Parcel in) {
- readFromParcel(in);
- }
- @Override
- public int describeContents() {
- return 0;
- }
- @Override
- public void writeToParcel(Parcel dest, int flags) {
- dest.writeInt(sno);
- dest.writeString(name);
- dest.writeInt(sex);
- dest.writeInt(age);
- }
- public void readFromParcel(Parcel in) {
- sno = in.readInt();
- name = in.readString();
- sex = in.readInt();
- age = in.readInt();
- }
- @Override
- public String toString() {
- return String.format(Locale.ENGLISH, "Student[ %d, %s, %d, %d ]", sno, name, sex, age);
- }
- }
package com.ryg.sayhi.aidl;
import java.util.Locale;
import android.os.Parcel;
import android.os.Parcelable;
public final class Student implements Parcelable {
public static final int SEX_MALE = 1;
public static final int SEX_FEMALE = 2;
public int sno;
public String name;
public int sex;
public int age;
public Student() {
}
public static final Parcelable.Creator<Student> CREATOR = new
Parcelable.Creator<Student>() {
public Student createFromParcel(Parcel in) {
return new Student(in);
}
public Student[] newArray(int size) {
return new Student[size];
}
};
private Student(Parcel in) {
readFromParcel(in);
}
@Override
public int describeContents() {
return 0;
}
@Override
public void writeToParcel(Parcel dest, int flags) {
dest.writeInt(sno);
dest.writeString(name);
dest.writeInt(sex);
dest.writeInt(age);
}
public void readFromParcel(Parcel in) {
sno = in.readInt();
name = in.readString();
sex = in.readInt();
age = in.readInt();
}
@Override
public String toString() {
return String.format(Locale.ENGLISH, "Student[ %d, %s, %d, %d ]", sno, name, sex, age);
}
}
说明:通过AIDL传输非基本类型的对象,被传输的对象需要序列化,序列化功能java有提供,但是android sdk提供了更轻量级更方便的方法,即实现Parcelable接口,关于android的序列化,我会在以后写文章介绍。这里只要简单理解一下就行,大意是要实现如下函数readFromParcel : 从parcel中读取对象
3.创建服务端service
- /**
- * @author scott
- */
- public class MyService extends Service
- {
- private final static String TAG = "MyService";
- private static final String PACKAGE_SAYHI = "com.example.test";
- private NotificationManager mNotificationManager;
- private boolean mCanRun = true;
- private List<Student> mStudents = new ArrayList<Student>();
- //这里实现了aidl中的抽象函数
- private final IMyService.Stub mBinder = new IMyService.Stub() {
- @Override
- public List<Student> getStudent() throws RemoteException {
- synchronized (mStudents) {
- return mStudents;
- }
- }
- @Override
- public void addStudent(Student student) throws RemoteException {
- synchronized (mStudents) {
- if (!mStudents.contains(student)) {
- mStudents.add(student);
- }
- }
- }
- //在这里可以做权限认证,return false意味着客户端的调用就会失败,比如下面,只允许包名为com.example.test的客户端通过,
- //其他apk将无法完成调用过程
- public boolean onTransact(int code, Parcel data, Parcel reply, int flags)
- throws RemoteException {
- String packageName = null;
- String[] packages = MyService.this.getPackageManager().
- getPackagesForUid(getCallingUid());
- if (packages != null && packages.length > 0) {
- packageName = packages[0];
- }
- Log.d(TAG, "onTransact: " + packageName);
- if (!PACKAGE_SAYHI.equals(packageName)) {
- return false;
- }
- return super.onTransact(code, data, reply, flags);
- }
- };
- @Override
- public void onCreate()
- {
- Thread thr = new Thread(null, new ServiceWorker(), "BackgroundService");
- thr.start();
- synchronized (mStudents) {
- for (int i = 1; i < 6; i++) {
- Student student = new Student();
- student.name = "student#" + i;
- student.age = i * 5;
- mStudents.add(student);
- }
- }
- mNotificationManager = (NotificationManager) getSystemService(NOTIFICATION_SERVICE);
- super.onCreate();
- }
- @Override
- public IBinder onBind(Intent intent)
- {
- Log.d(TAG, String.format("on bind,intent = %s", intent.toString()));
- displayNotificationMessage("服务已启动");
- return mBinder;
- }
- @Override
- public int onStartCommand(Intent intent, int flags, int startId)
- {
- return super.onStartCommand(intent, flags, startId);
- }
- @Override
- public void onDestroy()
- {
- mCanRun = false;
- super.onDestroy();
- }
- private void displayNotificationMessage(String message)
- {
- Notification notification = new Notification(R.drawable.icon, message,
- System.currentTimeMillis());
- notification.flags = Notification.FLAG_AUTO_CANCEL;
- notification.defaults |= Notification.DEFAULT_ALL;
- PendingIntent contentIntent = PendingIntent.getActivity(this, 0,
- new Intent(this, MyActivity.class), 0);
- notification.setLatestEventInfo(this, "我的通知", message,
- contentIntent);
- mNotificationManager.notify(R.id.app_notification_id + 1, notification);
- }
- class ServiceWorker implements Runnable
- {
- long counter = 0;
- @Override
- public void run()
- {
- // do background processing here.....
- while (mCanRun)
- {
- Log.d("scott", "" + counter);
- counter++;
- try
- {
- Thread.sleep(2000);
- } catch (InterruptedException e)
- {
- e.printStackTrace();
- }
- }
- }
- }
- }
/**
* @author scott
*/
public class MyService extends Service
{
private final static String TAG = "MyService";
private static final String PACKAGE_SAYHI = "com.example.test";
private NotificationManager mNotificationManager;
private boolean mCanRun = true;
private List<Student> mStudents = new ArrayList<Student>();
//这里实现了aidl中的抽象函数
private final IMyService.Stub mBinder = new IMyService.Stub() {
@Override
public List<Student> getStudent() throws RemoteException {
synchronized (mStudents) {
return mStudents;
}
}
@Override
public void addStudent(Student student) throws RemoteException {
synchronized (mStudents) {
if (!mStudents.contains(student)) {
mStudents.add(student);
}
}
}
//在这里可以做权限认证,return false意味着客户端的调用就会失败,比如下面,只允许包名为com.example.test的客户端通过,
//其他apk将无法完成调用过程
public boolean onTransact(int code, Parcel data, Parcel reply, int flags)
throws RemoteException {
String packageName = null;
String[] packages = MyService.this.getPackageManager().
getPackagesForUid(getCallingUid());
if (packages != null && packages.length > 0) {
packageName = packages[0];
}
Log.d(TAG, "onTransact: " + packageName);
if (!PACKAGE_SAYHI.equals(packageName)) {
return false;
}
return super.onTransact(code, data, reply, flags);
}
};
@Override
public void onCreate()
{
Thread thr = new Thread(null, new ServiceWorker(), "BackgroundService");
thr.start();
synchronized (mStudents) {
for (int i = 1; i < 6; i++) {
Student student = new Student();
student.name = "student#" + i;
student.age = i * 5;
mStudents.add(student);
}
}
mNotificationManager = (NotificationManager) getSystemService(NOTIFICATION_SERVICE);
super.onCreate();
}
@Override
public IBinder onBind(Intent intent)
{
Log.d(TAG, String.format("on bind,intent = %s", intent.toString()));
displayNotificationMessage("服务已启动");
return mBinder;
}
@Override
public int onStartCommand(Intent intent, int flags, int startId)
{
return super.onStartCommand(intent, flags, startId);
}
@Override
public void onDestroy()
{
mCanRun = false;
super.onDestroy();
}
private void displayNotificationMessage(String message)
{
Notification notification = new Notification(R.drawable.icon, message,
System.currentTimeMillis());
notification.flags = Notification.FLAG_AUTO_CANCEL;
notification.defaults |= Notification.DEFAULT_ALL;
PendingIntent contentIntent = PendingIntent.getActivity(this, 0,
new Intent(this, MyActivity.class), 0);
notification.setLatestEventInfo(this, "我的通知", message,
contentIntent);
mNotificationManager.notify(R.id.app_notification_id + 1, notification);
}
class ServiceWorker implements Runnable
{
long counter = 0;
@Override
public void run()
{
// do background processing here.....
while (mCanRun)
{
Log.d("scott", "" + counter);
counter++;
try
{
Thread.sleep(2000);
} catch (InterruptedException e)
{
e.printStackTrace();
}
}
}
}
}
说明:为了表示service的确在活着,我通过打log的方式,每2s打印一次计数。上述代码的关键在于onBind函数,当客户端bind上来的时候,将IMyService.Stub mBinder返回给客户端,这个mBinder是aidl的存根,其实现了之前定义的aidl接口中的抽象函数。
4. 在AndroidMenifest中声明service
- <service
- android:name="com.ryg.sayhi.MyService"
- android:process=":remote"
- android:exported="true" >
- <intent-filter>
- <category android:name="android.intent.category.DEFAULT" />
- <action android:name="com.ryg.sayhi.MyService" />
- </intent-filter>
- </service>
<service
android:name="com.ryg.sayhi.MyService"
android:process=":remote"
android:exported="true" >
<intent-filter>
<category android:name="android.intent.category.DEFAULT" />
<action android:name="com.ryg.sayhi.MyService" />
</intent-filter>
</service>
说明:上述的 <action android:name="com.ryg.sayhi.MyService" />是为了能让其他apk隐式bindService,通过隐式调用的方式来起activity或者service,需要把category设为default,这是因为,隐式调用的时候,intent中的category默认会被设置为default。
5. 新建一个工程,充当客户端
- import com.ryg.sayhi.aidl.IMyService;
- import com.ryg.sayhi.aidl.Student;
- public class MainActivity extends Activity implements OnClickListener {
- private static final String ACTION_BIND_SERVICE = "com.ryg.sayhi.MyService";
- private IMyService mIMyService;
- private ServiceConnection mServiceConnection = new ServiceConnection()
- {
- @Override
- public void onServiceDisconnected(ComponentName name)
- {
- mIMyService = null;
- }
- @Override
- public void onServiceConnected(ComponentName name, IBinder service)
- {
- //通过服务端onBind方法返回的binder对象得到IMyService的实例,得到实例就可以调用它的方法了
- mIMyService = IMyService.Stub.asInterface(service);
- try {
- Student student = mIMyService.getStudent().get(0);
- showDialog(student.toString());
- } catch (RemoteException e) {
- e.printStackTrace();
- }
- }
- };
- @Override
- protected void onCreate(Bundle savedInstanceState) {
- super.onCreate(savedInstanceState);
- setContentView(R.layout.activity_main);
- Button button1 = (Button) findViewById(R.id.button1);
- button1.setOnClickListener(new OnClickListener() {
- @Override
- public void onClick(View view) {
- if (view.getId() == R.id.button1) {
- Intent intentService = new Intent(ACTION_BIND_SERVICE);
- intentService.setFlags(Intent.FLAG_ACTIVITY_NEW_TASK);
- MainActivity.this.bindService(intentService, mServiceConnection, BIND_AUTO_CREATE);
- }
- }
- public void showDialog(String message)
- {
- new AlertDialog.Builder(MainActivity.this)
- .setTitle("scott")
- .setMessage(message)
- .setPositiveButton("确定", null)
- .show();
- }
- @Override
- protected void onDestroy() {
- if (mIMyService != null) {
- unbindService(mServiceConnection);
- }
- super.onDestroy();
- }
- }