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

冬浩大大_2352

冬浩大大_2352

2026-05-31

767人浏览

原创

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

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

不能“一键”,但三步走对、两处不漏,HTTP 接口就能跑起来。

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

很多人想用一条 protoc 命令同时生成 .pb.go_grpc.pb.go.pb.gw.go,结果要么报错 google/api/annotations.proto: File not found,要么生成的 .pb.gw.go 是空文件。

根本原因在于:插件职责不同——--go_out--go-grpc_out 负责生成数据结构和 gRPC 接口;--grpc-gateway_out 只负责读取已有定义,生成反向代理逻辑,它不参与 protobuf 解析。

Unified LLM Gateway - One API for 70+ AI models. Route to GPT, Claude, Gemini, Qwen, Deepseek, Grok and more
Unified LLM Gateway - One API for 70+ AI models. Route to GPT, Claude, Gemini, Qwen, Deepseek, Grok and more

统一LLM网关 - 一个API对接70+AI模型,使用单一API密钥即可调用GPT、Claude、Gemini、Qwen、Deepseek、Grok等主流模型。

下载
  • 先运行 gRPC 生成命令(确保 .pb.go_grpc.pb.go 存在):
    protoc -I . -I $GOPATH/pkg/mod/github.com/grpc-ecosystem/grpc-gateway@v2.15.2/third_party/googleapis/ --go_out=. --go-grpc_out=. sum.proto
  • 再单独运行 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 sum.proto
  • 如果用 bufbuf.gen.yaml 中必须把 plugin: grpcplugin: grpc-gateway 分开配置,不能塞进同一个 plugins 块里

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

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

  • 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 的一级字段,嵌套结构(如 UserFilter.status)不支持自动展开
  • 避免换行缩进写法:option (google.api.http) = { post: "/v1/foo" }; 这种格式在某些旧版 protoc 下会被静默忽略

RegisterXXXHandlerFromEndpoint 必须在 ListenAndServe 前调用

生成的 .pb.gw.go 文件里会提供类似 RegisterSumHandlerFromEndpoint 的函数,它负责把反向代理 handler 挂载到 http.ServeMux 上。这个注册动作必须发生在 http.ListenAndServehttp.Server.Serve 之前,否则请求进来时 mux 还是空的。

  • 常见错误写法:先 http.ListenAndServe(":8080", mux),再调用 RegisterSumHandlerFromEndpoint
  • 正确顺序:
    ① 创建 http.ServeMux
    ② 调用 RegisterSumHandlerFromEndpoint(mux, ...)
    ③ 启动 http.Server 并传入该 mux
  • 注意 endpoint 参数要指向正在运行的 gRPC 服务地址(如 "localhost:8080"),不是 ":8080" —— 后者是监听地址,不是可连接的 endpoint

最容易被忽略的是 third_party/googleapis 路径的显式指定,以及 body: "*" 这类绑定规则和 message 字段的严格一致性——它们不出现在编译错误里,只在运行时用 400/404 静静惩罚你。

相关文章

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

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

下载

相关标签:

gate 微服务

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

相关专题

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

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

2023.06.20

2529

3

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

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

2023.07.25

2068

9

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

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

2023.08.02

1060

5

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

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

2023.08.09

978

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

1236

5

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

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

2023.09.20

1878

7

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

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

2023.09.20

2820

8

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

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

2023.09.22

12075

6

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

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

2023.09.22

509

3

热门下载

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

精品课程

更多
相关推荐
/
热门推荐
/
最新课程
Hyperf官方中文手册(3.1)
Hyperf官方中文手册(3.1)

共0课时 | 0人学习

高级PHP之Swoft入门到微服务
高级PHP之Swoft入门到微服务

共56课时 | 6万人学习

webman初步使用及后台搭建
webman初步使用及后台搭建

共15课时 | 2.6万人学习