Frugal 项目使用教程

1. 项目目录结构及介绍

Frugal 项目的目录结构如下：

frugal/
├── cmd/
│   └── frugal/
│       └── main.go
├── config/
│   └── config.yaml
├── internal/
│   ├── handler/
│   ├── model/
│   └── service/
├── pkg/
│   ├── logger/
│   └── utils/
├── 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/frugal/main.go。该文件是整个项目的入口，负责初始化配置、启动服务等操作。

main.go 文件内容概览

package main

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

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

    // 初始化日志
    logger.Init()

    // 启动服务
    service.Start()
}

启动流程

1. 初始化配置: 调用 config.Init() 函数加载配置文件。
2. 初始化日志: 调用 logger.Init() 函数初始化日志系统。
3. 启动服务: 调用 service.Start() 函数启动服务。

3. 项目配置文件介绍

项目的配置文件位于 config/config.yaml。该文件包含了项目的各种配置项，如数据库连接、日志级别等。

config.yaml 文件内容示例

server:
  port: 8080

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

logger:
  level: "info"
  output: "stdout"

配置项说明

• server: 服务配置，包括端口号等。
• database: 数据库配置，包括主机地址、端口、用户名、密码和数据库名称。
• logger: 日志配置，包括日志级别和输出方式。

通过以上配置文件，项目可以根据不同的环境需求进行灵活配置。

---

以上是 Frugal 项目的目录结构、启动文件和配置文件的详细介绍。希望这份教程能帮助你快速上手该项目。