golang 中的微服务 - 第3部分 - docker compose 和 datastores
收藏

golang 中的微服务 - 第3部分 - docker compose 和 datastores

之前的文章(「GCTT 出品」Golang 中的微服务-第一部分「GCTT 出品」Golang 中的微服务-第二部分-Docker 和 go-micro中,我们介绍了 go-microDocker 的一些基础知识。在推出了这两项服务之后我们将在本文介绍 docker-compose、教大家如何更便捷地在本地运行多个服务,还会列述一些在本系列微服务教程中可以使用的数据库类型,最后引出本系列的第三项服务 —— User service。

(译者注:阅读本文之前建议先下载作者源码配合理解)

准备工作

安装 docker-compose: https://docs.docker.com/compose/install/

docker-compose 安装完毕之后,我们来介绍一些可用的数据库以及他们之间的区别。

数据库选择

在前两篇文章,我们的数据并不会持久化的存储到某地,它只会存储在我们服务的内存中,当容器重新启动时,这些数据会丢失。所以需要选择一种数据库来持久化的存储和查询我们的数据。

微服务的优点是,你可以为每个服务选择一个不同的数据库。当然许多情况下我们不必这样做。例如生产环境中的小团队完全不必选择多个数据库,这样会增加维护成本。但在某些情况下,一个服务的数据可能并不兼容其他服务的数据库,这时不得不增加一个数据库。微服务使得数据兼容这件事变得更加简单,你完全不必操心不同服务的数据使用不同的数据库带来的额外维护成本。

本文不会解释如何为你的服务选择“正确的”数据库,这是一个值得深入探究的话题,详情可以借鉴如何为你的服务选择“正确的”数据库。本文示例的数据持久化选择 NoSQL 文档存储解决方案,NoSQL 更适用于处理大量松散且不一致的数据集,例如 json 存储数据更加灵活,我会选择效果良好并且社区服务更加完善的 MongoDB 作为我们的 NoSQL。

如果需要处理的数据是被严格定义并且联系紧密,那么可以使用传统的关系型数据库(RDBMS),但实际上并非一定要这么做。在选择之前一定考虑我们服务的数据结构,它是做的读操作更多还是写操作更多?查询的复杂程度如何?等等。这些才是我们选择使用何种数据库的出发点。由于个人原因,关系数据库我更喜欢使用 Postgres,当然,你也可以使用 MySQL 或者 MariaDB 等等。

如果你不想亲自管理自己的数据库(通常是可取的),你可以选择使用亚马逊或者谷歌提供的完全成熟的 NoSQL 和 RDBMS 解决方案。除此之外 compose 则是另外一个非常棒的选择,你可以将自己的服务完全托管在 compose 上,它可以提供类似于亚马逊和谷歌的云服务,并且能够更加便捷的扩展各种数据库实例,同时还具备更低的延迟。

  • 亚马逊:
  • RDBMS:https://aws.amazon.com/rds/
  • NoSQL:https://aws.amazon.com/dynamodb/
  • 谷歌:
  • RDBMS:https://cloud.google.com/spanner/
  • NoSQL:https://cloud.google.com/datastore/

数据库相关知识讨论完毕之后我们就可以写一些代码了!

docker-compose

上一篇文章我们介绍了 Docker ,它可以用轻量级的容器运行我们的服务,并拥有自己独立的运行时间和依赖关系。但是服务数量较多的情景下使用单独的 Makefile 运行和管理每个服务太麻烦了。docker-compose应运而生,它很好的帮我们解决了这一问题。 Docker-compose 允许我们在 yaml 文件中定义 Docker 容器列表,并指定关于其运行时间的元数据。我们可以从 Docker-compose 中看到一些熟悉的 docker 命令的影子。例如:

golang 中的微服务 - 第3部分 - docker compose 和 datastores

在 docker-compose 里可以写为:

golang 中的微服务 - 第3部分 - docker compose 和 datastores

太简单了,不是吗?

接下来我们可以在根目录下创建一个 docker-compose 文件

golang 中的微服务 - 第3部分 - docker compose 和 datastores

然后在这个 yml 文件里添加我们的服务:

golang 中的微服务 - 第3部分 - docker compose 和 datastores

这个 yml 文件首先定义了要使用的 docker-compose 的版本号3.1,然后定义一个 service 列表。还有其他的根级定义,比如网络和卷。

先关注 service ,每个 service 都由其名称定义,然后我们加入了一个 build 路径,这里要存放我们的 Dockerfile 文件,docker-compose 会从这个路径下寻找 Dockerfile 来构建镜像,后文我们会演示如何用 image 字段来引用一个构建好的镜像。然后我们还可以定义映射端口和环境变量。

这些是 docker-compose 的基本命令:

  • 构建你的docker-compose集: $ docker-compose build && docker-compose run
  • 在后台运行你的容器集: $ docker-compose up -d
  • 查看当前正在运行的容器的列表: $ docker ps
  • 停止正在运行的所有容器: $ docker stop $(docker ps -qa)

接下来就可以运行我们的容器集了。你能够看到很多 dockerfile 正在 build 的输出信息。也可能会从我们的 CLI 中看到少量 error ,不用太在意,这一般都是一些其他服务在处理彼此之间的依赖关系。

命令 $ docker-compose run consignment-cli 可以帮助我们使用 CLI 工具来测试所有服务是否正常工作,一旦所有容器都显示 running 就意味着我们的 docker-compose 成功了。和我们以前不借助 docker-compose 直接使用 dockerfile 和 docker 命令取得的效果一样。

容器实体和 protobufs

本系列前面的文章已经讲过使用 protobufs 作为数据模型的模板。我们用它来定义我们的服务结构和功能函数。因为 protobuf 生成的结构基本上都是正确的数据类型,我们也可以将这些结构重复利用为底层数据库模型。这实际上是相当令人兴奋的。protobufs保证了数据的来源单一性和一致性。

当然这种方法确有其不足之处。有时候,将 protobuf 生成的代码封装到一个有效的数据库实体是非常棘手的。有时数据库很难利用 protobuf 生成的自定义本地数据类型。例如,如何将一个 Mongodb 实体里的 bson.ObjectId 类型的 ID 转换成 string 类型的 ID 就困扰了我很久。后来通过实验论证,无论如何 bson.ObjectId 实际上只是一个字符串,所以你可以把它们封装在一起。此外,mongodb 的 id 索引在内部被存储为_id,该 _Id 字段是无法被执行的,所以必须要将它与 Id 字符串字段绑定在一起。这意味着你要为你的 protobuf 文件定义自定义标签。稍后我们讨论如何做到这一点。

与此同时,使用 protobuf 会导致服务间通信与数据库代码的耦合度更高,这也成为了许多人反对使用 protobuf 定义的数据作为数据库实体的一大原因。

一般建议在 protobuf 定义代码和你的数据库实体之间进行相互转换。但是,这两种类型的代码之间相互转换需要大量的编码工作:

golang 中的微服务 - 第3部分 - docker compose 和 datastores

表面上看起来不是那么糟糕,但是当你有大量嵌套的结构体和类型的时候。它就会变得非常繁琐,并且可能涉及很多在嵌套的结构之间进行转换的迭代等。

这并不是一种优雅的处理方式,就像编程中的许多选择一样,可以实现需求也不会报错,但感觉并不完美。我个人的观点是选择使用 protobuf 作为我们的数据存储方式,它可以更加优雅的定义我们数据的基本类型。不用 protobufs 简直就是对 protobufs 作为模板定义代码格式所获得的好处的一种浪费。当然,这并不意味着我就是完全正确的,对此我很想听听你的不同意见,你可以点击此链接与我联系

接下来可以开始连接我们的第一个服务,consignment(委托)服务。

先整理一下代码文件: main.go 文件已经包含了我们所有的逻辑代码。为了使我们的微服务示例代码更加清晰,我在 consignment 服务的根目录下创建了另外几个文件:handler.go、datastore.go和respository.go,而不是将这些代码文件创建为一个新的目录或包。这种方式对于一个小型的微服务来说是完全可行的。插一句题外话,对于开发人员来说,可能会非常喜欢使用这样的目录结构来存放自己的代码文件:

golang 中的微服务 - 第3部分 - docker compose 和 datastores

这是MVC的常见目录结构,但 Golang 并不建议这样做。 就目录结构而言,无论是简单的小项目还是需要处理多个复杂关系的大项目,Golang 的建议是这样的:

golang 中的微服务 - 第3部分 - docker compose 和 datastores

这里是按函数的定义域分组代码,而不是随意地将代码按其功能分组。

但是,由于我们正在处理的是一个只需要关注单一简单问题的微服务,所以我们不需要将目录结构考虑得太复杂。实际上,Go的精神就是鼓励简单。 所以我们将从简单的一步开始,把所有简易命名的代码文件都放在我们的服务的根目录中。

一方面,我们要修改 Dockerfile 文件的内容,因为我们没有将新代码分离出来作为包导入,我们需要在 Dockerfile 文件里告诉go编译器来引入这些新文件并更新构建函数:

golang 中的微服务 - 第3部分 - docker compose 和 datastores

这条命令会将我们刚刚创建的新文件导入。

Golang 编写的 MongoDB driver 就是这种简单性的一个很好的例子。最后,这里有一篇关于组织Go代码库的文章推荐给大家学习。

我们可以先删除 main.go 中已经导入的所有仓库代码然后使用 golang 的 mongodb 库 mgo 来重新实现它。我在代码里进行了详细的标注以解释每部分的作用,因此请仔细阅读代码和注释。 尤其是mgo如何处理 sessions 的部分:

golang 中的微服务 - 第3部分 - docker compose 和 datastores

接下来需要编写与 Mongodb 数据库交互的代码,创建主会话/连接。 按照如下所示修改consignment-service/datastore.go:

golang 中的微服务 - 第3部分 - docker compose 和 datastores

就是这样,非常简单。下一步修改main.go文件用以连接 repository,它将一个主机字符串作为参数,返回了一个连接到数据库的 session 和一个可能出现的 error,以便程序启动时可以处理这个 error。

golang 中的微服务 - 第3部分 - docker compose 和 datastores

Copy vs Clone

你可能已经注意到使用 mgo Mongodb 库时。我们会创建一个被传递给 handlers 的数据库 session,每出现一个请求,就会调用一个该session的克隆方法。

实际上,除了建立与数据库的第一次连接之外,我们从不调用“主会话”,每次我们要访问数据存储时都调用 session.Clone() 方法。如代码注释所言,若使用主会话,则必须再次使用相同的套接字。这意味着您的查询可能会被其他查询阻塞,必须等待此套接字的占用被锁释放。在支持并发的语言中这是绝对无法容忍的。

所以为了避免阻塞请求,mgo 允许你 Copy() 或者 Clone() 一个会话,这样你就可以为每个请求建立一个并发连接。你会注意到我提到了 Copy 和 Clone 方法,这些方法非常相似,但有一个微妙但重要的区别:Clone重新使用和主会话相同的套接字,减少了产生一个新的套接字的开销,十分适用于对写入性能要求更高的代码。但是,在耗时较长的读操作(例如十分复杂的查询或大数据作业等)中其他 Go 协程使用这个相同套接字时可能会引发阻塞。

像我们公司这样写入操作更多的业务,使用 Clone() 更合适一些。

最后一步是将我们的 gRPC 处理程序代码移出到我们新的 handler.go 文件中,代码如下:

golang 中的微服务 - 第3部分 - docker compose 和 datastores

我将上一篇教程中 repo 的返回值做了轻微的修改,修改如下: 旧:

golang 中的微服务 - 第3部分 - docker compose 和 datastores

新:

golang 中的微服务 - 第3部分 - docker compose 和 datastores

改成这样的原因是我认为我们在创建 Consignment 之后不需要再返回一个相同的 Consignment。为了防止可能出现的错误,get 查询还会返回一个 error,最后还要添加一个Close()方法。

请对 vessel-service 做相同的修改。这篇文章不再赘述,你应该可以参考我的代码库自行完成。

我们也可以修改 protobuf 来在 vessel-service 里添加一个新的方法,这个方法要负责创建新 vessels :

golang 中的微服务 - 第3部分 - docker compose 和 datastores

我们在gRPC服务下创建了一个新的Create方法,该方法需要一个 vessel 并返回 generic response。 我已经在 response message 中添加了一个 bool 类型的新字段:created。 这是你需要运行$ make build来更新这个服务。 现在我们将在vessel-service / handler.go中添加一个新的处理程序,并添加一个新的 repository 方法:

golang 中的微服务 - 第3部分 - docker compose 和 datastores

golang 中的微服务 - 第3部分 - docker compose 和 datastores

终于可以创造 vessels 了! 为了使用新的 Create 方法来存储虚拟数据,我已经更新了 main.go ,请看这里

做完上述内容之后。 我们已经使用Mongodb更新了我们的服务。在尝试运行之前,需要更新我们的 docker-compose 文件来启动一个 Mongodb 容器:

golang 中的微服务 - 第3部分 - docker compose 和 datastores

更新两个服务中的环境变量:DB_HOST:“datastore:27017”。

请注意,由于 docker-compose 为我们做了一些内部DNS处理, hostname 被命名为 datastore 而不是示例中的 localhost。

所以最终的 docker-compose 文件应该更新为:

golang 中的微服务 - 第3部分 - docker compose 和 datastores

重新 build 一下,运行$ docker-compose build然后运行$ docker-compose up。 请注意,有时候由于 Dockers 的缓存机制,在 build 时需要加一个--no-cache 参数来取消缓存。

User service

User service 是我们创建的第三个服务。首先修改docker-compose.yml,微服务的概念之一就是将所有的东西全部集中起来服务化,所以我们将 Postgres 添加到 docker 容器集里面用来为我们的 User service 服务。

golang 中的微服务 - 第3部分 - docker compose 和 datastores

现在在根目录下创建一个 user-service 目录。根据创建前几个 service 的经验,我们还需要创建以下文件:handler.go,main.go,repository.go,database.go,Dockerfile,Makefile,以及一个存放 proto 文件的子目录,以及 proto 文件本身: proto/user/user.proto

将以下内容添加到 user.proto:

golang 中的微服务 - 第3部分 - docker compose 和 datastores

现在,确保你已经在根目录下创建了 Makefile 文件,按照前几个服务的 Makefile 文件照猫画虎写一个即可,接下来运行$ make build来生成 gRPC 代码。据以往经验,已经自动生成了一些连接的 gRPC 方法的代码。 本文只会讲解其中一小部分 service 的运行,其余 service 的运行详解会在本系列的其余文章给出。在本文我们只介绍 User service 如何创建和获取用户。 在本系列接下来的文章中,我们将讨论认证和 JWT 的具体实现。阅读过程中请做好相关标记。

【译者注:本系列是 Ewan Valentine 编写的关于 golang 微服务的长文教程系列第三篇,每一篇的讲解都很细致,建议大家结合作者源码仔细将每一篇阅读完毕】

你的处理程序应该是这样的:

golang 中的微服务 - 第3部分 - docker compose 和 datastores

现在让我们添加我们的 repository 代码:

golang 中的微服务 - 第3部分 - docker compose 和 datastores

为了避免使用整数 ID ,我们还需要更改 ORM 行为,以便在创建时生成一个 UUID。如果您不知道,UUID是一组随机生成的带有连字符的字符串,用作ID或主键。这比使用自动递增的整数 ID 更安全,因为它可以阻止人们猜测或遍历 API 节点。MongoDB 已经使用了 UUID,但我们需要告诉 Postgres 模型使用UUID。 因此,我们需要在user-service/proto/user中创建一个名为extensions.go的新文件,编码如下:

golang 中的微服务 - 第3部分 - docker compose 和 datastores

这段代码会关联到 GORM 的事件生命周期中,以便在实体保存之前为我们的 Id 队列生成一个 UUID。

与 Mongodb 服务不同的是我们没有进行任何连接处理,这与原生 SQL/postgres 驱动程序的工作方式稍有不同,但是这次我们不需要为连接问题担心,因为我们正在使用一个名为'gorm'的软件包,我们来简单介绍一下。

Gorm - Go + ORM

Gorm 是一个相当轻量级的对象关系映射器,它可以很好地与 Postgres,MySQL,Sqlite 等配合使用。它可以非常容易地自动设置、使用和管理你的数据库模式。

这就是说,使用微服务,您的数据结构要小得多,耦合度更低,整体复杂性更小。

现在尝试一下创建用户,所以我们可以先创建一个 cli 工具。 这个user-cli位于这个项目的根目录下。类似于consignment-cli,,但稍有不同,代码如下:

golang 中的微服务 - 第3部分 - docker compose 和 datastores

在这里,我们使用了 go-micro 的命令行助手,这非常简洁。

运行并创建一个用户:

golang 中的微服务 - 第3部分 - docker compose 和 datastores

golang 中的微服务 - 第3部分 - docker compose 和 datastores

你应该在列表中看到创建完成的用户!

由于使用纯文本存储密码,安全性太低,在本系列的下一部分文章,我会把身份验证和 JWT 添加进来。

所以目前为止,代码雏形已经建立出来了,我们创建了一个额外的命令行工具,并且我们已经开始使用两种不同的数据库来保存我们的数据。

为了避免给读者造成太大压力,本文到此结束,若读者对本系列文章有所建议,请尽可能给我反馈

如果你发现这个系列有用,请打赏作者


via: https://ewanvalentine.io/microservices-in-golang-part-3/

作者:Ewan Valentine 译者:zhangyang9 校对:polaris1119

本文由 GCTT 原创编译,Go语言中文网 荣誉推出

golang 中的微服务 - 第3部分 - docker compose 和 datastores