Go 单体应用示例教程

1. 项目目录结构及介绍

go-monolith-example 项目展示了如何实现一个包含嵌入式微服务的单体应用（也称为模块化单体）。以下是项目的目录结构及其介绍：

go-monolith-example/
├── api/
│   ├── ext-*/
│   └── *.go
├── build/
│   └── gorules/
├── cmd/
│   └── mono/
├── configs/
│   └── insecure-dev-pki/
├── internal/
│   ├── config/
│   ├── dom/
│   ├── srv/
│   ├── sub/
│   ├── dal/
│   ├── migrations/
│   └── *.go
├── ms/
│   ├── internal/
│   │   ├── config/
│   │   ├── app/
│   │   ├── srv/
│   │   ├── sub/
│   │   ├── dal/
│   │   └── migrations/
│   └── *.go
├── pkg/
│   └── def/
├── scripts/
├── third_party/
├── web/
├── .dockerignore
├── .gitattributes
├── .gitignore
├── .golangci.yml
├── Dockerfile
├── LICENSE
├── README.md
├── buf.yaml
├── docker-compose.yml
├── env.sh.dist
├── go.mod
├── go.sum
└── tools.go

目录结构介绍

• api/: 包含自定义和第三方 API/协议的定义以及相关的自动生成代码。
• build/gorules/: 构建规则相关文件。
• cmd/mono/: 主应用程序入口。
• configs/insecure-dev-pki/: 开发环境下的不安全证书配置。
• internal/: 嵌入式微服务共享的包，例如配置、领域类型等。
• ms/: 嵌入式微服务，每个微服务都有自己的配置、业务逻辑、服务接口等。
• pkg/: 与架构和业务逻辑无关的辅助包，可能会被移动到独立的模块或替换为外部依赖。
• scripts/: 辅助脚本。
• third_party/: 第三方依赖。
• web/: Web 相关文件。
• .dockerignore: Docker 忽略文件。
• .gitattributes: Git 属性文件。
• .gitignore: Git 忽略文件。
• .golangci.yml: GolangCI-Lint 配置文件。
• Dockerfile: Docker 构建文件。
• LICENSE: 项目许可证。
• README.md: 项目说明文档。
• buf.yaml: Buf 配置文件。
• docker-compose.yml: Docker Compose 配置文件。
• env.sh.dist: 环境变量配置模板。
• go.mod: Go 模块定义文件。
• go.sum: Go 模块校验文件。
• tools.go: 工具依赖定义文件。

2. 项目的启动文件介绍

项目的启动文件位于 cmd/mono/ 目录下，主要文件是 main.go。该文件负责初始化应用程序并启动嵌入式微服务。

main.go 文件介绍

package main

import (
    "go-monolith-example/internal/config"
    "go-monolith-example/internal/srv"
    // 其他导入
)

func main() {
    // 初始化配置
    config.Init()
    
    // 启动嵌入式微服务
    srv.Start()
    
    // 其他初始化逻辑
}

启动流程

1. 初始化配置: 从环境变量和配置文件中加载配置。
2. 启动嵌入式微服务: 根据配置启动各个嵌入式微服务。
3. 其他初始化逻辑: 可能包括日志、数据库连接等。

3. 项目的配置文件介绍

项目的配置文件主要位于 configs/ 目录下，包括开发环境下的不安全证书配置 insecure-dev-pki/ 和环境变量配置模板 env.sh.dist。

env.sh.dist 文件介绍

env.sh.dist 是一个环境变量配置模板，用户需要将其复制为 env.sh 并根据实际环境进行修改。

# 数据库配置
export DB_HOST="localhost"
export DB_PORT="3306"
export DB_USER="root"
export DB_PASS="password"
export DB_NAME="example"

# 其他配置
export LOG_LEVEL="debug"
export SERVER_PORT="8080"

配置加载流程

1. 复制配置模板: 将 env.sh.dist 复制为 env.sh。
2. 修改配置: 根据实际环境修改 env.sh 中的配置项。
3. 加载配置: 在启动应用程序前，通过 source env.sh 加载配置。

通过以上步骤，您可以成功启动并配置 go-monolith-example 项目。