this is a toolkit target android platform communicate to remote process, through interface-developing communication. if you got a situation to take ipc call to another process, but find aidl is rather hard to use, this toolkit might be useful for you.
sorry the repository does not provide compiled packages yet, we will publish latest releases as soon as possible.
- declare your process installations.
object ProcessManager {
private val context: Context get() = App.context
private val providers = ConcurrentHashMap<Address, IPCProvider>()
/**
* this means you want to get implementations towards main process,
* the following functions are the same.
*/
@JvmOverloads
fun <T> fromMainProcess(clazz: Class<T>, uniqueKey: String? = null): T {
return this.getProviderInstance(ProcessAddress.main)
.serviceCreate(clazz, uniqueKey)
}
@JvmOverloads
fun <T> fromBroadcastProcess(clazz: Class<T>, uniqueKey: String? = null): T {
return this.getProviderInstance(ProcessAddress.broadcast)
.serviceCreate(clazz, uniqueKey)
}
@JvmOverloads
fun <T> fromProviderProcess(clazz: Class<T>, uniqueKey: String? = null): T {
return this.getProviderInstance(ProcessAddress.provider)
.serviceCreate(clazz, uniqueKey)
}
private fun getProviderInstance(address: Address): IPCProvider {
return this.providers.getOrPut(address) { IPCProvider.on(address) }
}
object ProcessAddress {
val main: Address
get() = provider(context, context.getString(R.string.content_provider_main_ipc))
val broadcast: Address
get() = provider(context, context.getString(R.string.content_provider_lib_ipc))
val provider: Address
get() = provider(context, context.getString(R.string.content_provider_provider_ipc))
}
}- then in
AndroidManifest.xmladd android-component:
<?xml version="1.0" encoding="utf-8"?>
<manifest xmlns:android="http://schemas.android.com/apk/res/android">
<application>
<provider
android:authorities="@string/content_provider_main_ipc"
android:name=".Provider0"
android:exported="false" />
<provider
android:authorities="@string/content_provider_lib_ipc"
android:name=".Provider1"
android:process=":broadcast"
android:exported="false" />
<provider
android:authorities="@string/content_provider_provider_ipc"
android:name=".Provider2"
android:process=":provider"
android:exported="false" />
</application>
</manifest>- declare android component:
// class ProcessComponent
class Provider0 : ContentAndroidProvider()
class Provider1 : ContentAndroidProvider()
class Provider2 : ContentAndroidProvider()- declare provider authorities
<?xml version="1.0" encoding="utf-8" ?>
<resources>
<string name="content_provider_main_ipc">com.android.inter.process.provider.main</string>
<string name="content_provider_lib_ipc">com.android.inter.process.provider.broadcast</string>
<string name="content_provider_provider_ipc">com.android.inter.process.provider.provider</string>
</resources>- initialize at app start this is just the template code for app start, you can design installation patterns of your own.
class App : Application() {
override fun attachBaseContext(base: Context?) {
super.attachBaseContext(base)
context = this
val packageName = getProcessName(this)
println("process name: ${packageName}.")
if (packageName.endsWith(":broadcast")) { // broadcast process
IPCManager.installAndroid(InitConfig(ProcessManager.ProcessAddress.broadcast))
} else if (packageName.endsWith(":provider")) { // provider process
IPCManager.installAndroid(InitConfig(ProcessManager.ProcessAddress.provider))
} else if (!packageName.contains(":")) { // main process
IPCManager.installAndroid(InitConfig(ProcessManager.ProcessAddress.main))
}
}
companion object {
fun getProcessName(context: Context): String {
val pid = Process.myPid()
return kotlin.runCatching {
(context.getSystemService(Context.ACTIVITY_SERVICE) as? ActivityManager)
?.runningAppProcesses?.find { it.pid == pid }?.processName
}.getOrNull() ?: ""
}
}
}- declare your own interface
as we designed, many type of classes is supported transportation through binder, like primitive types, serializable types, parcelable types etc.
any types that support with [binder] does supported in this toolkit.
data class Metadata(val data: Long, val string: String): Seriazliable
// kapt or ksp tool will generate helper code to improve running performance.
@IPCService
interface MyInterface : INoProguard {
fun getMetadata(): Metadata
suspend fun getMetadataSuspend(): Metadata
}- add ksp or kapt dependencies to your module.
dependencies {
// wait for further release publish.
implementation("xxx:xxx:1.0.0")
}- declare your interface implementations
class MyInterfaceService : MyInterface {
override fun getMetadata(): Metadata {
return Metadata(1L, "")
}
override suspend fun getMetadataSuspend(): Metadata {
return Metadata(1L, "")
}
}- declare implementation collector
@IPCServiceFactory(interfaceClazz = MyInterface::class, uniqueKey = "")
class MyInterfaceServiceFactory : ServiceFactory<MyInterface> {
override fun serviceCreate(): MyInterfae {
return MyInterfaceService()
}
}- use in your code
fun main() {
val myInterface = ProcessManager.fromPlayerProcess(MyInterface::class.java)
val metadata: Metadata? = kotlin.runCatching {
myInterface.getMetadata()
}.getOrNull()
}- define different implementation of one interface
const val KEY_INTERFACE_A = "key_a"
const val KEY_INTERFACE_B = "key_b"
@IPCServiceFactory(interfaceClazz = MyInterface::class, uniqueKey = KEY_INTERFACE_A)
class MyInterfaceServiceFactory : ServiceFactory<MyInterface> {
override fun serviceCreate(): MyInterfae {
// provide different implementation here.
return MyInterfaceServiceA()
}
}
@IPCServiceFactory(interfaceClazz = MyInterface::class, uniqueKey = KEY_INTERFACE_B)
class MyInterfaceServiceFactory : ServiceFactory<MyInterface> {
override fun serviceCreate(): MyInterfae {
// provide different implementation here.
return MyInterfaceServiceB()
}
}
fun main() {
// decide the specific process you want to communicate to.
// and then enjoy your self.
val myInterfaceA = ProcessManager.fromBroadcastProcess(MyInterface::class.java, KEY_INTERFACE_A)
val myInterfaceB = ProcessManager.fromBroadcastProcess(MyInterface::class.java, KEY_INTERFACE_B)
// do your jobs.
}MIT License
Copyright (c) 202503 liuzhongao
Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.