Golang 项目 `golang-good-code-bad-code` 使用教程

1. 项目目录结构及介绍

golang-good-code-bad-code/
├── cmd/
│   └── main.go
├── internal/
│   ├── bad/
│   │   └── bad_code.go
│   └── good/
│       └── good_code.go
├── configs/
│   └── config.yaml
├── go.mod
├── go.sum
└── README.md

目录结构说明

• cmd/: 存放项目的启动文件，通常包含 main.go 文件。
• internal/: 存放项目的内部代码，通常分为 bad/ 和 good/ 两个子目录，分别存放不符合 Go 语言习惯的代码和符合 Go 语言习惯的代码。
• configs/: 存放项目的配置文件，通常包含 config.yaml 文件。
• go.mod 和 go.sum: Go 模块管理文件，用于管理项目的依赖。
• README.md: 项目的说明文档。

2. 项目的启动文件介绍

cmd/main.go

cmd/main.go 是项目的启动文件，负责初始化项目并启动应用程序。通常包含以下内容：

package main

import (
    "fmt"
    "golang-good-code-bad-code/internal/bad"
    "golang-good-code-bad-code/internal/good"
)

func main() {
    fmt.Println("Running bad code example:")
    bad.RunBadCode()

    fmt.Println("Running good code example:")
    good.RunGoodCode()
}

启动文件说明

• main 函数: 项目的入口函数，负责调用 bad 和 good 包中的代码示例。
• bad.RunBadCode(): 调用不符合 Go 语言习惯的代码示例。
• good.RunGoodCode(): 调用符合 Go 语言习惯的代码示例。

3. 项目的配置文件介绍

configs/config.yaml

configs/config.yaml 是项目的配置文件，通常包含应用程序的配置信息。示例如下：

app:
  name: "golang-good-code-bad-code"
  version: "1.0.0"
  environment: "development"

database:
  host: "localhost"
  port: 5432
  username: "user"
  password: "password"
  name: "dbname"

配置文件说明

• app: 包含应用程序的基本信息，如名称、版本和运行环境。
• database: 包含数据库的连接信息，如主机、端口、用户名、密码和数据库名称。

通过以上配置文件，可以方便地管理应用程序的运行环境和数据库连接信息。