Multiplatform IM SDK: unified network, sync, local DB and event layers with Wire-generated protobufs, Ktor client, SQLDelight, coroutines and catalog-driven Gradle dependency management.
XueHua IM 的 Kotlin Multiplatform SDK，支持 Android、iOS、JVM、JS 与 Wasm。
| 模块 | 说明 |
|---|---|
:shared | 对外发布的 KMP SDK（网络、同步、数据库、事件等） |
:proto | OpenIM .proto 定义，使用 Square Wire 生成 Kotlin 代码 |
gradle/wrapper/gradle-wrapper.properties）gradle/libs.versions.toml本项目使用 Gradle Version Catalog 统一管理插件与依赖版本，配置文件位于：
gradle/libs.versions.toml
libs.versions.toml 分为三段：
根工程 build.gradle.kts — 声明插件（不立即应用）：
plugins {
alias(libs.plugins.kotlinMultiplatform) apply false
alias(libs.plugins.wire) apply false
// ...
}
子模块 shared/build.gradle.kts — 应用插件与依赖：
plugins {
alias(libs.plugins.kotlinMultiplatform)
alias(libs.plugins.sqldelight)
}
kotlin {
sourceSets {
commonMain.dependencies {
implementation(libs.kotlinx.coroutines.core)
implementation(libs.wire.runtime)
implementation(libs.ktor.client.core)
}
androidMain.dependencies {
implementation(libs.ktor.client.okhttp)
}
}
}
Android 编译参数 同样来自 catalog：
android {
compileSdk = libs.versions.android.compileSdk.get().toInt()
minSdk = libs.versions.android.minSdk.get().toInt()
}
settings.gradle.kts中已启用enableFeaturePreview("TYPESAFE_PROJECT_ACCESSORS")，因此可通过libs.xxx类型安全访问 catalog 条目。
[versions] 增加或修改版本号[libraries] 或 [plugins] 增加别名build.gradle.kts 中使用 libs.xxx 引用示例 — 添加 OkHttp 版本：
# gradle/libs.versions.toml
[versions]
okhttp = "4.12.0"
[libraries]
okhttp = { module = "com.squareup.okhttp3:okhttp", version.ref = "okhttp" }
// shared/build.gradle.kts
androidMain.dependencies {
implementation(libs.okhttp)
}
# 编译 JVM
./gradlew :shared:compileKotlinJvm
# 运行 JVM 单元测试
./gradlew :shared:jvmTest
# 编译 iOS / Wasm
./gradlew :shared:compileKotlinIosSimulatorArm64 :shared:compileKotlinWasmJs
# 全量 assemble
./gradlew :shared:assemble
./gradlew :shared:publishToMavenLocal
发布坐标（见 shared/build.gradle.kts）：
io.github.matkurbanxuehuasdk1.0.0在业务工程的 gradle/libs.versions.toml 中声明 SDK 版本：
[versions]
xuehuasdk = "1.0.0"
[libraries]
xuehuasdk = { module = "io.github.matkurban:xuehuasdk", version.ref = "xuehuasdk" }
shared/build.gradle.kts 依赖：
kotlin {
sourceSets {
commonMain.dependencies {
implementation(libs.xuehuasdk)
}
}
}
Android 额外依赖（若使用 AAR 变体）：
dependencies {
implementation(libs.xuehuasdk)
}
// commonMain
implementation("io.github.matkurban:xuehuasdk:1.0.0")
// settings.gradle.kts
includeBuild("../XueHuaSDK")
// build.gradle.kts
implementation(project(":shared"))
import com.kurban.xuehuaim.sdk.OpenIM
import com.kurban.xuehuaim.sdk.config.InitConfig
OpenIM.initialize(
InitConfig(
apiAddr = "https://your-api.example.com",
wsAddr = "wss://your-ws.example.com",
authAddr = "https://your-auth.example.com",
),
)
val imManager = OpenIM.iMManager
// imManager.login(...)
// API 命名与 openim_sdk (Dart) 一致，例如：
请根据项目实际情况补充许可证信息。
[versions]
# 版本号集中定义
kotlin = "2.4.0"
wire = "6.4.0"
ktor = "3.5.0"
# ...
[libraries]
# 依赖别名，引用 [versions] 中的 version.ref
kotlinx-coroutines-core = { module = "org.jetbrains.kotlinx:kotlinx-coroutines-core", version.ref = "kotlinx-coroutines" }
wire-runtime = { module = "com.squareup.wire:wire-runtime", version.ref = "wire" }
# ...
[plugins]
# Gradle 插件别名
kotlinMultiplatform = { id = "org.jetbrains.kotlin.multiplatform", version.ref = "kotlin" }
wire = { id = "com.squareup.wire", version.ref = "wire" }
# ...
| 能力 | 库 | catalog 别名 |
|---|
| 网络 | Ktor Client | libs.ktor.client.* |
| Protobuf | Square Wire | libs.wire.runtime / libs.plugins.wire |
| 本地数据库 | SQLDelight | libs.sqldelight.* |
| 序列化 | kotlinx.serialization | libs.kotlinx.serialization.json |
| DI | Koin | libs.koin.core |
| 协程 | kotlinx.coroutines | libs.kotlinx.coroutines.core |
Surfaced from shared tags and platforms — no rankings paid for.