gRPC-Gateway 快速实战

这篇具有很好参考价值的文章主要介绍了gRPC-Gateway 快速实战。希望对大家有所帮助。如果存在错误或未考虑完全的地方,请大家不吝赐教,您也可以点击"举报违法"按钮提交疑问。

今天来分享一波 gRPC-Gateway , 之前咱们有分享过什么是 gRPC 及其使用方式,可以看看这些关于 gRPC 的历史文章:

  • gRPC介绍
  • gRPC 客户端调用服务端需要连接池吗?
  • gRPC的拦截器
  • gRPC的认证
  • 分享一下 gRPC- HTTP网关 I

今天主要是分享关于 gRPC-Gateway 的实战部分,文章大体分为如下几个部分:

  • gRPC-GateWay 简单原理介绍
  • 基本环境创建
  • gRPC-GateWay 实战

gRPC-GateWay 简单原理介绍

如下是官网的一张基本原理图

gRPC-Gateway 是一个协议插件,它读取一个 gRPC 服务定义,并生成一个反向代理服务它将一个 RESTful JSON API 转换为 gRPC ,这个服务器是根据gRPC定义中的自定义选项生成的。

gRPC-Gateway 快速实战,gateway

简单来说,咱们的 gRPC-Gateway 能做到的事情就是:

能够提供 RESTful JSON API 接口,并且请求通过 http 接口打进来,gRPC-Gateway 能够将其请求转给 grpc 服务,最终 grpc 服务进行处理并响应

接下来,我们就来看看 gRPC-Gateway 是如何同时提供 http 接口和 grpc 服务的

基本环境创建

使用 gRPC-Gateway ,我们需要搭建基本的环境,正如之前我们实战 grpc 的时候,需要搭建一个基本的 grpc 环境,总的来说需要做如下事项:

  1. 开始创建自己的项目目录
mkdir my_grpcgateway
cd my_grpcgateway
mdkir protoc/order
cd protoc/order
  1. 下载 gRPC-Gateway 的依赖
$ go get github.com/grpc-ecosystem/grpc-gateway/v2/protoc-gen-grpc-gateway
$ go get google.golang.org/protobuf/cmd/protoc-gen-go
$ go get google.golang.org/grpc/cmd/protoc-gen-go-grpc
  1. 检查工具,执行完第二步之后,我们可以看到咱们将 gRPC-Gateway 的依赖库和工具都下载下来了,咱们可以看到在我们的 GOPATH 目录下有如下工具

gRPC-Gateway 快速实战,gateway

  • protoc-gen-go
  • protoc-gen-grpc-gateway
  • protoc-gen-go-grpc
  • protoc
  1. 将依赖库的 google/api 拷贝到咱们的 order 目录下

这个时候我们主要是后续实战会使用库里面的 annotations.proto他的作用就是将 HTTP 映射成 gRPC,目录是这样的

google/
├── api
│   ├── annotations.proto
│   ├── httpbody.proto
│   └── http.proto

例如我的 GOPATH 在 “/root/go” ,因此我们可以这样来复制

gRPC-Gateway 快速实战,gateway

cp /root/go/pkg/mod/github.com/grpc-ecosystem/grpc-gateway@v1.16.0/third_party/googleapis/google/api/ ./

接下来就可以进入到实战部分了,目前,我们的目录是这样的

my_grpcgateway/
├── protoc
│   └── order
│       ├── google
│       │   ├── api
│       │   │   ├── annotations.proto
│       │   │   ├── httpbody.proto
│       │   │   └── http.proto

gRPC-GateWay 实战

来到实战部分,先说一下咱们的需求:

  • 咱们客户端通过请求服务端接口,查询订单信息

这个时候,其实我们只需要走如下 3 步骤即可

  1. 编写 proto 文件
  1. 用工具生成相应的代码
  1. 填写相应的代码逻辑即可

编写 proto 文件

在上述的 my_grpcgateway/protoc/order 下 创建 文件 order.proto

cd my_grpcgateway/protoc/order
vim  order.proto

gRPC-Gateway 快速实战,gateway

编写 order.proto 文件的时候我们导入了annotations.proto 文件 import "google/api/annotations.proto";

另外,我们在编写 proto 的时候,现在多定义了一个 Service

service Order {
  rpc GetOrderInfo (GetOrderReq) returns (GetOrderRsp) {
   option (google.api.http) = {
      post: "/v1/order/getorder"
      body: "*"
    };
  };
}

那通过我们写的 order.proto 文件,我们知道,咱们定义的

  • HTTP 接口是 POST /v1/order/getorder
  • gRPC 接口是 GetOrderInfo

用工具生成相应的代码

protoc -I ./ \
  --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 \
  ./order.proto

我们生成的文件存放目录都是当前目录,使用 protoc 工具生成代码后,我们可以看到 order 目录下是这样的

# ls
google  order_grpc.pb.go  order.pb.go  order.pb.gw.go  order.proto

这个时候,其实我们本次最关注的是 order.pb.gw.go 文件的生成

填写相应的代码逻辑即可

那这个时候,我们就可以创建代码文件来实现上述的 gRPC 接口,以及初始化 gRPC 服务和 gRPC-Gateway 的反向代理了

  1. 在 my_grpcgateway 目录下创建 main.go

gRPC-Gateway 快速实战,gateway

  1. 在 my_grpcgateway 下创建 server 目录,并在 server 目录下编写 server.go
mkdir server 
cd server
vim server.go

server.go
gRPC-Gateway 快速实战,gateway

gRPC-Gateway 快速实战,gateway

gRPC-Gateway 快速实战,gateway

  1. 回到 my_grpcgateway ,创建 mod,拉依赖包,并运行代码
go mod init mytest
go mod tidy
go run main.go

这个时候,我们可以看到 6666 端口,和 9999 端口都被服务监听着,此时我们来请求 9999 的 HTTP 端口,如下:

服务端已经启动:

gRPC-Gateway 快速实战,gateway

客户端可以使用 postman 来请求接口:

gRPC-Gateway 快速实战,gateway

当然也可以在 linux 里面使用 curl 来请求接口

curl -X POST -d '{"tid":"0001-000001", "tenant_name":"test tenant", "order_id":"1000-1000001"}' http://localhost:9999/v1/order/getorder

gRPC-Gateway 快速实战,gateway

写在最后

至此,我们从 gRPC-Gateway 的基本原理到快速实战,相信 xdm 能够有一定的收获吧,赶紧动起手来实战一波,并加入自己的想法变着花样的去玩他

使用 gRPC-Gateway 可以极大的提高我们的效率,直接实现 grpc 服务接口也可以提供 http 接口出去

下一篇,将会是 gRPC-Gateway Swaager 相关,能够让我们提供出去的接口更加友好和方便

项目代码可以查看地址:https://github.com/qingconglaixueit/my_grpcgateway_demo

感谢阅读,欢迎交流,点个赞,关注一波 再走吧

欢迎点赞,关注,收藏

朋友们,你的支持和鼓励,是我坚持分享,提高质量的动力

好了,本次就到这里

技术是开放的,我们的心态,更应是开放的。拥抱变化,向阳而生,努力向前行。

我是阿兵云原生,欢迎点赞关注收藏,下次见~

可以进入地址进行体验和学习:https://xxetb.xet.tech/s/3lucCI文章来源地址https://www.toymoban.com/news/detail-687438.html

到了这里,关于gRPC-Gateway 快速实战的文章就介绍完了。如果您还想了解更多内容,请在右上角搜索TOY模板网以前的文章或继续浏览下面的相关文章,希望大家以后多多支持TOY模板网!

本文来自互联网用户投稿,该文观点仅代表作者本人,不代表本站立场。本站仅提供信息存储空间服务,不拥有所有权,不承担相关法律责任。如若转载,请注明出处: 如若内容造成侵权/违法违规/事实不符,请点击违法举报进行投诉反馈,一经查实,立即删除!

领支付宝红包 赞助服务器费用

相关文章

  • golang工程——grpc-gateway 转发http header中自定义字段到grpc上下文元数据

    http header 转发到 grpc上下文 grpc网关可以将请求体内容转发到grpc对应消息中。那如何获取http header头中的信息,本文将介绍如何将http header转发到grpc上下文并采用拦截器,获取http header中的内容。 有些http header中的内置字段是会转发的比如Authorization,但是狠多自定义字段是转发

    2024年02月08日
    浏览(33)
  • gRPC之gRPC Gateway

    etcd3 API全面升级为gRPC后,同时要提供REST API服务,维护两个版本的服务显然不太合理,所以 grpc-gateway 诞生了。通过protobuf的自定义option实现了一个网关,服务端同时开启gRPC和HTTP服务, HTTP服务接收客户端请求后转换为grpc请求数据,获取响应后转为json数据返回给客户端。结构

    2024年02月07日
    浏览(37)
  • Spring Cloud Gateway的快速使用

    环境前置搭建Nacos:点击跳转 Spring Cloud Gateway Docs 新建gateway网关模块 pom.xml 导入依赖     编写启动类 GatewayApplication.java (不是新模块就不用编写)     application.yml 配置gateway     完成以上配置,直接启动即可,访问 http://localhost:10010     GatewayFilter Factories 过滤器工厂:Gat

    2024年02月11日
    浏览(45)
  • 【GateWay快速入门】 —— 每天一点小知识

                                                                                   💧 G a t e W a y 快速入门 color{#FF1493}{GateWay快速入门} G a t e Wa y 快速入门 💧           🌷 仰望天空,妳我亦是行人.✨ 🦄 个人主页——微风撞见云的博

    2024年02月09日
    浏览(90)
  • Spring Cloud Gateway快速入门(二)——断言工厂

    Spring Cloud Gateway包含许多内置的Route Predicate工厂。所有这些断言都匹配HTTP请求的不同属性。多路由断言工厂通过and组合。 官方提供的路由工厂: 这些断言工厂的配置方式,参照官方文档:https://cloud.spring.io/spring-cloud-static/spring-cloud-gateway/2.1.0.RELEASE/single/spring-cloud-gateway.html

    2024年02月07日
    浏览(45)
  • 【SpringCloud】微服务技术栈入门3 - Gateway快速上手

    WebFlux gateway 基于 webflux 构建 WebFlux 是基于反应式流概念的响应式编程框架,用于构建异步非阻塞的 Web 应用程序。它支持响应式编程范式,并提供了一种响应式的方式来处理 Web 请求。 与传统的 Servlet API 相比,WebFlux 采用了基于事件驱动的编程模型,不依赖于传统的线程池模

    2024年02月07日
    浏览(39)
  • SpringCloud Gateway + Security + JWT 最快速的集成

    Springboot版本采用的是最新的: 网关主要采用的是:

    2024年02月16日
    浏览(43)
  • Spring Cloud Gateway快速入门(三)——过滤器

    Gateway过滤器是Spring Cloud Gateway提供的一种机制,用于对进入网关的请求和返回进行处理和转换。它可以用于实现各种功能,如请求鉴权、请求转发、请求限流、请求重试等。 网关过滤器是Spring Cloud Gateway提供的一种机制,用于在请求进入网关和响应离开网关时进行一些预处理

    2024年02月04日
    浏览(46)
  • 实战项目 在线学院springcloud调用篇3(nacos,feging,hystrix,gateway)

    结果:   1.nacos的搭建部署 2.vod,edu项目的注册nacos 3.查看 2.4.1 edu配置 1.controller  2.feginclient  2.4.2 vod配置  2.4.3 测试 2.5.1 配置步骤  1.feginclient 2.降级类 API 网关出现的原因是微服务架构的出现,不同的微服务一般会有不同的网络地址,而外部客户端可能需要调用多个服务的

    2024年02月11日
    浏览(33)
  • 5.微服务项目实战---Gateway--服务网关,实现统一认证、鉴权、监控、路由转发等

    大家都都知道在微服务架构中,一个系统会被拆分为很多个微服务。那么作为客户端要如何去调用 这么多的微服务呢?如果没有网关的存在,我们只能在客户端记录每个微服务的地址,然后分别去调用。   这样的架构,会存在着诸多的问题: 客户端多次请求不同的微服务,

    2024年02月16日
    浏览(44)

觉得文章有用就打赏一下文章作者

支付宝扫一扫打赏

博客赞助

微信扫一扫打赏

请作者喝杯咖啡吧~博客赞助

支付宝扫一扫领取红包,优惠每天领

二维码1

领取红包

二维码2

领红包