Awesome Go 项目教程

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

awesome-go/
├── README.md
├── LICENSE
├── .gitignore
├── cmd/
│   └── awesome-go/
│       └── main.go
├── config/
│   └── config.yaml
├── internal/
│   ├── app/
│   │   └── app.go
│   └── server/
│       └── server.go
├── pkg/
│   ├── utils/
│   │   └── utils.go
│   └── api/
│       └── api.go
└── web/
    ├── templates/
    │   └── index.html
    └── static/
        ├── css/
        │   └── style.css
        └── js/
            └── script.js

目录结构介绍

• README.md: 项目介绍文件。
• LICENSE: 项目许可证文件。
• .gitignore: Git 忽略文件配置。
• cmd/: 存放项目的启动文件。
  • awesome-go/: 主应用程序目录。
    • main.go: 项目启动文件。
• config/: 存放项目的配置文件。
  • config.yaml: 配置文件。
• internal/: 存放内部包，不对外公开。
  • app/: 应用程序逻辑。
    • app.go: 应用程序核心逻辑。
  • server/: 服务器相关逻辑。
    • server.go: 服务器配置和启动逻辑。
• pkg/: 存放公共包，可以对外公开。
  • utils/: 工具函数。
    • utils.go: 通用工具函数。
  • api/: API 相关逻辑。
    • api.go: API 接口定义。
• web/: 存放前端资源。
  • templates/: HTML 模板文件。
    • index.html: 主页模板。
  • static/: 静态资源文件。
    • css/: CSS 样式文件。
      • style.css: 主样式文件。
    • js/: JavaScript 脚本文件。
      • script.js: 主脚本文件。

2. 项目的启动文件介绍

main.go

package main

import (
    "awesome-go/config"
    "awesome-go/internal/app"
    "awesome-go/internal/server"
    "log"
)

func main() {
    // 加载配置文件
    cfg, err := config.LoadConfig("config/config.yaml")
    if err != nil {
        log.Fatalf("无法加载配置文件: %v", err)
    }

    // 初始化应用程序
    app := app.NewApp(cfg)

    // 启动服务器
    server := server.NewServer(app)
    if err := server.Start(); err != nil {
        log.Fatalf("服务器启动失败: %v", err)
    }
}

启动文件介绍

• main.go: 项目的入口文件，负责加载配置、初始化应用程序和启动服务器。
  • config.LoadConfig("config/config.yaml"): 加载配置文件。
  • app.NewApp(cfg): 初始化应用程序。
  • server.NewServer(app): 初始化服务器并启动。

3. 项目的配置文件介绍

config.yaml

server:
  host: "0.0.0.0"
  port: 8080

database:
  driver: "mysql"
  source: "user:password@tcp(127.0.0.1:3306)/dbname"

log:
  level: "info"
  file: "app.log"

配置文件介绍

• server: 服务器配置。
  • host: 服务器监听的地址。
  • port: 服务器监听的端口。
• database: 数据库配置。
  • driver: 数据库驱动。
  • source: 数据库连接字符串。
• log: 日志配置。
  • level: 日志级别。
  • file: 日志文件路径。

以上