当前位置:首页 > 文章列表 > Golang > Go教程 > Golang实现REST转gRPC网关教程

Golang实现REST转gRPC网关教程

2025-12-31 11:36:00 0浏览 收藏

Golang不知道大家是否熟悉?今天我将给大家介绍《Golang实现REST转gRPC网关方法》,这篇文章主要会讲到等等知识点,如果你在看完本篇文章后,有更好的建议或者发现哪里有问题,希望大家都能积极评论指出,谢谢!希望我们能一起加油进步!

答案:在Golang中通过gRPC网关将REST转为gRPC调用需定义带google.api.http注解的proto文件,生成gRPC和服务代码后分别启动gRPC服务器和HTTP网关,实现RESTful API到内部gRPC的自动转换。

如何在Golang中使用gRPC网关转换REST请求

在Golang中使用gRPC网关将REST请求转换为gRPC调用,是构建现代微服务API的常见做法。它允许你通过HTTP/JSON对外提供RESTful接口,同时内部使用高性能的gRPC进行服务间通信。整个流程依赖于Protocol Buffers定义服务,并借助grpc-gateway生成反向代理代码。

定义Protocol Buffer服务

要启用gRPC网关,首先需要在.proto文件中定义gRPC服务,并添加特定的google.api.http注解来映射REST路径。

安装必要的proto插件:

go install github.com/grpc-ecosystem/grpc-gateway/v2/protoc-gen-grpc-gateway@latest
go install google.golang.org/protobuf/cmd/protoc-gen-go@latest
go install google.golang.org/grpc/cmd/protoc-gen-go-grpc@latest

编写service.proto文件:

syntax = "proto3";

package example;

import "google/api/annotations.proto";

message HelloRequest {
  string name = 1;
}

message HelloResponse {
  string message = 1;
}

service Greeter {
  rpc SayHello (HelloRequest) returns (HelloResponse) {
    option (google.api.http) = {
      get: "/v1/hello/{name}"
    };
  }
}

这里option (google.api.http)SayHello方法绑定到GET /v1/hello/{name},URL中的{name}会自动映射到请求字段。

生成gRPC和gRPC-Gateway代码

运行protoc命令生成Go代码:

protoc \
  --go_out=. --go_opt=paths=source_relative \
  --go-grpc_out=. --go-grpc_opt=paths=source_relative \
  --grpc-gateway_out=. --grpc-gateway_opt=paths=source_relative \
  service.proto

这会生成三个文件:

  • service.pb.go:基础结构体和gRPC客户端/服务接口
  • service_grpc.pb.go:gRPC服务实现桩代码
  • service.pb.gw.go:gRPC网关的HTTP处理器,负责将REST转为gRPC调用

启动gRPC服务与HTTP网关

你需要同时运行gRPC服务器和HTTP网关。通常gRPC监听本地端口,而HTTP网关作为前端代理转发请求。

实现gRPC服务:

type server struct{}

func (s *server) SayHello(ctx context.Context, req *example.HelloRequest) (*example.HelloResponse, error) {
  return &example.HelloResponse{Message: "Hello " + req.Name}, nil
}

启动gRPC服务器:

lis, _ := net.Listen("tcp", ":50051")
s := grpc.NewServer()
example.RegisterGreeterServer(s, &server{})
s.Serve(lis)

启动HTTP网关(反向代理):

ctx := context.Background()
mux := runtime.NewServeMux()
opts := []grpc.DialOption{grpc.WithInsecure()}
_ = example.RegisterGreeterHandlerFromEndpoint(ctx, mux, "localhost:50051", opts)

http.ListenAndServe(":8080", mux)

现在你可以通过GET /v1/hello/world访问服务,网关会将其转换为gRPC调用并返回JSON响应。

处理复杂路由和方法

除了GET,你还可以映射POST、PUT等方法,并指定body字段:

rpc CreateBook(CreateBookRequest) returns (CreateBookResponse) {
  option (google.api.http) = {
    post: "/v1/shelves/{shelf_id}/books"
    body: "book"
  };
}

这表示POST数据到/v1/shelves/123/books,请求体中的JSON会被解析到book字段。

确保你的proto文件导入google/api/annotations.protogoogle/api/http.proto,可通过buf或手动下载管理依赖。

基本上就这些。只要定义好proto注解,生成代码并正确启动两个服务,gRPC网关就能自动完成REST到gRPC的转换,无需手动写HTTP handler。这种方式统一了API契约,便于维护和文档生成。不复杂但容易忽略的是注解语法和生成命令的参数顺序。

到这里,我们也就讲完了《Golang实现REST转gRPC网关教程》的内容了。个人认为,基础知识的学习和巩固,是为了更好的将其运用到项目中,欢迎关注golang学习网公众号,带你了解更多关于的知识点!

GolangDockerVolume数据管理实战GolangDockerVolume数据管理实战
上一篇
GolangDockerVolume数据管理实战
AI真相揭秘:事实、观点与智能边界
下一篇
AI真相揭秘:事实、观点与智能边界
查看更多
最新文章
查看更多
课程推荐
  • 前端进阶之JavaScript设计模式
    前端进阶之JavaScript设计模式
    设计模式是开发人员在软件开发过程中面临一般问题时的解决方案,代表了最佳的实践。本课程的主打内容包括JS常见设计模式以及具体应用场景,打造一站式知识长龙服务,适合有JS基础的同学学习。
    543次学习
  • GO语言核心编程课程
    GO语言核心编程课程
    本课程采用真实案例,全面具体可落地,从理论到实践,一步一步将GO核心编程技术、编程思想、底层实现融会贯通,使学习者贴近时代脉搏,做IT互联网时代的弄潮儿。
    516次学习
  • 简单聊聊mysql8与网络通信
    简单聊聊mysql8与网络通信
    如有问题加微信:Le-studyg;在课程中,我们将首先介绍MySQL8的新特性,包括性能优化、安全增强、新数据类型等,帮助学生快速熟悉MySQL8的最新功能。接着,我们将深入解析MySQL的网络通信机制,包括协议、连接管理、数据传输等,让
    500次学习
  • JavaScript正则表达式基础与实战
    JavaScript正则表达式基础与实战
    在任何一门编程语言中,正则表达式,都是一项重要的知识,它提供了高效的字符串匹配与捕获机制,可以极大的简化程序设计。
    487次学习
  • 从零制作响应式网站—Grid布局
    从零制作响应式网站—Grid布局
    本系列教程将展示从零制作一个假想的网络科技公司官网,分为导航,轮播,关于我们,成功案例,服务流程,团队介绍,数据部分,公司动态,底部信息等内容区块。网站整体采用CSSGrid布局,支持响应式,有流畅过渡和展现动画。
    485次学习
查看更多
AI推荐
  • ljg-skills -
    ljg-skills
    ljg-skills 是李继刚开源的 AI 技能与提示词集合,面向大模型使用者整理了一批可复用的 prompt、角色设定和任务技能模板,适合用于学习提示词设计、搭建个人 AI 工作流和沉淀团队常用智能体能力。
    161次使用
  • MELO音乐 - AI 音乐生成平台,支持多模态创作能力
    MELO音乐
    MELO音乐是一站式AI视频与音乐制作助手,对标suno, udio的高品质体验。提供伴奏生成、原创写词、无损导出、哼唱识曲、混音变声等全套音频与短视频编辑工具。无论是流行Kpop、电音说唱、民谣古风、摇滚儿歌还是商用轻音乐,MELO为你免费谱曲,轻松做同款!
    175次使用
  • UniScribe - AI 免费在线音视频转文字平台
    UniScribe
    UniScribe 是一款 AI 音视频转文字与内容整理工具,支持上传音频、视频文件或粘贴 YouTube 链接,自动生成转写文本、摘要、思维导图和关键问题,并支持多格式导出,适合会议记录、课程学习、访谈整理和内容创作复盘。
    157次使用
  • 剧云 - 免费 AI 智能中文剧本创作平台
    剧云
    剧云是专业中文剧本创作平台,安全稳定运行十余年,集成AI编剧、剧本医生审核、人物小传、剧情关系图、大纲编写、多人协作、Word导入导出、版权管控功能,数据安全防护,轻松高效创作剧本。
    313次使用
  • 万象有声 - AI 一站式有声内容创作平台
    万象有声
    万象有声,一个专为有声创作者打造的新一代智能有声内容创作平台。平台提供专业的智能拆章、智能画本编辑、AI配音、AI生成音效、后期制作、智能对轨、智能审听等有声创作全流程工具,可以帮助创作者高效、低成本创作出引人入胜的有声作品。立即体验,让有声书制作更简单!
    317次使用
微信登录更方便
  • 密码登录
  • 注册账号
登录即同意 用户协议隐私政策
返回登录
  • 重置密码