Go-Sigma 项目教程

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

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

sigma/
├── cmd/
│   └── sigma/
│       └── main.go
├── configs/
│   └── config.yaml
├── internal/
│   ├── api/
│   ├── service/
│   └── repository/
├── pkg/
│   ├── logger/
│   └── utils/
├── go.mod
├── go.sum
└── README.md

目录结构介绍

• cmd/: 存放项目的入口文件，通常包含 main.go 文件。
• configs/: 存放项目的配置文件，如 config.yaml。
• internal/: 存放项目的内部逻辑代码，通常分为 api、service 和 repository 等模块。
• pkg/: 存放项目的公共包，如 logger 和 utils 等。
• go.mod 和 go.sum: Go 模块依赖管理文件。
• README.md: 项目说明文档。

2. 项目的启动文件介绍

项目的启动文件位于 cmd/sigma/main.go。该文件是整个项目的入口，负责初始化配置、启动服务等操作。

package main

import (
    "github.com/go-sigma/sigma/internal/api"
    "github.com/go-sigma/sigma/configs"
)

func main() {
    // 初始化配置
    config := configs.LoadConfig()

    // 启动 API 服务
    api.Start(config)
}

启动文件介绍

• main.go: 项目的入口文件，负责加载配置并启动 API 服务。
• configs.LoadConfig(): 加载配置文件，返回配置对象。
• api.Start(config): 启动 API 服务，传入配置对象。

3. 项目的配置文件介绍

项目的配置文件位于 configs/config.yaml。该文件定义了项目的各种配置参数，如数据库连接、日志级别等。

server:
  port: 8080

database:
  host: localhost
  port: 5432
  user: sigma
  password: sigma123
  name: sigma_db

log:
  level: info

配置文件介绍

• server: 定义服务器的端口。
• database: 定义数据库的连接信息，包括主机、端口、用户名、密码和数据库名称。
• log: 定义日志的级别。

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