JuggleIM 即时通讯系统使用教程

1. 项目介绍

JuggleIM 是一个高性能、可扩展的开源即时通讯系统。它支持多种部署模式，包括公有云、私有云和托管云等。JuggleIM 使用 Protobuf+Websocket 实现长连接，具有低流量、高性能的特点，即使在网络不佳的环境下也能保持较好的连通性。系统支持集群部署，能够无限横向扩展，支撑亿级日活应用。此外，JuggleIM 提供了丰富的 API 和 WebHook，方便与现有系统集成。

2. 项目快速启动

以下步骤将指导你快速启动 JuggleIM 服务器：

安装和初始化 MySQL

1. 安装 MySQL。

2. 创建数据库实例：

   CREATE SCHEMA `jim_db`;
   

3. 初始化表结构，将以下 SQL 命令导入到 MySQL：

   mysql -u{db_user} -p{db_password} jim_db < jim.sql
   

安装 MongoDB（可选）

1. 安装 MongoDB。
2. 配置 MongoDB。

启动 im-server

1. 运行目录为 im-server/launcher，配置文件位于 conf/config.yml。

2. 编辑配置文件，设置以下参数：

   nodeName: testNode
   nodeHost: 127.0.0.1
   msgStoreEngine: mysql
   log:
     logPath: ./logs
     logName: jim-info
     visual: false
   mysql:
     user: root
     password: 123456
     address: 127.0.0.1:3306
     name: im_db
   mongodb:
     address: 127.0.0.1:27017
     name: jim_msgs
   connectManager:
     wsPort: 9002
   apiGateway:
     httpPort: 8082
   navGateway:
     httpPort: 8081
   adminGateway:
     httpPort: 8090
   

3. 在 im-server/launcher 目录下运行以下命令启动服务器：

   go run main.go
   

配置外网访问地址

配置外网地址的端口列表如下：

端口	协议类型	说明
8081	HTTP	导航服务的监听端口
8082	HTTP	服务端 API 服务监听端口
8090	HTTP	IM 服务的管理后台监听端口
9002	WebSocket	IM 长连接监听端口

配置外网地址的方法可以根据环境灵活配置，例如挂公网 IP、使用 nginx 反向代理、负载均衡等。

将长连接地址配置到 IM 系统中

在数据库中插入以下配置数据：

insert into globalconfs (conf_key, conf_value) values ('connect_address', '{"default":["127.0.0.1:9002"]}');

将 127.0.0.1 替换为内网 IP 或公网 IP/域名。

3. 应用案例和最佳实践

应用案例

• 多租户系统：JuggleIM 支持多租户系统，可以在一套服务中创建多个应用，实现数据隔离。
• 社交平台：利用 JuggleIM 实现社交平台中的即时通讯功能。
• 企业协作：企业内部通讯，支持文件传输、音视频通话等功能。

最佳实践

• 安全：确保所有通信都通过加密进行，防止数据泄露。
• 性能优化：根据实际负载进行集群部署，优化服务器性能。
• 运维管理：使用 JuggleIM 提供的管理后台进行系统监控和维护。

4. 典型生态项目

• JuggleIM 客户端 SDK：提供 Android、iOS、Web 和 PC 平台的 SDK，方便开发者快速集成即时通讯功能。
• JuggleIM 管理后台：用于系统监控、配置和管理。
• JuggleIM API：供业务服务器访问，实现用户注册、群组创建等功能。