讲师中心 微信公众号
AI工具推荐 视频效率加速

Go微服务利用gRPC-Gateway一键生成HTTP

雨强吖_8812

雨强吖_8812

发布时间:2026-05-20 23:33:26

|

1052人浏览过

|

来源于php中文网

原创

gRPC-Gateway需三步:先用protoc生成gRPC stub(--go_out和--go-grpc_out),再单独运行gateway命令(显式指定third_party/googleapis路径),最后在ListenAndServe前调用RegisterXXXHandlerFromEndpoint注册handler。

go微服务利用grpc-gateway一键生成http

gRPC-Gateway 不是“一键”工具,但只要三步走对、两处不漏,HTTP 接口就能跑起来——关键在 protoc 命令顺序、注解写法和 handler 注册时机。

protoc 命令必须分两次执行,不能合并

很多人想用一条 protoc 命令同时生成 gRPC stub 和 gateway 代码,结果报错找不到 google/api/annotations.proto 或生成的 .pb.gw.go 文件为空。这是因为:grpc-gateway 插件只负责生成 HTTP 路由逻辑,不参与 protobuf 结构定义;而 go 和 go-grpc 插件才真正生成 message 和 service 接口。

  • 先运行 gRPC 相关生成命令(含 --go_out 和 --go-grpc_out),确保 .pb.go 和 _grpc.pb.go 存在
  • 再单独运行 gateway 命令:protoc -I . -I $GOPATH/pkg/mod/github.com/grpc-ecosystem/grpc-gateway@v2.15.2/third_party/googleapis/ --grpc-gateway_out=. --grpc-gateway_opt logtostderr=true your_service.proto
  • 路径中的 third_party/googleapis 必须显式指定,否则 google.api.http 注解无法解析
  • 如果用 buf,需在 buf.gen.yaml 中分开配置 plugin: grpc 和 plugin: grpc-gateway,不能混在一个插件块里

google.api.http 注解写错一个字符,HTTP 就 404

注解不是装饰,是 gateway 的路由源。它直接决定 HTTP 方法、路径、参数绑定方式,且大小写、引号、字段名都必须严格匹配 Protobuf message 定义。

frigatebird
frigatebird

使用 frigatebird npm 包在命令行与 X 交互,提供类鸟命令对等、发布/回复/文章功能以及列表自动化,且无需 X API 密钥。

下载
  • post:"/v1/users" 表示整个请求体映射到入参 message,此时 body: "*" 是必需的;漏写会返回 400 Bad Request,不是 404
  • get:"/v1/users/{id}" 要求 message 中存在字段 string id = 1;;若字段名是 user_id 却写成 {id},gateway 解析失败,直接 404
  • 路径中带 query 参数(如 get:"/v1/users?status={status}")时,status 字段必须是 message 的一级字段,嵌套结构不支持自动展开
  • 不要用 option (google.api.http) = { post: "/v1/foo" }; 这种换行缩进写法——某些旧版 protoc 会静默忽略整条注解

RegisterXXXHandlerFromEndpoint 必须在 ListenAndServe 前调用

生成的 .pb.gw.go 文件里只有一堆未注册的 handler 函数,不显式挂载,http.ServeMux 根本看不到任何路由。这不是配置问题,是根本没加载。

  • 必须在 http.ListenAndServe 或 http.Serve 之前调用 RegisterYourServiceHandlerFromEndpoint
  • ctx 不能是短生命周期上下文(例如 context.WithTimeout(ctx, 100ms)),注册过程可能耗时几十毫秒,超时会导致静默失败
  • endpoint 必须指向已启动的 gRPC 服务地址,如 "localhost:9090";写成 "127.0.0.1:9090" 在启用了 mTLS 或自定义 DNS 的环境里可能连不上
  • 别把 gateway 的 runtime.NewServeMux() 塞进 Gin/Echo 的某个子路由(比如 r.POST("/api", mux.ServeHTTP)),这会破坏 gateway 内部的 path 解析和 query/body 提取逻辑

HTTP 接口返回空 JSON 或 panic,大概率是响应结构没导出

gateway 将 gRPC response message 序列化为 JSON 时,依赖 Go 的 json 包反射机制。如果 message 字段未导出(小写开头)、或类型不支持 JSON 编码(如 func、chan、未实现 json.Marshaler 的自定义类型),就会返回空对象或 panic。

  • Protobuf 生成的 struct 字段名默认首字母大写,但如果你手动改了 go_tag 注释(如 json:"user_id"),要确认对应字段确实可被 json 包访问
  • 避免在 response message 中嵌入非基本类型:比如 map[string]interface{} 可能导致序列化失败,改用明确字段的 struct 更稳妥
  • 如果用了 google.protobuf.Timestamp,需确保已 import "google.golang.org/protobuf/types/known/timestamppb",且 gateway 版本 ≥ v2.10.0(旧版对 timestamp 处理有 bug)
  • 开启 gateway 日志(--grpc-gateway_opt logtostderr=true)后,panic 会打印在 stderr,但 HTTP 响应仍是 500 空体——这是常见盲区

最常被跳过的其实是 endpoint 连通性验证和 handler 注册顺序。哪怕 proto 写得再标准、protoc 命令跑得再顺,这两点任一缺失,HTTP 接口就只是个摆设。

热门AI工具

更多
DeepSeek

DeepSeek是一款面向对话、写作、编程和推理场景的AI大模型工具。

讯飞智作

讯飞智作是一款AI视频创作工具,AI文本配音工具,数字人课程、营销视频制作。

蛙蛙写作

一款AI论文写作工具,主要用于超级AI智能写作助手,适合需要提升相关任务效率的用户。

豆包大模型

豆包大模型是一款由字节跳动推出的企业级大语言模型服务平台。

VibeKnow
VibeKnow Hot

一款AI视频创作工具,主要用于全球首个AI知识视频创作平台,文档、文章、网页,一键生成视频,适合需要提升相关任务效率的用户。

咔片AIPPT

一款在线AI演示文稿制作工具,可根据主题和内容需求辅助生成PPT结构与页面,提高演示材料制作效率。

WorkBuddy

一款AI办公效率工具,主要用于腾讯云推出的AI原生桌面智能体工作台,适合需要提升相关任务效率的用户。

音述AI
音述AI Hot

一款AI音频处理工具,主要用于音述AI是一个以“用声音述说故事”为核心的 AI 音乐创作与声音分享社区,适合需要提升相关任务效率的用户。

Seko
Seko Hot

一款AI视频创作工具,主要用于商汤科技推出的创编一体的AI短视频创作Agent,适合需要提升相关任务效率的用户。

相关专题

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

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

3329

2023.06.20

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

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

2348

2023.07.25

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

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

1300

2023.08.02

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

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

1238

2023.08.09

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

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

1376

2023.09.05

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

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

2238

2023.09.20

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

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

3620

2023.09.20

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

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

16675

2023.09.22

Gradle插件开发入门教程
Gradle插件开发入门教程

本专题介绍Gradle插件开发的基本流程,涵盖插件类编写、自定义任务注册、扩展参数设计和插件应用方法,帮助你理解插件如何组织构建逻辑,减少多个项目之间的重复配置。

0

2026.10.22

热门下载

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

精品课程

更多
相关推荐
/
热门推荐
/
最新课程
关于我们 免责申明 举报中心 意见反馈 讲师合作 广告合作 最新更新
php中文网:公益在线php培训,帮助PHP学习者快速成长!
关注服务号
PHP中文网订阅号
每天精选资源文章推送

Copyright 2014-2026 https://www.php.cn/ All Rights Reserved | php.cn