Android Studio中使用AIDL簡單示例
這兩天在學習aidl跨程序呼叫,研究了一天終於寫出了個helloword。。做下記錄吧。
根據官方提供的指南,開發aidl跨程序呼叫,主要分以下步驟:
1.建立.aidl檔案-該檔案(YourInterface.aidl)定義了客戶端可用的方法和資料的介面。
2.在makefile檔案中加入.aidl檔案-(Eclipse中的ADT外掛提供管理功能)Android包括名為AIDL的編譯器,位於tools/資料夾。
3.實現介面-AIDL編譯器從AIDL介面檔案中利用Java語言建立介面,該介面有一個繼承的命名為Stub的內部抽象類(並且實現了一些IPC呼叫的附加方法),要做的就是建立一個繼承YourInterface.Stub的類並且實現在.aidl檔案中宣告的方法。
4.向客戶端公開介面-如果是編寫服務,應該繼承Service並且過載Service.onBind(Intent) 以返回實現了介面的物件例項
上面的東西真的很官方。。下面結合我的例子做一下學習總結:
先開發伺服器端
1.建立一個aidl檔案,可以看提供的原始碼。建立完成後,android studio構建工具會自動在module/build/generated/source/aidl/debuge/pakagename/目錄下生成同名字的java檔案。裡面包含一個Stub抽象類,這個類繼承自android.os.Binder,這個類是實現整個遠端呼叫的核心。
2.然後建立一個類來繼承上面說到的那個Stub抽象類,實現裡面的抽象方法。(這些抽象方法是根據aidl檔案自動生成的)。
3.建立一個自定義Service繼承自Service,實現其onBind方法,注意此onBind方法必須返回第二步建立的那個Stub類的子類。然後在xml中宣告此service,注意此service的宣告必須包含一個action,此action也用於客戶端的呼叫使用。(在下面的客戶端開發中會有介紹)。
4.建立一個activity,此activity只要實現把service啟動了即可。
這樣伺服器端就開發完畢,執行後啟動了一個可供遠端呼叫的service。關鍵還是通過onBind暴露一個Binder給客戶端。Binder哪來呢?就是通過aidl檔案adt會自動生成一個抽象類Stub繼承自Binder,只需要建立一個類實現這個Stub的抽象方法即可。
然後開發客戶端:
1.客戶端也需要一個aidl檔案,注意客戶端的aidl檔案的包名必須和伺服器端的aidl包名一致,名字也相同。所以可以直接將服務端的拷貝到客戶端。
2.建立一個Activity,包含變數ServiceConnection con,實現其onServiceConnected和onServiceDisconnected方法,onServiceConnected方法生成第一步那個介面的實現類的物件。con物件用於在onCreate中繫結service,這個service的action必須為伺服器端宣告的那個service的配置action。繫結中用到con會執行onServiceConnected方法生成aidl物件iPerson。然後就可以通過iPerson來呼叫aidl裡的任意方法返回伺服器的東西。
客戶端開發完畢。關鍵點是建立aidl檔案自動生成了一個介面,在activity中必須繫結服務程式開啟的service,在繫結過程中初始化aidl物件。然後就可用aidl物件呼叫任意方法了。
OK,過程真的很繁瑣。。但是好像也只能這樣了。最主要的還是服務端onBind暴露,然後客戶端bindService得到aidl物件。
接下來是在Android Studio環境下寫的AIDL小例子,實現步驟如下:
1.建立服務端
1.1 建立一個module,名稱為aidlserverdemo,然後在main目錄下建立一個aidl檔案IPerson.aidl,建立成功後會自動在目錄module/build/generated/source/aidl/debuge/pakagename/xxx.java下生成.java的檔案,如果沒有自動生成,rebuild一下之後一般會生成.
IPerosn.aidl
package com.sg7.aidlserverdemo;
interface IPerson {
void setAge(int age);
void setName(String name);
String display();
}
生成的.java檔案:
1.2 建立IPersonImpl類,繼承IPerson的子類IPerson.Stub
public class IPersonImpl extends IPerson.Stub {
// 宣告兩個變數
private int age;
private String name;
@Override
public void setAge(int age) throws RemoteException {
this.age = age;
}
@Override
public void setName(String name) throws RemoteException {
this.name = name;
}
@Override
public String display() throws RemoteException {
return "name:zzz;age=18";
}
}
1.3 建立一個遠端服務MyRemoteService,在AndroidManifest.xml中宣告action為com.sg7.app.action.MY_REMOTE_SERVICE
/**
* @author zzz
* 使用Service將介面暴露給客戶端
*/
public class MyRemoteService extends Service {
// 宣告IPerson介面
private Binder iPerson = new IPersonImpl();
@Override
public IBinder onBind(Intent intent) {
return iPerson;
}
}
<service android:name=".MyRemoteService">
<intent-filter>
<action android:name="com.sg7.app.action.MY_REMOTE_SERVICE"/>
</intent-filter>
</service>
1.4 在MainActivity中啟動服務
public class MainActivity extends Activity {
@Override
public void onCreate(Bundle savedInstanceState) {
super.onCreate(savedInstanceState);
setContentView(R.layout.activity_main);
Intent intent = new Intent();
// 設定Intent的Action 屬性
intent.setAction("com.sg7.app.action.MY_REMOTE_SERVICE");
// 繫結服務
startService(intent);
}
}
整個專案結構
2.建立客戶端
2.1 建立一個module,名稱為aidlclientdemo,然後將aidlserverdemo中的aidl整個資料夾複製到aidlclientdemo的main資料夾下,複製成功後會自動在目錄module/build/generated/source/aidl/debuge/pakagename/xxx.java下生成.java的檔案,如果沒有自動生成,rebuild一下之後一般會生成.
2.2 在MainActivity中通過ServiceConnection獲得IPerson介面,並且呼叫其中的方法
public class MainActivity extends Activity {
// 宣告IPerson介面
private IPerson iPerson;
private Button btn;
// 例項化ServiceConnection
private ServiceConnection conn = new ServiceConnection() {
@Override
synchronized public void onServiceConnected(ComponentName name, IBinder service) {
// 獲得IPerson介面
iPerson = IPerson.Stub.asInterface(service);
System.out.println("iperson----------:" + iPerson);
}
@Override
public void onServiceDisconnected(ComponentName name) {
iPerson = null;
}
};
@Override
public void onCreate(Bundle savedInstanceState) {
super.onCreate(savedInstanceState);
setContentView(R.layout.activity_main);
btn = (Button) findViewById(R.id.Button01);
Intent intent = new Intent("com.sg7.app.action.MY_REMOTE_SERVICE");
bindService(intent, conn, Service.BIND_AUTO_CREATE);
btn.setOnClickListener(new OnClickListener() {
@Override
public void onClick(View v) {
try {
String msg = iPerson.display();
// 顯示方法呼叫返回值
Toast.makeText(MainActivity.this, msg, Toast.LENGTH_LONG).show();
} catch (Exception e) {
e.printStackTrace();
}
}
});
}
@Override
protected void onDestroy() {
unbindService(conn);
super.onDestroy();
}
}
效果圖:
原始碼下載:http://download.csdn.net/detail/lingwu7/9314021