欢迎您访问程序员文章站本站旨在为大家提供分享程序员计算机编程知识!
您现在的位置是: 首页  >  移动技术

AIDL

程序员文章站 2022-07-03 12:39:58
借鉴:https://www.jianshu.com/p/29999c1a93cd一、概述AIDL 意思即 Android Interface Definition Language,翻译过来就是Android接口定义语言,是用于定义服务器和客户端通信接口的一种描述语言,可以拿来生成用于IPC的代码。从某种意义上说AIDL其实是一个模板,因为在使用过程中,实际起作用的并不是AIDL文件,而是据此而生成的一个IInterface的实例代码,AIDL其实是为了避免我们重复编写代码而出现的一个模板设计AID...

借鉴:https://www.jianshu.com/p/29999c1a93cd

一、概述

AIDL 意思即 Android Interface Definition Language,翻译过来就是Android接口定义语言,是用于定义服务器和客户端通信接口的一种描述语言,可以拿来生成用于IPC的代码。从某种意义上说AIDL其实是一个模板,因为在使用过程中,实际起作用的并不是AIDL文件,而是据此而生成的一个IInterface的实例代码,AIDL其实是为了避免我们重复编写代码而出现的一个模板

设计AIDL这门语言的目的就是为了实现进程间通信。在Android系统中,每个进程都运行在一块独立的内存中,在其中完成自己的各项活动,与其他进程都分隔开来。可是有时候我们又有应用间进行互动的需求,比较传递数据或者任务委托等,AIDL就是为了满足这种需求而诞生的。通过AIDL,可以在一个进程中获取另一个进程的数据和调用其暴露出来的方法,从而满足进程间通信的需求

通常,暴露方法给其他应用进行调用的应用称为服务端,调用其他应用的方法的应用称为客户端,客户端通过绑定服务端的Service来进行交互

二、语法

AIDL的语法十分简单,与Java语言基本保持一致,需要记住的规则有以下几点:

  1. AIDL文件以 .aidl 为后缀名
  2. AIDL支持的数据类型分为如下几种:
    • 八种基本数据类型:byte、char、short、int、long、float、double、boolean
    • String,CharSequence
    • 实现了Parcelable接口的数据类型
    • List 类型。List承载的数据必须是AIDL支持的类型,或者是其它声明的AIDL对象
    • Map类型。Map承载的数据必须是AIDL支持的类型,或者是其它声明的AIDL对象
  3. AIDL文件可以分为两类。一类用来声明实现了Parcelable接口的数据类型,以供其他AIDL文件使用那些非默认支持的数据类型。还有一类是用来定义接口方法,声明要暴露哪些接口给客户端调用,定向Tag就是用来标注这些方法的参数值
  4. 定向Tag。定向Tag表示在跨进程通信中数据的流向,用于标注方法的参数值,分为 in、out、inout 三种。
in表示数据只能由客户端流向服务端,也就是客户端的对象的值不会随着服务端的变化而改变
out表示数据只能由服务端流向客户端,也就是客户端的值会随着服务端的变化而改变,但是服务端不会接收客户端的值
inout则表示数据可在服务端与客户端之间双向流通。也就是服务端和客户端的值会随着双方的变化而改变

此外,如果AIDL方法接口的参数值类型是:基本数据类型、String、CharSequence或者其他AIDL文件定义的方法接口,那么这些参数值的定向 Tag 默认是且只能是 in,所以除了这些类型外,其他参数值都需要明确标注使用哪种定向Tag。定向Tag具体的使用差别后边会有介绍
5. 明确导包。在AIDL文件中需要明确标明引用到的数据类型所在的包名,即使两个文件处在同个包名下

三、案例-服务端

创建服务端工程AidlServerTest,包名com.lbq.aidlservertest

1.创建实体类Book

注意: 这里的readFromParcel默认是不会自动生成的,需要自己手动添加,当tag是inout时,就需要此方法,不然会报错

public class Book implements Parcelable {

    private String name;

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

    public Book(){

    }

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

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

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

    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(name);
    }

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

}
2.创建Book.aidl

右键创建AIDL文件,删除原有代码,将之改为声明parcelable数据类型的AIDL文件,代码如下

// Book.aidl
package com.lbq.aidlservertest;

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

parcelable Book;
3.定义接口AIDL文件

服务端暴露给客户端,添加书籍和获取书籍的方法,同时验证in、out、inout的区别,代码如下

这时编译后,系统会在build生成对应的aidl代码

注意:Book类需要导包

// BookControl.aidl
package com.lbq.aidlservertest;
import com.lbq.aidlservertest.Book;

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

interface BookControl {

    List<Book> getBookList();

    void addBookInOut(inout Book book);

    void addBookIn(in Book book);

    void addBookOut(out Book book);

}

4.右键创建service文件,命名AidlService

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<>();
        initData();
    }

    private void initData() {
        Book book1 = new Book("活着");
        Book book2 = new Book("或者");
        Book book3 = new Book("叶应是叶");
        bookList.add(book1);
        bookList.add(book2);
        bookList.add(book3);
    }

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

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

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

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

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

    };

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

四、案例-客户端

创建客户端工程AidlClientTest,包名com.lbq.aidlclienttest

1.把服务端的AIDL文件以及Book类复制过来,将 aidl文件夹整个复制到和Java文件夹同个层级下,不需要改动任何代码,包名路径需要和服务端一致
2.创建MainActivity进行测试

布局文件如下

<?xml version="1.0" encoding="utf-8"?>
<LinearLayout xmlns:android="http://schemas.android.com/apk/res/android"
    xmlns:tools="http://schemas.android.com/tools"
    android:layout_width="match_parent"
    android:layout_height="match_parent"
    android:orientation="vertical"
    tools:context=".MainActivity">

    <Button
        android:id="@+id/btn_book_list"
        android:layout_width="wrap_content"
        android:layout_height="wrap_content"
        android:text="书籍列表" />

    <Button
        android:id="@+id/btn_add_book_inout"
        android:layout_width="wrap_content"
        android:layout_height="wrap_content"
        android:text="添加书籍inout" />

    <Button
        android:id="@+id/btn_add_book_in"
        android:layout_width="wrap_content"
        android:layout_height="wrap_content"
        android:text="添加书籍in" />

    <Button
        android:id="@+id/btn_add_book_out"
        android:layout_width="wrap_content"
        android:layout_height="wrap_content"
        android:text="添加书籍out" />

</LinearLayout>

MainActivity代码如下

public class MainActivity extends AppCompatActivity {

    private static final String TAG = "MainActivity";

    private BookControl bookControl;

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

        bindService();

        findViewById(R.id.btn_book_list).setOnClickListener(new View.OnClickListener() {
            @Override
            public void onClick(View v) {
                try {
                    List<Book> bookList = bookControl.getBookList();
                    Log.d(TAG, "bookList: " + bookList.toString());
                } catch (RemoteException e) {
                    e.printStackTrace();
                }

            }
        });

        findViewById(R.id.btn_add_book_inout).setOnClickListener(new View.OnClickListener() {
            @Override
            public void onClick(View v) {
                try {
                    Book book = new Book("三国inout");
                    bookControl.addBookInOut(book);
                    Log.d(TAG, "bookList: " + book.getName());
                } catch (RemoteException e) {
                    e.printStackTrace();
                }

            }
        });

        findViewById(R.id.btn_add_book_in).setOnClickListener(new View.OnClickListener() {
            @Override
            public void onClick(View v) {
                try {
                    Book book = new Book("三国in");
                    bookControl.addBookIn(book);
                    Log.d(TAG, "bookList: " + book.getName());
                } catch (RemoteException e) {
                    e.printStackTrace();
                }

            }
        });

        findViewById(R.id.btn_add_book_out).setOnClickListener(new View.OnClickListener() {
            @Override
            public void onClick(View v) {
                try {
                    Book book = new Book("三国out");
                    bookControl.addBookOut(book);
                    Log.d(TAG, "bookList: " + book.getName());
                } catch (RemoteException e) {
                    e.printStackTrace();
                }

            }
        });
    }

    private void bindService() {
        Intent intent = new Intent();
        intent.setComponent(new ComponentName("com.lbq.aidlservertest", "com.lbq.aidlservertest.AidlService"));
        bindService(intent, connection, Context.BIND_AUTO_CREATE);
    }

    private ServiceConnection connection = new ServiceConnection() {
        @Override
        public void onServiceConnected(ComponentName name, IBinder service) {
            Log.d(TAG, "onServiceConnected: ");
            bookControl = BookControl.Stub.asInterface(service);
        }

        @Override
        public void onServiceDisconnected(ComponentName name) {
            Log.d(TAG, "onServiceDisconnected: ");
            bookControl = null;
        }
    };

    @Override
    protected void onDestroy() {
        super.onDestroy();
        unbindService(connection);
    }

}

安装服务端和客户端apk

依次点击获取booklist按钮-inout添加按钮-in添加按钮-out添加按钮-获取booklist按钮

客户端打印如下:

com.lbq.aidlclienttest D/MainActivity: bookList: [Book{name='活着'}, Book{name='或者'}, Book{name='叶应是叶'}]
com.lbq.aidlclienttest D/MainActivity: bookList: 服务器改了新书的名字 InOut
com.lbq.aidlclienttest D/MainActivity: bookList: 三国in
com.lbq.aidlclienttest D/MainActivity: bookList: 服务器改了新书的名字 Out
com.lbq.aidlclienttest D/MainActivity: bookList: [Book{name='活着'}, Book{name='或者'}, Book{name='叶应是叶'}, Book{name='服务器改了新书的名字 InOut'}, Book{name='服务器改了新书的名字 In'}, Book{name='服务器改了新书的名字 Out'}]

服务端打印如下:

com.lbq.aidlservertest E/Server: 接收到了一个对象 InOut 三国inout
com.lbq.aidlservertest E/Server: 接收到了一个对象 In 三国in
com.lbq.aidlservertest E/Server: 接收到了一个对象 Out null

可以看到

inout形式服务端和客户端对象都会对应修改

in形式客户端的对象并没有改变,还是三国in

out形式服务端收到一个空对象,服务端改变后,客户端的对象也随之改变了

本文地址:https://blog.csdn.net/lbqcsdn/article/details/107461784

相关标签: Android