AIDL使用和语法详解

前言

AIDL（Android Interface Definition Language，Android接口定义语言）是用于定义服务器和客户端通信接口的一种描述语言，可以拿来生成用于IPC的代码。

从某种意义上说AIDL其实是一个模板，因为在使用过程中，实际起作用的并不是AIDL文件，而是据此而生成的一个IInterface的实例代码，AIDL其实是为了避免我们重复编写代码而出现的一个模板。

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

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

一、语法

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

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

二、案例

interface IMyAidlInterface {
    /**
     * Demonstrates some basic types that you can use as parameters
     * and return values in AIDL.
     */
    int getProgress();	//用于获取进度值

    void control(boolean pause); //用于控制进度的 暂停、开始
}

//服务端关键代码
public class MyBinder extends com.hdib.service.IMyAidlInterface.Stub {
    private int progress;
    private boolean isRunning;

    @Override
    public int getProgress() throws RemoteException {
        return progress;
    }

    @Override
    public void control(boolean pause) throws RemoteException {
        isRunning = !pause;
        if (pause) {
            return;
        }
        new Thread(new Runnable() {
            @Override
            public void run() {
                while (isRunning) {
                    SystemClock.sleep(1000);
                    progress++;
                }
            }
        }).start();
    }
}

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

//客户端关键代码
private ServiceConnection scnn = new ServiceConnection() {
	final com.hdib.service.IMyAidlInterface iMyAidlInterface;
    @Override
    public void onServiceConnected(ComponentName name, IBinder service) {
        isBind = true;
        Log.d("MyService", "MainActivity onServiceConnected: " + name.getClassName());
        if (service == null || !(service instanceof MyService.MyBinder)) {
            return;
        }
        try {
            iMyAidlInterface = com.hdib.service.IMyAidlInterface.Stub.asInterface(service);
            iMyAidlInterface.control(false);

            new Thread(new Runnable() {
                @Override
                public void run() {
                    while (isBind) {
                        try {
                            SystemClock.sleep(1000);
                            Log.d("MyService", "MainActivity progress: " + iMyAidlInterface.getProgress());
                        } catch (RemoteException e) {
                            e.printStackTrace();
                        }
                    }
                }
            }).start();
        } catch (RemoteException e) {
            e.printStackTrace();
        }
    }

	/**
     * 异常情况下，服务被杀死时才会调用该方法，主动解绑不会调该方法
     * @param name
     */
    @Override
    public void onServiceDisconnected(ComponentName name) {
		try {
            isBind = false;
            iMyAidlInterface.control(true);
        } catch (RemoteException e) {
            e.printStackTrace();
        }        
    }
};

private void bindServiceWrapper() {
    bindService(new Intent(this, MyService.class), scnn, Context.BIND_AUTO_CREATE);
}

private void unbindServiceWrapper() {
    scnn.onServiceDisconnected(null);
    unbindService(scnn);
}

三、接口中传递Parcelable数据

以下代码为服务端和客户端的公用代码，如果服务端和客户端在不同工程中，需要拷贝两份，放在相同目录下。

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
package com.czy.server;

parcelable Book;

//BookController.aidl
package com.czy.server;
import com.czy.server.Book;

interface BookController {

    List<Book> getBookList();

    void addBookInOut(inout Book book);

    void addBookIn(in Book book);

    void addBookOut(out Book book);

}

附：参考

官方文档
leavesC 简书
SDK源码