open-im-sdk-web 的安装和配置教程
2025-05-25 14:13:59作者:凌朦慧Richard
1. 项目基础介绍和主要编程语言
open-im-sdk-web
是一个开源项目,它提供了用于在网页应用中集成即时通讯功能的 JavaScript SDK。通过连接到自托管的 OpenIM
服务器,开发者可以轻松地将即时通讯功能集成到自己的应用程序中。该项目主要使用 TypeScript 语言开发,以确保类型的正确性和代码的健壮性。
2. 项目使用的关键技术和框架
该项目依赖于以下关键技术和框架:
- TypeScript:一种由微软开发的开源编程语言,它是 JavaScript 的一个超集,添加了静态类型选项。
- WebSocket:一种网络通信协议,提供了一个在单个 TCP 连接上进行全双工通讯的方式。
- OpenIM SDK Core:
open-im-sdk-web
通过与 OpenIM SDK Core 的 WebSocket 代理层通信来实现功能。
3. 项目安装和配置的准备工作及详细安装步骤
准备工作
在开始安装之前,请确保你已经安装了以下环境:
- Node.js:JavaScript 的运行环境,用于执行 npm 命令。
- npm:Node.js 的包管理工具,用于管理项目依赖。
安装步骤
以下是将 open-im-sdk-web
SDK 集成到你的项目中的详细步骤:
-
克隆项目
首先,你需要克隆或下载项目到你的本地环境。你可以使用以下命令:
git clone https://github.com/openimsdk/open-im-sdk-web.git
-
安装依赖
进入项目目录后,使用 npm 安装项目依赖:
cd open-im-sdk-web npm install
-
集成 SDK
在你的项目中,你可以通过以下方式引入
open-im-sdk-web
SDK:import { OpenIMSDK } from 'open-im-sdk';
-
配置 SDK
在使用 SDK 之前,你需要配置 SDK 的参数,包括用户 ID、token、服务器地址等。以下是一个示例配置:
const OpenIM = new OpenIMSDK({ userID: 'IM user ID', token: 'IM user token', platformID: 5, wsAddr: 'ws://your-server-ip:10003', apiAddr: 'http://your-server-ip:10002', });
-
登录和监听事件
在配置完 SDK 后,你可以监听连接状态事件,并执行登录操作:
OpenIM.on(CbEvents.OnConnecting, handleConnecting); OpenIM.on(CbEvents.OnConnectFailed, handleConnectFailed); OpenIM.on(CbEvents.OnConnectSuccess, handleConnectSuccess); OpenIM.login({ userID: 'IM user ID', token: 'IM user token', platformID: 5, wsAddr: 'ws://your-server-ip:10003', apiAddr: 'http://your-server-ip:10002', }); function handleConnecting() { // 正在连接... } function handleConnectFailed({ errCode, errMsg }: WsResponse) { // 连接失败 ❌ console.log(errCode, errMsg); } function handleConnectSuccess() { // 连接成功 ✅ }
-
发送和接收消息
最后,你可以监听新消息事件,并发送消息给其他用户:
OpenIM.on(CbEvents.OnRecvNewMessages, handleNewMessages); const message = (await OpenIM.createTextMessage('hello openim')).data; OpenIM.sendMessage({ recvID: 'recipient user ID', groupID: '', message, }).then(() => { // 消息发送成功 ✉️ }).catch(err => { // 发送消息失败 ❌ console.log(err); }); function handleNewMessages({ data }: WsResponse<MessageItem[]>) { // 新消息列表 📨 console.log(data); }
完成以上步骤后,你就可以在你的网页应用中使用 open-im-sdk-web
SDK 实现即时通讯功能了。
登录后查看全文
热门项目推荐
- QQwen3-Next-80B-A3B-InstructQwen3-Next-80B-A3B-Instruct 是一款支持超长上下文(最高 256K tokens)、具备高效推理与卓越性能的指令微调大模型00
- QQwen3-Next-80B-A3B-ThinkingQwen3-Next-80B-A3B-Thinking 在复杂推理和强化学习任务中超越 30B–32B 同类模型,并在多项基准测试中优于 Gemini-2.5-Flash-Thinking00
GitCode-文心大模型-智源研究院AI应用开发大赛
GitCode&文心大模型&智源研究院强强联合,发起的AI应用开发大赛;总奖池8W,单人最高可得价值3W奖励。快来参加吧~0267cinatra
c++20实现的跨平台、header only、跨平台的高性能http库。C++00AI内容魔方
AI内容专区,汇集全球AI开源项目,集结模块、可组合的内容,致力于分享、交流。02- HHunyuan-MT-7B腾讯混元翻译模型主要支持33种语言间的互译,包括中国五种少数民族语言。00
GOT-OCR-2.0-hf
阶跃星辰StepFun推出的GOT-OCR-2.0-hf是一款强大的多语言OCR开源模型,支持从普通文档到复杂场景的文字识别。它能精准处理表格、图表、数学公式、几何图形甚至乐谱等特殊内容,输出结果可通过第三方工具渲染成多种格式。模型支持1024×1024高分辨率输入,具备多页批量处理、动态分块识别和交互式区域选择等创新功能,用户可通过坐标或颜色指定识别区域。基于Apache 2.0协议开源,提供Hugging Face演示和完整代码,适用于学术研究到工业应用的广泛场景,为OCR领域带来突破性解决方案。00- HHowToCook程序员在家做饭方法指南。Programmer's guide about how to cook at home (Chinese only).Dockerfile06
- PpathwayPathway is an open framework for high-throughput and low-latency real-time data processing.Python00
热门内容推荐
最新内容推荐
项目优选
收起

OpenHarmony documentation | OpenHarmony开发者文档
Dockerfile
144
1.93 K

deepin linux kernel
C
22
6

React Native鸿蒙化仓库
C++
192
274

openGauss kernel ~ openGauss is an open source relational database management system
C++
145
189

🎉 (RuoYi)官方仓库 基于SpringBoot,Spring Security,JWT,Vue3 & Vite、Element Plus 的前后端分离权限管理系统
Vue
930
553

Nop Platform 2.0是基于可逆计算理论实现的采用面向语言编程范式的新一代低代码开发平台,包含基于全新原理从零开始研发的GraphQL引擎、ORM引擎、工作流引擎、报表引擎、规则引擎、批处理引引擎等完整设计。nop-entropy是它的后端部分,采用java语言实现,可选择集成Spring框架或者Quarkus框架。中小企业可以免费商用
Java
8
0

旨在打造算法先进、性能卓越、高效敏捷、安全可靠的密码套件,通过轻量级、可剪裁的软件技术架构满足各行业不同场景的多样化要求,让密码技术应用更简单,同时探索后量子等先进算法创新实践,构建密码前沿技术底座!
C
423
392

为非计算机科班出身 (例如财经类高校金融学院) 同学量身定制,新手友好,让学生以亲身实践开源开发的方式,学会使用计算机自动化自己的科研/创新工作。案例以量化投资为主线,涉及 Bash、Python、SQL、BI、AI 等全技术栈,培养面向未来的数智化人才 (如数据工程师、数据分析师、数据科学家、数据决策者、量化投资人)。
Jupyter Notebook
75
66

为仓颉编程语言开发者打造活跃、开放、高质量的社区环境
Markdown
1.11 K
0

本仓将为广大高校开发者提供开源实践和创新开发平台,收集和展示openHiTLS示例代码及创新应用,欢迎大家投稿,让全世界看到您的精巧密码实现设计,也让更多人通过您的优秀成果,理解、喜爱上密码技术。
C
64
509