Workshop 开源项目使用教程

1. 项目目录结构及介绍

workshop/
├── cmd/
│   ├── workshop/
│   │   └── main.go
├── configs/
│   └── config.yaml
├── internal/
│   ├── handlers/
│   │   └── workshop.go
│   ├── models/
│   │   └── workshop.go
│   └── services/
│       └── workshop.go
├── pkg/
│   ├── utils/
│   │   └── utils.go
│   └── logger/
│       └── logger.go
├── .gitignore
├── go.mod
├── go.sum
└── README.md

目录结构说明

• cmd/: 存放项目的入口文件，通常是 main.go 文件所在的位置。
• configs/: 存放项目的配置文件，如 config.yaml。
• internal/: 存放项目的内部逻辑代码，通常包括处理请求的 handlers、数据模型 models 和业务逻辑 services。
• pkg/: 存放项目的公共库代码，如工具函数 utils 和日志库 logger。
• .gitignore: Git 忽略文件列表。
• go.mod 和 go.sum: Go 模块依赖管理文件。
• README.md: 项目说明文档。

2. 项目启动文件介绍

cmd/workshop/main.go

main.go 是项目的入口文件，负责初始化项目并启动服务。以下是 main.go 的主要内容：

package main

import (
    "fmt"
    "log"
    "net/http"
    "github.com/gravitational/workshop/internal/handlers"
    "github.com/gravitational/workshop/configs"
)

func main() {
    // 加载配置文件
    config := configs.LoadConfig()

    // 初始化路由
    http.HandleFunc("/workshop", handlers.WorkshopHandler)

    // 启动服务
    log.Printf("Starting server on port %s", config.Port)
    if err := http.ListenAndServe(fmt.Sprintf(":%s", config.Port), nil); err != nil {
        log.Fatalf("Failed to start server: %v", err)
    }
}

启动文件说明

• 加载配置文件: 通过 configs.LoadConfig() 加载项目的配置文件。
• 初始化路由: 使用 http.HandleFunc 注册路由处理函数。
• 启动服务: 使用 http.ListenAndServe 启动 HTTP 服务，监听配置文件中指定的端口。

3. 项目配置文件介绍

configs/config.yaml

config.yaml 是项目的配置文件，用于存储项目的各种配置参数。以下是一个示例配置文件内容：

port: "8080"
logLevel: "info"
database:
  host: "localhost"
  port: "5432"
  user: "user"
  password: "password"
  name: "workshop"

配置文件说明

• port: 服务监听的端口号。
• logLevel: 日志级别，如 info, debug, error 等。
• database: 数据库连接配置，包括主机地址、端口、用户名、密码和数据库名称。

通过以上配置文件，项目可以根据不同的环境（如开发、测试、生产）加载不同的配置参数。

---

以上是 Workshop 开源项目的使用教程，涵盖了项目的目录结构、启动文件和配置文件的详细介绍。希望这些内容能帮助你更好地理解和使用该项目。