Go 单体架构示例项目教程

1. 项目介绍

项目概述

go-monolith-example 是一个展示如何使用嵌入式微服务实现单体架构的示例项目。该项目结合了单体架构和微服务架构的优点，既避免了单体架构的复杂性，又保留了微服务架构的灵活性。通过使用 Uncle Bob 的“Clean Architecture”，该项目展示了如何在 Go 语言中实现模块化的单体架构。

主要特点

• 模块化单体架构：项目展示了如何将微服务嵌入到单体架构中，使得每个微服务可以独立开发和测试。
• Clean Architecture：遵循 Uncle Bob 的“Clean Architecture”原则，确保代码的可维护性和可测试性。
• 自动化代码生成：使用自动化工具生成 API 定义和相关代码，减少手动编写代码的工作量。
• Docker 支持：提供 Docker 和 Docker Compose 支持，方便开发和部署。
• CI/CD 集成：支持 GitHub Actions 和 CircleCI，确保代码质量和持续集成。

2. 项目快速启动

环境准备

• Go 1.16 或更高版本
• Docker 19.03+
• Docker Compose 1.25+

克隆项目

git clone https://github.com/powerman/go-monolith-example.git
cd go-monolith-example

配置环境变量

cp env.sh.dist env.sh

根据需要编辑 env.sh 文件，配置相关环境变量。

启动项目

source env.sh
docker-compose up -d

运行测试

go test ./...

构建和运行

./scripts/build
./bin/mono serve

3. 应用案例和最佳实践

应用案例

• 多租户系统：通过模块化单体架构，可以轻松实现多租户系统，每个租户可以独立管理自己的数据和服务。
• 复杂业务逻辑：对于复杂的业务逻辑，可以将不同的业务模块拆分为独立的微服务，通过嵌入式微服务的方式集成到单体架构中。

最佳实践

• 遵循 Clean Architecture：确保每个模块的独立性和可测试性，遵循“依赖倒置”原则。
• 自动化测试：使用自动化测试工具，确保每个模块的功能和性能。
• 持续集成：通过 CI/CD 工具，确保代码质量和持续集成，减少手动部署的工作量。

4. 典型生态项目

相关项目

• go-service-example：一个展示如何实现 Go 微服务的示例项目，可以作为嵌入式微服务的参考。
• grpc-gateway：一个将 gRPC 服务暴露为 HTTP/1 API 的工具，适合与 go-monolith-example 结合使用。
• Prometheus：用于监控和报警的工具，可以与 go-monolith-example 结合使用，提供生产级别的监控支持。

通过以上步骤，您可以快速启动并运行 go-monolith-example 项目，并了解如何将其应用于实际开发中。