Spartan 项目使用文档

1. 项目目录结构及介绍

spartan/
├── cmd/
│   └── main.go
├── config/
│   └── config.yaml
├── internal/
│   ├── handler/
│   │   └── handler.go
│   ├── model/
│   │   └── model.go
│   └── service/
│       └── service.go
├── pkg/
│   ├── logger/
│   │   └── logger.go
│   └── utils/
│       └── utils.go
├── go.mod
├── go.sum
└── README.md

目录结构说明

• cmd/: 存放项目的启动文件，通常包含 main.go。
• config/: 存放项目的配置文件，如 config.yaml。
• internal/: 存放项目的内部逻辑代码，通常分为 handler、model 和 service 等子目录。
  • handler/: 处理请求的逻辑。
  • model/: 定义数据模型。
  • service/: 业务逻辑层。
• pkg/: 存放项目的公共包，如 logger 和 utils。
  • logger/: 日志记录相关的代码。
  • utils/: 工具函数。
• go.mod 和 go.sum: Go 模块依赖文件。
• README.md: 项目说明文档。

2. 项目启动文件介绍

cmd/main.go

main.go 是项目的入口文件，负责初始化配置、启动服务等操作。以下是 main.go 的基本结构：

package main

import (
    "fmt"
    "log"
    "net/http"

    "github.com/goetzrobin/spartan/config"
    "github.com/goetzrobin/spartan/internal/handler"
)

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

    // 初始化路由
    http.HandleFunc("/", handler.HomeHandler)

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

启动文件说明

• 加载配置: 通过 config.LoadConfig 函数加载配置文件 config/config.yaml。
• 初始化路由: 使用 http.HandleFunc 注册路由处理函数。
• 启动服务: 使用 http.ListenAndServe 启动 HTTP 服务。

3. 项目配置文件介绍

config/config.yaml

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

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

配置文件说明

• port: 服务监听的端口号。
• logLevel: 日志级别，如 info、debug 等。
• database: 数据库连接配置，包括 host、port、user、password 和 name。

通过以上配置文件，项目可以灵活地调整运行时的参数，而无需修改代码。