AIDL的使用笔记

1,470

最近这段时间在项目开发中使用到了AIDL,之前对这块的内容比较陌生.所以特地分享一下关于AIDL的一些使用知识,如果有什么写的不对的地方还请指出.这里先谢谢了!!!

本文知识点:

    1. AIDL简介
    1. AIDL的一些简单说明
    1. AIDL的DEMO演示
    1. AIDL的进阶使用

1. AIDL简介

其实我平时很烦一下概念上的东西,但是有的时候面试会使用到,所以这里还是简单提一下吧!你只要记住"AIDL(Android 接口定义语言) 是 Android 提供的一种进程间通信 (IPC) 机制。其次就是AIDL是实现跨进程通信的"就可以了,如果想了解更多的概念的话,建议你看看百度百科关于AIDL的说明剩下的就不在这里多做解释了!

2. AIDL的一些简单说明

AIDL说的简单一些的话,其实就是一个app要访问另外一个app的服务,访问者为客户端,被访问者是服务器.就这么简单.然后你觉得这一小节就完了?太天真了.这里还有许多要说的呢?

2.1 AIDL可以传递的数据类型

AIDL支持如下类型传递

支持的类型 说明 是否需要导包
Java的基本类型 如 int、long、char、boolean 等等 不需要导包
List 只支持ArrayList,里面的每个元素都必须被AIDL支持 不需要导包
Map 只支持HashMap, 里面的每个元素都必须被AIDL支持 不需要导包
实现Parcelable的类 必须是实现了序列化的类 需要导包
其他AIDL定义的AIDL接口 符合AIDL定义的接口 需要导包

上面注意一些问题,AIDL定义的接口,其实就是多个AIDL的组合而已,和正常的接口的使用是一样的!没什么高深的...

2.2 AIDL的开发步骤

一般在项目中,我都是先把服务端的代码写好,确定好相应的方法之后,在尽行客户端的编写。因为这样的话,编写起来比较方便!

    1. (服务端)创建相应的AIDL文件

AIDL文件的创建

这里值得注意的是,创建完AIDL重新定义方法的时候。你最好ReBuild一下!因为这样可以刷新一下你的接口文件!

    1. (服务端)相应接口的编写

创建一个相应的服务,关联相应AIDL的一些内容。创建服务就不再这里说了,这里只说明一下怎么关联相应的AIDL文件。

public class AidlService extends Service {

    private String TAG = AidlService.class.getSimpleName();

    private IMyAidlInterface.Stub mInterface = new IMyAidlInterface.Stub() {
        @Override
        public int add(int a, int b) throws RemoteException {
            Log.e(TAG, "a的值是:" + a + "b的值是:" + b);
            return a + b;
        }

        @Override
        public int sub(int a, int b) throws RemoteException {
            Log.e(TAG, "a的值是:" + a + "b的值是:" + b);
            return a - b;
        }
    };

    @Override
    public IBinder onBind(Intent intent) {
        return mInterface;
    }
}

上面是一段Service的代码,这个Service主要是提供相应的服务的类。其他APP都是调用这个Service中的方法的!

    1. 将客户端的AIDL文件复制到客户端

这一步很重要,否则你根本不知道怎么你该调用那个接口进行操作。具体位置,请看下面这张图片

复制文件的路径

这里注意一点,注意包名的问题。

    1. (客户端)绑定相应的服务

客户端通过相应的bindService绑定这个服务,就能使用里面的方法了!来段java代码。

public class MainActivity extends AppCompatActivity {

    /**
     * AIDL对象,以它来调用接口中的方法
     */
    private IMyAidlInterface mIMyAidlInterface;

    /**
     * 是否连接成功
     */
    private boolean mIsConnection;

    private TextView mTvResult;

    /**
     * Connection对象,用来创建连接
     */
    private ServiceConnection mConnection = new ServiceConnection() {
        @Override
        public void onServiceConnected(ComponentName name, IBinder service) {
            //初始化AIDL对象
            mIMyAidlInterface = IMyAidlInterface.Stub.asInterface(service);
        }

        @Override
        public void onServiceDisconnected(ComponentName name) {
            //连接失败的时候回调的方法
        }
    };

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

        mTvResult = findViewById(R.id.tv_result);

        //绑定服务的方法
        bindMathService();
    }

    private void bindMathService() {
        Intent intent = new Intent();
        intent.setComponent(new ComponentName("com.along.aidldemo", "com.along.aidldemo.AidlService"));
        bindService(intent, mConnection, BIND_AUTO_CREATE);
    }


    /**
     * 点击事件调用AIDL的方法
     */
    public void add(View view) {
        try {
            int add = mIMyAidlInterface.add(3, 4);
            mTvResult.setText(String.valueOf(add));
        } catch (RemoteException e) {
            e.printStackTrace();
        }
    }

    @Override
    protected void onDestroy() {
        super.onDestroy();
        //解绑相应的服务
        if (mIsConnection) {
            unbindService(mConnection);
        }
    }
}

注释我已经写的很清楚了,剩下的就没有什么好说的了!但是注意一点问题,绑定服务最好在onCreate中进行,这样能确保你在使用的时候,绑定已经成功了!因为有的时候,你在使用的时候绑定的话,可能会出现空指针的问题。基本上就是上面这些步骤了。

3. AIDL的DEMO演示

关于这个Demo演示,我一直没有太好的案例,一般网上都是演示加减法。我上面也是演示的加减法,但是我觉得这个有点low。所以我们就来一个添加图书的案例吧!正好方便下面的延申。

案例演示

案例是这个样子的,根据你输入的书名,添加到远端(AIDL),然后通过服务端(AIDL)把所有的书名显示回来!但是这里有一个重要的知识点,就是序列化对象的传递。我在用到的时候会着重讲解的。其实不是很难了。。。

各位看官请准备好瓜子!!!

1. 创建相应的AIDL文件

// IBookAidlInterface.aidl
package com.along.aidldemo;

// Declare any non-default types here with import statements

import com.along.aidldemo.Book;

interface IBookAidlInterface {

    void addBooks(in Book book);

    List<Book> getBooks();
}

这个是我创建的AIDL文件,首先注意这里的import导入的文件,因为这个文件很重哟,我会在一会创建的时候讲解。

public class Book implements Parcelable {

    private String name;
    private String price;

    public Book(String name, String price) {
        this.name = name;
        this.price = price;
    }

    public String getName() {
        return name;
    }

    public void setName(String name) {
        this.name = name;
    }

    public String getPrice() {
        return price;
    }

    public void setPrice(String price) {
        this.price = price;
    }

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

    @Override
    public void writeToParcel(Parcel dest, int flags) {
        dest.writeString(this.name);
        dest.writeString(this.price);
    }

    protected Book(Parcel in) {
        this.name = in.readString();
        this.price = 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];
        }
    };
}

这个是一个序列化的对象,我用的是Android Studio的插件直接序列化的。这个插件的名称叫Android Parcelable code generator至于怎么安装自己百度一下就好了!

重头戏来了。。。

// Book.aidl
package com.along.aidldemo;

// Declare any non-default types here with import statements

parcelable Book;

目录结构

首先这个文件名称是Book.aidl 为什么要有这个文件呢?其实也不难理解,你在AIDL中使用了Book这个类,如果你没有这个文件的话,AIDL不知道怎么找到这个类啊?但是注意啊?这个AIDL文件名称和你定义的类是一样的!

创建了之后,要在build.gradle中增加如下代码(这个千万别忘了):

 sourceSets {
        main {
            manifest.srcFile 'src/main/AndroidManifest.xml'
            java.srcDirs = ['src/main/java', 'src/main/aidl']
            resources.srcDirs = ['src/main/java', 'src/main/aidl']
            aidl.srcDirs = ['src/main/aidl']
            res.srcDirs = ['src/main/res']
            assets.srcDirs = ['src/main/assets']
        }
    }

PS: 这里有一个坑! 大家可能注意到了,在 Book.aidl 文件中,我一直在强调: Book.aidl与Book.java的包名应当是一样的。 但如果你要是想把他们放在不同的文件夹下也是可以的.如果你对此感兴趣的话可以看一下 Android学习AIDL,这一篇文章就够了这篇文章中讲解怎么去修改相应的位置.其实我觉得只有极度强迫症的人才需要,哈哈!

2.创建相应的Service

这里其实也不难,就是创建一个Service然后进行相应的绑定,上面已经讲解了,所以这里直接贴代码了!

public class BookService extends Service {

    private final List<Book> mBooks;

    private IBookAidlInterface.Stub mIBookAidlInterface = new IBookAidlInterface.Stub() {
        @Override
        public void addBooks(Book book) throws RemoteException {
            mBooks.add(book);
        }

        @Override
        public List<Book> getBooks() throws RemoteException {
            return mBooks;
        }
    };


    public BookService() {
        //注意这里只能用Arraylist
        mBooks = new ArrayList<>();
    }

    @Override
    public IBinder onBind(Intent intent) {
        return mIBookAidlInterface;
    }
}

3. 复制相应的文件到客户端

这个比较简单没有什么可以说的了!直接ctrl+c然后ctrl+v就可以了!

4. 在客户端绑定相应的服务

绑定服务的代码,基本上就大同小异了.这里就直接贴代码了!

public class MainActivity extends AppCompatActivity {

    /**
     * 是否连接成功
     */
    private boolean mIsConnection;

    private TextView mTvResult;

    /**
     * Connection对象,用来创建连接
     */
    private ServiceConnection mConnection = new ServiceConnection() {
        @Override
        public void onServiceConnected(ComponentName name, IBinder service) {
            //初始化AIDL对象
            mIBookAidlInterface = IBookAidlInterface.Stub.asInterface(service);
        }

        @Override
        public void onServiceDisconnected(ComponentName name) {
            //连接失败的时候回调的方法
        }
    };
    private IBookAidlInterface mIBookAidlInterface;

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

        mTvResult = findViewById(R.id.tv_result);

        //绑定服务的方法
        bindMathService();
    }

    private void bindMathService() {
        Intent intent = new Intent();
        intent.setComponent(new ComponentName("com.along.aidldemo", "com.along.aidldemo.BookService"));
        bindService(intent, mConnection, BIND_AUTO_CREATE);
    }


    /**
     * 点击事件调用AIDL的方法
     */
    public void add(View view) {
        Book book = new Book("java基础", "$1.00");
        try {
            mIBookAidlInterface.addBooks(book);
        } catch (RemoteException e) {
            e.printStackTrace();
        }
    }

    public void getBooks(View view) {
        try {
            List<Book> books = mIBookAidlInterface.getBooks();
            StringBuilder sb = new StringBuilder();
            for (Book book : books) {
                sb.append(book.toString());
            }
            mTvResult.setText(sb.toString());
        } catch (RemoteException e) {
            e.printStackTrace();
        }
    }

    @Override
    protected void onDestroy() {
        super.onDestroy();
        //解绑相应的服务
        if (mIsConnection) {
            unbindService(mConnection);
        }
    }
}

没有什么注意的点!

定向tag

不知道大家有没有注意到一个问题,在入参的地方多了一个in这个标识?这个是什么呢?简单的说就是数据的流向.那么都有哪些数据的流向呢?

  • in 表示数据只能由客户端流向服务端
  • out 表示数据只能由服务端流向客户端
  • inout 表示数据可在服务端与客户端之间双向流通

其中,数据流向是针对在客户端中的那个传入方法的对象而言的。in 为定向 tag 的话表现为服务端将会接收到一个那个对象的完整数据,但是客户端的那个对象不会因为服务端对传参的修改而发生变动;out 的话表现为服务端将会接收到那个对象的参数为空的对象,但是在服务端对接收到的空对象有任何修改之后客户端将会同步变动;inout 为定向 tag 的情况下,服务端将会接收到客户端传来对象的完整信息,并且客户端将会同步服务端对该对象的任何变动。

关于这个如果要是有不懂的,可以看看 你真的理解AIDL中的in,out,inout么?分析的还是比较透彻的!


关于AIDL基本上我在项目中只做三方登录,还没有用它做过和音乐播放器相关的内容,有时间的话可以尝试一下,关于以上内容,如果有童鞋不是很了解的话,可以私聊我哦!!!