GoIM 开源项目教程

GoIM 开源项目教程

goimgoim项目地址:https://gitcode.com/gh_mirrors/go/goim

1. 项目的目录结构及介绍

GoIM 是一个高性能的即时通讯服务器，其目录结构清晰，便于理解和维护。以下是 GoIM 的主要目录结构及其介绍：

goim/
├── app/
│   ├── comet/
│   ├── job/
│   ├── logic/
│   └── main.go
├── conf/
│   ├── app.conf
│   └── config.go
├── docs/
├── pkg/
│   ├── buffer/
│   ├── bytes/
│   ├── discovery/
│   ├── json/
│   ├── log/
│   ├── protocol/
│   ├── rpc/
│   ├── sync/
│   └── time/
├── scripts/
├── vendor/
└── README.md

• app/: 包含项目的核心应用逻辑，分为 comet、job、logic 等子模块。
  • comet/: 负责处理客户端连接。
  • job/: 负责消息的投递。
  • logic/: 负责业务逻辑处理。
  • main.go: 项目的入口文件。
• conf/: 包含项目的配置文件和配置相关的代码。
  • app.conf: 主要的配置文件。
  • config.go: 配置文件的解析代码。
• docs/: 包含项目的文档。
• pkg/: 包含项目的公共库，如 buffer、bytes、discovery 等。
• scripts/: 包含项目的脚本文件。
• vendor/: 包含项目的依赖包。
• README.md: 项目的说明文档。

2. 项目的启动文件介绍

GoIM 的启动文件位于 app/main.go，它是整个项目的入口点。以下是 main.go 的主要内容：

package main

import (
    "flag"
    "goim/app/comet"
    "goim/app/job"
    "goim/app/logic"
    "goim/conf"
    "goim/pkg/log"
)

func main() {
    flag.Parse()
    if err := conf.Init(); err != nil {
        log.Fatalf("conf.Init() error(%v)", err)
    }
    // 启动逻辑服务
    logic.Init()
    // 启动 comet 服务
    comet.Init()
    // 启动 job 服务
    job.Init()
    // 等待信号退出
    log.Info("goim start")
    select {}
}

• flag.Parse(): 解析命令行参数。
• conf.Init(): 初始化配置。
• logic.Init(): 初始化逻辑服务。
• comet.Init(): 初始化 comet 服务。
• job.Init(): 初始化 job 服务。
• select {}: 使主程序进入无限循环，等待信号退出。

3. 项目的配置文件介绍

GoIM 的配置文件位于 conf/app.conf，它包含了项目的主要配置项。以下是 app.conf 的主要内容：

[server]
addr = "0.0.0.0:3101"
rpc_addr = "0.0.0.0:3102"

[log]
level = "info"
dir = "./logs"

[discovery]
nodes = ["127.0.0.1:2181"]

[logic]
rpc_addrs = ["127.0.0.1:3103"]

[job]
rpc_addrs = ["127.0.0.1:3104"]

• [server]: 服务器配置。
  • addr: 服务监听地址。
  • rpc_addr: RPC 服务监听地址。
• [log]: 日志配置。
  • level: 日志级别。
  • dir: 日志文件目录。
• [discovery]: 服务发现配置。
  • nodes: 服务发现节点地址。
• [logic]: 逻辑服务配置。
  • rpc_addrs: 逻辑服务 RPC 地址。
• [job]: job 服务配置。
  • rpc_addrs: job

goimgoim项目地址:https://gitcode.com/gh_mirrors/go/goim