首页 > 文章列表 > 无法找到或有错误导入“protoc-gen-openapiv2/options/annotations.proto”文件

无法找到或有错误导入“protoc-gen-openapiv2/options/annotations.proto”文件

270 2024-02-21
问题内容

我有一个原始文件,我想在其中添加分页。技术堆栈是 golang 和 grpc。

import "google/api/annotations.proto";
import "protoc-gen-openapiv2/options/annotations.proto";
import "google/protobuf/timestamp.proto";

当尝试通过 go installgo get 添加依赖项时。我明白

go install protoc-gen-openapiv2/options/annotations.proto@latest                                                       
go: protoc-gen-openapiv2/options/annotations.proto@latest: malformed module path "protoc-gen-openapiv2/options/annotations.proto": missing dot in first path element
go get protoc-gen-openapiv2/options/annotations.proto                                                                  
go: go.mod file not found in current directory or any parent directory.
        'go get' is no longer supported outside a module.

当我阅读文档时,我发现我的做法是正确的。还有其他人遇到过这个问题吗?

message BlogAllRequest {
    option (grpc.gateway.protoc_gen_openapiv2.options.openapiv2_schema) = {
        json_schema: {
            required: ["filter"]
        }
    };

    string id = 1;
    int32 page = 2;
    int32 per_page = 3 [json_name="per_page"];
    SortOrder order = 4 [json_name = "order"];

}


正确答案


注意抱歉,我对 grpc gateway 不太熟悉,但我对 protocol buffers(和 grpc)非常熟悉。因此,我无法提供完整的解决方案,但我可以向您展示如何编译原型。

使用 protocol buffers,您需要本地源文件(例如 .proto 文件)。您不能 go getgo install 协议缓冲区文件。

您需要的 grpc-gateway 原型是:

对于下一步,最简单的方法可能是 git clone grpc-gateway回购。上面提到的原型位于 repo 的 ./protoc-gen-openapiv2 文件夹中。

我已将其克隆到我的工作目录中(请参阅下面的树)。

第一步是 protoc 编译引用这些原型的原型。这是我完成的原型文件:

foo.proto

syntax = "proto3";

option go_package = "{module}/protos";

import "protoc-gen-openapiv2/options/annotations.proto";

message blogallrequest {
    option (grpc.gateway.protoc_gen_openapiv2.options.openapiv2_schema) = {
        json_schema: {
            required: ["filter"]
        }
    };

    enum sortorder{
        bar = 0;
        baz = 1;
    }

    string id = 1;
    int32 page = 2;
    int32 per_page = 3 [json_name="per_page"];
    sortorder order = 4 [json_name = "order"];
}

注意{module} 替换为您的存储库名称。一般来说,您的存储库名称将与您的 go 模块名称相匹配。正如我所做的那样,您可能想要添加例如/protos 到您的 {module} 值作为 go_package 的值,因为这为协议生成的源提供了自己的包名称。我还添加了任意 sortorder 类型。

您现在可以 protoc 编译您的原型:

# your go.mod module value and probably matching your git repo 
module="..."

# doing this here to prove the point
go mod init ${module}

# protoc will output foo.pb.go in protos folder
# this will make it the ${module}/protos package
mkdir protos

protoc 
--proto_path=${pwd} 
--proto_path=${pwd}/grpc-gateway 
--go_out=./protos 
--go_opt=module=${module} 
${pwd}/foo.proto

protoc 非常特别关注路径。我总是将其根植于我的工作目录 (${pwd}) 上,在本例中,我已将 gprc-gateway 克隆到工作目录中。这两个文件夹都包含 protos,因此两者都必须是 proto_path。因为我使用 ${pwd} 作为 proto_path,所以我也必须在 proto 文件名前加上 ${pwd} 前缀(即 ${pwd}/foo.proto)。这是 protoc 的方式。

重要的是,我希望你的原型编译成一个以 protos 结尾的包,所以我也需要在工作文件夹中反映这一点

为了确保 protoc 知道我的工作目录(包含 go.mod)是我的 go 模块根目录,您可以使用 --go_opt=module=${module} 正确放置文件。

我已将您的部分原型命名为 foo.proto

grpc-gateway 存储库不仅包含 protos (./protoc-gen-openapiv2/options/*.proto),还包含 protoc 生成的 golang 源 (./protoc-gen-openapiv2/options) /*.pb.go).这是存储库维护者做出的一个(有用的)选择(我认为是很好的做法),这意味着您不需要自己生成这些源。

事实上,你的协议生成的 foo.pb.go 应该包含对这些源的正确引用,你只需要 go mod tidygo get 它们。这是我生成的 foo.pb.go 的开头:

foo.pb.go

// code generated by protoc-gen-go. do not edit.
// versions:
//  protoc-gen-go v1.28.1
//  protoc        v3.21.12
// source: foo.proto

package protos

import (
    _ "github.com/grpc-ecosystem/grpc-gateway/v2/protoc-gen-openapiv2/options"
    protoreflect "google.golang.org/protobuf/reflect/protoreflect"
    protoimpl "google.golang.org/protobuf/runtime/protoimpl"
    reflect "reflect"
    sync "sync"
)

运行 tree:

tree
.
├── foo.proto
├── go.mod
├── grpc-gateway
│   ├── protoc-gen-openapiv2
│   │   └── options
│   │       ├── annotations.pb.go
│   │       ├── annotations.proto
│   │       ├── annotations.swagger.json
│   │       ├── BUILD.bazel
│   │       ├── openapiv2.pb.go
│   │       ├── openapiv2.proto
│   │       └── openapiv2.swagger.json
├── protoc-21.12-linux-x86_64
│   ├── bin
│   │   └── protoc
│   ├── include
│   │   └── google
│   │       └── protobuf
│   │           ├── any.proto
│   │           ├── api.proto
│   │           ├── compiler
│   │           │   └── plugin.proto
│   │           ├── descriptor.proto
│   │           ├── duration.proto
│   │           ├── empty.proto
│   │           ├── field_mask.proto
│   │           ├── source_context.proto
│   │           ├── struct.proto
│   │           ├── timestamp.proto
│   │           ├── type.proto
│   │           └── wrappers.proto
│   └── readme.txt
└── protos
    └── protos
        └── foo.pb.go