go-canal 项目教程

1. 项目目录结构及介绍

go-canal/
├── cmd/
│   └── main.go
├── config/
│   └── config.yaml
├── internal/
│   ├── handler/
│   │   └── handler.go
│   ├── model/
│   │   └── model.go
│   └── service/
│       └── service.go
├── pkg/
│   ├── logger/
│   │   └── logger.go
│   └── utils/
│       └── utils.go
├── go.mod
├── go.sum
└── README.md

目录结构介绍

• cmd/: 存放项目的启动文件，通常包含 main.go 文件。
• config/: 存放项目的配置文件，如 config.yaml。
• internal/: 存放项目的内部逻辑代码，通常包含以下子目录：
  • handler/: 处理请求的逻辑代码。
  • model/: 定义数据模型的代码。
  • service/: 业务逻辑代码。
• pkg/: 存放项目的公共库代码，通常包含以下子目录：
  • logger/: 日志相关的代码。
  • utils/: 工具类代码。
• go.mod 和 go.sum: Go 模块管理文件。
• README.md: 项目说明文档。

2. 项目的启动文件介绍

cmd/main.go

main.go 是项目的入口文件，负责初始化配置、启动服务等操作。以下是 main.go 的示例代码：

package main

import (
    "fmt"
    "log"
    "net/http"

    "github.com/emmeair/go-canal/config"
    "github.com/emmeair/go-canal/internal/handler"
    "github.com/emmeair/go-canal/pkg/logger"
)

func main() {
    // 初始化配置
    cfg, err := config.LoadConfig("config/config.yaml")
    if err != nil {
        log.Fatalf("Failed to load config: %v", err)
    }

    // 初始化日志
    logger.InitLogger(cfg.Log)

    // 注册路由
    http.HandleFunc("/", handler.HomeHandler)

    // 启动服务
    addr := fmt.Sprintf(":%d", cfg.Server.Port)
    log.Printf("Starting server on %s", addr)
    if err := http.ListenAndServe(addr, nil); err != nil {
        log.Fatalf("Failed to start server: %v", err)
    }
}

启动文件功能介绍

• 初始化配置: 通过 config.LoadConfig 函数加载配置文件。
• 初始化日志: 使用 logger.InitLogger 初始化日志系统。
• 注册路由: 使用 http.HandleFunc 注册路由处理函数。
• 启动服务: 使用 http.ListenAndServe 启动 HTTP 服务。

3. 项目的配置文件介绍

config/config.yaml

config.yaml 是项目的配置文件，用于配置服务端口、日志级别等信息。以下是 config.yaml 的示例内容：

server:
  port: 8080

log:
  level: info
  file: "logs/app.log"

配置文件字段介绍

• server: 服务配置
  • port: 服务监听的端口号。
• log: 日志配置
  • level: 日志级别，如 info、debug 等。
  • file: 日志文件路径。

通过以上配置文件，可以灵活地调整项目的运行参数，满足不同的部署需求。