Go 项目教程：siddontang/go

Go 项目教程：siddontang/go

go my golang lib 项目地址: https://gitcode.com/gh_mirrors/go28/go

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

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

目录结构介绍

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

2. 项目的启动文件介绍

cmd/main.go

main.go 是项目的入口文件，负责初始化配置、启动服务等操作。以下是一个简单的 main.go 示例：

package main

import (
    "fmt"
    "log"
    "os"

    "github.com/siddontang/go/config"
    "github.com/siddontang/go/internal/service"
)

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

    // 初始化服务
    svc := service.NewService(cfg)

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

    // 等待程序退出
    fmt.Println("服务已启动...")
    os.Exit(0)
}

启动文件功能

• 加载配置文件: 通过 config.LoadConfig 函数加载配置文件。
• 初始化服务: 使用配置文件初始化服务实例。
• 启动服务: 调用服务的 Start 方法启动服务。

3. 项目的配置文件介绍

config/config.yaml

config.yaml 是项目的配置文件，通常包含数据库连接、服务端口等信息。以下是一个简单的配置文件示例：

server:
  port: 8080

database:
  host: "localhost"
  port: 3306
  user: "root"
  password: "password"
  name: "mydb"

配置文件内容

• server: 服务配置，包含服务端口等信息。
• database: 数据库配置，包含数据库连接信息。

配置文件加载

在 main.go 中，通过 config.LoadConfig 函数加载配置文件，并将其传递给服务实例进行初始化。

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

通过以上步骤，您可以了解并启动 siddontang/go 项目。

go my golang lib 项目地址: https://gitcode.com/gh_mirrors/go28/go