個(gè)人學(xué)習(xí)筆記~
在學(xué)習(xí)AIDL前穿铆,可以先學(xué)習(xí)一下[Android跨進(jìn)程通信]
目錄:
一丹壕、概述
- Binder機(jī)制淺析
- AIDL簡(jiǎn)介
二径密、AIDL實(shí)現(xiàn)簡(jiǎn)單的進(jìn)程間通信 - 創(chuàng)建.aidl文件
AIDL源碼分析 - 實(shí)現(xiàn)接口
- 向客戶端公開接口
一、概述
- Binder機(jī)制淺析
Binder通信采用C/S架構(gòu),從組件視角來(lái)說(shuō)死陆,由Client待牵、Server其屏、ServiceManager 以及 Binder 驅(qū)動(dòng)構(gòu)成,其中 ServiceManager 用于管理系統(tǒng)中的各種服務(wù)缨该。Binder通信的大概調(diào)用流程如下:
- Client發(fā)起請(qǐng)求(Blocking)偎行,拿到服務(wù)端的Proxy(代理接口),調(diào)用Proxy中的方法贰拿;
- Proxy的方法會(huì)將Client傳遞的參數(shù)打包為Parcel對(duì)象蛤袒,然后Proxy把該P(yáng)arcel對(duì)象發(fā)送給內(nèi)核中的Binder Driver;
- Server讀取Binder Driver中的請(qǐng)求數(shù)據(jù)膨更,將發(fā)送給自己的請(qǐng)求數(shù)據(jù)解包妙真,處理后返回結(jié)果;
- Proxy拿到結(jié)果返回給Client询一。
Proxy中定義的方法和Server中定義的方法是一一對(duì)應(yīng)的隐孽,整個(gè)調(diào)用過(guò)程是同步的,Server在處理時(shí)健蕊,Client處于Blocking菱阵。而AIDL就是Proxy的接口定義語(yǔ)言。
- AIDL簡(jiǎn)介
AIDL (Android Interface Definition Language) 是一種接口定義語(yǔ)言缩功∏缂埃可以利用它定義Client與Server(兩個(gè)進(jìn)程)均認(rèn)可的接口,以便二者進(jìn)行進(jìn)程間通信(IPC)嫡锌。在 Android 中虑稼,一個(gè)進(jìn)程通常無(wú)法訪問(wèn)另一個(gè)進(jìn)程的數(shù)據(jù)。因此势木,為進(jìn)行通信蛛倦,進(jìn)程需將其對(duì)象分解成可供操作系統(tǒng)理解的原語(yǔ),并將其編組為可操作的對(duì)象啦桌。編寫執(zhí)行該編組操作的代碼較為繁瑣溯壶,因此 Android通過(guò)AIDL 處理此問(wèn)題及皂。簡(jiǎn)單來(lái)說(shuō),就是Android為了簡(jiǎn)化應(yīng)用層進(jìn)行IPC操作且改,提供了AIDL验烧。
AIDL并非真正的編程語(yǔ)言,只是定義兩個(gè)進(jìn)程間通信的接口而已又跛。而符合通信協(xié)議的Java代碼則是由Android SDK的aidl工具生成碍拆,生成的java文件與aidl文件同名,在build/generated目錄下慨蓝。在該生成的接口中包含一個(gè)Stub的內(nèi)部類感混,Stub實(shí)現(xiàn)了IBinder接口和自定義的通信接口,所以可以作為Service的onBind()方法的返回值菌仁。
二浩习、AIDL實(shí)現(xiàn)簡(jiǎn)單的進(jìn)程間通信
具體步驟:
- 創(chuàng)建.aidl文件
- 自定義Serice,實(shí)現(xiàn)stub济丘,作為onBind()方法的返回值:Android SDK工具根據(jù).aidl文件以Java編程語(yǔ)言生成一個(gè)接口 谱秽。這個(gè)接口有一個(gè)Stub的內(nèi)部抽象類,它繼承了Binder并實(shí)現(xiàn)了AIDL接口中的方法摹迷。必須繼承這個(gè) Stub類并實(shí)現(xiàn)這些方法疟赊。
- 客戶端綁定Service,并實(shí)現(xiàn)ServiceConnection接口:和本地Service不同峡碉,綁定遠(yuǎn)程Service的ServiceConnection并不能直接獲取Service的onBind( )方法返回的IBinder對(duì)象近哟,只能返回onBind( )方法所返回的代理對(duì)象,需要調(diào)用Stub.asInterface()鲫寄。
注意事項(xiàng):
1. 默認(rèn)情況下吉执,AIDL支持以下數(shù)據(jù)類型:
- Java中的基本類型(int,long地来,char戳玫,boolean,float未斑,double咕宿,byte,short)
- String
- CharSequence
- List
List中的所有元素都必須是以上支持的數(shù)據(jù)類型之一蜡秽,或者是您聲明的其他AIDL生成的接口或可接受的元素之一府阀。 列表可以選擇性地用作“通用”類(例如List)。對(duì)方收到的實(shí)際具體類始終是一個(gè)ArrayList芽突,盡管生成的方法是使用List接口试浙。 - Map
Map中的所有元素都必須是此列表中受支持的數(shù)據(jù)類型之一,或者是您聲明的其他AIDL生成的接口或可接受元素之一寞蚌。 通用映射(如Map形式的映射)不被支持田巴。對(duì)方接收的實(shí)際具體類總是一個(gè)HashMap力细,盡管該方法是使用Map接口生成的。
對(duì)于上面沒(méi)有列出的每種附加類型固额,即使它們?cè)谂c接口相同的包中定義,也必須包含一條import語(yǔ)句煞聪。
2. 在定義AIDL接口時(shí)斗躏,注意:
- 方法可以采用零個(gè)或多個(gè)參數(shù),并返回一個(gè)值或void昔脯。
- 所有非原始參數(shù)都需要一個(gè)指向數(shù)據(jù)的方向標(biāo)簽啄糙。in,out或者inout云稚∷肀基本數(shù)據(jù)默認(rèn)是in的,不能以其他方式静陈。
警告:應(yīng)該將方向限制在真正需要的地方燕雁,因?yàn)榫幗M參數(shù)非常昂貴。 - 包含在.aidl文件中的所有代碼注釋都包含在生成的IBinder接口中(導(dǎo)入和包裝語(yǔ)句之前的注釋除外)鲸拥。
- 只支持方法拐格,不能在AIDL中公開靜態(tài)字段。
具體實(shí)現(xiàn)如下:
-
創(chuàng)建.aidl文件
在java同級(jí)目錄下創(chuàng)建一個(gè)aidl的文件夾刑赶,并在該文件夾中新建一個(gè)aidl文件(new->AIDL->AIDL File)捏浊,通常aidl接口文件以“I”起頭命名:
在AIDL中添加需要的方法:
interface IRemoteService {
void setPause(String pause);
void setPlay(String play);
}
AIDL 文件定義好了。在Android Studio中點(diǎn)擊Make build進(jìn)行build撞叨,build結(jié)束后會(huì)在 build 目錄下生成與AIDL文件同名的java文件:
AIDL源碼分析
對(duì)比下圖理解更有助于理解源碼:
- 在文件開頭就有注釋金踪,該文件是自動(dòng)生成的,不要修改牵敷。所以如果要為跨進(jìn)程通信添加新的方法胡岔,只需要在IRemoteService.aidl文件中添加再build即可。
/*
* This file is auto-generated. DO NOT MODIFY.
*/
package com.wanda.musicplayer;
// Declare any non-default types here with import statements
- IInterface:IRemoteService繼承自IInterface劣领,所有Binder通信的接口必須繼承IInterface接口
public interface IRemoteService extends android.os.IInterface {
/**
* Default implementation for IRemoteService.
*/
public static class Default implements com.wanda.musicplayer.IRemoteService {
@Override
public void setPause(java.lang.String pause) throws android.os.RemoteException {
}
@Override
public void setPlay(java.lang.String play) throws android.os.RemoteException {
}
@Override
public android.os.IBinder asBinder() {
return null;
}
}
... ...
- Stub繼承了Binder類并實(shí)現(xiàn)了IRemoteService姐军。而學(xué)過(guò)activity與service通信的都知道,在Service中的onBind方法會(huì)返回一個(gè)Binder對(duì)象尖淘,而Stub繼承了Binder奕锌,又是一個(gè)抽象類,所以Stub可以作為我們跨進(jìn)程通信時(shí)村生,服務(wù)端自定義Binder的父類惊暴。
public static abstract class Stub extends android.os.Binder implements com.wanda.musicplayer.IRemoteService {
- DESCRIPTOR:Binder的唯一標(biāo)識(shí),通常是包名+接口名組成的字符串
private static final java.lang.String DESCRIPTOR = "com.wanda.musicplayer.IRemoteService";
- asInterface:asInterface將服務(wù)端Binder轉(zhuǎn)換為客戶端所需的AIDL接口類型對(duì)象趁桃。在方法中首先會(huì)調(diào)用queryLocalInterface(DESCRIPTOR)辽话,參數(shù)是binder的唯一標(biāo)識(shí)肄鸽,用來(lái)查詢本地接口。如果能查詢到本地接口IRemoteService(客戶端和服務(wù)端處于同一進(jìn)程)油啤,就返回本地接口典徘,不跨進(jìn)程通信。如果查詢不到本地接口益咬,就構(gòu)造Proxy代理對(duì)象并返回逮诲,通過(guò)代理對(duì)象可以跨進(jìn)程通信。
public static com.wanda.musicplayer.IRemoteService asInterface(android.os.IBinder obj) {
if ((obj == null)) {
return null;
}
android.os.IInterface iin = obj.queryLocalInterface(DESCRIPTOR);
// 5.1\. 如果能查詢到本地接口IRemoteService幽告,就返回本地接口梅鹦,不跨進(jìn)程通信。
if (((iin != null) && (iin instanceof com.wanda.musicplayer.IRemoteService))) {
return ((com.wanda.musicplayer.IRemoteService) iin);
}
// 5.2\. 如果查詢不到本地接口冗锁,就返回代理對(duì)象齐唆,通過(guò)代理對(duì)象可以跨進(jìn)程通信。
return new com.wanda.musicplayer.IRemoteService.Stub.Proxy(obj);
}
- asBinder():用于返回當(dāng)前Binder對(duì)象
//6\. asBinder()用于返回當(dāng)前Binder對(duì)象
@Override
public android.os.IBinder asBinder() {
return this;
}
Proxy代理類:構(gòu)造Proxy時(shí)冻河,把服務(wù)端的Binder對(duì)象賦值給mRemote箍邮,Proxy中實(shí)現(xiàn)了自定義方法:setPause和setPlay ,通過(guò)調(diào)用mRemote的transact方法叨叙,最后走到Stub的onTransact媒殉,完成對(duì)服務(wù)端Binder的調(diào)用。
onTransact與transact
(1)每個(gè)AIDL中定義的方法都有一個(gè)int code來(lái)標(biāo)識(shí):
static final int TRANSACTION_setPause = (android.os.IBinder.FIRST_CALL_TRANSACTION + 0);
static final int TRANSACTION_setPlay = (android.os.IBinder.FIRST_CALL_TRANSACTION + 1);
(2)Proxy中實(shí)現(xiàn)了setPause和setPlay摔敛,其中分別調(diào)用了mRemote.transact()方法廷蓉,transact的第一個(gè)參數(shù)code是每個(gè)方法的唯一標(biāo)識(shí)÷黻迹客戶端遠(yuǎn)程請(qǐng)求Binder并寫入?yún)?shù)桃犬,通過(guò)transact傳入服務(wù)端。
private static class Proxy implements com.wanda.musicplayer.IRemoteService {
private android.os.IBinder mRemote;
Proxy(android.os.IBinder remote) {
mRemote = remote;
}
@Override
public android.os.IBinder asBinder() {
return mRemote;
}
public java.lang.String getInterfaceDescriptor() {
return DESCRIPTOR;
}
@Override
public void setPause(java.lang.String pause) throws android.os.RemoteException {
android.os.Parcel _data = android.os.Parcel.obtain();
android.os.Parcel _reply = android.os.Parcel.obtain();
try {
_data.writeInterfaceToken(DESCRIPTOR);
_data.writeString(pause);
boolean _status = mRemote.transact(Stub.TRANSACTION_setPause, _data, _reply, 0);
if (!_status && getDefaultImpl() != null) {
getDefaultImpl().setPause(pause);
return;
}
_reply.readException();
} finally {
_reply.recycle();
_data.recycle();
}
}
@Override
public void setPlay(java.lang.String play) throws android.os.RemoteException {
android.os.Parcel _data = android.os.Parcel.obtain();
android.os.Parcel _reply = android.os.Parcel.obtain();
try {
_data.writeInterfaceToken(DESCRIPTOR);
_data.writeString(play);
boolean _status = mRemote.transact(Stub.TRANSACTION_setPlay, _data, _reply, 0);
if (!_status && getDefaultImpl() != null) {
getDefaultImpl().setPlay(play);
return;
}
_reply.readException();
} finally {
_reply.recycle();
_data.recycle();
}
}
public static com.wanda.musicplayer.IRemoteService sDefaultImpl;
}
(3)onTransact運(yùn)行在服務(wù)端的Binder線程池中行楞,當(dāng)客戶端發(fā)起跨進(jìn)程請(qǐng)求時(shí)攒暇,請(qǐng)求會(huì)通過(guò)底層封裝后,交由onTransact處理子房,服務(wù)端通過(guò)code來(lái)判斷客戶端請(qǐng)求的方法是什么形用,接著從data取出目標(biāo)方法需要的參數(shù)(如果目標(biāo)方法有參數(shù)的話),然后執(zhí)行目標(biāo)方法证杭,執(zhí)行完之后就向reply中寫入返回值(如果目標(biāo)方法有返回值的話)田度,這就是這個(gè)方法的執(zhí)行過(guò)程,如果此方法返回false解愤,那么客戶端請(qǐng)求失敗镇饺。
@Override
public boolean onTransact(int code, android.os.Parcel data, android.os.Parcel reply, int flags) throws android.os.RemoteException {
java.lang.String descriptor = DESCRIPTOR;
switch (code) {
case INTERFACE_TRANSACTION: {
reply.writeString(descriptor);
return true;
}
case TRANSACTION_setPause: {
data.enforceInterface(descriptor);
java.lang.String _arg0;
_arg0 = data.readString();
this.setPause(_arg0);
reply.writeNoException();
return true;
}
case TRANSACTION_setPlay: {
data.enforceInterface(descriptor);
java.lang.String _arg0;
_arg0 = data.readString();
this.setPlay(_arg0);
reply.writeNoException();
return true;
}
default: {
return super.onTransact(code, data, reply, flags);
}
}
}
所以,aidl通信體現(xiàn)著代理模式的設(shè)計(jì)思想送讲,RemoteService具體實(shí)現(xiàn)了Stub奸笤,Proxy是Stub在本地的Client代理對(duì)象惋啃,Proxy與Stub依靠transact和onTransact通信,Proxy與Stub的封裝設(shè)計(jì)最終很方便地完成了客戶端與服務(wù)端的跨進(jìn)程通信
-
實(shí)現(xiàn)接口
和本地service通信同理监右,需要一個(gè)Binder對(duì)象來(lái)進(jìn)行通信边灭。而IRemoteService.aidl build生成的IRemoteService.java中的抽象類Stub剛好繼承Binder類并實(shí)現(xiàn)了IRemoteService接口,所以谷歌都已經(jīng)幫你生成好了健盒,咱們直接用唄:
private final IRemoteService.Stub mBinder = new IRemoteService.Stub() {
@Override
public void setPause(String pause) throws RemoteException {
Log.d(TAG, "setPause: ");
}
@Override
public void setPlay(String play) throws RemoteException {
Log.d(TAG, "setPlay: ");
}
};
在實(shí)現(xiàn) AIDL 接口時(shí)存筏,您應(yīng)注意遵守以下規(guī)則:
- 由于無(wú)法保證在主線程上執(zhí)行傳入調(diào)用,因此您一開始便需做好多線程處理的準(zhǔn)備味榛,并對(duì)您的服務(wù)進(jìn)行適當(dāng)構(gòu)建,使其達(dá)到線程安全的標(biāo)準(zhǔn)娇斑。
- 默認(rèn)情況下触徐,RPC 調(diào)用是同步調(diào)用芬探。如果您知道服務(wù)完成請(qǐng)求的時(shí)間不止幾毫秒,則不應(yīng)從 Activity 的主線程調(diào)用該服務(wù)频轿,因?yàn)檫@可能會(huì)導(dǎo)致ANR— 通常,您應(yīng)從客戶端內(nèi)的單獨(dú)線程調(diào)用服務(wù)烁焙。
- 您引發(fā)的任何異常都不會(huì)回傳給調(diào)用方航邢。
-
向客戶端公開接口
(1)繼承Service并實(shí)現(xiàn)onBind(),return步驟2的Stub實(shí)例mBinder:
public class RemoteService extends Service {
private static final String TAG = "RemoteService";
@Override
public void onCreate() {
super.onCreate();
}
@Override
public IBinder onBind(Intent intent) {
// Return the interface
return mBinder;
}
private final IRemoteService.Stub mBinder = new IRemoteService.Stub() {
@Override
public void setPause(String pause) throws RemoteException {
Log.d(TAG, "setPause: ");
}
@Override
public void setPlay(String play) throws RemoteException {
Log.d(TAG, "setPlay: ");
}
};
}
(2)將服務(wù)端的aidl文件及目錄一起拷貝到客戶端同級(jí)目錄:
客戶端需要有IRemoteService訪問(wèn)權(quán)限骄蝇,因此如果Client與Service是跨進(jìn)程的膳殷,則Client的同級(jí)目錄也必須包含相同的aidl文件。
(3)客戶端創(chuàng)建ServiceConnection對(duì)象九火,并bindService()赚窃,此時(shí)客戶端onServiceConnected() 回調(diào)會(huì)接受到服務(wù)端onBind() 方法所返回的 binder 實(shí)例,注意這里用到了上文說(shuō)的asInterface哦:
private IRemoteService mRemoteService;
private ServiceConnection mRemoteConn = new ServiceConnection() {
@Override
public void onServiceConnected(ComponentName name, IBinder service) {
Log.i(TAG, "RemoteService-onServiceConnected");
mRemoteService = IRemoteService.Stub.asInterface(service);
}
@Override
public void onServiceDisconnected(ComponentName name) {
Log.i(TAG, "RemoteService-onServiceDisconnected");
}
};