上篇文章寫(xiě)到了AIDL,但并么有詳細(xì)講解其使用的方法悟衩。
AIDL(Android 接口定義語(yǔ)言) 是 Android 提供的一種進(jìn)程間通信 (IPC) 機(jī)制。
我們可以利用它定義客戶(hù)端與服務(wù)使用進(jìn)程間通信 (IPC) 進(jìn)行相互通信時(shí)都認(rèn)可的編程接口栓拜。
在 Android 上座泳,一個(gè)進(jìn)程通常無(wú)法訪(fǎng)問(wèn)另一個(gè)進(jìn)程的內(nèi)存。 盡管如此幕与,進(jìn)程需要將其對(duì)象分解成操作系統(tǒng)能夠識(shí)別的原語(yǔ)挑势,并將對(duì)象編組成跨越邊界的對(duì)象。
編寫(xiě)執(zhí)行這一編組操作的代碼是一項(xiàng)繁瑣的工作啦鸣,因此 Android 會(huì)使用 AIDL 來(lái)處理潮饱。
通過(guò)這種機(jī)制,我們只需要寫(xiě)好 aidl 接口文件诫给,編譯時(shí)系統(tǒng)會(huì)幫我們生成 Binder 接口香拉。
AIDL的語(yǔ)法十分簡(jiǎn)單,與Java語(yǔ)言基本保持一致中狂,需要記住的規(guī)則有以下幾點(diǎn):
1凫碌,AIDL文件以 .aidl 為后綴名
2,AIDL支持的數(shù)據(jù)類(lèi)型分為如下幾種:
八種基本數(shù)據(jù)類(lèi)型:byte胃榕、char盛险、short、int勋又、long苦掘、float、double楔壤、boolean
String鸟蜡,CharSequence
實(shí)現(xiàn)了Parcelable接口的數(shù)據(jù)類(lèi)型
List 類(lèi)型。List承載的數(shù)據(jù)必須是AIDL支持的類(lèi)型挺邀,或者是其它聲明的AIDL對(duì)象
Map類(lèi)型揉忘。Map承載的數(shù)據(jù)必須是AIDL支持的類(lèi)型,或者是其它聲明的AIDL對(duì)象
3端铛,AIDL文件可以分為兩類(lèi)泣矛。一類(lèi)用來(lái)聲明實(shí)現(xiàn)了Parcelable接口的數(shù)據(jù)類(lèi)型,以供其他AIDL文件使用那些非默認(rèn)支持的數(shù)據(jù)類(lèi)型禾蚕。還有一類(lèi)是用來(lái)定義接口方法您朽,聲明要暴露哪些接口給客戶(hù)端調(diào)用,定向Tag就是用來(lái)標(biāo)注這些方法的參數(shù)值
4,定向Tag哗总。定向Tag表示在跨進(jìn)程通信中數(shù)據(jù)的流向几颜,用于標(biāo)注方法的參數(shù)值,分為 in讯屈、out蛋哭、inout 三種。其中 in 表示數(shù)據(jù)只能由客戶(hù)端流向服務(wù)端涮母, out 表示數(shù)據(jù)只能由服務(wù)端流向客戶(hù)端谆趾,而 inout 則表示數(shù)據(jù)可在服務(wù)端與客戶(hù)端之間雙向流通。此外叛本,如果AIDL方法接口的參數(shù)值類(lèi)型是:基本數(shù)據(jù)類(lèi)型沪蓬、String、CharSequence或者其他AIDL文件定義的方法接口来候,那么這些參數(shù)值的定向 Tag 默認(rèn)是且只能是 in跷叉,所以除了這些類(lèi)型外,其他參數(shù)值都需要明確標(biāo)注使用哪種定向Tag营搅。定向Tag具體的使用差別后邊會(huì)有介紹
5云挟,明確導(dǎo)包。在AIDL文件中需要明確標(biāo)明引用到的數(shù)據(jù)類(lèi)型所在的包名剧防,即使兩個(gè)文件處在同個(gè)包名下。
服務(wù)端編碼
這里來(lái)實(shí)際完成一個(gè)例子作為示范辫樱,需要實(shí)現(xiàn)的功能是:客戶(hù)端通過(guò)綁定服務(wù)端的Service的方式來(lái)調(diào)用服務(wù)端的方法峭拘,獲取服務(wù)端的書(shū)籍列表并向其添加書(shū)籍,實(shí)現(xiàn)應(yīng)用間的數(shù)據(jù)共享
首先是服務(wù)端的代碼
新建一個(gè)工程狮暑,包名就定義為 example.sx.com.test
首先鸡挠,在應(yīng)用中需要用到一個(gè) Book 類(lèi),而 Book 類(lèi)是兩個(gè)應(yīng)用間都需要使用到的搬男,所以也需要在AIDL文件中聲明Book類(lèi)拣展,為了避免出現(xiàn)類(lèi)名重復(fù)導(dǎo)致無(wú)法創(chuàng)建文件的錯(cuò)誤,這里需要先建立 Book AIDL 文件缔逛,之后再創(chuàng)建 Book 類(lèi)
右鍵點(diǎn)擊新建一個(gè)AIDL文件备埃,命名為 Book
創(chuàng)建完成后,系統(tǒng)就會(huì)默認(rèn)創(chuàng)建一個(gè) aidl 文件夾褐奴,文件夾下的目錄結(jié)構(gòu)即是工程的包名按脚,Book.aidi 文件就在其中
Book.aidl 文件中會(huì)有一個(gè)默認(rèn)方法,可以刪除掉
此時(shí)就可以來(lái)定義Book類(lèi)了敦冬,Book類(lèi)只包含一個(gè) Name 屬性辅搬,并使之實(shí)現(xiàn) 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];
}
};
}
現(xiàn)在再來(lái)修改 Book.aidl 文件,將之改為聲明Parcelable數(shù)據(jù)類(lèi)型的AIDL文件
package example.sx.com.test;
parcelable Book;
此外脖旱,根據(jù)一開(kāi)始的設(shè)想堪遂,服務(wù)端需要暴露給客戶(hù)端一個(gè)獲取書(shū)籍列表以及一個(gè)添加書(shū)籍的方法介蛉,這兩個(gè)方法首先要定義在AIDL文件中,命名為 BookController.aidl溶褪,注意這里需要明確導(dǎo)包
package example.sx.com.test;
import example.sx.com.test.Book;
interface BookController {
List<Book> getBookList();
void addBookInOut(inout Book book);
}
上面說(shuō)過(guò)币旧,在進(jìn)程間通信中真正起作用的并不是 AIDL 文件,而是系統(tǒng)據(jù)此而生成的文件竿滨,可以在以下目錄中查看系統(tǒng)生成的文件佳恬。之后需要使用到當(dāng)中的內(nèi)部靜態(tài)抽象類(lèi) Stub
創(chuàng)建或修改過(guò)AIDL文件后需要clean下工程,使系統(tǒng)及時(shí)生成我們需要的文件
現(xiàn)在需要來(lái)創(chuàng)建一個(gè) Service 供客戶(hù)端遠(yuǎn)程綁定了于游,這里命名為 AIDLService
public class AIDLService extends Service {
private final String TAG = "Server";
private List<Book> bookList;
public AIDLService() {
}
@Override
public void onCreate() {
super.onCreate();
bookList = new ArrayList<>();
initData();
}
private void initData() {
Book book1 = new Book("java");
Book book2 = new Book("android");
Book book3 = new Book("kotlin");
bookList.add(book1);
bookList.add(book2);
bookList.add(book3);
}
private final BookController.Stub stub = new BookController.Stub() {
@Override
public List<Book> getBookList() throws RemoteException {
return bookList;
}
@Override
public void addBookInOut(Book book) throws RemoteException {
if (book != null) {
book.setName("服務(wù)器改了新書(shū)的名字 InOut");
bookList.add(book);
} else {
Log.e(TAG, "接收到了一個(gè)空對(duì)象 InOut");
}
}
};
@Override
public IBinder onBind(Intent intent) {
return stub;
}
}
可以看到毁葱, onBind 方法返回的就是 BookController.Stub 對(duì)象,實(shí)現(xiàn)當(dāng)中定義的兩個(gè)方法
最后贰剥,服務(wù)端還有一個(gè)地方需要注意倾剿,因?yàn)榉?wù)端的Service需要被客戶(hù)端來(lái)遠(yuǎn)程綁定,所以客戶(hù)端要能夠找到這個(gè)Service蚌成,可以通過(guò)先指定包名前痘,之后再配置Action值或者直接指定Service類(lèi)名的方式來(lái)綁定Service
如果是通過(guò)指定Action值的方式來(lái)綁定Service,那還需要將Service的聲明改為如下所示:
本例子采用配置 Action 的方案
客戶(hù)端編碼
客戶(hù)端需要再創(chuàng)建一個(gè)新的工程担忧,包名命名為 com.sx.client
首先芹缔,需要把服務(wù)端的AIDL文件以及Book類(lèi)復(fù)制過(guò)來(lái),將 aidl 文件夾整個(gè)復(fù)制到和Java文件夾同個(gè)層級(jí)下瓶盛,不需要改動(dòng)任何代碼
之后最欠,需要?jiǎng)?chuàng)建和服務(wù)端Book類(lèi)所在的相同包名來(lái)存放 Book類(lèi)
修改布局文件,添加兩個(gè)按鈕
<?xml version="1.0" encoding="utf-8"?>
<LinearLayout xmlns:android="http://schemas.android.com/apk/res/android"
android:layout_width="match_parent"
android:layout_height="match_parent"
android:gravity="center"
android:orientation="vertical">
<Button
android:id="@+id/btn_getBookList"
android:layout_width="match_parent"
android:layout_height="wrap_content"
android:text="獲取書(shū)籍列表" />
<Button
android:id="@+id/btn_addBook_inOut"
android:layout_width="match_parent"
android:layout_height="wrap_content"
android:text="InOut 添加書(shū)籍" />
</LinearLayout>
public class MainActivity extends AppCompatActivity {
private final String TAG = "Client";
private BookController bookController;
private boolean connected;
private List<Book> bookList;
private ServiceConnection serviceConnection = new ServiceConnection() {
@Override
public void onServiceConnected(ComponentName name, IBinder service) {
bookController = BookController.Stub.asInterface(service);
connected = true;
}
@Override
public void onServiceDisconnected(ComponentName name) {
connected = false;
}
};
private View.OnClickListener clickListener = new View.OnClickListener() {
@Override
public void onClick(View v) {
switch (v.getId()) {
case R.id.btn_getBookList:
if (connected) {
try {
bookList = bookController.getBookList();
} catch (RemoteException e) {
e.printStackTrace();
}
log();
}
break;
case R.id.btn_addBook_inOut:
if (connected) {
Book book = new Book("這是一本新書(shū) InOut");
try {
bookController.addBookInOut(book);
Log.e(TAG, "向服務(wù)器以InOut方式添加了一本新書(shū)");
Log.e(TAG, "新書(shū)名:" + book.getName());
} catch (RemoteException e) {
e.printStackTrace();
}
}
break;
}
}
};
@Override
protected void onCreate(Bundle savedInstanceState) {
super.onCreate(savedInstanceState);
setContentView(R.layout.activity_main);
findViewById(R.id.btn_getBookList).setOnClickListener(clickListener);
findViewById(R.id.btn_addBook_inOut).setOnClickListener(clickListener);
bindService();
}
@Override
protected void onDestroy() {
super.onDestroy();
if (connected) {
unbindService(serviceConnection);
}
}
private void bindService() {
Intent intent = new Intent();
intent.setPackage("com.sx.example.test");
intent.setAction("com.sx.example.test.action");
bindService(intent, serviceConnection, Context.BIND_AUTO_CREATE);
}
private void log() {
for (Book book : bookList) {
Log.e(TAG, book.toString());
}
}
}
兩個(gè)按鈕分別用于獲取服務(wù)端的書(shū)籍列表和添加書(shū)籍惩猫,在添加書(shū)籍時(shí)芝硬,服務(wù)端還改變了Book對(duì)象的Name屬性,據(jù)此觀察客戶(hù)端和服務(wù)端數(shù)據(jù)的變化情況
首先點(diǎn)擊獲取書(shū)籍列表轧房,數(shù)據(jù)獲取無(wú)誤
再點(diǎn)擊按鈕添加書(shū)籍拌阴,可以看到,服務(wù)端對(duì)數(shù)據(jù)的修改也同時(shí)同步到了客戶(hù)端這邊
到此為止奶镶,客戶(hù)端和服務(wù)端之間的通信已經(jīng)實(shí)現(xiàn)了迟赃,客戶(hù)端獲取到了服務(wù)端的數(shù)據(jù),也向服務(wù)端傳送了數(shù)據(jù)
定向Tag
最后厂镇,再來(lái)講下三種定向Tag之間的差別捺氢。上邊使用的是 InOut 類(lèi)型,服務(wù)端對(duì)數(shù)據(jù)的改變同時(shí)也同步到了客戶(hù)端剪撬,因此可以說(shuō)兩者之間數(shù)據(jù)是雙向流動(dòng)的
In 類(lèi)型的表現(xiàn)形式是:數(shù)據(jù)只能由客戶(hù)端傳向服務(wù)端摄乒,服務(wù)端對(duì)數(shù)據(jù)的修改不會(huì)影響到客戶(hù)端
Out類(lèi)型的表現(xiàn)形式是:數(shù)據(jù)只能由服務(wù)端傳向客戶(hù)端,即使客戶(hù)端向方法接口傳入了一個(gè)對(duì)象,該對(duì)象中的屬性值也是為空的馍佑,即不包含任何數(shù)據(jù)斋否,服務(wù)端獲取到該對(duì)象后,對(duì)該對(duì)象的任何操作拭荤,就會(huì)同步到客戶(hù)端這邊
這里再來(lái)實(shí)際演示一下
先修改服務(wù)器端的 BookController.aidl 文件茵臭,向之添加兩個(gè)新方法
package example.sx.com.test;
import example.sx.com.test.Book;
// Declare any non-default types here with import statements
interface BookController {
List<Book> getBookList();
void addBookInOut(inout Book book);
void addBookIn(in Book book);
void addBookOut(out Book book);
}
則 AIDLService 類(lèi)的 BookController.Stub 對(duì)象就需要修改為如下所示:
private final BookController.Stub stub = new BookController.Stub() {
@Override
public List<Book> getBookList() throws RemoteException {
return bookList;
}
@Override
public void addBookInOut(Book book) throws RemoteException {
if (book != null) {
book.setName("服務(wù)器改了新書(shū)的名字 InOut");
bookList.add(book);
} else {
Log.e(TAG, "接收到了一個(gè)空對(duì)象 InOut");
}
}
@Override
public void addBookIn(Book book) throws RemoteException {
if (book != null) {
book.setName("服務(wù)器改了新書(shū)的名字 In");
bookList.add(book);
} else {
Log.e(TAG, "接收到了一個(gè)空對(duì)象 In");
}
}
@Override
public void addBookOut(Book book) throws RemoteException {
if (book != null) {
Log.e(TAG, "客戶(hù)端傳來(lái)的書(shū)的名字:" + book.getName());
book.setName("服務(wù)器改了新書(shū)的名字 Out");
bookList.add(book);
} else {
Log.e(TAG, "接收到了一個(gè)空對(duì)象 Out");
}
}
};
同步修改客戶(hù)端的 BookController.aidl 文件
向布局文件多增添兩個(gè)按鈕粟瞬,分別用于添加不同的 定向Tag 的數(shù)據(jù)
private View.OnClickListener clickListener = new View.OnClickListener() {
@Override
public void onClick(View v) {
switch (v.getId()) {
case R.id.btn_getBookList:
if (connected) {
try {
bookList = bookController.getBookList();
} catch (RemoteException e) {
e.printStackTrace();
}
log();
}
break;
case R.id.btn_addBook_inOut:
if (connected) {
Book book = new Book("這是一本新書(shū) InOut");
try {
bookController.addBookInOut(book);
Log.e(TAG, "向服務(wù)器以InOut方式添加了一本新書(shū)");
Log.e(TAG, "新書(shū)名:" + book.getName());
} catch (RemoteException e) {
e.printStackTrace();
}
}
break;
case R.id.btn_addBook_in:
if (connected) {
Book book = new Book("這是一本新書(shū) In");
try {
bookController.addBookIn(book);
Log.e(TAG, "向服務(wù)器以In方式添加了一本新書(shū)");
Log.e(TAG, "新書(shū)名:" + book.getName());
} catch (RemoteException e) {
e.printStackTrace();
}
}
break;
case R.id.btn_addBook_out:
if (connected) {
Book book = new Book("這是一本新書(shū) Out");
try {
bookController.addBookOut(book);
Log.e(TAG, "向服務(wù)器以O(shè)ut方式添加了一本新書(shū)");
Log.e(TAG, "新書(shū)名:" + book.getName());
} catch (RemoteException e) {
e.printStackTrace();
}
}
break;
}
}
};
此外霜幼,還有個(gè)地方需要修改下驰凛,即Book類(lèi)参咙。因?yàn)?Out 類(lèi)型的確會(huì)使得客戶(hù)端傳一個(gè)不包含任何數(shù)據(jù)的對(duì)象回服務(wù)端,但該對(duì)象卻不是直接就等于 null 盛卡,所以說(shuō)明系統(tǒng)還是需要實(shí)例化 Book 類(lèi)狐史,但當(dāng)前 Book 類(lèi)只有一個(gè)有參構(gòu)造函數(shù)哲嘲,所以還需要修改 Book 類(lèi)罢低,為之添加一個(gè)無(wú)參構(gòu)造函數(shù)以供系統(tǒng)使用
分別點(diǎn)擊三個(gè)按鈕 ,服務(wù)端在獲取到客戶(hù)端以O(shè)ut方式傳來(lái)的Book對(duì)象時(shí)查辩,的確是不包含書(shū)名這個(gè)屬性值