AIDL是Android中IPC(Inter-Progress Communication)方式中的一种,AIDL是Android Interface Definition Language(安卓接口定义语言)的缩写。
其主要作用是用于进程间的通信,在Android系统中,每个进程都运行在一块独立的内存中,在其中完成自己的各项活动,与其他进程都分隔开来。可是有时候我们又有应用间进行互动的需求,比较传递数据或者任务委托等,AIDL就是为了满足这种需求而诞生的。通过AIDL,可以在一个进程中获取另一个进程的数据和调用其暴露出来的方法,从而满足进程间通信的需求。
1、支持的数据类型:
2、AIDL文件分类
AIDL文件可以分为两类,一类用来声明实现了Parcelable接口的数据类型,以供其他AIDL文件使用那些非默认支持的数据类型。还有一类是用来定义接口方法,声明要暴露哪些接口给客户端调用,定向Tag就是用来标注这些方法的参数值。
3、定向Tag
定向Tag表示在跨进程通信中数据的流向,用于标注方法的参数值,分为 in、out、inout 三种。其中:
in 表示数据只能由客户端流向服务端;
out 表示数据只能由服务端流向客户端;
inout 则表示数据可在服务端与客户端之间双向流通。
此外,如果AIDL方法接口的参数值类型是:基本数据类型、String、CharSequence或者其他AIDL文件定义的方法接口,那么这些参数值的定向 Tag 默认是且只能是 in,所以除了这些类型外,其他参数值都需要明确标注使用哪种定向Tag。
4、明确导包
在AIDL文件中需要明确标明引用到的数据类型所在的包名,即使两个文件处在同个包名下。
分别创建两个工程,一个服务端工程,一个客户端工程,客户端绑定服务端提供的Service,然后调用AIDL提供的接口实现从服务端获取数据、向服务端添加数据。
1、服务端工程(AIDLServer)
(1)创建Book.aidl文件
在Android studio工程里,选中工程app目录,右键,New->AIDL->AIDL File,AS会自动帮我们创建好所需aidl文件以及路径文件夹。
(2)创建Book.java类,注意Book.java类需要和Book.aidl的包名一致,但是不可在同一路径文件夹下。
Book.java类内容:
package com.cwang.aidlserver;
import android.os.Parcel;
import android.os.Parcelable;
/**
* @author: cwang Interjoy
* @time: 2020/7/14 18:00
* @Description:Book实例类,实现Parcelable序列化
*/
public class Book implements Parcelable {
private String bookName;
public Book(String bookName) {
this.bookName = bookName;
}
public String getBookName() {
return bookName;
}
public void setBookName(String bookName) {
this.bookName = bookName;
}
@Override
public String toString() {
return "Books{" +
"bookName='" + bookName + '\'' +
'}';
}
protected Book(Parcel in) {
bookName = in.readString();
}
public static final Creator CREATOR = new Creator() {
@Override
public Book createFromParcel(Parcel in) {
return new Book(in);
}
@Override
public Book[] newArray(int size) {
return new Book[size];
}
};
@Override
public int describeContents() {
return 0;
}
@Override
public void writeToParcel(Parcel parcel, int i) {
parcel.writeString(bookName);
}
public void readFromParcel(Parcel parcel) {
bookName = parcel.readString();
}
}
(3)修改Book.aidl文件内容
将Book.aidl声明为parcelable类型,并且需要注意的是,原先默认的interface接口需要去掉,否则编译会报错。
// Book.aidl
package com.cwang.aidlserver;
// Declare any non-default types here with import statements
//interface Book {
// /**
// * Demonstrates some basic types that you can use as parameters
// * and return values in AIDL.
// */
// void basicTypes(int anInt, long aLong, boolean aBoolean, float aFloat,
// double aDouble, String aString);
//}
parcelable Book;
(4)定义暴露给客户端调用的接口
在Book.aidl文件所在目录下创建接口aidl文件BookManager.aidl,声明调用接口(获取书籍列表,添加书籍)
BookManager.aidl内容:
// BookManager.aidl
package com.cwang.aidlserver;
import com.cwang.aidlserver.Book;
// Declare any non-default types here with import statements
interface BookManager {
// 获取书籍列表
List getBookList();
// 添加书籍
void addBook(inout Book book);
}
接下来编译代码,Make project,便可看到aidl编译成代码文件,有时候需要clean一下工程。
这个文件才是真正需要的
(5)创建服务端Service,供客户端绑定
onBind方法返回的是BookManager.Stub对象,实现里面的两个方法,客户端拿到这个对象后就可以与服务端通讯了。
package com.cwang.aidlserver;
import android.app.Service;
import android.content.Intent;
import android.content.ServiceConnection;
import android.os.IBinder;
import android.os.RemoteException;
import android.util.Log;
import java.util.ArrayList;
import java.util.List;
/**
* @author: cwang Interjoy
* @time: 2020/7/14 18:13
* @Description:服务端Service,供客户端绑定
*/
public class BookService extends Service {
private final String Tag = BookService.class.getSimpleName();
private List bookList;
@Override
public void onCreate() {
super.onCreate();
bookList = new ArrayList<>();
for (int i = 0; i < 5; i++) {
Book book = new Book("第" + i + "本书");
bookList.add(book);
}
}
@Override
public IBinder onBind(Intent intent) {
Log.d(Tag, "onBind()");
return bookManager;
}
@Override
public void unbindService(ServiceConnection conn) {
Log.d(Tag, "unbindService()");
super.unbindService(conn);
}
private BookManager.Stub bookManager = new BookManager.Stub() {
@Override
public List getBookList() throws RemoteException {
Log.i(Tag, "getBookList()");
return bookList;
}
@Override
public void addBook(Book book) throws RemoteException {
Log.i(Tag, "addBook()");
if (bookList != null) {
bookList.add(book);
}
Log.i(Tag, "Book:" + book.toString());
}
};
@Override
public void onDestroy() {
Log.d(Tag, "onDestroy()");
super.onDestroy();
}
}
(6)注册Service,修改配置文件AndroidManifest.xml
到此服务端代码已完成,接下来看客户端代码~
2、客户端工程(AIDLClient)
(1)拷贝aidl文件和Book.java类到客户端工程目录
将aidl文件与Book.class拷贝到客户端的工程,注意他们的目录需要与服务端的一样,也就是说aidl与Book.class包名要与服务端的一样。然后Make project,便可看到aidl编译成代码文件,有时候需要clean一下工程。
(2)编写绑定服务端Service代码,以及调用aidl定义的接口实现客户端与服务端的通信
package com.cwang.aidlclient;
import android.content.ComponentName;
import android.content.Context;
import android.content.Intent;
import android.content.ServiceConnection;
import android.os.IBinder;
import android.os.RemoteException;
import android.support.v7.app.AppCompatActivity;
import android.os.Bundle;
import android.util.Log;
import android.view.View;
import android.widget.Button;
import com.cwang.aidlserver.Book;
import com.cwang.aidlserver.BookManager;
import java.util.List;
public class MainActivity extends AppCompatActivity implements View.OnClickListener {
private final String Tag = "AIDL_Client";
private Button btn_bindServer, btn_getBookList, btn_addBook, btn_unbind;
private BookManager bookManager;
private final String SERVICE_PACKNAME = "com.cwang.aidlserver";
private final String SERVICE_ACTION = "android.intent.action.BookService";
@Override
protected void onCreate(Bundle savedInstanceState) {
super.onCreate(savedInstanceState);
setContentView(R.layout.activity_main);
initView();
}
private void initView() {
btn_bindServer = findViewById(R.id.btn_bindServer);
btn_getBookList = findViewById(R.id.btn_getBookList);
btn_addBook = findViewById(R.id.btn_addBook);
btn_unbind = findViewById(R.id.btn_unbind);
btn_bindServer.setOnClickListener(this);
btn_getBookList.setOnClickListener(this);
btn_addBook.setOnClickListener(this);
btn_unbind.setOnClickListener(this);
}
@Override
public void onClick(View view) {
switch (view.getId()) {
case R.id.btn_bindServer: // 绑定服务
Intent intent = new Intent();
// 注意在 Android 5.0以后,不能通过隐式 Intent 启动 service,必须制定包名
intent.setPackage(SERVICE_PACKNAME);
intent.setAction(SERVICE_ACTION);
bindService(intent, serviceConnection, Context.BIND_AUTO_CREATE);
break;
case R.id.btn_getBookList: // 获取书籍列表
if (bookManager != null) {
try {
List bookList = bookManager.getBookList();
for (Book book : bookList){
Log.i(Tag, "Book = " + book.toString());
}
} catch (RemoteException e) {
e.printStackTrace();
}
}
break;
case R.id.btn_addBook: // 向服务器添加书籍
Book book = new Book("新添加的书籍");
if (bookManager != null) {
try {
bookManager.addBook(book);
Log.i(Tag, "添加一本书籍");
} catch (RemoteException e) {
e.printStackTrace();
}
}
break;
case R.id.btn_unbind:
unbindService(serviceConnection);
break;
}
}
private ServiceConnection serviceConnection = new ServiceConnection() {
@Override
public void onServiceConnected(ComponentName componentName, IBinder iBinder) {
Log.i(Tag, "onServiceConnected()");
bookManager = BookManager.Stub.asInterface(iBinder);
}
@Override
public void onServiceDisconnected(ComponentName componentName) {
Log.i(Tag, "onServiceDisconnected()");
bookManager = null;
}
};
@Override
protected void onDestroy() {
super.onDestroy();
}
}
测试:
资源下载:AIDLServer AIDLClient