Go-Learn 项目启动与配置教程

1. 项目目录结构及介绍

Go-Learn 项目的目录结构如下所示：

Go-Learn/
├── cmd/
│   └── main.go        # 项目的主入口文件
├── configs/           # 配置文件存放目录
│   └── config.yaml    # 默认配置文件
├── internal/          # 项目内部模块
│   ├── controller/    # 控制器相关代码
│   ├── middleware/    # 中间件相关代码
│   ├── model/         # 数据模型相关代码
│   └── service/       # 业务逻辑代码
├── pkg/               # 外部模块或工具类代码
├── scripts/           # 脚本文件存放目录
├── test/              # 测试文件存放目录
└── go.mod             # 项目依赖管理文件

• cmd/: 存放项目的主入口文件，通常为 main.go。
• configs/: 存放项目的配置文件，例如 config.yaml。
• internal/: 存放项目内部模块，通常包括控制器、中间件、模型和业务逻辑等。
• pkg/: 存放可以被其他项目引用的外部模块或工具类代码。
• scripts/: 存放项目的辅助脚本文件，如部署、数据库迁移等脚本。
• test/: 存放项目的测试文件，用于确保代码质量。
• go.mod: 存放项目的依赖管理信息。

2. 项目的启动文件介绍

项目的启动文件位于 cmd/main.go，以下是启动文件的基本内容：

package main

import (
    "log"
    "Go-Learn/internal"
)

func main() {
    // 初始化配置
    config := internal.NewConfig("configs/config.yaml")

    // 初始化数据库连接
    db := internal.NewDB(config)

    // 初始化路由
    router := internal.NewRouter()

    // 启动服务
    log.Fatal(router.Run(":8080"))
}

该文件负责初始化项目所依赖的配置、数据库连接和路由，并启动 HTTP 服务。

3. 项目的配置文件介绍

项目的配置文件位于 configs/config.yaml，以下是配置文件的基本结构：

app:
  name: Go-Learn
  port: 8080

database:
  driver: mysql
  dsn: "user:password@tcp(host:port)/dbname"

该文件定义了应用的基本配置，如应用名称、端口号以及数据库连接信息。在项目启动时，这些配置会被加载并用于初始化项目环境。