WuKongIM Docs

WuKongEasySDK

选择平台,使用固定版本完成第一次在线双向收发。

编辑此页报告文档问题

WuKongEasySDK 提供轻量的连接、在线消息和事件 API。你负责业务后端与界面,SDK 负责通过 WebSocket JSON-RPC CONNECT 建立认证连接并收发消息。先选择平台;需要准备服务端和测试账号时,跟随运行官方示例

选择平台,发送第一条消息

是否适合你的应用

选择 EasySDK,如果你只需要选择完整版 WuKongIMSDK,如果你还需要
WebSocket 连接与自动重连本地消息数据库与离线恢复
单聊或群聊 Channel 的在线消息会话列表、未读数与消息同步
发送结果和实时消息事件推送、多设备与完整平台能力
自己维护 UI、持久化和业务回执SDK 承担更多客户端消息状态

EasySDK 不是聊天 UI,也不是完整产品后端。send 成功表示服务端返回了发送结果,不表示对方已经收到、展示或处理消息。需要完整能力时,回到 SDK 选择

先认识三个概念

Channel(频道) 是消息的目标。单聊时,发送目标是对方 UID;群聊时,目标是后端创建的群 ID。

Payload(消息内容) 是应用约定的 JSON,例如 {"type":1,"content":"你好"}。SDK 收到消息后,把内容交给你的 UI 或业务处理代码。

发送结果 表示服务端返回的处理结果。它与“对方收到”和“对方已读”不同;首次接入要分别观察发送端结果和接收端事件。

准备连接材料

客户端不应该创建自己的身份或调用 Product HTTP 管理接口。用户登录产品后,受信业务后端通过 HTTPS 返回最小连接材料:

{
  "uid": "alice",
  "token": "short-lived-token",
  "websocketUrl": "wss://im.example.com/ws"
}
字段所有者与约束
uid业务后端确认的稳定用户标识;Alice 与 Bob 必须不同
token短期、可撤销,只用于当前身份连接;不能授予 Product HTTP 管理权限
websocketUrl后端从部署配置或安全路由结果中选择;生产环境使用 wss://

先完成认证与 Token。当前默认组合会把 CONNECT Token 与 /user/token 保存的相同 UID、设备类别记录精确匹配;部署仍必须保护该接口、实现过期与轮换策略,并证明无效、撤销和按业务规则过期的 Token 会被拒绝。

跑通 Alice 与 Bob

各平台遵循同一条最小路径:

  1. 为 Alice 和 Bob 分别取得自己的 uid、短期 tokenwebsocketUrl
  2. 在两个独立设备、进程或浏览器上下文中按平台教程创建客户端;
  3. 两端都观察到连接成功后,Alice 向个人 Channel bob 发送文本 JSON Payload;
  4. Alice 保存发送结果,Bob 在实时消息事件中核对 fromUid、Channel 与 Payload;
  5. Bob 向 Alice 回发,验证反向链路;
  6. 退出页面或账号,移除监听器并断开连接,确认没有重复事件或后台连接。

这个闭环只验证在线消息。发送确认、实时接收与业务完成是三个不同状态,具体建模见消息收发

退出时释放资源

平台事件订阅与取消连接所有者退出
iOSonMessage / removeListenerdisconnect()
AndroidaddEventListener / removeEventListenerdisconnect()
FlutteraddEventListener / removeEventListenerdisconnect() + dispose()
Webon / offdestroy()
Rustsubscribe() / drop receiverdestroy().await
C#+= / -=await using / DisposeAsync()
C++on / off(listenerId)destroy().get()
Pythonon / offasync with / await destroy()

连接通常由应用级对象持有。页面只移除自己的订阅,退出账号时再释放连接。各平台的单例、线程和重连约束不同,按对应教程处理。

版本与兼容性

平台本教程版本安装来源
iOS1.1.1Swift Package Manager / CocoaPods
Android1.0.5Maven Central
Flutter1.1.0pub.dev
Web2.0.5npm
Rust0.1.0crates.io
C#1.0.0NuGet
C++0.1.0vcpkg / ZIP
Python0.1.0PyPI

教程固定上表版本,方便复现与排障。Web 2.0.5 包含握手失败时的重连修复,见发布说明。C++ 使用 WuKongIM 自定义 registry 或匹配系统的预编译包。

本次入门目标是在线双向消息;自动重连不会补拉离线历史,也不等于自动切换到其他节点。集群故障恢复与成员更新还取决于服务端版本。完整历史运行环境、成功与失败范围见工程验证记录

下一步

运行官方示例 → 选择平台教程 → 完成双向收发 → 按上线检查验证实际设备、WSS、Token 轮换和故障恢复。

本页内容