【问题标题】:How do I correctly include golang protobuf/ptypes for protoc when using dep?使用 dep 时,如何正确包含 protoc 的 golang protobuf/ptypes?
【发布时间】:2019-06-11 20:57:50
【问题描述】:

在使用dep 时,我无法包含google/protobuf/timestamp.proto 众所周知的类型。

我收到一个错误:google/protobuf/timestamp.proto: File not found

service.proto:

syntax = "proto3";
import "google/protobuf/timestamp.proto";

package com.rynop.platform;
option go_package = "rpc";

service PlatformService {
  rpc Test(EmptyMessage) returns (EmptyMessage);
}

message EmptyMessage { }

message A {  
    string summary = 1;
    google.protobuf.Timestamp start = 2;
}

message B {
  repeated A foos = 1;
}

安装包含时间戳的包 .proto def:

dep ensure -add github.com/golang/protobuf/ptypes/timestamp 

运行protoc 并得到错误:

build/bin/protoc -Ivendor -I. --twirp_typescript_out=version=v6:./clients/ts-json/ rpc/service.proto
google/protobuf/timestamp.proto: File not found.

包含时间戳的 .proto 定义的目录存在:

file vendor/github.com/golang/protobuf/ptypes/timestamp/timestamp.proto
vendor/github.com/golang/protobuf/ptypes/timestamp/timestamp.proto: ASCII text

我正在本地安装 protoc,因为我不想将 protoc 版本锁定/绑定到该项目:

# fetch the protoc compiler
OS_NAME=$(shell uname -s)
ifeq ($(OS_NAME),Darwin)
    PROTOC_URL=https://github.com/google/protobuf/releases/download/v3.7.1/protoc-3.7.1-osx-x86_64.zip
endif
ifeq ($(OS_NAME),Linux)
    PROTOC_URL=https://github.com/google/protobuf/releases/download/v3.7.1/protoc-3.7.1-linux-x86_64.zip
endif
build/protoc build/bin/protoc:
    mkdir -p build/protoc/bin build/bin
    cd build/protoc && curl -L -o protoc.zip $(PROTOC_URL) && \
        unzip protoc.zip && mv bin/protoc ../bin/protoc

我做错了什么?

【问题讨论】:

    标签: go protocol-buffers protoc twirp


    【解决方案1】:

    您遇到的protoc 错误与您的INCLUDE 路径有关。

    当您安装 protoc 编译器(例如到​​ /usr/local/bin/protoc)时,它可以获取 google 的标准原型定义,例如 timestamp.proto - 这些需要添加到您的 INCLUDE 路径中的某个位置(在 MacOS/Linux 上可以使用/usr/local/include)。注意:protoc 头文件应该已经包含在 protoc 编译器中。

    因此,您的 proto 导入文件通常位于此处:

    /usr/local/include/google/protobuf/timestamp.proto
    

    protoc 编译器看到如下导入时将引用此路径:

    import "google/protobuf/timestamp.proto";
    

    因此,请检查您的 INCLUDE 路径并确保正确安装了 protoc 标头。

    【讨论】:

    • 谢谢,很有帮助。如果我这样做 -I/usr/local/include -I. 就可以了。但是,我使用 dep 来“锁定”我的依赖项。我想用 protoc 做同样的事情。我不想全局安装 protoc,因为我不想将 protoc 版本锁定/绑定到这个项目。我已经用我的安装方式更新了我的帖子。是否有最佳实践仍然可以获得标题?还是我在这里过于担心(无中生有)?
    • 我同意/分享您对锁定的担忧。您将遇到proto2proto3 项目,并且能够在构建系统上处理它们是关键。在我的 makefile 中,我明确地将 PROTOC2PROTOC3 env vars 指向相关的编译器路径 - 并且类似地使用 -IPATH 标志指向相关的标准头文件。我会尽快更新此答案以包含这些详细信息...
    • 谢谢。我的 zip 包含 include 目录,但我从未意识到这一点。我改成-Ibuild/protoc/include -I.,现在我是金子了。谢谢!
    猜你喜欢
    • 1970-01-01
    • 2019-07-29
    • 1970-01-01
    • 1970-01-01
    • 2022-10-14
    • 1970-01-01
    • 1970-01-01
    • 1970-01-01
    • 1970-01-01
    相关资源
    最近更新 更多