Android AIDL使用详解

最新推荐文章于 2024-05-13 19:36:46 发布

Mibeo

最新推荐文章于 2024-05-13 19:36:46 发布

阅读量286

点赞数

分类专栏： IPC

本文链接：https://blog.csdn.net/qq_25017839/article/details/94434904

版权

IPC 专栏收录该内容

1 篇文章 0 订阅

订阅专栏

一、概述

AIDL 意思即 Android Interface Definition Language，翻译过来就是Android接口定义语言，是用于定义服务器和客户端通信接口的一种描述语言，可以拿来生成用于IPC的代码。
目的就是为了实现进程间通信。通常，暴露方法给其他应用进行调用的应用称为服务端，调用其他应用的方法的应用称为客户端，客户端通过绑定服务端的Service来进行交互

二、语法

AIDL支持的数据类型分为如下几种：
(1). 八种基本数据类型：byte、char、short、int、long、float、double、boolean
(2).String，CharSequence
(3).实现了Parcelable接口的数据类型
(4).List 类型。List承载的数据必须是AIDL支持的类型，或者是其它声明的AIDL对象
(5).Map类型。Map承载的数据必须是AIDL支持的类型，或者是其它声明的AIDL对象
AIDL文件可以分为两类。一类用来声明实现了Parcelable接口的数据类型，以供其他AIDL文件使用那些非默认支持的数据类型。还有一类是用来定义接口方法，声明要暴露哪些接口给客户端调用，定向Tag就是用来标注这些方法的参数值
定向Tag。定向Tag表示在跨进程通信中数据的流向，用于标注方法的参数值，分为 in、out、inout 三种。其中 in 表示数据只能由客户端流向服务端， out 表示数据只能由服务端流向客户端，而 inout 则表示数据可在服务端与客户端之间双向流通。此外，如果AIDL方法接口的参数值类型是：基本数据类型、String、CharSequence或者其他AIDL文件定义的方法接口，那么这些参数值的定向 Tag 默认是且只能是 in，所以除了这些类型外，其他参数值都需要明确标注使用哪种定向Tag。
明确导包。在AIDL文件中需要明确标明引用到的数据类型所在的包名，即使两个文件处在同个包名下

三、编码

创建2个工程，一个为服务端，一个为客户端，客户端绑定服务端service，然后调用方法向服务端获取书籍列表，向服务端添加书籍。

1、服务端编码

新建一个工程，包名定为com.zbj.server
在应用中需要用到一个Book类，为了避免出现类名重复，需要先建立Book AIDL文件，之后再创建Book类
右键点击新建一个AIDL文件，命名为Book
在这里插入图片描述创建完成后，系统会默认创建一个aidl文件，文件夹下的目录结构即是工程的包名，Book.aidi 文件就在其中
此时可以定义Book类，Book类只包含一个 Name 属性，并使之实现 Parcelable 接口

/**
 * Created by bingjia.zheng on 2019/7/2.
 */

public class Book implements Parcelable {

    private String name;

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

    public String getName() {
        return name;
    }

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

    @Override
    public String toString() {
        return "book name：" + name;
    }

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

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

    public void readFromParcel(Parcel dest) {
        name = dest.readString();
    }

    protected Book(Parcel in) {
        this.name = in.readString();
    }

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

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

修改Book.aidl文件，将之改为声明Parcelable数据类型的AIDL文件

package com.zbj.server;
parcelable Book;

接着，服务端需要暴露给客户端一个获取书籍列表以及一个添加书籍的方法，这两个方法首先要定义在AIDL文件中，命名为BookController.aidl，这里需要明确导包

package com.zbj.server;
import com.zbj.server.Book;
interface BookController {
    List<Book> getBookList();
    void addBookInOut(inout Book book);
}

在进程间通信中真正起作用的并不是 AIDL 文件，而是系统据此而生成的文件，可以在以下目录中查看系统生成的文件。之后需要使用到当中的内部静态抽象类 Stub
创建或修改过AIDL文件后需要clean下工程，使系统及时生成我们需要的文件
在这里插入图片描述
现在需要创建一个Service供客户端远程绑定，这里命名为AIDLService

/**
 * Created by bingjia.zheng on 2019/7/2.
 */

public class AIDLService extends Service {

    private final String TAG = "Server";

    private List<Book> bookList;

    public AIDLService() {
    }

    @Override
    public void onCreate() {
        super.onCreate();
        bookList = new ArrayList<>();
        for (int i = 0; i < 7; i++) {
            Book book = new Book("第" + i + "本书");
            bookList.add(book);
        }
    }

    private final BookController.Stub stub = new BookController.Stub() {

        @Override
        public List<Book> getBookList() throws RemoteException {
            return bookList;
        }

        @Override
        public void addBookInOut(Book book) throws RemoteException {
            if (book != null) {
                book.setName("服务器改了新书的名字 InOut");
                bookList.add(book);
            } else {
                Log.e(TAG, "接收到了一个空对象 InOut");
            }
        }

    };

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

}

onBind 方法返回的就是 BookController.Stub 对象，实现当中定义的两个方法
服务端还有一个地方需要注意，因为服务端的Service需要被客户端来远程绑定，所以客户端要能够找到这个Service，可以通过先指定包名，之后再配置Action值或者直接指定Service类名的方式来绑定Service
如果是通过指定Action值的方式来绑定Service，那还需要将Service的声明改为如下所示：

<service android:name=".AIDLService"
    android:enabled="true"
    android:exported="true">
    <intent-filter>
        <action android:name="com.zbj.server.action"/>
        <category android:name="android.intent.category.DEFAULT"/>
    </intent-filter>
</service>

本例子采用配置 Action 的方案

2、客户端编码

客户端需要再创建一个新的工程，包名命名为 com.zbj.client
首先，需要把服务端的AIDL文件以及Book类复制过来，将 aidl 文件夹整个复制到和Java文件夹同个层级下，不需要改动任何代码
在这里插入图片描述
之后，需要创建和服务端Book类所在的相同包名来存放 Book类

修改布局文件，添加两个按钮

<?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:gravity="center"
    android:orientation="vertical">

    <Button
        android:id="@+id/btn_getBookList"
        android:layout_width="match_parent"
        android:layout_height="wrap_content"
        android:text="获取书籍列表" />

    <Button
        android:id="@+id/btn_addBook_inOut"
        android:layout_width="match_parent"
        android:layout_height="wrap_content"
        android:text="InOut 添加书籍" />

</LinearLayout>

接着，修改MainActivity，主要实现与服务端进行交互

public class MainActivity extends AppCompatActivity {
    private final String TAG = "Client";

    private BookController bookController;

    private boolean connected;

    private List<Book> bookList;

    private ServiceConnection serviceConnection = new ServiceConnection() {
        @Override
        public void onServiceConnected(ComponentName name, IBinder service) {
            bookController = BookController.Stub.asInterface(service);
            connected = true;
        }

        @Override
        public void onServiceDisconnected(ComponentName name) {
            connected = false;
        }
    };

    private View.OnClickListener clickListener = new View.OnClickListener() {
        @Override
        public void onClick(View v) {
            switch (v.getId()) {
                case R.id.btn_getBookList:
                    if (connected) {
                        try {
                            bookList = bookController.getBookList();
                        } catch (RemoteException e) {
                            e.printStackTrace();
                        }
                        log();
                    }
                    break;
                case R.id.btn_addBook_inOut:
                    if (connected) {
                        Book book = new Book("这是一本新书 InOut");
                        try {
                            bookController.addBookInOut(book);
                            Log.e(TAG, "向服务器以InOut方式添加了一本新书");
                            Log.e(TAG, "新书名：" + book.getName());
                        } catch (RemoteException e) {
                            e.printStackTrace();
                        }
                    }
                    break;
            }
        }
    };

    @Override
    protected void onCreate(Bundle savedInstanceState) {
        super.onCreate(savedInstanceState);
        setContentView(R.layout.activity_main);
        findViewById(R.id.btn_getBookList).setOnClickListener(clickListener);
        findViewById(R.id.btn_addBook_inOut).setOnClickListener(clickListener);
        bindService();
    }

    @Override
    protected void onDestroy() {
        super.onDestroy();
        if (connected) {
            unbindService(serviceConnection);
        }
    }

    private void bindService() {
        Intent intent = new Intent();
        intent.setPackage("com.zbj.server");
        intent.setAction("com.zbj.server.action");
        bindService(intent, serviceConnection, Context.BIND_AUTO_CREATE);
    }

    private void log() {
        for (Book book : bookList) {
            Log.e(TAG, book.toString());
        }
    }
}

最后，先安装服务端应用到手机上，再安装客户端应用
首先点击获取书籍列表，数据获取无误
在这里插入图片描述
再点击按钮添加书籍，可以看到，服务端对数据的修改也同时同步到了客户端这边

到此为止，客户端和服务端之间的通信已经实现了，客户端获取到了服务端的数据，也向服务端传送了数据

Mibeo

关注

0
点赞
踩
1

收藏

觉得还不错? 一键收藏
0
评论
Android AIDL使用详解

一、概述AIDL 意思即 Android Interface Definition Language，翻译过来就是Android接口定义语言，是用于定义服务器和客户端通信接口的一种描述语言，可以拿来生成用于IPC的代码。目的就是为了实现进程间通信。通常，暴露方法给其他应用进行调用的应用称为服务端，调用其他应用的方法的应用称为客户端，客户端通过绑定服务端的Service来进行交互二、语法A...
复制链接

扫一扫

专栏目录