一款不错的 Go Server/API boilerplate,使用 K8S+DDD+CQRS+ES+gRPC 最佳实践构建

本文涉及的产品
云数据库 RDS SQL Server,独享型 2核4GB
云数据库 RDS MySQL Serverless,0.5-2RCU 50GB
简介: 一款不错的 Go Server/API boilerplate,使用 K8S+DDD+CQRS+ES+gRPC 最佳实践构建

该项目的主要目的是使用最佳实践、DDDCQRSESgRPC 提供样板项目设置。为开发和生产环境提供 kubernetes 配置。允许与反映生产的 environment 一起工作,从而减少任何错误配置。


这是许多服务(如身份验证或用户域)的单一存储库(mono-repository)。除了共享包外,每个服务都有自己的代码库,以简化这个样板文件。服务之间通过 gRPC 进行通信。每个服务都可能为外部通信或/和 gRPC 公开 HTTP API

这个项目设置应该减少整个 kubernetes 集群和/或每个微服务的环境配置时间。将每个服务提取到自己的存储库或将其保留为 mono-repo 应该是一个偏好问题。


Web UI 示例 (React)



此样板包括简单的 Web UI,以演示与 API 的示例交互。部署并设置好 hosts 后,请查看 https://api.go-api-boilerplate.local 以访问 UI。


微信图片_20220612143249.jpg


关键概念



  1. Rest API
  2. Docker
  1. https://www.docker.com/what-docker
  1. Kubernetes
  1. https://kubernetes.io
  1. Helm chart
  1. https://helm.sh
  1. Terraform
  1. https://terraform.io
  1. gRPC
  1. https://grpc.io/docs
  1. Domain Driven Design (DDD)
  1. https://en.wikipedia.org/wiki/Domain-driven_design
  1. CQRS
  1. https://martinfowler.com/bliki/CQRS.html
  1. Event Sourcing
  1. https://martinfowler.com/eaaDev/EventSourcing.html
  1. Hexagonal, Onion, Clean Architecture
  1. https://herbertograca.com/2017/11/16/explicit-architecture-01-ddd-hexagonal-onion-clean-cqrs-how-i-put-it-all-together
  1. oAuth2
  1. https://github.com/go-oauth2/oauth2


值得了解一下这个样板文件中使用的包:



  1. gorouter
  1. https://github.com/vardius/gorouter
  1. message-bus
  1. https://github.com/vardius/message-bus
  1. gollback
  1. https://github.com/vardius/gollback
  1. shutdown
  1. https://github.com/vardius/shutdown
  1. pubsub
  1. https://github.com/vardius/pubsub
  1. pushpull
  1. https://github.com/vardius/pushpull
  1. gocontainer
  1. https://github.com/vardius/gocontainer


📚 文档



  • Wiki
  • Package level docs
  • Getting Started
  • Installing and Setting up
  • Configuration
  • Guides


快速开始



Localhost alias


编辑 /etc/hosts 以添加 localhost 别名


➜ go-api-boilerplate git:(master) cat /etc/hosts
##
# Host Database
#
# localhost is used to configure the loopback interface
# when the system is booting. Do not change this entry.
##
127.0.0.1 go-api-boilerplate.local api.go-api-boilerplate.local maildev.go-api-boilerplate.local mysql.go-api-boilerplate.local


Build release



Local image


make docker-build BIN=auth
make docker-build BIN=migrate
make docker-build BIN=user
make docker-build BIN=web


GitHub Package Registry


使用 metadata 创建 tag 将触发 github workflow 并将 docker 镜像发布到 GitHub Package Registry。


标签 v1.0.0+user 将触发 user 服务的构建,发布 1.0.0 docker image tag。您可以在 cmd 目录中为所有服务创建 release。


v1.0.0+auth
v1.0.0+user
v1.0.0+web
v1.0.0+migrate


替换 main.yaml 中的 image 细节


image:
-    repository: go-api-boilerplate-user
+    repository: docker.pkg.github.com/vardius/go-api-boilerplate/go-api-boilerplate-user
-    tag: latest
+    tag: 1.0.0
    pullPolicy: IfNotPresent


对所有服务重复此操作和 migrate init containers。


Private Registry


登录到 Docker


docker login


复制 docker config


cp ~/.docker/config.json ./k8s/.docker/config.json


验证 config.json


Deploy release



make terraform-install


Destroy


make terraform-destroy


如果持久卷(persistent volume)在终止时堆叠(stack),则在持久卷受到保护时会发生这种情况。您应该能够交叉验证这一点:


kubectl describe pvc PVC_NAME --namespace=go-api-boilerplate | grep Finalizers
Output:
Finalizers:    [kubernetes.io/pvc-protection]


您可以通过使用 kubectl patchfinalizers 设置为 null 来解决此问题:


kubectl patch pvc PVC_NAME --namespace=go-api-boilerplate -p '{"metadata":{"finalizers": []}}' --type=merge


Build tags



Build flags 用于不同的持久层(persistence layers)。有关详细信息,请参阅 services.go 文件。提供的层是 mysqlmongomemory。如果需要,可以按照给定的模式以类似的方式轻松添加新层。


go build -tags=persistence_mysql


可用的 build tags


  • persistence_mysql (mysql service container)
  • persistence_mongodb (mongodb service container)

Important 如果没有提供 flag,持久层默认为 memory(Docker image 设置了 persistence_mysql flag),详情请参阅每个服务 Dockerfile


Domain(领域)



Dispatching command(分发命令)


通过 POST 请求发送示例 JSON


curl -d '{"email":"test@test.com"}' -H "Content-Type: application/json" -X POST https://api.go-api-boilerplate.local/users/v1/dispatch/user/user-register-with-email --insecure


View(视图)



Public routes(公共路由)


获取 user 详细信息 https://api.go-api-boilerplate.local/users/v1/34e7ed39-aa94-4ef2-9422-401bba9fc812


{"id":"34e7ed39-aa94-4ef2-9422-401bba9fc812","email":"test@test.com"}


获取 user 列表 https://api.go-api-boilerplate.local/users/v1?page=1&limit=10


{"page":1,"limit":20,"total":1,"users":[{"id":"34e7ed39-aa94-4ef2-9422-401bba9fc812","email":"test@test.com"}]}


Protected routes(受保护的路由)


访问 protected route,使用 `auth token https://api.go-api-boilerplate.local/users/v1/me.


{"code": "401","message": "Unauthorized"}


user 请求 access token


curl -d '{"email":"test@test.com"}' -H "Content-Type: application/json" -X POST https://api.go-api-boilerplate.local/users/v1/dispatch/user/user-request-access-token --insecure


mail catcher 获取您的 access token https://maildev.go-api-boilerplate.local.

使用 auth token 访问受保护的路由 https://api.go-api-boilerplate.local/users/v1/me?authToken=eyJhbGciOiJIUzUxMiIsInR5cCI6IkpXVCJ9.eyJhdWQiOiJyXHUwMDE277-977-977-977-9IiwiZXhwIjoxNTU5NjEwOTc2LCJzdWIiOiIzNGU3ZWQzOS1hYTk0LTRlZjItOTQyMi00MDFiYmE5ZmM4MTIifQ.pEkgtDAvNh2D3Dtgfpu4tt-Atn1h6QwMkDhz4KpgFxNX8jE7fQH00J6K5V7CV063pigxWhOMMTRLmQdhzhajzQ


{"id":"34e7ed39-aa94-4ef2-9422-401bba9fc812","email":"test@test.com"}


微信图片_20220612143518.png

相关实践学习
容器服务Serverless版ACK Serverless 快速入门:在线魔方应用部署和监控
通过本实验,您将了解到容器服务Serverless版ACK Serverless 的基本产品能力,即可以实现快速部署一个在线魔方应用,并借助阿里云容器服务成熟的产品生态,实现在线应用的企业级监控,提升应用稳定性。
云原生实践公开课
课程大纲 开篇:如何学习并实践云原生技术 基础篇: 5 步上手 Kubernetes 进阶篇:生产环境下的 K8s 实践 相关的阿里云产品:容器服务 ACK 容器服务 Kubernetes 版(简称 ACK)提供高性能可伸缩的容器应用管理能力,支持企业级容器化应用的全生命周期管理。整合阿里云虚拟化、存储、网络和安全能力,打造云端最佳容器化应用运行环境。 了解产品详情: https://www.aliyun.com/product/kubernetes
相关文章
|
2天前
|
Go API 数据安全/隐私保护
Go语言标准库概览:构建高效、可靠的软件开发基石
【2月更文挑战第8天】Go语言标准库是Go语言生态系统的重要组成部分,它为开发者提供了一系列高效、可靠的工具和函数,帮助开发者构建高质量的软件应用。本文将对Go语言标准库进行概览,介绍其组成特点、设计哲学以及使用场景与优势,帮助读者更好地理解和应用Go语言标准库。
|
6天前
|
中间件 Go 数据库
Go开发者必读:Gin框架的实战技巧与最佳实践
在当今快速发展的互联网时代,Web开发的需求日益增长。Go语言以其简洁、高效、并发性强的特点,成为了开发者们的首选。而在Go语言的众多Web框架中,Gin无疑是其中的佼佼者。本文将深入探讨Gin框架的特性、优势以及如何利用Gin构建高性能的Web应用。
|
7天前
|
IDE Java API
使用Java Web技术构建RESTful API的实践指南
使用Java Web技术构建RESTful API的实践指南
|
23天前
|
Web App开发 JavaScript NoSQL
深入浅出:构建基于Node.js的RESTful API
在当今快速发展的互联网时代,RESTful API已成为前后端分离架构中不可或缺的一部分。本文旨在为初学者和中级开发人员提供一个清晰、简洁的指南,详细介绍如何使用Node.js构建一个高效、可维护的RESTful API。通过结合实际案例,本文将从API设计理念出发,深入讲解如何利用Express框架及MongoDB数据库实现API的增删改查功能,同时探讨如何通过JWT进行安全认证,确保数据传输的安全性。此外,文章还将简要介绍如何使用Swagger生成API文档,使得API的测试和维护更加便捷。无论你是希望提升现有项目的API设计,还是想从零开始构建一个新项目,本文都将为你提供一条清晰的道路
|
1天前
|
搜索推荐 Go 开发者
Go模块与依赖管理:构建稳定、可维护的项目生态
【2月更文挑战第9天】Go模块是Go语言从1.11版本开始引入的一个新的依赖管理工具,它改变了以往通过GOPATH管理项目依赖的方式,为Go开发者带来了更加灵活、高效的依赖管理方式。本文将深入探讨Go模块与依赖管理的概念、使用方法和最佳实践,帮助读者更好地理解和应用Go模块,构建稳定、可维护的项目生态。
|
1天前
|
Go 开发者
Go语言包管理基础:构建高效、可维护的代码库
【2月更文挑战第9天】Go语言以其简洁、高效和并发的特性受到了开发者的广泛欢迎。在Go中,包(package)是组织和管理代码的基本单位。本文将深入探讨Go语言包管理的基础知识,包括包的定义、组织结构、导入导出规则等,帮助读者更好地理解和应用Go语言中的包管理机制,构建高效、可维护的代码库。
|
2天前
|
Java 测试技术 Go
Go语言标准库进阶应用与最佳实践:提升代码质量与性能
【2月更文挑战第8天】在掌握了Go语言标准库的基础应用后,如何进一步发掘其潜力,提升代码质量和性能,是每位Go语言开发者所关心的问题。本文将探讨Go语言标准库的进阶应用与最佳实践,包括标准库与其他库的协同使用、性能优化与内存管理、错误处理与异常捕获、标准库在实际项目中的应用案例,以及推荐的最佳实践与编程规范。通过深入了解这些内容,开发者能够更好地利用Go语言标准库,提升代码质量与性能,构建出更加高效、可靠的软件应用。
|
2天前
|
算法 安全 Go
Go语言标准库核心模块详解:构建高效应用的基石
【2月更文挑战第8天】Go语言标准库中的核心模块为开发者提供了构建高效应用所需的基础功能和工具。本文将深入探讨Go语言标准库中的几个核心模块,包括容器与集合、并发与并行、输入输出、时间与日期、字符串处理以及加密与安全,帮助读者更好地理解和应用这些核心模块,为构建高效应用打下坚实基础。
|
4天前
|
API 网络架构
解释 RESTful API,以及如何使用它构建 web 应用程序。
解释 RESTful API,以及如何使用它构建 web 应用程序。
11 0
|
4天前
|
存储 缓存 网络协议
Go语言并发编程实战:构建高性能Web服务器
【2月更文挑战第6天】本文将通过构建一个高性能的Web服务器实战案例,深入探讨如何在Go语言中运用并发编程技术。我们将利用goroutine和channel实现高效的请求处理、资源管理和并发控制,以提升Web服务器的性能和稳定性。通过这一实战,你将更好地理解和掌握Go语言在并发编程方面的优势和应用。

相关产品

  • 云迁移中心
  • 推荐镜像

    更多