XuqmGroup b25a27c9f6 docs(sdk): 添加 Android SDK 架构总览文档 - 新增架构总览文档，包含整体架构图和依赖关系 - 详细描述初始化流程（ContentProvider 自动和手动两种方式） - 补充技术栈版本信息和发布说明 - 更新服务器端和Web端项目上下文文档 - 添加新模块 xuqm-log-service 的版本文件 - 在服务器端 POM 中注册 xuqm-log-service 模块 - 修复 Android SDK 字符串模板语法错误 - 修改服务器端 webhook 服务的 Redis 锁获取逻辑		2026-06-16 12:35:17 +08:00
..
src/main	docs(sdk): 添加 Android SDK 架构总览文档	2026-06-16 12:35:17 +08:00
build.gradle.kts	build: 各 SDK 模块独立版本，publish.gradle 改用 project.version	2026-05-21 16:48:10 +08:00
consumer-rules.pro	docs(test): 更新测试报告和文档	2026-05-05 16:06:32 +08:00
README.md	docs: 添加 CLAUDE.md + 各 module README + sdk-webview JSBridge 补全	2026-06-16 12:14:54 +08:00

README.md

sdk-core

XuqmGroup Android SDK 核心模块。提供 SDK 初始化、HTTP 请求、Token 管理、文件操作、通用工具。

依赖

implementation("com.xuqm:sdk-core:VERSION")

初始化

方式 A — ContentProvider 自动初始化（推荐）

将 config.xuqm 放入 src/main/assets/xuqm/，SDK 在 App 启动时自动读取并初始化。

// XuqmInitializerProvider 自动触发，无需代码

方式 B — 手动初始化

// Application.onCreate() 中：
XuqmSDK.initialize(context, appKey = "xxx")
XuqmSDK.initialize(context, appKey = "xxx", platformUrl = "https://xxx")

API

XuqmSDK（全局单例）

API	说明
`XuqmSDK.initialize(context, appKey, platformUrl?, logLevel?)`	手动初始化
`XuqmSDK.awaitInitialization()`	等待平台配置拉取（coroutine）
`XuqmSDK.isInitialized()`	检查是否已初始化
`XuqmSDK.setUserInfo(info)`	设置用户信息，触发所有子模块登录
`XuqmSDK.setUserInfo(null)`	登出，触发全局登出
`XuqmSDK.getUserId()`	获取当前 userId
`XuqmSDK.getUserInfo()`	获取当前用户信息
`XuqmSDK.appKey`	当前 appKey
`XuqmSDK.platformConfig`	平台配置（init 后可用）
`XuqmSDK.logApiUrl`	日志服务地址（从平台配置获取）
`XuqmSDK.logEnabled`	是否启用日志上报
`XuqmSDK.useLocalServiceEndpoints(ip)`	切换本地联调环境
`XuqmSDK.tokenStore`	Token 存储（EncryptedSharedPreferences）

XuqmUserInfo

data class XuqmUserInfo(
    val userId: String,      // 必填
    val userSig: String? = null,  // IM 登录凭证（可选）
    val name: String? = null,
    val phone: String? = null,
    val avatar: String? = null,
)

TokenStore

基于 EncryptedSharedPreferences 持久化存储。

XuqmSDK.tokenStore.saveToken("eyJ...")
val token = XuqmSDK.tokenStore.getToken()
XuqmSDK.tokenStore.clear()

ApiClient

基于 OkHttp 5 + Retrofit 3，自动附加 Bearer Token。

val service = RetrofitFactory.create(MyApiService::class.java)

FileSDK

文件上传、下载、打开的统一入口（com.xuqm.sdk.file）。

// 上传
val result = FileSDK.upload(context, uri, onProgress = { /* 0-100 */ })
val result = FileSDK.uploadBytes(fileName, mimeType, bytes, onProgress)

// 下载
val file = FileSDK.download(context, url, fileName, destination, notificationTitle, onProgress)

// 打开
FileSDK.openFile(context, file)

README.md Unescape Escape