GinSkeleton 项目教程

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

GinSkeleton 是一个基于 Go 语言 Gin 框架封装的 Web 项目骨架。以下是其主要目录结构及介绍：

GinSkeleton/
├── app/
│   ├── controllers/  # 控制器目录
│   ├── models/       # 模型目录
│   ├── services/     # 服务目录
│   └── utils/        # 工具目录
├── config/           # 配置文件目录
├── docs/             # 文档目录
├── public/           # 静态文件目录
├── routes/           # 路由目录
├── tests/            # 测试目录
├── .env              # 环境变量文件
├── .gitignore        # Git 忽略文件
├── go.mod            # Go 模块文件
├── go.sum            # Go 模块校验文件
├── main.go           # 项目启动文件
└── README.md         # 项目说明文件

2. 项目的启动文件介绍

main.go 是 GinSkeleton 项目的启动文件。以下是其主要内容及介绍：

package main

import (
    "github.com/qifengzhang007/GinSkeleton/config"
    "github.com/qifengzhang007/GinSkeleton/routes"
    "github.com/gin-gonic/gin"
)

func main() {
    // 初始化配置
    config.Init()

    // 创建 Gin 引擎
    r := gin.Default()

    // 加载路由
    routes.Load(r)

    // 启动服务
    r.Run(":8080")
}

• config.Init()：初始化配置文件。
• gin.Default()：创建一个默认的 Gin 引擎。
• routes.Load(r)：加载路由配置。
• r.Run(":8080")：启动 HTTP 服务，监听 8080 端口。

3. 项目的配置文件介绍

GinSkeleton 的配置文件主要位于 config 目录下。以下是主要配置文件及介绍：

config/
├── app.yaml         # 应用配置文件
├── database.yaml    # 数据库配置文件
└── log.yaml         # 日志配置文件

app.yaml

app:
  name: "GinSkeleton"
  version: "1.0.0"
  port: 8080

• name：应用名称。
• version：应用版本。
• port：应用监听端口。

database.yaml

database:
  driver: "mysql"
  host: "localhost"
  port: 3306
  user: "root"
  password: "password"
  name: "ginskeleton"

• driver：数据库驱动。
• host：数据库主机。
• port：数据库端口。
• user：数据库用户名。
• password：数据库密码。
• name：数据库名称。

log.yaml

log:
  level: "info"
  path: "/var/log/ginskeleton"

• level：日志级别。
• path：日志文件路径。

以上是 GinSkeleton 项目的基本教程，涵盖了项目的目录结构、启动文件和配置文件的介绍。希望对您有所帮助！