GMQ 开源项目使用教程

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

gmq/
├── cmd/
│   └── gmq/
│       └── main.go
├── config/
│   └── config.go
├── examples/
│   └── example.go
├── gmq/
│   ├── client.go
│   ├── server.go
│   └── utils.go
├── .gitignore
├── go.mod
├── go.sum
└── README.md

• cmd/: 包含项目的入口文件。
  • gmq/: 主程序入口目录。
    • main.go: 项目的启动文件。
• config/: 包含项目的配置文件。
  • config.go: 配置文件的定义和加载。
• examples/: 包含示例代码。
  • example.go: 使用示例。
• gmq/: 核心功能实现目录。
  • client.go: 客户端实现。
  • server.go: 服务端实现。
  • utils.go: 工具函数。
• .gitignore: Git 忽略文件配置。
• go.mod: Go 模块文件。
• go.sum: Go 模块依赖校验文件。
• README.md: 项目说明文档。

2. 项目的启动文件介绍

项目的启动文件位于 cmd/gmq/main.go。该文件主要负责初始化配置、启动服务端和客户端等操作。以下是 main.go 的主要内容：

package main

import (
    "gmq/config"
    "gmq/gmq"
)

func main() {
    // 加载配置
    cfg := config.LoadConfig()

    // 启动服务端
    server := gmq.NewServer(cfg)
    server.Start()

    // 启动客户端
    client := gmq.NewClient(cfg)
    client.Start()
}

3. 项目的配置文件介绍

项目的配置文件定义在 config/config.go 中。该文件主要负责定义配置结构体和加载配置文件。以下是 config.go 的主要内容：

package config

import (
    "encoding/json"
    "os"
)

type Config struct {
    ServerAddress string `json:"server_address"`
    ClientAddress string `json:"client_address"`
}

func LoadConfig() *Config {
    file, err := os.Open("config.json")
    if err != nil {
        panic(err)
    }
    defer file.Close()

    decoder := json.NewDecoder(file)
    cfg := &Config{}
    err = decoder.Decode(cfg)
    if err != nil {
        panic(err)
    }

    return cfg
}

配置文件 config.json 的示例如下：

{
    "server_address": "localhost:8080",
    "client_address": "localhost:8081"
}

以上是 GMQ 开源项目的目录结构、启动文件和配置文件的介绍。希望这份教程能帮助你更好地理解和使用该项目。