xuqmGroup/XuqmGroup-Web
0
0
派生 0
代码 工单 合并请求 版本发布 百科 动态
6cd938cfbc
XuqmGroup-Web/docs-site/docs/guide/quickstart.md

123 行
3.3 KiB
Markdown
原始文件 普通视图 文件历史

feat: add VitePress docs-site with full SDK integration guides - Add docs-site workspace (VitePress 1.5.0) with Android/iOS/RN/Vue3/HarmonyOS/Server docs - Update Dockerfile to build and serve docs under /docs/ - Add /docs/ location block to Nginx config - Add docs-site to yarn workspaces Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
2026-04-24 15:35:24 +08:00
# 快速开始
5 分钟接入 XuqmGroup IM，实现消息收发。
## 1. 注册账号与创建应用
feat(sdk): 初始化 Android SDK 核心功能模块 - 添加 SDK 配置管理、网络请求客户端和令牌存储功能 - 实现即时通讯 IM 模块，包括消息收发、群组管理和会话功能 - 集成推送服务和应用更新功能模块 - 创建示例应用演示 SDK 使用方法 - 配置项目依赖管理和构建设置
2026-04-27 17:18:56 +08:00
1. 访问 [XuqmGroup 控制台](https://dev.xuqinmin.com)
feat: add VitePress docs-site with full SDK integration guides - Add docs-site workspace (VitePress 1.5.0) with Android/iOS/RN/Vue3/HarmonyOS/Server docs - Update Dockerfile to build and serve docs under /docs/ - Add /docs/ location block to Nginx config - Add docs-site to yarn workspaces Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
2026-04-24 15:35:24 +08:00
2. 注册租户账号，创建应用
feat(sdk): 更新 SDK 设计文档和 API 重构 - 添加 expiresAt 和 refreshUserSig 参数支持自动续签 - 修改 PushSDK 初始化方式，自动完成设备注册和厂商初始化 - 调整过期续签策略，从提前 15 分钟改为提前 5 分钟触发 - 重构 RN SDK 文档结构，简化安装和使用方式 - 更新统一登录流程，支持 profile 信息传递 - 添加 IM 数据库自动隔离功能 - 修复 Android 群消息聚合问题 - 补充自动化测试验证和错误处理机制
2026-05-01 21:27:39 +08:00
3. 记录 `appKey`（Android）或 `appId + appSecret`（iOS）
feat: add VitePress docs-site with full SDK integration guides - Add docs-site workspace (VitePress 1.5.0) with Android/iOS/RN/Vue3/HarmonyOS/Server docs - Update Dockerfile to build and serve docs under /docs/ - Add /docs/ location block to Nginx config - Add docs-site to yarn workspaces Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
2026-04-24 15:35:24 +08:00
## 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 均可直接连接演示环境验证功能：
```
feat(sdk): 初始化 Android SDK 核心功能模块 - 添加 SDK 配置管理、网络请求客户端和令牌存储功能 - 实现即时通讯 IM 模块，包括消息收发、群组管理和会话功能 - 集成推送服务和应用更新功能模块 - 创建示例应用演示 SDK 使用方法 - 配置项目依赖管理和构建设置
2026-04-27 17:18:56 +08:00
API 地址：https://dev.xuqinmin.com
WS 地址：wss://dev.xuqinmin.com/ws/im
docs(sdk): 添加 Android SDK 文档和 API 设计规范 - 新增 Android SDK 使用文档，包含模块结构、集成方式和快速开始指南 - 添加 SDK API 重设计规范，统一初始化和登录接口设计 - 补充安全设计规范，完善 UserSig 鉴权和敏感数据处理方案 - 创建平台 REST API 规范，定义服务端到服务端的调用接口 - 添加离线推送架构设计，集成各大厂商推送服务与 IM 联动方案
2026-04-29 15:46:40 +08:00
演示 AppKey：ak_demo_chat
feat: add VitePress docs-site with full SDK integration guides - Add docs-site workspace (VitePress 1.5.0) with Android/iOS/RN/Vue3/HarmonyOS/Server docs - Update Dockerfile to build and serve docs under /docs/ - Add /docs/ location block to Nginx config - Add docs-site to yarn workspaces Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
2026-04-24 15:35:24 +08:00
演示用户：demo_alice / demo_bob
```
docs(server): 添加服务器信息记录和联调接口文档 - 创建信息记录文档，包含项目管理要求、产物范围、Git仓库、制品仓库信息 - 添加服务器部署信息，包括应用服务器、MySQL/Redis服务器、Jenkins服务配置 - 记录邮件服务、DNS/HTTPS证书配置及安全备注 - 创建API联调文档，包含线上入口、ID约定、初始化管理员账号信息 - 添加统一响应格式、常见错误码、鉴权规则说明 - 提供核心接口清单，涵盖tenant-service、im-service、push-service等服务 - 补充curl示例，包含运营平台登录、IM登录、会话管理等操作示例 - 实现会话控制器，支持置顶、免打扰、标记已读、草稿等功能 - 添加全局异常处理器，统一处理业务异常和参数校验错误 - 创建IM管理控制器，提供用户管理、好友请求、黑名单等管理功能
2026-04-29 12:33:26 +08:00
## 4. 演示项目
手机端演示包和 Web 演示入口单独放在 [演示项目](/demo/) 页面，便于直接扫码或跳转验证。
## 5. 接入流程
feat: add VitePress docs-site with full SDK integration guides - Add docs-site workspace (VitePress 1.5.0) with Android/iOS/RN/Vue3/HarmonyOS/Server docs - Update Dockerfile to build and serve docs under /docs/ - Add /docs/ location block to Nginx config - Add docs-site to yarn workspaces Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
2026-04-24 15:35:24 +08:00
```
你的业务服务端
docs(sdk): 添加 Android SDK 文档和 API 设计规范 - 新增 Android SDK 使用文档，包含模块结构、集成方式和快速开始指南 - 添加 SDK API 重设计规范，统一初始化和登录接口设计 - 补充安全设计规范，完善 UserSig 鉴权和敏感数据处理方案 - 创建平台 REST API 规范，定义服务端到服务端的调用接口 - 添加离线推送架构设计，集成各大厂商推送服务与 IM 联动方案
2026-04-29 15:46:40 +08:00
→ 持有 appKey/appSecret
feat(sdk): 更新 SDK 设计文档和 API 重构 - 添加 expiresAt 和 refreshUserSig 参数支持自动续签 - 修改 PushSDK 初始化方式，自动完成设备注册和厂商初始化 - 调整过期续签策略，从提前 15 分钟改为提前 5 分钟触发 - 重构 RN SDK 文档结构，简化安装和使用方式 - 更新统一登录流程，支持 profile 信息传递 - 添加 IM 数据库自动隔离功能 - 修复 Android 群消息聚合问题 - 补充自动化测试验证和错误处理机制
2026-05-01 21:27:39 +08:00
→ 调用 IM 登录接口换取 IM Token（或签发 UserSig JWT）
docs(sdk): 添加 Android SDK 文档和 API 设计规范 - 新增 Android SDK 使用文档，包含模块结构、集成方式和快速开始指南 - 添加 SDK API 重设计规范，统一初始化和登录接口设计 - 补充安全设计规范，完善 UserSig 鉴权和敏感数据处理方案 - 创建平台 REST API 规范，定义服务端到服务端的调用接口 - 添加离线推送架构设计，集成各大厂商推送服务与 IM 联动方案
2026-04-29 15:46:40 +08:00
→ 平台内部协议字段由 SDK 和后端自动处理，业务方无需感知
feat(sdk): 更新 SDK 设计文档和 API 重构 - 添加 expiresAt 和 refreshUserSig 参数支持自动续签 - 修改 PushSDK 初始化方式，自动完成设备注册和厂商初始化 - 调整过期续签策略，从提前 15 分钟改为提前 5 分钟触发 - 重构 RN SDK 文档结构，简化安装和使用方式 - 更新统一登录流程，支持 profile 信息传递 - 添加 IM 数据库自动隔离功能 - 修复 Android 群消息聚合问题 - 补充自动化测试验证和错误处理机制
2026-05-01 21:27:39 +08:00
→ 返回 Token / UserSig 给客户端
feat: add VitePress docs-site with full SDK integration guides - Add docs-site workspace (VitePress 1.5.0) with Android/iOS/RN/Vue3/HarmonyOS/Server docs - Update Dockerfile to build and serve docs under /docs/ - Add /docs/ location block to Nginx config - Add docs-site to yarn workspaces Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
2026-04-24 15:35:24 +08:00
客户端 SDK
feat(sdk): 更新 SDK 设计文档和 API 重构 - 添加 expiresAt 和 refreshUserSig 参数支持自动续签 - 修改 PushSDK 初始化方式，自动完成设备注册和厂商初始化 - 调整过期续签策略，从提前 15 分钟改为提前 5 分钟触发 - 重构 RN SDK 文档结构，简化安装和使用方式 - 更新统一登录流程，支持 profile 信息传递 - 添加 IM 数据库自动隔离功能 - 修复 Android 群消息聚合问题 - 补充自动化测试验证和错误处理机制
2026-05-01 21:27:39 +08:00
→ 使用 Token / UserSig 初始化 IM 连接
feat: add VitePress docs-site with full SDK integration guides - Add docs-site workspace (VitePress 1.5.0) with Android/iOS/RN/Vue3/HarmonyOS/Server docs - Update Dockerfile to build and serve docs under /docs/ - Add /docs/ location block to Nginx config - Add docs-site to yarn workspaces Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
2026-04-24 15:35:24 +08:00
→ 建立 WebSocket 长连接
→ 开始收发消息
```
> **安全提示**：appSecret 应仅在你的服务端持有，不应下发给客户端。
feat(sdk): 更新 SDK 设计文档和 API 重构 - 添加 expiresAt 和 refreshUserSig 参数支持自动续签 - 修改 PushSDK 初始化方式，自动完成设备注册和厂商初始化 - 调整过期续签策略，从提前 15 分钟改为提前 5 分钟触发 - 重构 RN SDK 文档结构，简化安装和使用方式 - 更新统一登录流程，支持 profile 信息传递 - 添加 IM 数据库自动隔离功能 - 修复 Android 群消息聚合问题 - 补充自动化测试验证和错误处理机制
2026-05-01 21:27:39 +08:00
---
## 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 功能需在真机测试
在新工单中引用 复制永久链接