Golang 语言 gRPC 服务怎么同时支持 gRPC 和 HTTP 客户端调用?

简介: Golang 语言 gRPC 服务怎么同时支持 gRPC 和 HTTP 客户端调用?

01

介绍

关于 gRPC 的文章,我们之前写过几篇,如果读者朋友还对 gRPC 不了解,我建议您可以翻阅一下公众号的历史文章。

当我们需要提供 gRPC 服务的 RESTful API 时,可以先创建一个 gRPC 客户端服务,在 gRPC 客户端服务编写 RESTful API,接收到 HTTP 请求时,通过 gRPC 客户端服务调用 gRPC 服务端服务的方法。

相信读者朋友们也意识到,仅仅为了提供 RESTful API 而编写一个 gRPC 客户端服务,显然有些小题大做。

在不借助 gRPC 客户端服务的前提下,gRPC 服务端服务怎么同时支持 gRPC 和 HTTP 客户端调用?今天我们介绍一个 protoc 插件 gRPC-Gateway。

gRPC-Gateway

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

gRPC-Gateway 可帮助您同时以 gRPC 和 RESTful 风格提供 API。

在我们开始编码之前,需要一些先决条件。

  1. 首先,我们需要先搭建一个 Go 环境。
  2. 使用 go get 工具下载一些依赖包。
  3. 使用 go mod init 工具创建一个 go.mod 文件。

依赖包列表:

$ 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

03

gRPC-Gateway 实战

在完成以上先决条件后,我们创建一个 gRPC 服务端服务,本文我们创建一个 ToDoList gRPC 服务。在创建 gRPC 服务之前,我们使用 protocol buffers 创建一个 proto 文件。

创建 proto 文件

...
service ToDoList {
  rpc CreateToDoList (ToDoListDetail) returns (CreateToDoListResult) {}
  rpc ReadToDoList (ToDoListPage) returns (ReadToDoListByPage) {}
}
...

生成 gRPC 服务端存根

使用 protoc 命令工具生成存根

protoc -I proto \
   --go_out ./pb/todoPb --go_opt paths=source_relative \
   --go-grpc_out ./pb/todoPb --go-grpc_opt paths=source_relative \
   proto/toDoList.proto

执行上面 protoc 命令工具,生成一个 *.pb.go 文件和一个 *_grpc.pb.go 文件。

编写剩余 Go 代码

创建 main.go

func main() {
 InitEngine()
 lis, err := net.Listen("tcp", address)
 if err != nil {
  log.Fatalf("failed to listen: %v", err)
 }
 server := grpc.NewServer()
 pb.RegisterToDoListServer(server, new(service.ToDoList))
 log.Printf("server listening at %v\n", lis.Addr())
 if err := server.Serve(lis); err != nil {
  log.Fatalf("failed to serve: %v", err)
 }
}

完整代码,请参阅 Github。

添加 gRPC-Gateway 选项

gRPC-Gateway 使用 google.api.http 选项定义 gRPC 服务如何映射到 JSON 请求和响应,使用 protoc 时,每个 RPC 必须使用 google.api.http 选项定义 HTTP 方法和路径。

因此,我们需要将 google/api/http.proto 导入添加到 proto 文件中。我们还需要添加我们想要的 HTTP -> gRPC 映射。

syntax = "proto3";
import "google/api/annotations.proto";
service ToDoList {
  rpc CreateToDoList (ToDoListDetail) returns (CreateToDoListResult) {
    option (google.api.http) = {
      post: "/v1/todolist/add"
      body: "*"
    };
  }
  rpc ReadToDoList (ToDoListPage) returns (ReadToDoListByPage) {
    option (google.api.http) = {
      get: "/v1/todolist/select"
    };
  }
}
...

关于 HTTP 和 gRPC 映射的更多内容,可以参阅 Google API 文档。

生成 gRPC-Gateway 存根

现在,我们已将 gRPC-Gateway 选项添加到 proto 文件中,我们需要使用 gRPC-Gateway 生成器来生成存根。

在使用 protoc 生成存根之前,我们需要将一些依赖项复制到 proto 文件目录中。将 googleapis 的子集从官方存储库下载并复制到本地 proto 文件目录中。如下所示:

.
├── dao
│   ├── mysql.go
│   └── toDoList.go
├── grpc-gateway
│   └── main.go
├── main.go
├── pb
│   └── todoPb
│       ├── toDoList.pb.go
│       ├── toDoList.pb.gw.go
│       └── toDoList_grpc.pb.go
├── proto
│   ├── google
│   │   └── api
│   │       ├── annotations.proto
│   │       └── http.proto
│   └── toDoList.proto
└── service
    └── toDoList.go

使用 protoc 生成存根

protoc -I proto \
  --go_out ./pb/todoPb --go_opt paths=source_relative \
  --go-grpc_out ./pb/todoPb --go-grpc_opt paths=source_relative \
  --grpc-gateway_out ./pb/todoPb --grpc-gateway_opt paths=source_relative \
  proto/toDoList.proto
protoc-go-inject-tag -XXX_skip=xorm -input=./pb/todoPb/toDoList.pb.go

执行以上 protoc 命令工具,生成一个 *.gw.pb.go 文件。

创建 grpc-gateway 目录,并创建 main.go 文件,创建 gRPC-Gateway 多路复用器。

func main() {
 ctx := context.Background()
 ctx, cancel := context.WithCancel(ctx)
 defer cancel()
 mux := runtime.NewServeMux()
 opts := []grpc.DialOption{grpc.WithTransportCredentials(insecure.NewCredentials())}
 err := pb.RegisterToDoListHandlerFromEndpoint(ctx, mux, grpcServerEndpoint, opts)
 if err != nil {
  log.Fatalf("Fail to register gRPC gateway service endpoint: %v", err)
 }
 if err = http.ListenAndServe(":8080", mux); err != nil {
  log.Fatalf("Could not setup HTTP endpoint: %v", err)
 }
}

完整代码,请参阅 Github。

启动服务

grpc 服务

go run main.go

gRPC-Gateway

go run grpc-gateway/main.go

cURL 测试

curl http://127.0.0.1:8080/v1/todolist/select?page=1&count=2

响应结果:

{
    "todolist": [
        {
            "id": "1",
            "content": "编程写代码",
            "datetime": "1632541505",
            "created": "1632541505",
            "updated": "1632541505"
        },
        {
            "id": "2",
            "content": "编程写代码",
            "datetime": "1632543373",
            "created": "1632543373",
            "updated": "1632543373"
        }
    ]
}

04

总结

本文我们介绍 gRPC-Gateway 如何实现同时支持 gRPC 和 RESTful 风格的 API。

当 HTTP 请求到达 gRPC-Gateway 时,它会将 JSON 数据解析为 protobuf 消息。然后,它使用解析的 protobuf 消息发出正常的 Go gRPC 客户端请求。

Go gRPC 客户端将 protobuf 结构编码为 protobuf 二进制格式,并将其发送到 gRPC 服务器。gRPC 服务器处理请求并以 protobuf 二进制格式返回响应。

Go gRPC 客户端将其解析为 protobuf 消息,并将其返回到 gRPC-Gateway,后者将 protobuf 消息编码为 JSON 并将其返回到原始客户端。

图片来自 gRPC-Gateway 官方文档

推荐阅读:

Golang 语言 gRPC 怎么使用?

参考资料:

https://github.com/grpc-ecosystem/grpc-gateway 

https://github.com/googleapis/googleapis 

https://github.com/googleapis/googleapis.github.io/ 


目录
相关文章
|
3月前
|
Go
Golang语言之管道channel快速入门篇
这篇文章是关于Go语言中管道(channel)的快速入门教程,涵盖了管道的基本使用、有缓冲和无缓冲管道的区别、管道的关闭、遍历、协程和管道的协同工作、单向通道的使用以及select多路复用的详细案例和解释。
125 4
Golang语言之管道channel快速入门篇
|
3月前
|
Go
Golang语言之gRPC程序设计示例
这篇文章是关于Golang语言使用gRPC进行程序设计的详细教程,涵盖了RPC协议的介绍、gRPC环境的搭建、Protocol Buffers的使用、gRPC服务的编写和通信示例。
108 3
Golang语言之gRPC程序设计示例
|
3月前
|
安全 Go
Golang语言goroutine协程并发安全及锁机制
这篇文章是关于Go语言中多协程操作同一数据问题、互斥锁Mutex和读写互斥锁RWMutex的详细介绍及使用案例,涵盖了如何使用这些同步原语来解决并发访问共享资源时的数据安全问题。
94 4
|
2月前
使用Netty实现文件传输的HTTP服务器和客户端
本文通过详细的代码示例,展示了如何使用Netty框架实现一个文件传输的HTTP服务器和客户端,包括服务端的文件处理和客户端的文件请求与接收。
53 1
使用Netty实现文件传输的HTTP服务器和客户端
|
3月前
|
Prometheus Cloud Native Go
Golang语言之Prometheus的日志模块使用案例
这篇文章是关于如何在Golang语言项目中使用Prometheus的日志模块的案例,包括源代码编写、编译和测试步骤。
65 3
Golang语言之Prometheus的日志模块使用案例
|
2月前
|
前端开发 中间件 Go
实践Golang语言N层应用架构
【10月更文挑战第2天】本文介绍了如何在Go语言中使用Gin框架实现N层体系结构,借鉴了J2EE平台的多层分布式应用程序模型。文章首先概述了N层体系结构的基本概念,接着详细列出了Go语言中对应的构件名称,包括前端框架(如Vue.js、React)、Gin的处理函数和中间件、依赖注入和配置管理、会话管理和ORM库(如gorm或ent)。最后,提供了具体的代码示例,展示了如何实现HTTP请求处理、会话管理和数据库操作。
33 0
|
Java
http协议客户端向服务器端请求时一般需要发送的内容
out.println("GET /shopping/index.html HTTP/1.1");//请求行 包括请求方式,文件路径, http协议版本(必写)请求头.... out.println("Aceept: */*");//客户端能够处理的文件类型(不是必须) out.
606 0
|
3月前
|
监控 安全 搜索推荐
设置 HTTPS 协议以确保数据传输的安全性
设置 HTTPS 协议以确保数据传输的安全性
|
2月前
|
安全 网络协议 算法
HTTPS网络通信协议揭秘:WEB网站安全的关键技术
HTTPS网络通信协议揭秘:WEB网站安全的关键技术
187 4
HTTPS网络通信协议揭秘:WEB网站安全的关键技术
|
2月前
|
存储 网络安全 对象存储
缺乏中间证书导致通过HTTPS协议访问OSS异常
【10月更文挑战第4天】缺乏中间证书导致通过HTTPS协议访问OSS异常
109 4