open-im-sdk-web 的安装和配置教程
2025-05-25 18:19:33作者:凌朦慧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 实现即时通讯功能了。
登录后查看全文
热门项目推荐
- DDeepSeek-V3.1-BaseDeepSeek-V3.1 是一款支持思考模式与非思考模式的混合模型Python00
- QQwen-Image-Edit基于200亿参数Qwen-Image构建,Qwen-Image-Edit实现精准文本渲染与图像编辑,融合语义与外观控制能力Jinja00
GitCode-文心大模型-智源研究院AI应用开发大赛
GitCode&文心大模型&智源研究院强强联合,发起的AI应用开发大赛;总奖池8W,单人最高可得价值3W奖励。快来参加吧~050CommonUtilLibrary
快速开发工具类收集,史上最全的开发工具类,欢迎Follow、Fork、StarJava04GitCode百大开源项目
GitCode百大计划旨在表彰GitCode平台上积极推动项目社区化,拥有广泛影响力的G-Star项目,入选项目不仅代表了GitCode开源生态的蓬勃发展,也反映了当下开源行业的发展趋势。06GOT-OCR-2.0-hf
阶跃星辰StepFun推出的GOT-OCR-2.0-hf是一款强大的多语言OCR开源模型,支持从普通文档到复杂场景的文字识别。它能精准处理表格、图表、数学公式、几何图形甚至乐谱等特殊内容,输出结果可通过第三方工具渲染成多种格式。模型支持1024×1024高分辨率输入,具备多页批量处理、动态分块识别和交互式区域选择等创新功能,用户可通过坐标或颜色指定识别区域。基于Apache 2.0协议开源,提供Hugging Face演示和完整代码,适用于学术研究到工业应用的广泛场景,为OCR领域带来突破性解决方案。00openHiTLS
旨在打造算法先进、性能卓越、高效敏捷、安全可靠的密码套件,通过轻量级、可剪裁的软件技术架构满足各行业不同场景的多样化要求,让密码技术应用更简单,同时探索后量子等先进算法创新实践,构建密码前沿技术底座!C0302- WWan2.2-S2V-14B【Wan2.2 全新发布|更强画质,更快生成】新一代视频生成模型 Wan2.2,创新采用MoE架构,实现电影级美学与复杂运动控制,支持720P高清文本/图像生成视频,消费级显卡即可流畅运行,性能达业界领先水平Python00
- GGLM-4.5-AirGLM-4.5 系列模型是专为智能体设计的基础模型。GLM-4.5拥有 3550 亿总参数量,其中 320 亿活跃参数;GLM-4.5-Air采用更紧凑的设计,拥有 1060 亿总参数量,其中 120 亿活跃参数。GLM-4.5模型统一了推理、编码和智能体能力,以满足智能体应用的复杂需求Jinja00
Yi-Coder
Yi Coder 编程模型,小而强大的编程助手HTML013
热门内容推荐
最新内容推荐
项目优选
收起

React Native鸿蒙化仓库
C++
178
262

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

🔥🔥🔥ShopXO企业级免费开源商城系统,可视化DIY拖拽装修、包含PC、H5、多端小程序(微信+支付宝+百度+头条&抖音+QQ+快手)、APP、多仓库、多商户、多门店、IM客服、进销存,遵循MIT开源协议发布、基于ThinkPHP8框架研发
JavaScript
93
15

openGauss kernel ~ openGauss is an open source relational database management system
C++
129
183

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

deepin linux kernel
C
22
5

🍒 Cherry Studio 是一款支持多个 LLM 提供商的桌面客户端
TypeScript
598
57

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

本仓将收集和展示仓颉鸿蒙应用示例代码,欢迎大家投稿,在仓颉鸿蒙社区展现你的妙趣设计!
Cangjie
398
371

本仓将收集和展示高质量的仓颉示例代码,欢迎大家投稿,让全世界看到您的妙趣设计,也让更多人通过您的编码理解和喜爱仓颉语言。
Cangjie
332
1.08 K