Go-Coffeeshop 项目使用教程

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

Go-Coffeeshop 项目的目录结构如下：

go-coffeeshop/
├── cmd/
│   ├── api/
│   ├── worker/
│   └── ...
├── internal/
│   ├── domain/
│   ├── services/
│   └── ...
├── pkg/
│   ├── config/
│   ├── logger/
│   └── ...
├── .gitignore
├── Dockerfile
├── go.mod
├── go.sum
└── README.md

目录介绍

• cmd/: 包含项目的入口文件，如 api 和 worker。
• internal/: 包含项目的内部逻辑，如 domain 和 services。
• pkg/: 包含项目的公共库，如 config 和 logger。
• .gitignore: Git 忽略文件。
• Dockerfile: Docker 配置文件。
• go.mod: Go 模块文件。
• go.sum: Go 模块依赖校验文件。
• README.md: 项目说明文档。

2. 项目的启动文件介绍

项目的启动文件主要位于 cmd/ 目录下，例如 cmd/api/main.go 和 cmd/worker/main.go。

启动文件示例

// cmd/api/main.go
package main

import (
    "log"
    "net/http"
    "go-coffeeshop/internal/api"
)

func main() {
    router := api.NewRouter()
    log.Fatal(http.ListenAndServe(":8080", router))
}

启动文件介绍

• cmd/api/main.go: 负责启动 API 服务。
• cmd/worker/main.go: 负责启动后台任务处理服务。

3. 项目的配置文件介绍

项目的配置文件主要位于 pkg/config/ 目录下，例如 pkg/config/config.go。

配置文件示例

// pkg/config/config.go
package config

import (
    "os"
    "log"
)

type Config struct {
    Port string
    DBHost string
    DBPort string
    DBUser string
    DBPassword string
    DBName string
}

func LoadConfig() *Config {
    cfg := &Config{
        Port:       os.Getenv("PORT"),
        DBHost:     os.Getenv("DB_HOST"),
        DBPort:     os.Getenv("DB_PORT"),
        DBUser:     os.Getenv("DB_USER"),
        DBPassword: os.Getenv("DB_PASSWORD"),
        DBName:     os.Getenv("DB_NAME"),
    }

    if cfg.Port == "" {
        cfg.Port = "8080"
    }

    return cfg
}

配置文件介绍

• pkg/config/config.go: 负责加载和解析配置文件，支持从环境变量中读取配置。

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