gosh 项目教程

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

gosh/
├── cmd/
│   ├── gosh/
│   │   └── main.go
├── internal/
│   ├── app/
│   │   └── app.go
│   ├── config/
│   │   └── config.go
│   └── utils/
│       └── utils.go
├── pkg/
│   ├── api/
│   │   └── api.go
│   └── models/
│       └── models.go
├── .gitignore
├── go.mod
├── go.sum
└── README.md

目录结构介绍

• cmd/: 包含项目的入口文件，通常是 main.go 文件所在的位置。
• internal/: 包含项目的内部逻辑代码，通常不对外公开。
  • app/: 包含应用程序的核心逻辑。
  • config/: 包含项目的配置文件处理逻辑。
  • utils/: 包含项目的工具函数。
• pkg/: 包含项目的公共包，可以被其他项目引用。
  • api/: 包含 API 相关的代码。
  • models/: 包含数据模型定义。
• .gitignore: 指定 Git 忽略的文件和目录。
• go.mod: Go 模块定义文件。
• go.sum: Go 模块依赖的校验文件。
• README.md: 项目说明文档。

2. 项目的启动文件介绍

cmd/gosh/main.go

package main

import (
    "gosh/internal/app"
    "gosh/internal/config"
)

func main() {
    // 加载配置
    cfg := config.LoadConfig()

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

启动文件介绍

• main.go: 项目的入口文件，负责加载配置并启动应用程序。
  • config.LoadConfig(): 加载项目的配置文件。
  • app.Start(cfg): 启动应用程序，传入配置对象。

3. 项目的配置文件介绍

internal/config/config.go

package config

import (
    "os"
    "log"
)

type Config struct {
    Port string
    DB   string
}

func LoadConfig() *Config {
    port := os.Getenv("PORT")
    if port == "" {
        port = "8080"
    }

    db := os.Getenv("DB_CONNECTION")
    if db == "" {
        log.Fatal("DB_CONNECTION environment variable is not set")
    }

    return &Config{
        Port: port,
        DB:   db,
    }
}

配置文件介绍

• config.go: 负责加载和管理项目的配置。
  • Config 结构体: 定义了项目的配置项，包括 Port 和 DB。
  • LoadConfig(): 从环境变量中加载配置，并返回一个 Config 对象。
    • PORT: 应用程序的监听端口，默认值为 8080。
    • DB_CONNECTION: 数据库连接字符串，如果未设置则程序会终止。