在 monorepo 中设置 Protobuf、gRPC 和 Go 模块的方法

学习知识要善于思考，思考，再思考！今天golang学习网小编就给大家带来《在 monorepo 中设置 Protobuf、gRPC 和 Go 模块的方法》，以下内容主要包含等知识点，如果你正在学习或准备学习Golang，就都不要错过本文啦~让我们一起来看看吧，能帮助到你就更好了！

我正在尝试用 go 创建一个基于微服务的 api，非常基础，只是为了学习一些东西。我必须实现三个主要目标。

1. 莫诺雷波。
2. 能够根据需要使用不同的后端语言（即 go 中的一种微服务、node.js 中的两种、python 中的一种）。
3. 使用 grpc。

目前我的结构如下所示（存储在 ~/projects/tkg 中，位于 gopath 之外）。

每个“服务”都应该是一个用“whatever”编写的独立应用程序。如您所见，我有一个 go 服务和一个 react 前端应用程序。此外，我想用一个 makefile 来构建东西，但我可能会转向 shell 脚本、docker 等。没关系。

现在问题来了。如何使生成的原型文件在此设置中正常运行？我认为我不了解有关 go 模块和包的信息，因为我无法设置它，因此 articles.go （来自 cmd）可以访问生成的 api/article.pb.go。怎么做？

// services/articles/go.mod
module tkg/services/articles

go 1.12

require (
    github.com/golang/protobuf v1.3.2
    google.golang.org/grpc v1.22.1
)

// services/articles/cmd/article.go
package main

import (
    pb "tkg/services/articles/api/article"
)

type repository interface {
    create(*pb.article) (*pb.article, error)
}

func main() {

}

// services/articles/api/article.proto
syntax = "proto3";

package article;
option go_package = "tkg/services/articles/api/article";
...

// Makefile
build:
    protoc services/articles/api/article.proto --go_out=.

我在 go.mod 中尝试了各种不同的包名称，在 proto 文件中尝试了不同的 go_packages，我尝试了不同的 protoc 命令和路径。我敢打赌这很愚蠢，对于精通 go 的人来说这是非常明显的，但对于像我这样有 node.js 背景的人来说，无法执行 import "../api/article.pb.go" 是令人愤怒的。 :(

我收到的错误是：无法导入 tkg/services/articles/api/article（没有包 tkg/services/articles/api/article 的解析文件）。当然，包名称具有不同的值。我已经尝试解决这个问题两天了。

您将如何解决这个问题？

解决方案

如果您在与 .proto 文件（推荐）相同的目录中生成 .pb.go 文件，则您的导入路径应为：

import (
    pb "tkg/services/articles/api"
)

（不是 tkg/services/articles/api/article。）

go 包是单个目录中 .go 文件的集合 - 每个文件都有相同的 package xyz 第一行 - 其中 xyz 是包名称。因此，在导入包时，使用包基目录 - 不包括任何 .go 文件名。

编辑：（这太长了，无法容纳评论）：

我会退一步思考整个项目的基本目录。

标准 go 包通常是单个单词，如 time、sync 等，因为它们是 go 标准库的一部分。所有其他包都应该有完整的互联网路径。这些通常与 git repo 地址匹配（例如 "github.com/boltdb/bolt"） - 但并不总是如此，例如（“gopkg.in/yaml.v2”）。这实际上优于集中托管的 npm 包模型 - 因为它可以轻松地从任何存储库主机提取包。此外，由于存储库被克隆到本地磁盘 - 这些相同的路径可以首先存在于本地磁盘上（在它们托管在互联网上之前，例如用于开发目的）。

所以我建议将您的本地基本目录命名为：

github.com/myname/myproj/tkg/services/...

然后确保您基于此目录结构导入包，例如

import "github.com/myname/myproj/tkg/services/api"

如果 go build 没有获取生成的 (.pb.go) 代码，则说明您的 gopath 出现问题，或者如果您的 go.mod 设置使用新的 go 模块。

今天关于《在 monorepo 中设置 Protobuf、gRPC 和 Go 模块的方法》的内容介绍就到此结束，如果有什么疑问或者建议，可以在golang学习网公众号下多多回复交流；文中若有不正之处，也希望回复留言以告知！