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

详解 Go 语言中 grpc-gateway 如何实现 RESTful 与 gRPC 协议转换

风芳大大_5925

风芳大大_5925

发布时间:2026-05-12 19:32:16

|

604人浏览过

|

来源于php中文网

原创

grpc-gateway 是基于 Go HTTP handler 的反向代理,不自动转换协议:它解析 HTTP/JSON 为 protobuf,用本地 gRPC client 转发请求,再将响应编码为 JSON;所有路由和行为依赖 protoc 插件生成的 service.pb.gw.go 及手动调用 RegisterXXXHandlerFromEndpoint。

grpc-gateway 不是“自动转换协议”,而是用 go http handler 做反向代理:它把 incoming http/json 请求解析成 protobuf 消息,再用本地 grpc client 转发给 grpc server,最后把 response 编码回 json —— 整个过程不改 grpc 协议,也不共享连接或序列化逻辑。

proto 中的 google.api.http 注解只是声明,不触发任何运行时行为

你写 get: "/v1/users/{id}" 或 post: "/v1/users" body: "*",这些不会让代码“自动注册路由”或“生成 handler”。它们只被 protoc 插件读取,用于生成 service.pb.gw.go 里的 HTTP 路由绑定逻辑。

  • 必须显式 import "google/api/annotations.proto" 和 import "google/api/http.proto",否则 protoc 报错或忽略注解
  • body: "*" 表示整个 JSON body 映射到 message;若只映射部分字段(如 body: "user.name"),gateway 会按路径提取并填充,但字段不存在时静默丢弃,不报错
  • 路径参数(如 {id})和 query 参数(如 ?page=1)都需在 proto message 中定义对应字段,否则 gateway 不解析、不传入

RegisterXXXHandlerFromEndpoint 必须手动调用,且不能塞进 Gin/Echo 的路由树

生成的 service.pb.gw.go 里有类似 RegisterGreeterHandlerFromEndpoint 的函数,它负责把 gRPC service 方法注册到 runtime.ServeMux。这个 mux 是独立的 HTTP handler,不是中间件。

  • 不能写成 r.POST("/xxx", mux.ServeHTTP) —— 这会让 Gin 丢失 method/path 匹配,所有请求都 fallback 到 404
  • 必须用 http.ListenAndServe(":8080", mux) 直接启动,或用自定义 http.Server{Handler: mux}
  • ctx 参数不能是已 cancel 的 context(比如从 context.WithTimeout 创建后超时了),否则注册失败且无提示
  • endpoint 必须指向正在运行的 gRPC server 地址(如 "localhost:9090"),不能是域名未解析、端口未监听或防火墙拦截的地址

gRPC server 与 gateway 共享端口需靠 http.Server.Handler 分流,而非复用 listener

想让 8080 端口同时响应 REST 和 gRPC 请求,不能起两个 ListenAndServe,也不能让 gRPC server 直接 Serve(lis) —— 否则会抢 socket、断连、503 随机出现。

IBKR Investing with Permission Gate
IBKR Investing with Permission Gate

通过IB网关在Interactive Brokers上投资股票/ETF,使用与okx交易相同的人机确认环节,适用于用户请求检查时

下载
  • 正确做法:用 golang.org/x/net/http2 + h2c.NewHandler 包裹 gRPC server,作为 fallback handler;主 http.ServeMux 处理 REST,未匹配路径才交给 gRPC
  • TLS 下注意:HTTP/2 over TLS 要求 ALPN 协商,而 gateway 默认走 HTTP/1.1;若客户端不支持 HTTP/2,gRPC 流量可能被拒绝,但 REST 不受影响
  • 别用 grpc.NewServer().Serve(lis) 单独监听 —— 它会独占 listener,导致 gateway 无法 accept 连接

protojson 编解码行为与原生 gRPC 不一致,空值、时间、枚举处理要提前对齐

gateway 默认用 google.golang.org/protobuf/encoding/protojson(非已弃用的 jsonpb),但它和 gRPC server 内部使用的二进制编码逻辑不同:字段名默认小驼峰、nil slice/map 输出为 null 而非 []、time.Time 序列化为 RFC3339 字符串而非纳秒整数。

  • 若 gRPC server 返回 repeated string tags = 1; 为空,gateway 默认输出 "tags": null;加 UseEnumNumbers: true 或 EmitUnpopulated: true 可调整
  • 自定义 protojson.MarshalOptions 并传给 runtime.WithMarshalerOption,否则无法控制空值、时间格式等细节
  • 错误返回:gateway 把 gRPC status.Code 映射为 HTTP 状态码(如 NotFound → 404),但 status.Details() 默认不透出,需显式启用 runtime.WithForwardResponseOption

最常被跳过的点是:以为 google.api.http 写完就万事大吉,结果跑起来全是 404;或者把 gateway mux 当成普通 handler 塞进框架路由,结果 path 匹配失效。真正起作用的永远是那几行手写的 RegisterXXXHandlerFromEndpoint 和 http.ListenAndServe —— 其他都是生成代码和配置。

热门AI工具

更多
Atoms
Atoms Hot

Atoms是一款AI智能体工具,第一支自动构建真实业务的 AI 团队。

火山引擎

火山引擎是一款面向企业的云计算与AI服务平台。

WorkBuddy

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

PixPix
PixPix Hot

PixPix是一款面向电商视觉生产的AI商品图生成工具。

立刻MV
立刻MV Hot

立刻MV是一款AI文本写作工具,AI 音乐视频(MV)创作工具。

PixTV
PixTV Hot

PixTV是一款面向AIGC内容创作的AI视频生成工具。

DeepSeek

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

Flowith
Flowith Hot

Flowith是一款基于画布和智能体工作流的 AI 协作工作空间。

豆包大模型

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

相关专题

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

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

3749

2023.06.20

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

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

2468

2023.07.25

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

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

1420

2023.08.02

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

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

1358

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

1436

2023.09.05

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

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

2398

2023.09.20

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

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

4000

2023.09.20

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

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

19075

2023.09.22

Postman身份认证怎么配置
Postman身份认证怎么配置

本专题从实际API接口调试场景出发,讲解Postman身份认证的完整配置流程,包括常见认证协议介绍、授权参数设置、访问令牌填写、OAuth 2.0授权及认证失败排查,帮助用户正确完成接口授权与访问验证。

0

2026.11.06

热门下载

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

精品课程

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

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