gkit 项目使用教程

1. 项目目录结构及介绍

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

目录结构说明

• cmd/: 存放项目的启动文件，通常包含 main.go。
• config/: 存放项目的配置文件，如 config.yaml。
• internal/: 存放项目的内部逻辑代码，通常包括 handler（处理请求）、model（数据模型）、service（业务逻辑）和 utils（工具函数）。
• pkg/: 存放项目的公共包，如 logger（日志记录）和 middleware（中间件）。
• go.mod 和 go.sum: Go 模块文件，用于管理项目的依赖。
• README.md: 项目的说明文档。

2. 项目启动文件介绍

cmd/main.go

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

package main

import (
    "gkit/config"
    "gkit/internal/service"
    "gkit/pkg/logger"
)

func main() {
    // 初始化配置
    config.Init()
    
    // 初始化日志
    logger.Init()
    
    // 启动服务
    service.Start()
}

启动文件说明

• config.Init(): 初始化项目的配置，通常从 config/config.yaml 中读取配置。
• logger.Init(): 初始化日志记录器，用于记录程序运行时的日志信息。
• service.Start(): 启动服务，通常包括启动 HTTP 服务器或其他服务。

3. 项目配置文件介绍

config/config.yaml

config.yaml 是项目的配置文件，用于配置项目的各种参数。以下是一个简单的示例：

server:
  port: 8080
  host: "0.0.0.0"

database:
  host: "localhost"
  port: 3306
  user: "root"
  password: "password"
  name: "gkit"

log:
  level: "info"
  output: "stdout"

配置文件说明

• server: 配置服务器的相关参数，如端口和主机地址。
• database: 配置数据库的相关参数，如主机地址、端口、用户名、密码和数据库名称。
• log: 配置日志记录的相关参数，如日志级别和输出方式。

通过以上配置文件，项目可以根据不同的环境（如开发、测试、生产）加载不同的配置参数。