前言
實現(xiàn)這個功能要解決兩個問題:
- 如何使用AIDL進行跨進程雙向通信邑狸?
- 如何傳輸一個2MB大小的文件?
問題1很簡單闸翅,可以參考AIDL官方文檔舟铜,這里不做過多介紹。本文主要集中火力解決問題2仇穗,講解如何通過匿名共享內存實現(xiàn)跨進程雙向大文件傳輸流部。
AIDL簡介
AIDL
是Android
中實現(xiàn)跨進程通信(Inter-Process Communication
)的一種方式。AIDL
的傳輸數(shù)據(jù)機制基于Binder
纹坐,Binder
對傳輸數(shù)據(jù)大小有限制枝冀,
傳輸超過1M的文件就會報android.os.TransactionTooLargeException
異常,一種解決辦法就是使用匿名共享內存進行大文件傳輸耘子。
共享內存簡介
共享內存是進程間通信的一種方式果漾,通過映射一塊公共內存到各自的進程空間來達到共享內存的目的。
對于進程間需要傳遞大量數(shù)據(jù)的場景下谷誓,這種通信方式是十分高效的绒障,但是共享內存并未提供同步機制,也就是說捍歪,在第一個進程結束對共享內存的寫操作之前户辱,并無自動機制可以阻止第二個進程開始對它進行讀取鸵钝,所以我們通常需要用其他的機制來同步對共享內存的訪問,例如信號量焕妙。
Android
中的匿名共享內存(Ashmem)是基于Linux
共享內存的蒋伦,借助Binder
+文件描述符(FileDescriptor
)實現(xiàn)了共享內存的傳遞。它可以讓多個進程操作同一塊內存區(qū)域焚鹊,并且除了物理內存限制痕届,沒有其他大小限制。相對于Linux
的共享內存末患,Ashmem對內存的管理更加精細化研叫,并且添加了互斥鎖。Java
層在使用時需要用到MemoryFile
璧针,它封裝了native
代碼嚷炉。Android
平臺上共享內存通常的做法如下:
- 進程A通過
MemoryFile
創(chuàng)建共享內存,得到fd(FileDescriptor
) - 進程A通過fd將數(shù)據(jù)寫入共享內存
- 進程A將fd封裝成實現(xiàn)
Parcelable
接口的ParcelFileDescriptor
對象探橱,通過Binder
將ParcelFileDescriptor
對象發(fā)送給進程B - 進程B獲從
ParcelFileDescriptor
對象中獲取fd申屹,從fd中讀取數(shù)據(jù)
客戶端和服務端雙向通信+傳輸大文件實戰(zhàn)
先放上實現(xiàn)效果圖:
我們先實現(xiàn)客戶端向服務端傳輸大文件,然后再實現(xiàn)服務端向客戶端傳輸大文件隧膏。
定義AIDL接口
//IMyAidlInterface.aidl
interface IMyAidlInterface {
void client2server(in ParcelFileDescriptor pfd);
}
服務端
- 實現(xiàn)
IMyAidlInterface
接口
//AidlService.kt
class AidlService : Service() {
private val mStub: IMyAidlInterface.Stub = object : IMyAidlInterface.Stub() {
@Throws(RemoteException::class)
override fun sendData(pfd: ParcelFileDescriptor) {
}
}
override fun onBind(intent: Intent): IBinder {
return mStub
}
}
- 接收數(shù)據(jù)
//AidlService.kt
@Throws(RemoteException::class)
override fun sendData(pfd: ParcelFileDescriptor) {
/**
* 從ParcelFileDescriptor中獲取FileDescriptor
*/
val fileDescriptor = pfd.fileDescriptor
/**
* 根據(jù)FileDescriptor構建InputStream對象
*/
val fis = FileInputStream(fileDescriptor)
/**
* 從InputStream中讀取字節(jié)數(shù)組
*/
val data = fis.readBytes()
......
}
客戶端
-
綁定服務
- 在項目的
src
目錄中加入.aidl
文件 - 聲明一個
IMyAidlInterface
接口實例(基于AIDL
生成) - 創(chuàng)建
ServiceConnection
實例哗讥,實現(xiàn)android.content.ServiceConnection
接口 - 調用
Context.bindService()
綁定服務,傳入ServiceConnection
實例 - 在
onServiceConnected()
實現(xiàn)中胞枕,調用IMyAidlInterface.Stub.asInterface(binder)
杆煞,將返回參數(shù)轉換為IMyAidlInterface
類型
- 在項目的
//MainActivity.kt
class MainActivity : AppCompatActivity() {
private var mStub: IMyAidlInterface? = null
private val serviceConnection = object : ServiceConnection {
override fun onServiceConnected(name: ComponentName, binder: IBinder) {
mStub = IMyAidlInterface.Stub.asInterface(binder)
}
override fun onServiceDisconnected(name: ComponentName) {
mStub = null
}
}
override fun onCreate(savedInstanceState: Bundle?) {
super.onCreate(savedInstanceState)
setContentView(R.layout.activity_main)
button1.setOnClickListener {
bindService()
}
}
private fun bindService() {
if (mStub != null) {
return
}
val intent = Intent("io.github.kongpf8848.aidlserver.AidlService")
intent.setClassName("io.github.kongpf8848.aidlserver","io.github.kongpf8848.aidlserver.AidlService")
try {
val bindSucc = bindService(intent, serviceConnection, Context.BIND_AUTO_CREATE)
if (bindSucc) {
Toast.makeText(this, "bind ok", Toast.LENGTH_SHORT).show()
} else {
Toast.makeText(this, "bind fail", Toast.LENGTH_SHORT).show()
}
} catch (e: Exception) {
e.printStackTrace()
}
}
override fun onDestroy() {
if(mStub!=null) {
unbindService(serviceConnection)
}
super.onDestroy()
}
}
-
發(fā)送數(shù)據(jù)
- 將發(fā)送文件轉換成字節(jié)數(shù)組
ByteArray
- 創(chuàng)建
MemoryFile
對象 - 向
MemoryFile
對象中寫入字節(jié)數(shù)組 - 獲取
MemoryFile
對應的FileDescriptor
- 根據(jù)
FileDescriptor
創(chuàng)建ParcelFileDescriptor
- 調用
IPC
方法,發(fā)送ParcelFileDescriptor
對象
- 將發(fā)送文件轉換成字節(jié)數(shù)組
//MainActivity.kt
private fun sendLargeData() {
if (mStub == null) {
return
}
try {
/**
* 讀取assets目錄下文件
*/
val inputStream = assets.open("large.jpg")
/**
* 將inputStream轉換成字節(jié)數(shù)組
*/
val byteArray=inputStream.readBytes()
/**
* 創(chuàng)建MemoryFile
*/
val memoryFile=MemoryFile("image", byteArray.size)
/**
* 向MemoryFile中寫入字節(jié)數(shù)組
*/
memoryFile.writeBytes(byteArray, 0, 0, byteArray.size)
/**
* 獲取MemoryFile對應的FileDescriptor
*/
val fd=MemoryFileUtils.getFileDescriptor(memoryFile)
/**
* 根據(jù)FileDescriptor創(chuàng)建ParcelFileDescriptor
*/
val pfd= ParcelFileDescriptor.dup(fd)
/**
* 發(fā)送數(shù)據(jù)
*/
mStub?.client2server(pfd)
} catch (e: IOException) {
e.printStackTrace()
} catch (e: RemoteException) {
e.printStackTrace()
}
}
至此腐泻,我們已經(jīng)實現(xiàn)了客戶端向服務端傳輸大文件决乎,下面就繼續(xù)實現(xiàn)服務端向客戶端傳輸大文件功能。服務端主動給客戶端發(fā)送數(shù)據(jù)派桩,客戶端只需要進行監(jiān)聽即可构诚。
- 定義監(jiān)聽回調接口
//ICallbackInterface.aidl
package io.github.kongpf8848.aidlserver;
interface ICallbackInterface {
void server2client(in ParcelFileDescriptor pfd);
}
- 在
IMyAidlInterface.aidl
中添加注冊回調和反注冊回調方法,如下:
//IMyAidlInterface.aidl
import io.github.kongpf8848.aidlserver.ICallbackInterface;
interface IMyAidlInterface {
......
void registerCallback(ICallbackInterface callback);
void unregisterCallback(ICallbackInterface callback);
}
- 服務端實現(xiàn)接口方法
//AidlService.kt
private val callbacks=RemoteCallbackList<ICallbackInterface>()
private val mStub: IMyAidlInterface.Stub = object : IMyAidlInterface.Stub() {
......
override fun registerCallback(callback: ICallbackInterface) {
callbacks.register(callback)
}
override fun unregisterCallback(callback: ICallbackInterface) {
callbacks.unregister(callback)
}
}
- 客戶端綁定服務后注冊回調
//MainActivity.kt
private val callback=object: ICallbackInterface.Stub() {
override fun server2client(pfd: ParcelFileDescriptor) {
val fileDescriptor = pfd.fileDescriptor
val fis = FileInputStream(fileDescriptor)
val bytes = fis.readBytes()
if (bytes != null && bytes.isNotEmpty()) {
......
}
}
}
private val serviceConnection = object : ServiceConnection {
override fun onServiceConnected(name: ComponentName, binder: IBinder) {
mStub = IMyAidlInterface.Stub.asInterface(binder)
mStub?.registerCallback(callback)
}
override fun onServiceDisconnected(name: ComponentName) {
mStub = null
}
}
- 服務端發(fā)送文件铆惑,回調給客戶端唤反。此處僅貼出核心代碼,如下:
//AidlService.kt
private fun server2client(pfd:ParcelFileDescriptor){
val n=callbacks.beginBroadcast()
for(i in 0 until n){
val callback=callbacks.getBroadcastItem(i);
if (callback!=null){
try {
callback.server2client(pfd)
} catch (e:RemoteException) {
e.printStackTrace()
}
}
}
callbacks.finishBroadcast()
}
至此鸭津,我們實現(xiàn)了客戶端和服務端雙向通信和傳輸大文件??????
GitHub
本文完整的代碼已經(jīng)上傳GitHub,地址:https://github.com/kongpf8848/aidldemo