首页
/ open-im-sdk-web 的安装和配置教程

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 Coreopen-im-sdk-web 通过与 OpenIM SDK Core 的 WebSocket 代理层通信来实现功能。

3. 项目安装和配置的准备工作及详细安装步骤

准备工作

在开始安装之前,请确保你已经安装了以下环境:

  • Node.js:JavaScript 的运行环境,用于执行 npm 命令。
  • npm:Node.js 的包管理工具,用于管理项目依赖。

安装步骤

以下是将 open-im-sdk-web SDK 集成到你的项目中的详细步骤:

  1. 克隆项目

    首先,你需要克隆或下载项目到你的本地环境。你可以使用以下命令:

    git clone https://github.com/openimsdk/open-im-sdk-web.git
    
  2. 安装依赖

    进入项目目录后,使用 npm 安装项目依赖:

    cd open-im-sdk-web
    npm install
    
  3. 集成 SDK

    在你的项目中,你可以通过以下方式引入 open-im-sdk-web SDK:

    import { OpenIMSDK } from 'open-im-sdk';
    
  4. 配置 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',
    });
    
  5. 登录和监听事件

    在配置完 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() {
        // 连接成功 ✅
    }
    
  6. 发送和接收消息

    最后,你可以监听新消息事件,并发送消息给其他用户:

    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 实现即时通讯功能了。

登录后查看全文
热门项目推荐

热门内容推荐

最新内容推荐

项目优选

收起
ohos_react_nativeohos_react_native
React Native鸿蒙化仓库
C++
178
262
RuoYi-Vue3RuoYi-Vue3
🎉 (RuoYi)官方仓库 基于SpringBoot,Spring Security,JWT,Vue3 & Vite、Element Plus 的前后端分离权限管理系统
Vue
866
513
ShopXO开源商城ShopXO开源商城
🔥🔥🔥ShopXO企业级免费开源商城系统,可视化DIY拖拽装修、包含PC、H5、多端小程序(微信+支付宝+百度+头条&抖音+QQ+快手)、APP、多仓库、多商户、多门店、IM客服、进销存,遵循MIT开源协议发布、基于ThinkPHP8框架研发
JavaScript
93
15
openGauss-serveropenGauss-server
openGauss kernel ~ openGauss is an open source relational database management system
C++
129
183
openHiTLSopenHiTLS
旨在打造算法先进、性能卓越、高效敏捷、安全可靠的密码套件,通过轻量级、可剪裁的软件技术架构满足各行业不同场景的多样化要求,让密码技术应用更简单,同时探索后量子等先进算法创新实践,构建密码前沿技术底座!
C
261
302
kernelkernel
deepin linux kernel
C
22
5
cherry-studiocherry-studio
🍒 Cherry Studio 是一款支持多个 LLM 提供商的桌面客户端
TypeScript
598
57
CangjieCommunityCangjieCommunity
为仓颉编程语言开发者打造活跃、开放、高质量的社区环境
Markdown
1.07 K
0
HarmonyOS-ExamplesHarmonyOS-Examples
本仓将收集和展示仓颉鸿蒙应用示例代码,欢迎大家投稿,在仓颉鸿蒙社区展现你的妙趣设计!
Cangjie
398
371
Cangjie-ExamplesCangjie-Examples
本仓将收集和展示高质量的仓颉示例代码,欢迎大家投稿,让全世界看到您的妙趣设计,也让更多人通过您的编码理解和喜爱仓颉语言。
Cangjie
332
1.08 K