go-olive 项目使用教程

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

go-olive 项目的目录结构如下：

go-olive/
├── cmd/
│   └── olive/
│       └── main.go
├── config/
│   └── config.yaml
├── internal/
│   ├── app/
│   └── pkg/
├── pkg/
│   ├── utils/
│   └── types/
├── .gitignore
├── go.mod
├── go.sum
└── README.md

目录结构介绍

• cmd/: 包含项目的入口文件。
  • olive/: 具体的应用程序目录。
    • main.go: 项目的启动文件。
• config/: 包含项目的配置文件。
  • config.yaml: 配置文件，用于存储项目的配置信息。
• internal/: 包含项目的内部代码，不对外暴露。
  • app/: 应用程序的核心逻辑。
  • pkg/: 内部使用的包。
• pkg/: 包含项目的公共包，可以对外暴露。
  • utils/: 工具类包。
  • types/: 类型定义包。
• .gitignore: Git 忽略文件配置。
• go.mod: Go 模块文件，定义项目的依赖。
• go.sum: Go 模块的校验文件。
• README.md: 项目说明文档。

2. 项目的启动文件介绍

项目的启动文件位于 cmd/olive/main.go。该文件是整个项目的入口点，负责初始化配置、启动服务等操作。

main.go 文件内容概览

package main

import (
    "fmt"
    "go-olive/config"
    "go-olive/internal/app"
)

func main() {
    // 加载配置
    cfg, err := config.LoadConfig("config/config.yaml")
    if err != nil {
        fmt.Println("Failed to load config:", err)
        return
    }

    // 启动应用程序
    app.Start(cfg)
}

启动文件功能介绍

• 加载配置文件：通过 config.LoadConfig 函数加载 config/config.yaml 配置文件。
• 启动应用程序：调用 app.Start 函数启动应用程序，传入加载的配置。

3. 项目的配置文件介绍

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

config.yaml 文件内容示例

server:
  port: 8080
  host: "localhost"

database:
  host: "localhost"
  port: 5432
  user: "user"
  password: "password"
  name: "dbname"

log:
  level: "info"

配置文件字段介绍

• server: 服务器配置。
  • port: 服务器监听的端口。
  • host: 服务器监听的主机地址。
• database: 数据库配置。
  • host: 数据库主机地址。
  • port: 数据库端口。
  • user: 数据库用户名。
  • password: 数据库密码。
  • name: 数据库名称。
• log: 日志配置。
  • level: 日志级别，如 info, debug, error 等。

通过以上配置文件，可以灵活地调整项目的运行参数，以适应不同的部署环境。