JuggleIM im-server 项目使用教程

JuggleIM im-server 项目使用教程

im-server A high-performance IM server. 项目地址: https://gitcode.com/gh_mirrors/imserv/im-server

1. 项目目录结构及介绍

JuggleIM im-server 是一个基于 Go 语言开发的高性能即时通讯服务器。项目目录结构如下：

• commons: 存放一些公共的工具类和配置文件。
• docs: 包含项目文档和相关 SQL 初始化文件。
• launcher: 项目启动相关文件，包括配置文件和主函数。
• services: 实现即时通讯服务的核心逻辑。
• simulator: 模拟器，用于测试服务器的功能。
• testmain: 测试主文件。
• .gitignore: Git 忽略文件列表。
• LICENSE: 项目许可证文件。
• README.md: 项目说明文件。
• go.mod: Go 项目的依赖管理文件。
• go.sum: Go 项目的依赖校验文件。

2. 项目的启动文件介绍

项目的启动文件位于 launcher 目录下的 main.go 文件。以下是启动文件的简要介绍：

package main

import (
    // 导入必要的包
)

func main() {
    // 初始化日志、配置等
    // 启动服务
}

在 main.go 文件中，首先导入所需的包，然后在 main 函数中初始化日志、配置等，最后启动即时通讯服务。

3. 项目的配置文件介绍

项目的配置文件位于 launcher/conf 目录下的 config.yml 文件。以下是配置文件的详细说明：

nodeName: testNode      # im-server 的节点名称
nodeHost: 127.0.0.1     # im-server 的节点IP
msgStoreEngine: mysql   # 配置消息数据存储引擎，可选 mysql 或 mongo
log:
    logPath: ./logs       # 运行日志所在目录
    logName: jim-info     # 运行日志的前缀名
    visual: false         # 是否开启可视化日志
mysql:                  # MySQL 相关配置
    user: root
    password: 123456
    address: 127.0.0.1:3306
    name: im_db
mongodb:                # MongoDB 相关配置（可选）
    address: 127.0.0.1:27017
    name: jim_msgs
connectManager:         # im-server 长连接端口配置
    wsPort: 9002
apiGateway:             # im-server 的服务端 API 端口配置
    httpPort: 8082
navGateway:             # im-server 的导航端口配置
    httpPort: 8081
adminGateway:           # im-server 自带的管理后台地址配置
    httpPort: 8090

配置文件中包含了项目运行所需的基本配置，如节点名称、IP 地址、存储引擎、日志配置、数据库配置等。根据实际情况，修改配置文件中的相关参数，以满足项目运行的需求。

im-server A high-performance IM server. 项目地址: https://gitcode.com/gh_mirrors/imserv/im-server