AIDL(Android Interface Definition Language)姨伟,即Android接口定義語言
Android系統(tǒng)中的進程之間不能共享內(nèi)存,因此豆励,需要提供一些機制在不同進程之間進行數(shù)據(jù)通信(即IPC夺荒,Inter-Process Communication進程間通信),Binder就是Android中最具特色的IPC方式良蒸,AIDL其實就是通過Binder實現(xiàn)的般堆。
以下通過具體示例說明aidl的使用,支持多個回調(diào)和傳遞自定義對象
建立AIDL服務要比建立普通的服務復雜一些诚啃,具體步驟如下:
(1)在studio工程的src/main目錄中建立一個名為aidl的文件夾淮摔,然后在該文件夾中創(chuàng)建.aidl文件,aidl文件的語法類似于Java代碼始赎,但會稍有不同和橙。
默認情況下,AIDL 支持下列數(shù)據(jù)類型:
- Java 編程語言中的所有原語類型(如
int
造垛、long
魔招、char
、boolean
等等) -
String
、CharSequence
-
List
:只支持ArrayList,里面的每個元素都必須被AIDL支持含友。 -
map
:只支持HashMap幌甘, 里面的每個元素都必須被AIDL支持 -
Parcelable
: 所有實現(xiàn)了Parcelable接口的對象 -
AIDL
: 所有的AIDL接口本身也可以在AIDL文件中使用
您必須為以上未列出的每個附加類型加入一個 import 語句蔚万,即使這些類型是在與您的接口相同的軟件包中定義。示例如下:
package com.demo.sdk.policy;
import com.demo.sdk.policy.callback.IMemoryClearCallback;
import com.demo.sdk.policy.callback.IMemoryScanCallback;
interface IRemoteService {
/**
* 內(nèi)存掃描
*/
void memoryScan(IMemoryScanCallback iMemoryScanCallback);
/**
* 內(nèi)存掃描
*/
void memoryClear(IMemoryClearCallback iMemoryClearCallback);
}
package com.demo.sdk.policy.callback;
import com.demo.sdk.model.AppPackageInfo;
import java.util.List;
//內(nèi)存清理回調(diào)
oneway interface IMemoryClearCallback {
/**
* 處理中
* @param progress 當前進度
* @param max 總進度值
* @param item 當前kill項
*/
void onUpdate(int progress, int max, String item);
/**
* 處理完成
*/
void onResult();
}
package com.demo.sdk.policy.callback;
import com.demo.sdk.model.AppPackageInfo;
import java.util.List;
// 內(nèi)存掃描回調(diào)
oneway interface IMemoryScanCallback {
/**
* 掃描引擎準備就緒
*/
void onReady();
/**
* 掃描中
* @param progress 當前進度
* @param max 總進度值
* @param item 當前掃描項
*/
void onUpdate(int progress, int max, String item);
/**
* 掃描結(jié)果
* @param isCancled 是否主動取消
* @param selectedSize 默認選擇占用的內(nèi)存的大小(單位B)
* @param size 共掃描出占用內(nèi)存的大小(單位B)
* @param result 掃描結(jié)果詳情
*/
void onResult(boolean isCancled, long selectedSize, long size, in List<AppPackageInfo> result);
}
注:若接口聲明語句中使用了oneway關鍵字蠕蚜,則該接口中聲明的所有方法都采用了oneway方式。oneway 關鍵字用于修改遠程調(diào)用的行為悔橄。使用該關鍵字時靶累,遠程調(diào)用不會阻塞;它只是發(fā)送事務數(shù)據(jù)并立即返回癣疟。接口的實現(xiàn)最終接收此調(diào)用時挣柬,是以正常遠程調(diào)用形式將其作為來自 Binder 線程池的常規(guī)調(diào)用進行接收。 如果 oneway 用于本地調(diào)用睛挚,則不會有任何影響邪蛔,調(diào)用仍是同步調(diào)用。
(2)如果aidl文件的內(nèi)容是正確的竞川,Android SDK 工具基于您的 .aidl
文件店溢,使用 Java 編程語言生成一個接口。此接口具有一個名為 Stub
的內(nèi)部抽象類委乌,用于擴展 Binder
類并實現(xiàn) AIDL 接口中的方法床牧。您必須擴展Stub
類并實現(xiàn)方法。也就是建立一個服務類(Service的子類)遭贸。
說明:新手來說可能回調(diào)部分看不懂戈咳,沒關系下面會介紹回調(diào),畢竟代碼只供參考壕吹,目前只要關注unBind()
方法和繼承Stub
類就行著蛙。
package com.demo.sdk.service;
import android.app.Service;
import android.content.Intent;
import android.os.IBinder;
import android.os.RemoteCallbackList;
import android.os.RemoteException;
import android.support.annotation.Nullable;
import com.demo.sdk.factory.FlyweightFactory;
import com.demo.sdk.model.AppPackageInfo;
import com.demo.sdk.constants.Const;
import com.demo.sdk.policy.IRemoteService;
import com.demo.sdk.policy.callback.IMemoryClearCallback;
import com.demo.sdk.policy.callback.IMemoryScanCallback;
import java.lang.reflect.InvocationTargetException;
import java.lang.reflect.Method;
import java.util.List;
/**
* aidl調(diào)用的服務
*/
public class RemoteService extends Service {
private String TAG = "SDK";
private IRemoteStrviceStub binderStub;
private RemoteCallbackList remoteCallbackList = new RemoteCallbackList();
private MemoryManager memoryManager;
@Override
public void onCreate() {
super.onCreate();
binderStub = new IRemoteStrviceStub();
}
@Nullable
@Override
public IBinder onBind(Intent intent) {
return binderStub;
}
public class IRemoteStrviceStub extends IRemoteService.Stub {
@Override
public void memoryScan(IMemoryScanCallback iMemoryScanCallback) throws RemoteException {
synchronized (this) {
if (iMemoryScanCallback != null) {
remoteCallbackList.register(iMemoryScanCallback, Const.MEMORY_SCAN);
}
doMemoryScan();
}
}
@Override
public void memoryClear(IMemoryClearCallback iMemoryClearCallback) throws RemoteException {
synchronized (this) {
if (iMemoryClearCallback != null) {
remoteCallbackList.register(iMemoryClearCallback, Const.MEMORY_CLEAR);
}
doMemoryClear();
}
}
}
/**
* 內(nèi)存掃描
*/
private void doMemoryScan(){
if (memoryManager == null) {
memoryManager = FlyweightFactory.getManager(getApplicationContext(), MemoryManager.class);
}
memoryManager.setCallback(new MemoryScanImpl() {
@Override
public void onReady() {
selectCallbackMethod(Const.MEMORY_SCAN, "onReady", null);
}
@Override
public void onUpdate(int progress, int max, String item) {
Class[] classes = new Class[]{int.class, int.class, String.class};
selectCallbackMethod(Const.MEMORY_SCAN, "onUpdate", classes, progress, max, item);
}
@Override
public void onResult(boolean isCanceled, long selectedSize, long size, List<AppPackageInfo> result) {
Class[] classes = new Class[]{boolean.class, long.class, long.class, List.class};
selectCallbackMethod(Const.MEMORY_SCAN, "onResult", classes, isCanceled, selectedSize, size, result);
}
}, null);
memoryManager.scan();
}
/**
* 內(nèi)存清理
*/
private void doMemoryClear(){
if (memoryManager == null){
return;
}
memoryManager.setCallback(null, new MemoryClearImpl() {
@Override
public void onUpdate(int progress, int max, String item) {
Class[] classes = new Class[]{int.class, int.class, String.class};
selectCallbackMethod(Const.MEMORY_CLEAR, "onUpdate", classes, progress, max, item);
}
@Override
public void onResult() {
selectCallbackMethod(Const.MEMORY_CLEAR, "onResult", null);
}
});
memoryManager.clear();
}
/**
* 選擇要執(zhí)行的回調(diào)的方法
* @param operateType 回調(diào)的cookie(用來確認調(diào)用哪一個回調(diào))
* @param methodName 方法名稱
* @param classes 執(zhí)行方法的參數(shù)類型
* @param args 執(zhí)行方法的參數(shù)
*/
public void selectCallbackMethod(String operateType, String methodName,Class[] classes, Object... args) {
final int N = remoteCallbackList.beginBroadcast();
for (int i = 0; i < N; i++){
if (remoteCallbackList.getBroadcastCookie(i).equals(operateType)){
invokeMethod(remoteCallbackList.getBroadcastItem(i), methodName, classes, args);
}
}
remoteCallbackList.finishBroadcast();
}
/**
* 執(zhí)行方法
* @param obj 執(zhí)行方法的對象
* @param methodName 方法名稱
* @param classes 執(zhí)行方法的參數(shù)類型
* @param args 執(zhí)行方法的參數(shù)
*/
public void invokeMethod(Object obj, String methodName, Class[] classes, Object... args){
try {
Method method;
if (classes != null && classes.length > 0){
method = obj.getClass().getDeclaredMethod(methodName,classes);
}else {
method = obj.getClass().getDeclaredMethod(methodName);
}
method.setAccessible(true);
method.invoke(obj, args);
} catch (NoSuchMethodException e) {
e.printStackTrace();
} catch (InvocationTargetException e) {
e.printStackTrace();
} catch (IllegalAccessException e) {
e.printStackTrace();
}
}
@Override
public void onDestroy() {
if (remoteCallbackList != null){
remoteCallbackList.kill();
}
super.onDestroy();
}
}
注:a.由于不能保證在主線程上執(zhí)行傳入調(diào)用,因此您一開始就需要做好多線程處理準備耳贬,并將您的服務正確地編譯為線程安全服務踏堡。(代碼中使用的是synchronized
,可以用Lock
代替)
b.默認情況下,RPC 調(diào)用是同步調(diào)用咒劲。如果您明知服務完成請求的時間不止幾毫秒顷蟆,就不應該從 Activity 的主線程調(diào)用服務,因為這樣做可能會使應用掛起(Android 可能會顯示“Application is Not Responding”對話框),您通常應該從客戶端內(nèi)的單獨線程調(diào)用服務腐魂。
c.您引發(fā)的任何異常都不會回傳給調(diào)用方帐偎。AIDL接口只支持方法,不能聲明靜態(tài)成員蛔屹;
(3)在AndroidManifest.xml文件中配置AIDL服務削樊,尤其要注意的是,<action>標簽中android:name的屬性值就是客戶端要引用該服務的ID兔毒,也就是Intent類的參數(shù)值漫贞。
<service
android:name="com.demo.sdk.service.RemoteService"
android:exported="true">
<intent-filter>
<action android:name="com.demo.sdk.policy.action.AIDL_SERVICE" />
</intent-filter>
</service>
建立客戶端調(diào)用遠程服務:
調(diào)用類必須執(zhí)行以下步驟,才能調(diào)用使用 AIDL 定義的遠程接口:
(1)在項目 src/ main目錄中加入 .aidl 文件育叁。(把服務端aidl文件夾完全復制到客戶端就行)
(2)a
.聲明一個 IBinder 接口實例(基于 AIDL 生成)b
.實現(xiàn) ServiceConnection绕辖。c
.調(diào)用 Context.bindService(),以傳入您的 ServiceConnection 實現(xiàn)擂红。d
.在您的 onServiceConnected() 實現(xiàn)中仪际,您將收到一個 IBinder 實例(名為 service)。調(diào)用YourInterfaceName.Stub.asInterface((IBinder)service)昵骤,以將返回的參數(shù)轉(zhuǎn)換為 YourInterface 類型树碱。示例如下:
package com.example.renkuo.aidldemo;
import android.app.Service;
import android.content.ComponentName;
import android.content.Context;
import android.content.Intent;
import android.content.ServiceConnection;
import android.content.pm.PackageManager;
import android.content.pm.ResolveInfo;
import android.os.IBinder;
import android.os.RemoteException;
import android.util.Log;
import com.demo.sdk.model.AppPackageInfo;
import com.demo.sdk.policy.IRemoteService;
import com.demo.sdk.policy.callback.IMemoryClearCallback;
import com.demo.sdk.policy.callback.IMemoryScanCallback;
import java.util.List;
public class PolicyAidlServiceWrapper {
private Context mContext;
private IRemoteService iRemoteService;
private static PolicyAidlServiceWrapper policyAidlServiceWrapper = null;
public PolicyAidlServiceWrapper(Context context) {
mContext = context;
// 創(chuàng)建所需綁定的Service的Intent
Intent intent = new Intent();
intent.setAction("com.vehiclesafe.sdk.policy.action.AIDL_SERVICE");
// intent.setPackage("com.example.renkuo.vehiclesafeaidldemo");
Intent eintent = new Intent(getExplicitIntent(mContext,intent));
// 綁定遠程Service
boolean binded = mContext.bindService(eintent, conn, Service.BIND_AUTO_CREATE);
}
public static PolicyAidlServiceWrapper getInstance(Context context) {
if (policyAidlServiceWrapper == null) {
synchronized (PolicyAidlServiceWrapper.class) {
if (policyAidlServiceWrapper == null) {
policyAidlServiceWrapper = new PolicyAidlServiceWrapper(context);
}
}
}
return policyAidlServiceWrapper;
}
private ServiceConnection conn = new ServiceConnection() {
// Called when the connection with the service is established
@Override
public void onServiceConnected(ComponentName name, IBinder service) {
// 獲取遠程Service的onBind方法返回的對象的代理
iRemoteService = IRemoteService.Stub.asInterface(service);
}
// Called when the connection with the service disconnects unexpectedly
@Override
public void onServiceDisconnected(ComponentName name) {
iRemoteService = null;
}
};
/**
* 判斷遠程服務是否存在
* @return
*/
public boolean isValid() {
return iRemoteService != null;
}
public static Intent getExplicitIntent(Context context, Intent implicitIntent) {
// Retrieve all services that can match the given intent
PackageManager pm = context.getPackageManager();
List<ResolveInfo> resolveInfo = pm.queryIntentServices(implicitIntent, 0);
// Make sure only one match was found
if (resolveInfo == null || resolveInfo.size() != 1) {
return null;
}
// Get component info and create ComponentName
ResolveInfo serviceInfo = resolveInfo.get(0);
String packageName = serviceInfo.serviceInfo.packageName;
String className = serviceInfo.serviceInfo.name;
ComponentName component = new ComponentName(packageName, className);
// Create a new intent. Use the old one for extras and such reuse
Intent explicitIntent = new Intent(implicitIntent);
// Set the component to be explicit
explicitIntent.setComponent(component);
return explicitIntent;
}
//內(nèi)存掃描的回調(diào)
private IMemoryScanCallback iMemoryScanCallback = new IMemoryScanCallback.Stub(){
@Override
public void onReady() throws RemoteException {
}
@Override
public void onUpdate(int progress, int max, String item) throws RemoteException {
}
@Override
public void onResult(boolean isCancled, long selectedSize, long size, List<AppPackageInfo> result) throws RemoteException {
}
};
/**
* 執(zhí)行內(nèi)存掃描
*/
public void executeMemoryScan() {
if (!isValid()) return;
try {
iRemoteService.memoryScan(iMemoryScanCallback);
} catch (Exception e) {
e.printStackTrace();
}
}
//內(nèi)存清理的回調(diào)
private IMemoryClearCallback iMemoryClearCallback = new IMemoryClearCallback.Stub(){
@Override
public void onUpdate(int progress, int max, String item) throws RemoteException {
}
@Override
public void onResult() throws RemoteException {
}
};
/**
* 執(zhí)行內(nèi)存清理
*/
public void executeMemoryClear() {
if (!isValid()) return;
try {
iRemoteService.memoryClear(iMemoryClearCallback);
} catch (Exception e) {
e.printStackTrace();
}
}
}
(3)調(diào)用您在接口上定義的方法。您應該始終捕獲 DeadObjectException 異常变秦,它們是在連接中斷時引發(fā)的成榜;這將是遠程方法引發(fā)的唯一異常。
(4)如需斷開連接蹦玫,請使用您的接口實例調(diào)用 Context.unbindService()赎婚。
(5)最后你可以通過客戶端調(diào)用PolicyAidlServiceWrapper
的executeMemorySca()和executeMemoryClear()方法刘绣,直接調(diào)用服務端的memoryScan和memoryCleaer方法實現(xiàn)內(nèi)存掃描和清理的功能。
通過上面代碼你可能會有疑問為什么要用getExplicitIntent(Context context, Intent implicitIntent)
方法挣输?
因為Android 5.0一出來后纬凤,其中有個特性就是Service Intent must be explitict,也就是說從Lollipop開始撩嚼,service服務必須采用顯示方式啟動停士。源碼如下:
傳遞自定義對象
自定義對象必須實現(xiàn)Parcelable
接口,支持 Parcelable 接口很重要,因為 Android 系統(tǒng)可通過它將對象分解成可編組到各進程的原語完丽。
(1)創(chuàng)建支持 Parcelable 協(xié)議的類恋技,您必須執(zhí)行以下操作:
- 讓您的類實現(xiàn)
Parcelable
接口。 - 實現(xiàn)
writeToParcel
逻族,它會獲取對象的當前狀態(tài)并將其寫入Parcel
蜻底。 - 為您的類添加一個名為
CREATOR
的靜態(tài)字段,這個字段是一個實現(xiàn) Parcelable.Creator 接口的對象聘鳞。
代碼示例:
package com.demo.sdk.model.processclear;
import android.os.Parcel;
import android.os.Parcelable;
public class AppPackageInfo implements Parcelable {
public String packageName;
public String appName;
public int usedMemory;
public int clearMemory;
@Override
public int describeContents() {
return 0;
}
@Override
public void writeToParcel(Parcel dest, int flags) {
dest.writeString(this.packageName);
dest.writeString(this.appName);
dest.writeInt(this.usedMemory);
dest.writeInt(this.clearMemory);
}
public AppPackageInfo() {
}
protected AppPackageInfo(Parcel in) {
this.packageName = in.readString();
this.appName = in.readString();
this.usedMemory = in.readInt();
this.clearMemory = in.readInt();
}
public static final Creator<AppPackageInfo> CREATOR = new Creator<AppPackageInfo>() {
@Override
public AppPackageInfo createFromParcel(Parcel source) {
return new AppPackageInfo(source);
}
@Override
public AppPackageInfo[] newArray(int size) {
return new AppPackageInfo[size];
}
};
}
(2)創(chuàng)建一個聲明的 .aidl 文件在aidl文件夾下朱躺,保持包名路徑名一致
package com.demo.sdk.model.processclear;
parcelable AppPackageInfo;
(3)客戶端和服務端的Parcelable
實現(xiàn)類的.java文件和.aidl文件的類名和包路徑必須保證一致。也就是說如果服務端(客戶端)創(chuàng)建完的Parcelable
文件完全復制到客戶端(服務端)即可
(4)傳遞自定義對象的時候要用in
關鍵字修飾
void onResult(boolean isCancled, long selectedSize, long size, in List<AppPackageInfo> result);
支持多個回調(diào)(參考RemoteServicel類)
(1)通過RemoteCallbackList
的 register(IInterface callback)和register(IInterface callback,Object cookie)方法注冊回調(diào)搁痛,示例采用的是register(IInterface callback,Object cookie)方法长搀,在多個回調(diào)時可以通過cookie判斷是哪個回調(diào)(可以通過unregister(IInterface callback)注銷回調(diào))
remoteCallbackList.register(iMemoryScanCallback, Const.MEMORY_SCAN);
(2)aidl通過廣播的方式去調(diào)用回調(diào)方法,代碼如下:(其中RemoteCallbackList的getBroadcastItem(int index)方法可以獲取對應的回調(diào)類鸡典,然后再通過invokeMethod方法執(zhí)行回調(diào)的對應方法)
/**
* 選擇要執(zhí)行的回調(diào)的方法
* @param operateType 回調(diào)的cookie(用來確認調(diào)用哪一個回調(diào))
* @param methodName 方法名稱
* @param classes 執(zhí)行方法的參數(shù)類型
* @param args 執(zhí)行方法的參數(shù)
*/
public void selectCallbackMethod(String operateType, String methodName,Class[] classes, Object... args) {
final int N = remoteCallbackList.beginBroadcast();
for (int i = 0; i < N; i++){
if (remoteCallbackList.getBroadcastCookie(i).equals(operateType)){
invokeMethod(remoteCallbackList.getBroadcastItem(i), methodName, classes, args);
}
}
//記得關閉廣播
remoteCallbackList.finishBroadcast();
}
(3)在onDestory的時候調(diào)用kill方法(kill方法說明:Disable this callback list. All registered callbacks are unregistered and the list is disabled so that future calls to {@link #register} will fail. This should be used when a Service is stopping, to prevent clients from registering callbacks after it is stopped.)
@Override
public void onDestroy() {
if (remoteCallbackList != null){
remoteCallbackList.kill();
}
super.onDestroy();
}
官方參考地址:https://developer.android.com/guide/components/aidl.html
錯誤不足之處或相關建議歡迎大家評論指出源请,謝謝!如果覺得內(nèi)容可以的話麻煩喜歡(?)一下