开源项目 Pendulum 使用教程

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

pendulum/
├── cmd/
│   ├── main.go
│   └── ...
├── config/
│   ├── config.yaml
│   └── ...
├── internal/
│   ├── handlers/
│   │   └── ...
│   ├── models/
│   │   └── ...
│   └── ...
├── pkg/
│   └── ...
├── .gitignore
├── go.mod
├── go.sum
└── README.md

目录结构介绍

• cmd/: 包含项目的启动文件 main.go，以及其他可能的命令行工具。
• config/: 包含项目的配置文件 config.yaml，以及其他配置相关的文件。
• internal/: 包含项目的内部逻辑，如处理请求的 handlers、数据模型的 models 等。
• pkg/: 包含项目的公共包，可能被其他项目引用。
• .gitignore: Git 忽略文件，指定哪些文件或目录不需要被版本控制。
• go.mod 和 go.sum: Go 模块文件，用于管理项目的依赖。
• README.md: 项目的说明文档。

2. 项目的启动文件介绍

cmd/main.go

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

package main

import (
    "log"
    "os"

    "github.com/titpetric/pendulum/config"
    "github.com/titpetric/pendulum/internal/server"
)

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

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

    // 等待中断信号
    signalChan := make(chan os.Signal, 1)
    signal.Notify(signalChan, os.Interrupt, syscall.SIGTERM)
    <-signalChan

    // 优雅关闭
    srv.Shutdown()
}

启动文件功能

• 加载配置: 通过 config.LoadConfig 函数加载配置文件 config/config.yaml。
• 启动服务: 使用 server.NewServer 创建服务实例，并调用 Start 方法启动服务。
• 优雅关闭: 监听中断信号，收到信号后调用 Shutdown 方法优雅关闭服务。

3. 项目的配置文件介绍

config/config.yaml

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

server:
  host: "0.0.0.0"
  port: 8080

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

log:
  level: "info"
  output: "stdout"

配置文件参数说明

• server: 服务配置
  • host: 服务监听的地址，默认为 0.0.0.0。
  • port: 服务监听的端口，默认为 8080。
• database: 数据库配置
  • driver: 数据库驱动类型，如 mysql、postgres 等。
  • dsn: 数据库连接字符串，包含用户名、密码、主机地址、端口和数据库名。
• log: 日志配置
  • level: 日志级别，如 debug、info、warn、error 等。
  • output: 日志输出方式，如 stdout、file 等。

通过以上配置文件，可以灵活调整服务的运行参数，满足不同的部署需求。