AIDL的基本使用

一、AIDL介绍

AIDL全程：android interface definition language，即android接口定义语言，可以理解为就是接口。

二、AIDL使用

AS专门为aidl文件配置了一个文件夹（aidl文件夹）
在这里插入图片描述

AIDL支持的数据类型：

基本数据类型（int、long、char、boolean、double）
string和charSequence
list:只支持arraylist，以及里面的所有元素必须被aidl支持
map:只支持hashmap
parcelable：所有实现parcelable接口的对象
aidl：所有aidl接口本身也可以在aidl文件中使用

注意：自定义的parcelable对象：需要创建一个同类名的aidl文件，只有这样aidl才能识别这个对象。
在这里插入图片描述

注意：在aidl中声明其他数据类型时需要在前面加in（输入型参数）、out（输出型参数）、inout（输入输出型参数）

三、AIDL例子

创建两个项目PersonAIDLServer和PersonAIDLClient，一个作为服务端一个作为客户端。

PersonAIDLServer项目结构图：
创建一个Person工具类，定义两个属性（id、name），生成构造方法和toString方法，然后再实现Parcelable接口，重写其中的方法。

package com.example.personaidlserver;

import android.os.Parcel;
import android.os.Parcelable;

public class Person implements Parcelable {
    int id;
    String name;

    public Person(int id, String name) {
        this.id = id;
        this.name = name;
    }

    protected Person(Parcel in) {
        id = in.readInt();
        name = in.readString();
    }

    public static final Creator<Person> CREATOR = new Creator<Person>() {
        @Override
        public Person createFromParcel(Parcel in) {
            return new Person(in);
        }

        @Override
        public Person[] newArray(int size) {
            return new Person[size];
        }
    };

    @Override
    public String toString() {
        return "Person{" +
                "id=" + id +
                ", name='" + name + '\'' +
                '}';
    }

    @Override
    public int describeContents() {
        return 0;
    }

    @Override
    public void writeToParcel(Parcel parcel, int i) {
        parcel.writeInt(id);
        parcel.writeString(name);
    }
}

创建两个aidl文件，一个person管理文件里面定义了一个添加person和获取person对象的方法，另一个用于声明Person是parcelable序列化后的对象。

注意：必须手动导入person对象的包，否则aidl无法识别，会导致构建项目出错。

注意：必须将person对象序列化。

// IPersonManager.aidl
package com.example.personaidlserver;

import com.example.personaidlserver.Person;  // 必须手敲，导入包

interface IPersonManager{
   void addPerson(in Person person);    // 自定义对象需要在前面加in、out、inout
   List<Person> getPersonList();
}

parcelable Person;   //声明Person对象被序列化了，否者也不能被AIDL识别

最后也是最重要的一步：makeProject，这一步会生成一个接口文件在build/getnerated文件下

创建一个PersonAIDLService，在onbind方法中返回IPersonManager.Stub(),然后会重写刚刚定义好的方法。AIDL文件中定义的知识一个方法名和参数，而这里才是真正定义这个方法里的具体内容的。直接贴代码：

package com.example.personaidlserver;

import android.app.Service;
import android.content.Intent;
import android.os.IBinder;
import android.os.RemoteException;
import android.util.Log;
import androidx.annotation.Nullable;
import java.util.ArrayList;
import java.util.List;


public class PersonAIDLService extends Service {

    ArrayList<Person> persons = new ArrayList<Person>();
    @Nullable
    @Override
    public IBinder onBind(Intent intent) {
        Log.d("tag", "onBind: ");
        return new IPersonManager.Stub() {
            @Override
            public void addPerson(Person person) throws RemoteException {
                Log.d("TAG", "addPerson: ");
                persons.add(person);
            }

            @Override
            public List<Person> getPersonList() throws RemoteException {
                Log.d("TAG", "getPersonList: "+persons.toString());
                return persons;
            }
        };
    }
}

注意：new ArrayList<>(),开辟内存空间，以便于客户端将Person对象放入其中，我在做的过程中没有new对象，导致报一个空指针异常的错。

到这里服务端就写完了。

客户端的项目结构图：

在这里插入图片描述

注意：将服务端的aidl文件和Person类完整复制过来，并保持包名一致，然后再makeProject。

MainActivity中的代码，Service的绑定是通过显示Intent来实现的。获取IPersonManager对象是通过Stub.asInterface(ibinder)的方法获取的。然后就可以使用这个接口封装的方法了。

package com.example.personaidlclient;

import android.annotation.SuppressLint;
import android.content.ComponentName;
import android.content.Intent;
import android.content.ServiceConnection;
import android.os.Bundle;
import android.os.IBinder;
import android.os.RemoteException;
import android.util.Log;
import android.view.View;
import android.widget.Button;
import androidx.appcompat.app.AppCompatActivity;
import com.example.personaidlserver.IPersonManager;
import com.example.personaidlserver.Person;
import java.util.ArrayList;

public class MainActivity extends AppCompatActivity implements View.OnClickListener{

    private Button bindService;
    private Button addPerson;
    private Button getPerson;
    private Button unBindService;
    private Intent intent;
    ArrayList<Person> persons;

    @Override
    protected void onCreate(Bundle savedInstanceState) {
        super.onCreate(savedInstanceState);
        setContentView(R.layout.activity_main);
        initView();
    }

    private void initView() {
        bindService = (Button) findViewById(R.id.bindService);
        addPerson = (Button) findViewById(R.id.addPerson);
        getPerson = (Button) findViewById(R.id.getPerson);
        unBindService = (Button) findViewById(R.id.unBindService);
        bindService.setOnClickListener(this);
        addPerson.setOnClickListener(this);
        getPerson.setOnClickListener(this);
        unBindService.setOnClickListener(this);
        intent = new Intent();
        intent.setComponent(new ComponentName("com.example.personaidlserver","com.example.personaidlserver.PersonAIDLService"));
    }

    @SuppressLint("NonConstantResourceId")
    @Override
    public void onClick(View view) {
        switch (view.getId()){
            case R.id.bindService:
                Log.d("TAG", "onClick: ");
                bindService(intent,conn,BIND_AUTO_CREATE);
                break;
            case R.id.addPerson:
                try {
                    iPersonManager.addPerson(new Person(24,"yqf"));
                } catch (RemoteException e) {
                    e.printStackTrace();
                }
                break;
            case R.id.getPerson:
                try {
                    persons = (ArrayList<Person>) iPersonManager.getPersonList();
                    Log.d("TAG", " 获取的数据"+persons.toString());
                } catch (RemoteException e) {
                    e.printStackTrace();
                }
                break;
            case R.id.unBindService:
                unbindService(conn);
                break;
            default:
                break;
        }
    }

    private IPersonManager iPersonManager;
    ServiceConnection conn = new ServiceConnection() {
        @Override
        public void onServiceConnected(ComponentName componentName, IBinder iBinder) {
            Log.d("TAG", "onServiceConnected: ");
            iPersonManager = IPersonManager.Stub.asInterface(iBinder);
        }

        @Override
        public void onServiceDisconnected(ComponentName componentName) {
            iPersonManager = null;

        }
    };
}