7b7989525f
- 添加 expiresAt 和 refreshUserSig 参数支持自动续签 - 修改 PushSDK 初始化方式，自动完成设备注册和厂商初始化 - 调整过期续签策略，从提前 15 分钟改为提前 5 分钟触发 - 重构 RN SDK 文档结构，简化安装和使用方式 - 更新统一登录流程，支持 profile 信息传递 - 添加 IM 数据库自动隔离功能 - 修复 Android 群消息聚合问题 - 补充自动化测试验证和错误处理机制
123 行
3.3 KiB
Markdown
123 行
3.3 KiB
Markdown
# 快速开始
|
||
|
||
5 分钟接入 XuqmGroup IM，实现消息收发。
|
||
|
||
## 1. 注册账号与创建应用
|
||
|
||
1. 访问 [XuqmGroup 控制台](https://dev.xuqinmin.com)
|
||
2. 注册租户账号，创建应用
|
||
3. 记录 `appKey`（Android）或 `appId + appSecret`（iOS）
|
||
|
||
## 2. 选择你的平台
|
||
|
||
| 平台 | 推荐接入方式 |
|
||
|------|------------|
|
||
| Android | [Android SDK →](/android/) |
|
||
| iOS | [iOS SDK →](/ios/) |
|
||
| React Native | [RN SDK →](/rn/) |
|
||
| Vue3 / Web | [Vue3 SDK →](/vue3/) |
|
||
| HarmonyOS | [HarmonyOS SDK →](/harmony/) |
|
||
|
||
## 3. 演示环境
|
||
|
||
所有 SDK 均可直接连接演示环境验证功能：
|
||
|
||
```
|
||
API 地址：https://dev.xuqinmin.com
|
||
WS 地址：wss://dev.xuqinmin.com/ws/im
|
||
演示 AppKey：ak_demo_chat
|
||
演示用户：demo_alice / demo_bob
|
||
```
|
||
|
||
## 4. 演示项目
|
||
|
||
手机端演示包和 Web 演示入口单独放在 [演示项目](/demo/) 页面，便于直接扫码或跳转验证。
|
||
|
||
## 5. 接入流程
|
||
|
||
```
|
||
你的业务服务端
|
||
→ 持有 appKey/appSecret
|
||
→ 调用 IM 登录接口换取 IM Token（或签发 UserSig JWT）
|
||
→ 平台内部协议字段由 SDK 和后端自动处理，业务方无需感知
|
||
→ 返回 Token / UserSig 给客户端
|
||
|
||
客户端 SDK
|
||
→ 使用 Token / UserSig 初始化 IM 连接
|
||
→ 建立 WebSocket 长连接
|
||
→ 开始收发消息
|
||
```
|
||
|
||
> **安全提示**：appSecret 应仅在你的服务端持有，不应下发给客户端。
|
||
|
||
---
|
||
|
||
## 6. Android Demo 运行说明
|
||
|
||
### 环境要求
|
||
|
||
- Android Studio Ladybug（2024.2.1）或更高版本
|
||
- JDK 21
|
||
- Android 模拟器或真机（API 24+）
|
||
|
||
### 运行步骤
|
||
|
||
1. 打开 `XuqmGroup-AndroidSDK` 目录为 Android Studio 项目
|
||
2. 等待 Gradle Sync 完成（首次可能需要下载依赖）
|
||
3. 在 `sample-app/src/main/java/.../MainActivity.kt` 或对应配置中修改服务器地址（如需连接本地环境）
|
||
4. 选择模拟器或真机，点击 **Run 'sample-app'**
|
||
5. 使用演示账号登录：`user_a` / `123456` 或 `user_b` / `123456`
|
||
|
||
### 关键路径
|
||
|
||
```
|
||
APK 输出：XuqmGroup-AndroidSDK/sample-app/build/outputs/apk/debug/sample-app-debug.apk
|
||
主 Activity：com.xuqm.sdk.sample.MainActivity
|
||
包名：com.xuqm.demo
|
||
```
|
||
|
||
### 常用命令
|
||
|
||
```bash
|
||
# 构建全量 SDK + App
|
||
cd XuqmGroup-AndroidSDK && ./gradlew clean build
|
||
|
||
# 安装到指定设备
|
||
adb -s emulator-5556 install -r sample-app/build/outputs/apk/debug/sample-app-debug.apk
|
||
|
||
# 查看 IM 日志
|
||
adb -s emulator-5556 logcat -d "*:S" XuqmImSDK:D XuqmImClient:D 2>/dev/null | tail -30
|
||
```
|
||
|
||
---
|
||
|
||
## 7. iOS Demo 运行说明
|
||
|
||
### 环境要求
|
||
|
||
- Xcode 16.0 或更高版本
|
||
- iOS 18 模拟器或真机（最低支持 iOS 14）
|
||
- Swift 5.9+
|
||
|
||
### 运行步骤
|
||
|
||
1. 打开 `XuqmGroup-iOSSDK/XuqmDemo/XuqmDemo.xcodeproj`（或 `.xcworkspace`）
|
||
2. 等待 Swift Package Manager 依赖解析完成
|
||
3. 在 Xcode 顶部选择目标模拟器（如 iPhone 16 Pro）或连接的真机
|
||
4. 点击 **Run**（⌘+R）
|
||
5. 使用演示账号登录验证消息收发
|
||
|
||
### 关键路径
|
||
|
||
```
|
||
Demo 工程：XuqmGroup-iOSSDK/XuqmDemo/XuqmDemo.xcodeproj
|
||
SDK 源码：XuqmGroup-iOSSDK/Sources/XuqmSDK/
|
||
单元测试：XuqmGroup-iOSSDK/Tests/
|
||
```
|
||
|
||
### 常见问题
|
||
|
||
- **SPM 依赖下载慢**：检查网络或更换 Xcode → Preferences → Accounts → Git 配置
|
||
- **真机运行失败**：确保 Apple Developer Account 已配置 Signing & Capabilities
|
||
- **Push 测试**：模拟器不支持 APNs，Push 功能需在真机测试
|
