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

Golang怎么实现gRPC Gateway_Golang如何用grpc-gateway同时提供HTTP和gRPC接口【教程】

浅辰姑娘_8779

浅辰姑娘_8779

发布时间:2026-03-19 19:33:11

|

254人浏览过

|

来源于php中文网

原创

gRPC Gateway 是一个独立的 HTTP 服务器,将 JSON/HTTP 请求(如 POST /v1/user)反向代理到本地 gRPC 服务(如 User.Get),不替代也不处理 gRPC 流量;需先启动 gRPC server 并正确配置 endpoint,再通过 protoc + grpc-gateway 插件生成 handler,注册时注意路径分离、CORS 和 JSON 字段映射规则。

golang怎么实现grpc gateway_golang如何用grpc-gateway同时提供http和grpc接口【教程】

gRPC Gateway 是什么,它不替代 gRPC 服务

它不是“让 gRPC 接口自动变 HTTP”,而是另起一个 HTTP 服务器,把 POST /v1/user 这类请求反向代理到本地的 gRPC 服务(比如 User.Get)。gRPC 服务必须独立运行,grpc-gateway 只负责翻译和转发。

常见错误现象:rpc error: code = Unavailable desc = connection refused —— 八成是没先跑起 gRPC server,或者 grpc-gateway 指向了错的地址(比如用 localhost:8080 但 gRPC server 绑在 127.0.0.1:9090,Docker 环境里还可能跨 host)。

  • 必须先启动 gRPC server,监听一个明确地址(推荐 127.0.0.1:9090,避免 IPv6 或 localhost 解析歧义)
  • grpc-gateway 启动时通过 grpc.Dial 连这个地址,不是连自己
  • 生成的 HTTP handler 不处理 gRPC 流量,也不暴露 .proto 文件 —— 它只响应 JSON/HTTP,不响应 application/grpc

怎么生成 gateway stub:protoc + grpc-gateway 插件

核心命令是 protoc,不是写代码。你改了 .proto,就必须重跑这步,否则 HTTP 路由、参数绑定、JSON 字段名全都不对。

典型错误:漏装插件、路径没加进 PATH、或用了旧版 grpc-gateway(v2 要求 google/api/annotations.proto 必须带 http 规则,且 protoc-gen-openapiv2 已废弃)。

立即学习“go语言免费学习笔记(深入)”;

Golang Uber Dig
Golang Uber Dig

使用 uber-go/dig 在 Golang 中实现依赖注入——基于反射容器,提供 Provide/Invoke、dig.In/dig.Out 参数与结果对象,支持命名依赖等

下载
  • 安装插件:go install github.com/grpc-ecosystem/grpc-gateway/v2/protoc-gen-grpc-gateway@latest
  • proto 文件里必须有 import "google/api/annotations.proto"; 和 option (google.api.http) = { get: "/v1/users/{id}" };
  • 生成命令示例:protoc -I . -I $GOPATH/src/github.com/grpc-ecosystem/grpc-gateway/v2/third_party/googleapis --grpc-gateway_out=logtostderr=true:. user.proto
  • 生成的 user.pb.gw.go 里是 HTTP handler,不是 client —— 别把它当 gRPC client 用

怎么注册 gateway handler 到 HTTP server

别直接用 http.ListenAndServe,gateway handler 需要和 gRPC server 共享 context 生命周期,并支持 CORS、gzip、超时等中间件。标准做法是用 gorilla/mux 或原生 http.ServeMux 注册,再套一层 http.Handler 包装。

容易踩的坑:runtime.NewServeMux() 默认不处理 OPTIONS 预检,前端发 CORS 请求直接 404;还有人把 gateway handler 和 gRPC server 注册到同一个端口但没做路径区分,结果 /healthz 走了 gateway、/grpc.health.v1.Health/Check 却 404。

  • gateway handler 只挂载在 HTTP 路径上(如 /v1/*),gRPC server 单独监听另一个端口(如 :9090)
  • 加 CORS 中间件:cors.New(cors.Options{AllowedOrigins: []string{"*"}}).Handler(mux)
  • 注册前务必调用 gw.RegisterXXXHandlerFromEndpoint,传入的是 gRPC server 的 endpoint 地址,不是 gateway 自己的地址
  • 如果要用 HTTPS,证书和 TLS 配置加在 HTTP server 层,gateway 层不感知

为什么 JSON 响应字段名不对,或嵌套结构崩了

因为 grpc-gateway 默认按 proto 字段的 json_name 选项或小驼峰规则转 JSON key,不是照抄 Go struct tag。如果你在 .proto 里写了 string user_name = 1;,默认 JSON 就是 user_name,不是 userName,除非你显式加 json_name: "user_name"。

更隐蔽的问题:proto message 里嵌套了另一个 message,但没在 http rule 里设 body: "*",结果 gateway 把整个 body 当成单个字段解析,报 cannot bind field "xxx" to body。

  • 统一控制 JSON 字段名:在 .proto 字段加 json_name,例如 string full_name = 1 [json_name = "fullName"];
  • POST/PUT 请求想接收完整 body,必须在 http rule 里写明 body: "*",否则 gateway 只从 query/path 提取字段
  • enum 值默认序列化为数字,要字符串需加 (google.api.field_behavior) = OUTPUT_ONLY 并配 runtime.WithMarshalerOption
  • 空值处理依赖 runtime.WithForwardResponseOption,否则 nil 字段可能被忽略或填默认值

最常被忽略的一点:gateway 的 JSON 解析和 gRPC 的二进制 wire format 是两套逻辑,哪怕字段名一致,类型不匹配(比如 proto 里是 int32,HTTP body 传了字符串 "123")也会静默失败或返回 400,调试时得看 gateway 日志里的 binding error,不是看 gRPC server 日志。

热门AI工具

更多
AionClaw
AionClaw Hot

AionClaw是一款面向办公、创作和编程任务的AI桌面智能体。

墨刀AI
墨刀AI Hot

一款AI图像与设计工具,主要用于产品经理的专属智能体,适合需要提升相关任务效率的用户。

Laper
Laper Hot

Laper是专为编剧、导演和制片人推出的 AI 原生剧本创作工具。

蛙蛙写作

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

火山引擎

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

豆包大模型

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

DeepSeek

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

WorkBuddy

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

PixPix
PixPix Hot

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

相关专题

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

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

3389

2023.06.20

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

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

2388

2023.07.25

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

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

1320

2023.08.02

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

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

1258

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

1396

2023.09.05

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

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

2258

2023.09.20

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

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

3680

2023.09.20

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

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

17075

2023.09.22

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

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

40

2026.10.22

热门下载

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

精品课程

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

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