开源项目 `curso-golang` 使用文档

开源项目 curso-golang 使用文档

curso-golangMódulos 1 e 2 do Curso de Golang项目地址:https://gitcode.com/gh_mirrors/cu/curso-golang

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

curso-golang/
├── cmd/
│   └── main.go
├── config/
│   └── config.yaml
├── internal/
│   ├── app/
│   │   └── app.go
│   └── pkg/
│       └── utils.go
├── go.mod
├── go.sum
└── README.md

• cmd/: 包含项目的入口文件，通常是 main.go。
• config/: 包含项目的配置文件，如 config.yaml。
• internal/: 包含项目的内部逻辑，分为 app 和 pkg 两个子目录。
  • app/: 包含应用的核心逻辑。
  • pkg/: 包含通用的工具函数或库。
• go.mod 和 go.sum: Go 模块文件，用于管理依赖。
• README.md: 项目说明文档。

2. 项目的启动文件介绍

cmd/main.go

package main

import (
    "curso-golang/internal/app"
    "curso-golang/config"
)

func main() {
    // 加载配置
    cfg := config.LoadConfig()
    
    // 启动应用
    app.Start(cfg)
}

• main 函数: 项目的入口点，负责加载配置并启动应用。
• config.LoadConfig(): 从 config/config.yaml 加载配置。
• app.Start(cfg): 启动应用，传入配置对象。

3. 项目的配置文件介绍

config/config.yaml

app:
  name: "curso-golang"
  version: "1.0.0"
  port: 8080

database:
  host: "localhost"
  port: 5432
  user: "user"
  password: "password"
  name: "curso_golang"

• app: 应用的基本配置，包括名称、版本和端口。
• database: 数据库连接配置，包括主机、端口、用户、密码和数据库名称。

以上是 curso-golang 项目的目录结构、启动文件和配置文件的详细介绍。希望这份文档能帮助你更好地理解和使用该项目。

curso-golangMódulos 1 e 2 do Curso de Golang项目地址:https://gitcode.com/gh_mirrors/cu/curso-golang