使用 dep 时如何为协议正确包含 golang protobuf/ptypes？

Question

我在添加 google/protobuf/timestamp.proto well known type, when using dep 时遇到问题。

我得到一个错误：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，因为我不想 lock-in/tie 这个项目的 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

我做错了什么？

Answer 1

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

当您安装 protoc 编译器（例如 /usr/local/bin/protoc）时，它会选择 google 的标准原型定义，如 timestamp.proto - 这些需要在你的 INCLUDE 路径的某处添加（在 MacOS/Linux 上可以使用 /usr/local/include）。注意：protoc headers 应该包含在 protoc 编译器中。

因此您的原型导入文件通常位于此处：

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

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

import "google/protobuf/timestamp.proto";

因此请检查您的 INCLUDE 路径并确保 protoc headers 安装正确。

使用 dep 时如何为协议正确包含 golang protobuf/ptypes？

How do I correctly include golang protobuf/ptypes for protoc when using dep?

go

protocol-buffers

protoc

twirp