Go语言怎么用gRPC Gateway_Go语言gRPC Gateway教程【基础】

老宇吖_3483

老宇吖_3483

2026-03-25

515人浏览

原创

先装 protoc(macos 用 brew install protobuf,ubuntu 用 apt-get install protobuf-compiler),再依次 go install protoc-gen-go、protoc-gen-go-grpc、protoc-gen-grpc-gateway,然后导出 path="$path:$(go env gopath)/bin",并手动下载 google/api/annotations.proto 到 proto/google 目录。

go语言怎么用grpc gateway_go语言grpc gateway教程【基础】

怎么装 protoc 和 gateway 插件才不报错

装错顺序或 PATH 没配对,protoc 一跑就提示 protoc-gen-go-grpc: plugin not found 或 file not found: google/api/annotations.proto——这不是你代码的问题,是环境没搭好。

  • 先装 protoc:macOS 用 brew install protobuf,Ubuntu 用 sudo apt-get install -y protobuf-compiler,别用源码编译,容易漏 protoc-gen-* 依赖
  • 再装 Go 插件(注意版本对齐):
    go install google.golang.org/protobuf/cmd/protoc-gen-go@latest
    go install google.golang.org/grpc/cmd/protoc-gen-go-grpc@latest
    go install github.com/grpc-ecosystem/grpc-gateway/v2/protoc-gen-grpc-gateway@latest
  • 必须加环境变量:export PATH="$PATH:$(go env GOPATH)/bin",否则 protoc 根本找不到插件;验证方式是直接敲 protoc-gen-go-grpc --version
  • google/api/annotations.proto 不是 Go 包,是 proto 文件,得手动下载或用 buf 管理依赖;最省事的是从 GitHub 官方 repo 下载整个 google 目录,放到项目根目录的 proto/google 下,然后 -I proto 引入

proto 里加 HTTP 映射,哪些字段必须写

google.api.http 不是可选装饰,是 gateway 路由的唯一依据。漏掉 body: "*" 或写错 method,会导致请求 404 或 500,且错误日志极不友好。

  • 必须显式声明 HTTP 方法和路径,比如:post: "/v1/hello";get 对应无 body 的查询,post/put 必须配 body: "*"(表示整个 message 当 JSON body 解析)
  • 如果想把某个字段当 URL path 参数,比如 get: "/v1/users/{id}",那 id 字段必须在 request message 里定义,且类型不能是 int32 以外的复杂类型(gateway v2 对嵌套 path 支持弱)
  • 别在 option (google.api.http) 里写 additional_bindings 除非真需要多路由映射同一 rpc;它会让生成的 .gw.pb.go 多出冗余逻辑,还容易和主 binding 冲突
  • message 字段名用 snake_case(如 user_id),gateway 默认按原样转 JSON key;若要前端用 camelCase,得在 struct tag 加 json:"userId",但注意:这仅影响 JSON 序列化,不影响 gateway 路由解析

生成 .gw.pb.go 后,启动网关服务常踩的坑

生成完代码,照着文档写几行 runtime.NewServeMux() 就跑,结果 curl 返回空、503、或 panic 报 failed to dial target——问题几乎都出在 mux 注册和 gRPC 连接上。

Go语言(Golang)1.26.0
Go语言(Golang)1.26.0

Go语言(Golang)1.26.0版本官方下载,版本号 1.26.0,适合旧项目维护、兼容性测试和指定版本开发环境搭建。

下载
  • 网关本质是反向代理,必须连到正在运行的 gRPC server;别用 localhost:9090 硬编码,推荐传参或环境变量,比如 grpcServerAddr := os.Getenv("GRPC_ADDR")
  • runtime.WithInsecure() 只能在开发环境开;生产必须配 runtime.WithTransportCredentials(credentials.NewTLS(...)),否则 gateway 会拒绝连接
  • 注册 handler 顺序很重要:先 gwMux.HandlePath("POST", "/v1/hello", ...),再 http.ListenAndServe(":8080", gwMux);但更稳妥的是用 gwMux := runtime.NewServeMux(runtime.WithErrorHandler(yourErrHandler)),自定义错误才能看到真实失败原因
  • 别忽略 reflection 服务:gRPC server 端要加 reflection.Register(grpcServer),否则某些 gateway 调试工具(如 grpcurl)无法获取 service 描述

HTTP 请求怎么透传 metadata 到 gRPC 后端

前端带了 Authorization: Bearer xxx,后端却收不到——因为 gateway 默认不转发 header,所有 header 都被过滤,只留白名单里的几个(如 Content-Type)。

  • header 名会被自动加前缀 Grpc-Metadata-,比如前端传 X-User-ID: 123,后端收到的是 Grpc-Metadata-X-User-ID;所以后端要用 metadata.Pairs("x-user-id", "123") 才能取到
  • 要在 gateway 初始化时显式放行:用 runtime.WithMetadata(func(ctx context.Context, req *http.Request) metadata.MD { return metadata.Pairs("x-user-id", req.Header.Get("X-User-ID")) })
  • 如果 header 值含空格或特殊字符(如 JWT token),务必做 URL decode;gateway 不自动 decode,直接透传会导致后端解析失败
  • 别在 gateway 层做鉴权逻辑;它只是协议转换层,业务校验一律交给 gRPC service 实现,否则违反分层职责,也难测难 debug

gateway 最容易被忽略的一点:它不处理重试、超时、熔断这些微服务治理能力。这些得靠上层网关(如 Envoy)或 client SDK 自己补。把它当成“协议翻译器”,而不是“智能代理”,心态就稳了。

golang免费学习笔记(深入):立即使用
在学习笔记中,你将探索golang的核心概念和高级技巧!

相关文章

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

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

下载

相关标签:

go语言

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

相关专题

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

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

2023.06.20

3069

3

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

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

2023.07.25

2288

9

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

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

2023.08.02

1220

5

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

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

2023.08.09

1158

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

1336

5

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

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

2023.09.20

2118

7

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

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

2023.09.20

3360

8

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

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

2023.09.22

15195

6

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

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

2023.09.22

549

3

热门下载

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

精品课程

更多
相关推荐
/
热门推荐
/
最新课程