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

Go微服务利用gRPC-Gateway一键生成HTTP接口转换

冬杰姑娘_9763

冬杰姑娘_9763

发布时间:2026-05-26 18:24:20

|

485人浏览过

|

来源于php中文网

原创

gRPC-Gateway不是一键黑盒工具,而是需分两步protoc生成(先gRPC stub后gateway handler)、显式指定third_party/googleapis路径、严格书写google.api.http注解、并在ListenAndServe前调用RegisterXXXHandlerFromEndpoint的手动配置反向代理生成器。

grpc-gateway 不是“一键生成 http”的黑盒工具,它本质是一个需显式配置、分步编译、手动挂载的反向代理生成器——漏掉 protoc 命令顺序、google/api/annotations.proto 路径或 registerxxxhandlerfromendpoint 调用,http 接口就根本不会响应。

protoc 必须分两次执行,不能合并生成

很多人试图用一条 protoc 命令同时生成 gRPC stub 和 gateway 代码,结果 .pb.gw.go 文件为空,或报错 google/api/annotations.proto: File not found。这是因为:

  • --go_out 和 --go-grpc_out 插件负责生成 .pb.go 和 _grpc.pb.go,它们依赖 protobuf 结构定义,但不处理 HTTP 注解
  • --grpc-gateway_out 插件只读取已存在的 .proto 和注解,生成路由逻辑,它不参与 message/service 的 Go 类型生成
  • 若先跑 gateway 命令,它找不到 .pb.go 中的 service 接口定义,无法生成 handler 函数体

正确顺序:

protoc -I . -I $GOPATH/pkg/mod/github.com/grpc-ecosystem/grpc-gateway@v2.15.2/third_party/googleapis/ \
  --go_out=. --go-grpc_out=. \
  your_service.proto

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

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

这个注解不是装饰,是 gateway 解析路由的唯一依据。大小写、引号、字段名、路径格式必须与 proto message 定义完全一致:

  • post:"/v1/users" + body: "*":整个请求体 JSON 映射到入参 message;漏掉 body: "*" → 400 Bad Request
  • get:"/v1/users/{id}":要求 message 中存在 string id = 1;;若字段是 user_id 却写成 {id} → 404(gateway 找不到绑定字段)
  • get:"/v1/users?status={status}":status 必须是一级字段,filter.status 这类嵌套结构不会被展开
  • 避免换行缩进写法:option (google.api.http) = { post: "/v1/foo" }; 是安全的;option (google.api.http) = { post: "/v1/foo" }; 在旧版 protoc 下可能静默失效

RegisterXXXHandlerFromEndpoint 必须在 http.ListenAndServe 前调用

生成的 .pb.gw.go 文件里只有一堆未注册的 handler 函数,比如 RegisterUserServiceHandlerFromEndpoint。它不会自动挂载到 http.ServeMux,必须手动触发:

  • 如果先 http.ListenAndServe,再调用注册函数 → 请求进来时 mux 还是空的,所有路径 404
  • 必须确保 RegisterXXXHandlerFromEndpoint 的 endpoint 参数指向正在运行的 gRPC server 地址(如 "localhost:9090"),否则启动时报错或后续调用超时
  • 若用 runtime.NewServeMux() 自定义 mux,注册时要传入该实例,而非默认全局 mux

典型启动顺序:

GateCrash Forms
GateCrash Forms

以 CLI 为先的表单构建器,采用 BYOK 理念。通过JSON Schema 生成美观的 HTML 表单,使用您自己的 SMTP 服务器处理提交,存储响应...

下载
ctx := context.Background()
mux := runtime.NewServeMux()
err := RegisterUserServiceHandlerFromEndpoint(ctx, mux, "localhost:9090", nil)
if err != nil {
    log.Fatal(err)
}
http.ListenAndServe(":8080", mux)

third_party/googleapis 路径必须显式指定

google/api/annotations.proto 不是标准 protobuf 内置,它来自 grpc-gateway 仓库的 third_party/googleapis 目录。不加 -I 引入该路径,protoc 就解析不了 option (google.api.http) —— 不报错,但生成的 .pb.gw.go 里没有路由逻辑,handler 函数体为空。

常见错误写法:protoc -I . --grpc-gateway_out=. your_service.proto(缺 googleapis 路径)

正确写法(注意版本号需匹配你 go.mod 中的 grpc-gateway 版本):

-I $GOPATH/pkg/mod/github.com/grpc-ecosystem/grpc-gateway@v2.15.2/third_party/googleapis/

用 buf 的话,也要在 buf.gen.yaml 中分开声明 plugin: grpc 和 plugin: grpc-gateway,不能塞进同一个插件块。

最易被忽略的点:gateway 启动后,它只是个反向代理,不处理任何业务逻辑;gRPC server 必须已就绪并监听,且 endpoint 地址可连通——否则看似启动成功,实际所有 HTTP 请求都会因 gRPC dial timeout 而失败,错误日志可能只显示 “context deadline exceeded”,容易误判为网关配置问题。

热门AI工具

更多
DeepSeek

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

WorkBuddy

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

咔片AIPPT

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

音述AI
音述AI Hot

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

Loomy
Loomy Hot

一款AI工具,主要用于科大讯飞发布的桌面级 AI 助理,比 OpenClaw 更易用、更安全!,适合需要提升相关任务效率的用户。

豆包大模型

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

蛙蛙写作

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

Lovart
Lovart Hot

一款面向视觉设计创作的AI设计平台,可通过智能体和画布工作流辅助制作海报、Logo、网页、PPT及其他视觉内容。

SkildArt
SkildArt Hot

SkildArt是一款AI文本写作工具,一站式 AI 视觉创作平台。

相关专题

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

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

3589

2023.06.20

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

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

2428

2023.07.25

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

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

1360

2023.08.02

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

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

1318

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,随机排序。

1416

2023.09.05

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

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

2338

2023.09.20

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

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

3840

2023.09.20

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

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

18075

2023.09.22

Vite 项目如何打包和部署
Vite 项目如何打包和部署

Vite项目打包部署专题汇集生产构建、产物预览、输出目录、资源路径、Nginx与GitHub Pages部署及常见白屏和路由404问题的已审核文章,帮助读者完成上线流程。

100

2026.10.28

热门下载

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

精品课程

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

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