之前写过一篇关于AIDL的入门篇,相信看过的朋友对AIDL多少会有点了解,如果对AIDL还不是很了解的可以看一下这篇文章Android进程通信(IPC)之AIDL快速入门.今天这篇文章主要讲讲在AIDL中如何传递对象。
在AIDL中可以传输的数据有:
- 基本数据类型(除short)
- String
- CharSequence
- List
- Map
我们知道Android的每个进程都运行在独立的虚拟机中,所以进程之间通信不是直接的,如果我们要传递一个对象我们得把对象拆分成Android系统可识别的数据单元,然后系统再重新将数据单元合成传递给另一个进程。这个过程其实也就是对象的序列化。在AIDL中传递对象我们要做以下几个步骤:
- 让你的对象类实现
Parcelable
接口 - 在该类中实现
writeToParcel
方法 - 添加一个静态构造器
CREATOR
- 创建你要传递的对象的
aidl
文件
接下我们来看一个具体的例子,这里我没有新建工程还是用的上篇文章的工程,如果对该工程目录结构不清楚的童鞋可以猛戳这里Android进程通信(IPC)之AIDL快速入门
首先在我们服务端建立要传递的对象类:
package com.example.administrator.aidldemo;
import android.os.Parcel;
import android.os.Parcelable;
public class Person implements Parcelable{
private String name;
private int age;
public Person(String name, int age){
this.name = name;
this.age = age;
}
//从Parcel中读出之前写进的数据
protected Person(Parcel in) {
this.name = in.readString();
this.age = in.readInt();
}
public static final Parcelable.Creator<Person> CREATOR = new Parcelable.Creator<Person>() {
//反序列化,把我们通过writeToParcel方法写进的数据再读出来
@Override
public Person createFromParcel(Parcel in) {
return new Person(in);
}
@Override
public Person[] newArray(int size) {
return new Person[size];
}
};
public String getName() {
return name;
}
public void setName(String name) {
this.name = name;
}
public int getAge() {
return age;
}
public void setAge(int age) {
this.age = age;
}
//实现 Parcelable 接口所需重写的方法1,一般不用管
@Override
public int describeContents() {
return 0;
}
//实现 Parcelable 接口所需重写的方法2,将对象的每个字段写入到Parcel中
@Override
public void writeToParcel(Parcel dest, int flags) {
dest.writeString(name);
dest.writeInt(age);
}
@Override
public String toString() {
return "Person{" +
"name='" + name + '\'' +
", age=" + age +
'}';
}
}
我们看到,这个对象实现Parcelable
接口,覆写了接口中的两个方法:describeContents()
、writeToParcel(Parcel dest, int flags)
,前一个方法我们暂且不用管它,主要看writeToParcel(Parcel dest, int flags)
这个方法,这个方法就是把该对象中的字段写进Parcel,相当于一艘轮船,我们把要运输的货物都装进去。通过查看文档我们发现Parcel
是没有writeShort()
这个方法的,这也正是AIDL无法传递short
类型的数据的原因。然后我们再静态创建构造器CREATOR
,注意要加final
修饰且名字必须为CREATOR
不能更改。其中我们要实现两个方法,主要看createFromParcel(Parcel in)
这个方法,这个方法其实就是把我们之前写进Parcel中的数据在读出来。这里要注意,我们之前怎么写的就怎么读出来,即哪个字段先写进去,就先读取哪个字段。最后覆写了toString
方法,以便之后打印数据。好了这样我们实体类就建好了。
然后我们在服务端创建该类的aidl
文件,文件名为Person
。
package com.example.administrator.aidldemo;
parcelable Person;
结构很简单,首先声明包名,然后在你建的对象类名前加上parcelable
,这样我们的类aidl文件也建好了。
然后我们新建一个aidl
接口,叫做DataTestAidlInterface
package com.example.administrator.aidldemo;
import com.example.administrator.aidldemo.Person;
interface DataTestAidlInterface {
List<Person> getPersonListIn(Person person);
}
这个接口定义了一个方法,方法很简单,传入一个Person
对象返回一个List,注意要导入之前我们创建的 Person
对象。好了我们现在构建下。
Fuck!报错了。。。好吧我们来看一下报的什么,这里有句话很关键
aidl.exe E 4888 4892 type_namespace.cpp:130] 'Person' can be an out type, so you must declare it as in, out or inout.
在AIDL进程传递数据时,都有一个数据拆包和打包的过程,这是一个很耗系统内存的,我们要在传递的数据前面加上in
、out
、inout
来表示数据传递的方向。
-
in
表示客户端向服务端传递数据,当服务端的数据发生改变,不会影响到客户端 -
out
表示服务端对数据修改,客户端会同步变动 -
inout
表示客户端和服务端的数据总是同步的
然后我们修改一下代码:
package com.example.administrator.aidldemo;
import com.example.administrator.aidldemo.Person;
interface DataTestAidlInterface {
List<Person> getPersonListIn(in Person person);
}
这样我们的aidl
接口也定义好了
然后我们新建一个服务
package com.example.administrator.aidldemo;
import android.app.Service;
import android.content.Intent;
import android.os.IBinder;
import android.os.RemoteException;
import android.support.annotation.Nullable;
import java.util.ArrayList;
import java.util.List;
public class IRemoteService extends Service {
List<Person> persons;
@Nullable
@Override
public IBinder onBind(Intent intent) {
persons = new ArrayList<>();
return iBinder;
}
private IBinder iBinder = new DataTestAidlInterface.Stub(){
@Override
public List<Person> getPersonList(Person person) throws RemoteException {
persons.add(person);
return persons;
}
}
}
这个服务很简单,当绑定该服务是新建一个List
,用于存放客户端添加的Person
对象。这样我们的服务端代码就都写完了,然后我们把服务端的Person
类文件和aidl
文件,以及我们定义的DataTestAidlInterface.aidl
文件都拷贝到客户端对应的文件夹下
在客户端,我们新建一个布局文件,里面就一个按钮,用于传递对象
<?xml version="1.0" encoding="utf-8"?>
<LinearLayout xmlns:android="http://schemas.android.com/apk/res/android"
android:layout_width="match_parent"
android:layout_height="match_parent"
android:orientation="vertical">
<Button
android:id="@+id/btn"
android:layout_width="match_parent"
android:layout_height="wrap_content"
android:text="传递对象"/>
</LinearLayout>
接下来看一下主界面:
public class DataTestActivity extends Activity{
private Button btn;
private List<Person> persons;
private DataTestAidlInterface mDataTestAidlInterface;
private ServiceConnection conn = new ServiceConnection() {
//服务连接成功时回调
@Override
public void onServiceConnected(ComponentName name, IBinder service) {
mDataTestAidlInterface = DataTestAidlInterface.Stub.asInterface(service);
}
//断开服务时回调
@Override
public void onServiceDisconnected(ComponentName name) {
if(mDataTestAidlInterface != null){
mDataTestAidlInterface = null;
}
}
};
@Override
protected void onCreate(Bundle savedInstanceSate){
super.onCreate(savedInstanceSate);
setContentView(R.layout.data_test_layout);
btn = (Button)findViewById(R.id.btn);
btn.setOnClickListener(new View.OnClickListener() {
@Override
public void onClick(View v) {
Person person = new Person("张三", 10);
try {
persons = mDataTestAidlInterface.getPersonListIn(person);
} catch (RemoteException e) {
e.printStackTrace();
}
Toast.makeText(DataTestActivity.this,persons.toString(),
Toast.LENGTH_SHORT).show();
}
});
bindService();
}
//绑定服务
private void bindService(){
Intent intent = new Intent();
intent.setComponent(new ComponentName("com.example.administrator.aidldemo",
"com.example.administrator.aidldemo.IRemoteService"));
bindService(intent, conn, Context.BIND_AUTO_CREATE);
}
@Override
protected void onDestroy(){
super.onDestroy();
unbindService(conn);
}
}
当界面启动时,就绑定到我们之前在服务端中的IRemoteService
,绑定成功后,将调用conn中的onServiceConnected
方法来获取在服务端实现好的接口。这样获取到接口后,当我们点击按钮时,新建一个Person
对象,然后调用获取到的DataTestAidlInterface
接口中getPersonListIn
方法,之后把返回的List
显示出来。
运行后效果如下: