跳到主要内容

OpenIM JS SDK Server 使用指南

OpenIM 的两个版本 JSSDK​

OpenIM 提供了两个版本的 JSSDK，每个版本都有其独特的特点和应用场景：

1. WASM 版本​

仓库地址

优点：

  • 性能优越：使用 WebAssembly (WASM) 技术，带来了更高的效率。
  • 本地消息存储：消息本地存储提高了数据处理速度。

缺点：

  • 文件体积较大：包体积相对较大，压缩前大约 20MB。
  • 小程序不兼容：在小程序中无法使用。

2. 纯 JS 版本​

仓库地址

优点：

  • 通用性强：不依赖于特定的技术栈，可以在更多的环境和平台中使用。

缺点：

  • 性能相对较差：由于历史消息需要从服务端拉取，在性能上有所不足。

OIMWS（OpenIM Websocket）是专为 OpenIM 的纯 JSSDK 设计的服务端解决方案。它负责处理来自 JSSDK 的所有Websocket请求。 本指南将详细介绍如何安装和运行 OIMWS，并提供对其关键功能和配置参数的全面解释。

安装​

您可以通过两种方式安装 OIMWS SDK Server：

  1. 克隆 GitHub 仓库： 克隆 OIMWS GitHub 仓库 到您的本地环境：

    git clone https://github.com/openimsdk/oimws

    完成后，请阅读 README 文件。

运行​

在运行 OIMWS SDK Server 之前，请确保您已经正确安装。

运行程序需要配置一些参数，您可以通过命令行标志来设置这些参数。以下是程序的主要函数及其参数：

openimApi: "http://127.0.0.1:10002"
openimWs: "ws://127.0.0.1:10001"
sdkWsPort: [ 10003 ]
dbDir: "../../../../db/"

参数说明​

  1. openimApi: openIM API 监听地址，默认为 http://127.0.0.1:10002。
  2. openimWs: openIM WebSocket 监听地址，默认为 ws://127.0.0.1:10001。
  3. sdkWsPort: openIMSDK WebSocket 监听端口，默认为 10003。
  4. dbDir: openIM 数据库目录，默认为当前目录下的 _output/db 文件夹。

运行示例​

在命令行中，您可以通过添加标志来修改这些参数。例如：

# 编译
mage
# 运行
mage start

这将启动服务器，并根据提供的参数配置服务。