gRPC 的 Protobuf 文件在 Go 中如何自动生成?

阿宇同学_9660

阿宇同学_9660

2026-04-28

663人浏览

原创

protoc-gen-go和protoc-gen-go-grpc必须匹配安装最新版(v1.30+),配合--go_out和--go-grpc_out分参数调用,并设置paths=source_relative及正确go_package路径,否则编译报错或导入失败。

grpc 的 protobuf 文件在 go 中如何自动生成?

直接用 protoc 命令加两个插件输出即可,不需要手写任何结构体或接口。关键不是“能不能生成”,而是插件版本、参数顺序和 go_package 路径是否对得上——错一个就编译报错或包导入失败。

protoc-gen-go 和 protoc-gen-go-grpc 必须都装对版本

这两个插件不能混用旧版和新版,尤其不能用 v1.26 之前的 protoc-gen-go 配合新版 protoc-gen-go-grpc。当前(2026 年)稳定组合是:

  • go install google.golang.org/protobuf/cmd/protoc-gen-go@latest
  • go install google.golang.org/grpc/cmd/protoc-gen-go-grpc@latest

装完检查是否在 $PATH 里:protoc-gen-go --version 和 protoc-gen-go-grpc --version 都应返回带 v1.30+ 的版本号。如果提示 command not found,说明 GOBIN 没进环境变量,或者 go install 没成功。

--go_out 和 --go-grpc_out 参数必须分开且顺序不能颠倒

老教程里常见的 --go_out=plugins=grpc:. 已被彻底废弃,继续用会报错:--go_out: protoc-gen-go: plugins are not supported。正确命令是:

protoc --go_out=. --go_opt=paths=source_relative \
  --go-grpc_out=. --go-grpc_opt=paths=source_relative \
  api/greet.proto

注意点:

使用Go语言搭建家庭相册系统-相关课件
使用Go语言搭建家庭相册系统-相关课件

使用Go语言搭建家庭相册系统-相关课件

下载
  • --go_out=. 只生成 .pb.go(消息结构体),不带 gRPC 逻辑
  • --go-grpc_out=. 单独生成 _grpc.pb.go(服务接口、客户端存根、服务注册函数)
  • --go_opt=paths=source_relative 确保生成的 package 和 import 路径与 proto 文件所在目录结构一致,否则 go build 找不到包

proto 文件里的 option go_package 必须写绝对导入路径

这一步最容易被跳过,但直接影响生成代码能否被正常 import。不能只写 option go_package = "greet";,而要写成:

option go_package = "./greet;greet";

含义是:生成的 Go 文件放在当前目录下的 greet 子目录中,包名为 greet。如果你的 proto 在 proto/greet/v1/greet.proto,那应该写:

option go_package = "proto/greet/v1;greetv1";

否则生成的 .pb.go 里会默认用 package greet,但文件实际在 ./proto/greet/v1/ 下,go mod tidy 时就会报 cannot find package。

生成的代码别直接提交到 git,但必须进 go.mod 依赖

生成的 *.pb.go 和 *_grpc.pb.go 是机器产物,不该手动修改,也不该长期留在 git 历史里——但它们又必须能被 go build 正确识别。推荐做法:

  • 把 proto 放在 proto/ 目录下,生成代码统一放 internal/pb/ 或 api/
  • 在 go.mod 里确保已包含 google.golang.org/protobuf 和 google.golang.org/grpc
  • CI 流程里加一步 protoc 生成,本地开发用 Makefile 或脚本封装,避免每次手敲命令

最常被忽略的是:生成后不运行 go mod tidy,导致 grpc.ServiceRegistrar 或 proto.Message 类型未解析——这不是 protoc 的问题,是 Go 模块没拉齐依赖。

相关文章

PHP速学视频免费教程(入门到精通)
PHP速学视频免费教程(入门到精通)

PHP怎么学习?PHP怎么入门?PHP在哪学?PHP怎么学才快?不用担心,这里为大家提供了PHP速学教程(入门到精通),有需要的小伙伴保存下载就能学习啦!

下载

相关标签:

本站声明:本文内容由网友自发贡献,版权归原作者所有,本站不承担相应法律责任。如您发现有涉嫌抄袭侵权的内容,请联系admin@php.cn

相关专题

更多
C语言变量命名
C语言变量命名

c语言变量名规则是:1、变量名以英文字母开头;2、变量名中的字母是区分大小写的;3、变量名不能是关键字;4、变量名中不能包含空格、标点符号和类型说明符。php中文网还提供c语言变量的相关下载、相关课程等内容,供大家免费下载使用。

2023.06.20

3349

3

c语言入门自学零基础
c语言入门自学零基础

C语言是当代人学习及生活中的必备基础知识,应用十分广泛,本专题为大家c语言入门自学零基础的相关文章,以及相关课程,感兴趣的朋友千万不要错过了。

2023.07.25

2368

9

c语言运算符的优先级顺序
c语言运算符的优先级顺序

c语言运算符的优先级顺序是括号运算符 > 一元运算符 > 算术运算符 > 移位运算符 > 关系运算符 > 位运算符 > 逻辑运算符 > 赋值运算符 > 逗号运算符。本专题为大家提供c语言运算符相关的各种文章、以及下载和课程。

2023.08.02

1300

5

c语言数据结构
c语言数据结构

数据结构是指将数据按照一定的方式组织和存储的方法。它是计算机科学中的重要概念,用来描述和解决实际问题中的数据组织和处理问题。数据结构可以分为线性结构和非线性结构。线性结构包括数组、链表、堆栈和队列等,而非线性结构包括树和图等。php中文网给大家带来了相关的教程以及文章,欢迎大家前来学习阅读。

2023.08.09

1258

4

c语言random函数用法
c语言random函数用法

c语言random函数用法:1、random.random,随机生成(0,1)之间的浮点数;2、random.randint,随机生成在范围之内的整数,两个参数分别表示上限和下限;3、random.randrange,在指定范围内,按指定基数递增的集合中获得一个随机数;4、random.choice,从序列中随机抽选一个数;5、random.shuffle,随机排序。

2023.09.05

1376

5

c语言const用法
c语言const用法

const是关键字,可以用于声明常量、函数参数中的const修饰符、const修饰函数返回值、const修饰指针。详细介绍:1、声明常量,const关键字可用于声明常量,常量的值在程序运行期间不可修改,常量可以是基本数据类型,如整数、浮点数、字符等,也可是自定义的数据类型;2、函数参数中的const修饰符,const关键字可用于函数的参数中,表示该参数在函数内部不可修改等等。

2023.09.20

2258

7

c语言get函数的用法
c语言get函数的用法

get函数是一个用于从输入流中获取字符的函数。可以从键盘、文件或其他输入设备中读取字符,并将其存储在指定的变量中。本文介绍了get函数的用法以及一些相关的注意事项。希望这篇文章能够帮助你更好地理解和使用get函数 。

2023.09.20

3640

8

c数组初始化的方法
c数组初始化的方法

c语言数组初始化的方法有直接赋值法、不完全初始化法、省略数组长度法和二维数组初始化法。详细介绍:1、直接赋值法,这种方法可以直接将数组的值进行初始化;2、不完全初始化法,。这种方法可以在一定程度上节省内存空间;3、省略数组长度法,这种方法可以让编译器自动计算数组的长度;4、二维数组初始化法等等。

2023.09.22

16815

6

c语言中null和NULL的区别
c语言中null和NULL的区别

c语言中null和NULL的区别是:null是C语言中的一个宏定义,通常用来表示一个空指针,可以用于初始化指针变量,或者在条件语句中判断指针是否为空;NULL是C语言中的一个预定义常量,通常用来表示一个空值,用于表示一个空的指针、空的指针数组或者空的结构体指针。

2023.09.22

549

3

热门下载

更多
网站特效
/
网站源码
/
网站素材
/
前端模板

精品课程

更多
相关推荐
/
热门推荐
/
最新课程