ToDo API 微服务示例项目教程

ToDo API 微服务示例项目教程

todo-api-microservice-example Go microservice tutorial project using Domain Driven Design and Onion Architecture! 项目地址: https://gitcode.com/gh_mirrors/to/todo-api-microservice-example

1. 项目目录结构及介绍

该项目采用领域驱动设计（Domain Driven Design, DDD）和洋葱架构（Onion Architecture），目录结构如下：

todo-api-microservice-example/
├── build/
│   ├── <cloud-providers>/
│   └── <executableN>/
├── cmd/
│   ├── <primary-server>/
│   └── <replica-server>/
├── db/
│   ├── migrations/
│   └── seeds/
├── internal/
│   ├── <datastoreN>/
│   ├── http/
│   └── service/
├── pkg/
│   └── openapi3/
├── .envrc
├── .gitattributes
├── .gitignore
├── .golangci.yml
├── LICENSE
├── Makefile
├── README.md
├── docker-compose.yml
├── env.example
├── go.mod
└── go.sum

目录结构介绍

• build/: 定义用于创建基础设施和Docker容器的代码。

  • <cloud-providers>/: 定义具体的云提供商。
  • <executableN>/: 包含用于构建二进制的Dockerfile。

• cmd/: 包含主要的启动文件。

  • <primary-server>/: 使用主数据库。
  • <replica-server>/: 使用只读数据库。

• db/: 数据库相关文件。

  • migrations/: 包含数据库迁移文件。
  • seeds/: 包含用于填充基本数据库值的文件。

• internal/: 定义核心领域逻辑。

  • <datastoreN>/: 具体的存储库实现，例如PostgreSQL。
  • http/: 定义HTTP处理程序。
  • service/: 协调用例和管理事务。

• pkg/: 公共API，可以被其他Go包导入。

  • openapi3/: OpenAPI 3.0规范相关文件。

• 其他文件:

  • .envrc: 环境变量配置文件。
  • .gitattributes: Git属性配置文件。
  • .gitignore: Git忽略配置文件。
  • .golangci.yml: GolangCI配置文件。
  • LICENSE: 项目许可证。
  • Makefile: 项目构建脚本。
  • README.md: 项目介绍文档。
  • docker-compose.yml: Docker Compose配置文件。
  • env.example: 环境变量示例文件。
  • go.mod: Go模块定义文件。
  • go.sum: Go模块依赖校验文件。

2. 项目启动文件介绍

项目的启动文件主要位于cmd/目录下，具体包括：

• cmd/ /main.go : 主服务器的启动文件，负责启动主数据库连接的服务。
• cmd/ /main.go : 副本服务器的启动文件，负责启动只读数据库连接的服务。

这些启动文件通常包含以下内容：

• 初始化配置
• 数据库连接
• 服务启动逻辑
• 优雅关闭逻辑

3. 项目配置文件介绍

项目的配置文件主要包括以下几个部分：

• .envrc: 环境变量配置文件，用于设置项目运行时的环境变量。
• docker-compose.yml: Docker Compose配置文件，定义了项目所需的Docker容器及其配置。
• Makefile: 项目构建脚本，包含项目的构建、测试、运行等命令。
• go.mod: Go模块定义文件，定义了项目的依赖模块。
• go.sum: Go模块依赖校验文件，用于校验依赖模块的完整性。

这些配置文件共同确保了项目的正确构建和运行。

todo-api-microservice-example Go microservice tutorial project using Domain Driven Design and Onion Architecture! 项目地址: https://gitcode.com/gh_mirrors/to/todo-api-microservice-example