go - 如何在 monorepo 中设置 protobuf、grpc 和 Go 模块？

Question

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

1. 莫诺雷波。
2. 能够根据需要使用不同的后端语言(即 Go 中的一种微服务、Node.js 中的两种、Python 中的一种)。
3. 使用 gRPC。

目前我的结构如下所示(存储在 GOPATH 之外的 ~/Projects/tkg 中)。

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

现在问题来了。如何使生成的原型(prototype)文件在此设置中正常运行？我想我不了解 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 的解析文件)。当然，包名称具有不同的值。我已经尝试解决这个问题两天了。

您将如何解决这个问题？

Answer 1

如果您在与 .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 存储库地址匹配(例如 "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-模块你的 go.mod 设置。