GoIM 项目教程
1、项目的目录结构及介绍
GoIM 项目的目录结构如下:
goim/
├── cmd/
│ ├── comet/
│ ├── job/
│ └── logic/
├── docs/
├── examples/
├── internal/
├── pkg/
├── scripts/
├── .gitignore
├── CHANGELOG.md
├── LICENSE
├── Makefile
├── README.md
├── README_cn.md
├── README_en.md
├── codecov.sh
├── go.mod
└── go.sum
目录介绍
cmd/
: 包含项目的入口文件,分为comet
、job
和logic
三个子目录,分别对应不同的服务。docs/
: 存放项目文档。examples/
: 包含示例代码。internal/
: 存放内部使用的包。pkg/
: 存放公共包。scripts/
: 存放脚本文件。.gitignore
: Git 忽略文件配置。CHANGELOG.md
: 项目更新日志。LICENSE
: 项目许可证。Makefile
: 项目构建文件。README.md
: 项目介绍文档。README_cn.md
: 中文项目介绍文档。README_en.md
: 英文项目介绍文档。codecov.sh
: 代码覆盖率脚本。go.mod
: Go 模块文件。go.sum
: Go 模块依赖校验文件。
2、项目的启动文件介绍
GoIM 项目的启动文件位于 cmd/
目录下,分别有 comet
、job
和 logic
三个服务。
comet
comet
服务负责处理客户端连接和消息转发。
cmd/comet/
├── main.go
└── ...
job
job
服务负责后台任务处理。
cmd/job/
├── main.go
└── ...
logic
logic
服务负责业务逻辑处理。
cmd/logic/
├── main.go
└── ...
3、项目的配置文件介绍
GoIM 项目的配置文件位于 target/
目录下,包含 comet.toml
、logic.toml
和 job.toml
三个配置文件。
comet.toml
comet.toml
配置文件用于配置 comet
服务的参数。
# comet.toml 配置示例
[server]
addr = "0.0.0.0:8080"
...
logic.toml
logic.toml
配置文件用于配置 logic
服务的参数。
# logic.toml 配置示例
[database]
driver = "mysql"
...
job.toml
job.toml
配置文件用于配置 job
服务的参数。
# job.toml 配置示例
[kafka]
brokers = ["localhost:9092"]
...
以上是 GoIM 项目的目录结构、启动文件和配置文件的介绍。希望这份教程能帮助你更好地理解和使用 GoIM 项目。