golang gRPC：根据.protobuf文件生成go代码

文章目录

golang gRPC：根据.protobuf文件生成go代码

根据.protobuf文件生成go代码

安装

protoc

编译器。如果没有安装，可以参考官方文档进行安装。

go install google.golang.org/protobuf/cmd/[email protected]
go install google.golang.org/grpc/cmd/[email protected]

使用 protoc 命令生成 gRPC 代码：

protoc --go_out=. --go-grpc_out=. your_proto_file.proto

此命令将生成 .pb.go 和 _grpc.pb.go 文件，其中包含 protobuf 和 gRPC 的代码实现.

• –go_out选项会生成纯粹的Protocol Buffer消息代码，这包括Go语言的消息结构体和一些辅助方法。如果你只需要使用Protocol Buffer消息，而不需要gRPC的功能，那么使用–go_out就足够了。
• 使用–go-grpc_out选项可以生成完整的gRPC服务端和客户端代码，包括Stub代码、服务接口的实现等。

在网上，你还能看到，如下写法：

$ protoc --go_out=plugins=grpc:. *.proto

–go_out=plugins=grpc和–go-grpc_out选项的效果是类似的，都可以生成gRPC相关的代码。但是它们之间还是有一些不同的。

在最新版本的Protocol Buffer编译器中，–go-grpc_out选项已经取代了–go_out=plugins=grpc选项，并且成为了生成gRPC服务端和客户端代码的推荐选项。

根据proto生成go放在什么位置是最佳实践

根据最佳实践，一般情况下，Proto文件应该放在单独的目录中。同时，生成的Go代码应该放在一个单独的目录中，这个目录与Proto文件所在的目录可以是同级目录或不同级目录。

具体来说，你可以将Protobuf文件放置在一个名为

proto/

的目录下，然后再创建一个名为

generated/

的目录来存放由 Protobuf 生成的 Go 代码。例如：

project/
├── proto/
│   └── example.proto
└── generated/
    └── example.pb.go

这样做有以下几个好处：

1. 可以更好地组织项目结构，使得每个组件、模块都有自己的独立位置。
2. 可以方便地对生成的代码进行管理和维护。
3. 可以避免在 Git 等版本控制系统中出现冲突和混乱。

ProtoBuf 生成 Go 代码去掉 JSON tag omitempty

PB 默认生成 的 Go struct 会带上 JSON tag omitempty，有时我们希望缺省值为零值的字段也能够出现在 JSON 串，我们需要将 struct 中的 JSON tag omitempty 去掉，那么该如何将其去掉呢？

本节直接参考原文链接：https://blog.csdn.net/K346K346/article/details/125077738

工作常见报错总结

报错：–go_out: protoc-gen-go: plugins are not supported; use ‘protoc --go-grpc_out=…’ to generate gRPC

这个错误通常是由于缺少gRPC插件造成的。在使用 --go_out 标志时，它只会生成普通的 protocol buffer 代码，而不是 gRPC 代码。要生成 gRPC 代码，您需要同时使用 --go-grpc_out 标志，并确保已安装正确的 gRPC Go 插件。

请按照以下步骤解决此问题：

确认您已正确安装了 gRPC Go 插件。

要安装 gRPC Go 插件，请执行以下命令：

go install google.golang.org/grpc/cmd/[email protected]

使用 --go-grpc_out 标志（而不是 --go_out 标志）来生成代码。

protoc --proto_path=. --go_out=. --go-grpc_out=. path/to/your/proto/file.proto

您还可以将 --go_out 标志用作较早版本的 fallback 选项，以防某些情况下存在插件无法正常工作的问题。

protoc --proto_path=. --go_out=. --go-grpc_out=. --go_opt=paths=source_relative path/to/your/proto/file.proto

如果您仍然遇到问题，请尝试更新 gRPC Go 并重新安装插件。

报错：undefined: grpc.SupportPackageIsVersion7

问题描述：
运行报错：undefined: grpc.SupportPackageIsVersion7

问题分析：
在gRPC 1.36 版本中，grpc.SupportPackageIsVersion7已被弃用。这个常量最初是为了支持旧版本的Go语言而添加的，现在已经废弃掉了。

解决方法：
如果您遇到了undefined: grpc.SupportPackageIsVersion7错误，请考虑升级您的代码以使用新的gRPC API。一般来说，不建议在新的gRPC应用程序中使用这个常量。

rpc.SupportPackageIsVersion7常量是由gRPC Go生成的客户端代码使用的。

从gRPC Go 1.36开始，这个常量已经被弃用，应该使用新的API来代替它。为了解决这个问题，请执行以下步骤：

确认您正在使用最新版本的gRPC Go。可以使用以下命令升级到最新版本：go get -u google.golang.org/grpc

检查gRPC Go和protoc-gen-go版本是否一致，查看go.mod中的版本信息。