AI 助理
文档备案控制台
开发者社区 大数据 文章 正文

【go 语言】gRPC 环境搭建（三）

2022-05-08 671
版权
版权声明：
本文内容由阿里云实名注册用户自发贡献，版权归原作者所有，阿里云开发者社区不拥有其著作权，亦不承担相应法律责任。具体规则请查看《 阿里云开发者社区用户服务协议》和 《阿里云开发者社区知识产权保护指引》。如果您发现本社区中有涉嫌抄袭的内容，填写 侵权投诉表单进行举报，一经查实，本社区将立刻删除涉嫌侵权内容。
简介： gRPC 环境搭建（三）

前言

昨晚写完【go 语言】gRPC 环境搭建（二） 后，今早爬起来继续踩坑，发现事情并不简单，版本更新太快，部分文档的滞后性相当明显，不过都已经解决了，相关内容，第一次看的话，直接跟着走就行。


好了，今天从继续往后面探索。


正文

gRPC 的调用方式简介


  • Unary RPC：一元 RPC。
  • Server-side streaming RPC：服务端流式 RPC。
  • Client-side streaming RPC：客户端流式 RPC。
  • Bidirectional streaming RPC：双向流式 RPC。


1. Unary RPC：一元 RPC


一元 RPC 也称为单次 RPC，简单来讲，就是客户单发起一次普通的 RPC 请求，是最基础的调用，也是最常用的方式，如下图所示，


45.webp.jpg

一元 RPC


服务端代码如下，


package main
import (
    "context"
    "google.golang.org/grpc"
    "net"
    pb "project_protoc/proto/helloworld"
)
type GreeterServer struct {
    pb.UnimplementedGreeterServer
}
func (g GreeterServer) SayHello(ctx context.Context, request *pb.HelloRequest) (*pb.HelloReply, error) {
    return &pb.HelloReply{Message: "hello world, QiJ"}, nil
}
func main() {
    server := grpc.NewServer()
    pb.RegisterGreeterServer(server, &GreeterServer{})
    lis, _ := net.Listen("tcp", ":"+"2021")
    server.Serve(lis)
}


代码说明，


  • 创建 gRPC Server 对象，可以把它理解为 Server 端的抽象对象。
  • 将 GreeterServer（其包含需要被调用的服务端接口）注册到 gRPC Server 的内部注册中心，这样在接收请求时，即可通过内部的“服务发现”发现该服务端接口，并进行逻辑处理。
  • 创建 Listen，监听 TCP 端口。
  • gRPC Server 开始 lis.Accept，直到 Stop 或 GracefulStop。


服务端代码需要注意的地方是 GreeterServer 这个结构体内必须带上 pb.UnimplementedGreeterServer，不然会报如下错误，


46.webp.jpg


Cannot use '&GreeterServer{}' (type *GreeterServer) as type GreeterServer Type does not implement 'GreeterServer' as some methods are missing: mustEmbedUnimplementedGreeterServer()


客户端代码如下，


package main
import (
    "context"
    "google.golang.org/grpc"
    "log"
    pb "project_protoc/proto/helloworld"
)
func main() {
    conn, _ := grpc.Dial(":"+"2021", grpc.WithInsecure())
    defer conn.Close()
    client := pb.NewGreeterClient(conn)
    _ = SayHello(client)
}
func SayHello(client pb.GreeterClient) error {
    resp, _ := client.SayHello(context.Background(), &pb.HelloRequest{Name: "七镜"})
    log.Printf("client.SayHello resp: %s", resp.Message)
    return nil
}


代码说明，


  • 创建与给定目标（服务端）的连接句柄。
  • 创建 Greeter 的客户端对象。
  • 发送 RPC 请求，等待同步响应，得到回调后返回响应结果。


二、Service-side streaming RPC：服务端流式 RPC


服务端流式 RPC 是一个单向流，指 Server 为 Stream、Client 为普通的一元 RPC 请求。

简单来讲，就是客户端发起一次普通的 RPC 请求，服务端通过流式响应多次发送数据集，客户端 Recv 接收数据集，如下图所示，


47.webp.jpg

服务端流式 RPC


proto 文件调整如下，


...
service Greeter {
  ...
  rpc SayList (HelloRequest) returns (stream HelloReply) {};
  ...
}
...


意思是新增一个 SayList 服务。加完之后，继续执行下述命令，重新生成 *.pb.go 和 *_grpc.pb.go 。


protoc -I=. --go_out=. --go-grpc_out=. ./proto/*.proto


服务端代码调整如下，


...
func (s GreeterServer) SayList(r *pb.HelloRequest, stream pb.Greeter_SayListServer) error {
    for n := 0; n <= 6; n++ {
        _ = stream.Send(&pb.HelloReply{Message: "hello list, QiJ"})
    }
    return nil
}
...


在 Server 端，需重点留意 stream.Send 方法。通过阅读源码，可以得知 protoc 在生成时，根据定义生成了各式各样符合标准的接口方法。最终再统一调用内部的 SendMsg 方法，改方法涉及以下流程：

  • 消息体（对象）序列化。
  • 压缩序列化后的消息体。
  • 为正在传输的消息体增加 5 字节的 header（标志位）。
  • 判断压缩 + 序列化后的消息体总字节长度是否大于预设的 maxStreamMessageSize（预设值为 math.MaxInt32），若超出则提示错误。
  • 写入流的数据集。


客户端代码调整如下，


...
func SayList(client pb.GreeterClient, r *pb.HelloRequest) error {
    stream, _ := client.SayList(context.Background(), r)
    for {
        resp, err := stream.Recv()
        if err == io.EOF {
            break
        }
        if err != nil {
            return err
        }
        log.Printf("resp: %v", resp.Message)
    }
    return nil
}
...


在 Client 端，需重点留意 stream.Recv 方法，并思考一下，在什么情况下会出现 io.EOF，又在什么情况下会出现错误信息呢？实际上，stream.Recv 方法是对 ClientStream.RecvMsg 方法的封装，而 RecvMsg 方法会从流中读取完整的 gRPC 消息体，有次可以得知：


  • RecvMsg 是阻塞等待的。
  • 当流成功或结束（调用了 Close）是，RecvMsg 会返回 io.EOF。
  • 当流出现任何错误时，流都会被中止。错误信息中会包含 RPC 错误码。RecvMsg 中可能出现的错误如下，


  1. io.EOF、io.ErrUnexpectedEOF。
  2. transport.ConnectionError。
  3. google.golang.org/grpc/codes（gRPC 的预定义错误码）


需要注意的是，默认的 MaxReceiveMessageSize 值为 1024x1024x4。若有特殊需求，则可以适当调整。


三、 Client-side streaming RPC：客户端流式 RPC


客户端流式 RPC 是一个单向流，客户端通过流式发起多次 RPC 请求给服务端，而服务端又发起一次响应给客户端，如下图所示，


48.webp.jpg

客户端流式 RPC


proto 文件调整如下


...
rpc SayRecord (stream HelloRequest) returns (HelloReply) {};
...


再次执行下述命令，重新生成 *.pb.go 和 *_grpc.pb.go


protoc -I=. --go_out=. --go-grpc_out=. ./proto/*.proto


服务端代码调整如下


...
func (s *GreeterServer) SayRecord(stream pb.Greeter_SayRecordServer) error {
    for {
        resp, err := stream.Recv()
        if err == io.EOF {
            message := &pb.HelloReply{Message: "hello record, QiJ"}
            return stream.SendAndClose(message)
        }
        if err != nil {
            return err
        }
        log.Printf("resp: %v", resp)
    }
}
...


上述代码中，我们对每一个 Recv 都进行了处理。当 io.EOF（流关闭）后，需要通过 stream.SendAndClose 方法将最终的响应结果发送给客户端，同时关闭在另外一侧等待的 Recv。


客户端代码调整如下，


...
func SayRecord(client pb.GreeterClient, r *pb.HelloRequest) error {
    stream, _ := client.SayRecord(context.Background())
    for n := 0; n < 6; n++ {
        _ = stream.Send(r)
    }
    resp, _ := stream.CloseAndRecv()
    log.Printf("client.SayRecord resp: %v", resp.Message)
    return nil
}
...


Server 端的 stream.SendAndClose 方法与 Client 端的 stream.CloseAndRecv 方法是配套使用的。


四、Bidirectional streaming RPC：双向流式 RPC


双向流式 RPC，顾名思义是双向流，由客户端以流式的方式发起请求，服务端同样以流式的方式响应请求。

首个请求一定是客户端发起的，但具体的交互方式（谁先谁后、一次发多少、响应多少、什么时候关闭）则由程序编写的方式来确定（可以结合协程）。

假设双向流是按顺序发送的，则大致如下图所示，


49.webp.jpg

双向流式 RPC


proto 文件调整如下


...
rpc SayRoute (stream HelloRequest) returns (stream HelloReply) {};
...


再次执行下述命令，重新生成 *.pb.go 和 *_grpc.pb.go


protoc -I=. --go_out=. --go-grpc_out=. ./proto/*.proto


服务端代码调整如下，


...
func (s *GreeterServer) SayRoute(stream pb.Greeter_SayRouteServer) error {
    n := 0
    for {
        _ = stream.Send(&pb.HelloReply{Message: "hello route"})
        resp, err := stream.Recv()
        if err == io.EOF {
            return nil
        }
        if err != nil {
            return err
        }
        n++
        log.Printf("server.SayRoute resp: %v", resp)
    }
}
...


客户端代码调整如下，


...
func SayRoute(client pb.GreeterClient, r *pb.HelloRequest) error {
    stream, _ := client.SayRoute(context.Background())
    for n := 0; n <= 6; n++ {
        _ = stream.Send(r)
        resp, err := stream.Recv()
        if err == io.EOF {
            return nil
        }
        if err != nil {
            return err
        }
        log.Printf("client.SayRoute resp: %v", resp.Message)
    }
    _ = stream.CloseSend()
    return nil
}
...


四种 gRPC 调用方式的结果展示汇总


Client 端：


50.webp.jpg

客户端结果展示汇总


Server 端：


51.webp.jpg

服务端结果展示汇总


项目工程下载

下载地址：点击下载

文章标签：
Go
流计算
网络协议
七镜
目录
相关文章
凉凉心.
|
存储 安全 Java
【Golang】（4）Go里面的指针如何？函数与方法怎么不一样？带你了解Go不同于其他高级语言的语法
结构体可以存储一组不同类型的数据，是一种符合类型。Go抛弃了类与继承，同时也抛弃了构造方法，刻意弱化了面向对象的功能，Go并非是一个传统OOP的语言，但是Go依旧有着OOP的影子，通过结构体和方法也可以模拟出一个类。
凉凉心.
565 2
跃@sir
|
Cloud Native 安全 Java
Go：为云原生而生的高效语言
Go：为云原生而生的高效语言
跃@sir
848 1
跃@sir
|
Cloud Native Go API
Go：为云原生而生的高效语言
Go：为云原生而生的高效语言
跃@sir
740 0
跃@sir
|
Cloud Native Java Go
Go：为云原生而生的高效语言
Go：为云原生而生的高效语言
跃@sir
574 0
跃@sir
|
Cloud Native Java 中间件
Go：为云原生而生的高效语言
Go：为云原生而生的高效语言
跃@sir
607 0
跃@sir
|
Cloud Native Java Go
Go：为云原生而生的高效语言
Go：为云原生而生的高效语言
跃@sir
1755 0
程序员爱钓鱼
|
数据采集 Go API
Go语言实战案例:多协程并发下载网页内容
本文是《Go语言100个实战案例 · 网络与并发篇》第6篇，讲解如何使用 Goroutine 和 Channel 实现多协程并发抓取网页内容，提升网络请求效率。通过实战掌握高并发编程技巧，构建爬虫、内容聚合器等工具，涵盖 WaitGroup、超时控制、错误处理等核心知识点。
程序员爱钓鱼
478 0
游客kehwsvh7b7a2i
|
存储 缓存 安全
Go 语言中的 Sync.Map 详解：并发安全的 Map 实现
`sync.Map` 是 Go 语言中用于并发安全操作的 Map 实现，适用于读多写少的场景。它通过两个底层 Map（`read` 和 `dirty`）实现读写分离，提供高效的读性能。主要方法包括 `Store`、`Load`、`Delete` 等。在大量写入时性能可能下降，需谨慎选择使用场景。
游客kehwsvh7b7a2i
1435 2
众所周知
|
存储 负载均衡 监控
如何利用Go语言的高效性、并发支持、简洁性和跨平台性等优势，通过合理设计架构、实现负载均衡、构建容错机制、建立监控体系、优化数据存储及实施服务治理等步骤，打造稳定可靠的服务架构。
在数字化时代，构建高可靠性服务架构至关重要。本文探讨了如何利用Go语言的高效性、并发支持、简洁性和跨平台性等优势，通过合理设计架构、实现负载均衡、构建容错机制、建立监控体系、优化数据存储及实施服务治理等步骤，打造稳定可靠的服务架构。
众所周知
644 1
九月天空
|
Java 大数据 Go
Go语言：高效并发的编程新星
【10月更文挑战第21】Go语言：高效并发的编程新星
九月天空
596 7

热门文章

最新文章

  • 1
    5分钟学习基于Go，go-microservice-template，Minke的微服务
  • 2
    dubbo-go 的开发、设计与功能介绍
  • 3
    Golang发送邮件
  • 4
    Go 语言体系下的微服务框架选型: Dubbo-go
  • 5
    Go开发：如何封装函数来统计执行时间
  • 6
    Go如何优雅的对时间进行格式化?
  • 7
    Go语言slice 实现原理，终于搞清楚它的扩容机制了！
  • 8
    Docker部署kafka｜Go操作实践
  • 9
    golang中的类和接口的使用
  • 10
    Go语言中的并发编程：掌握goroutines和channels####
  • 1
    基于 Go 语言跳表结构的局域网控制桌面软件进程管理算法研究
    428
  • 2
    go-dongle v1.1.7 发布，新增 SM4 国密分组对称加密算法支持
    531
  • 3
    go-dongle v1.1.7 发布，新增 SM4 国密分组对称加密算法支持
    499
  • 4
    防止员工泄密软件中文件访问日志管理的 Go 语言 B + 树算法
    400
  • 5
    如何管理员工上网：基于 Go 语言实现的布隆过滤器访问拦截算法应用
    476
  • 6
    【GoWails】Go做桌面应用开发？本篇文章带你上手Wails框架！一步步带你玩明白前后端双端的数据绑定！
    1871
  • 7
    【GoGin】（0）基于Go的WEB开发框架，GO Gin是什么？怎么启动？本文给你答案
    874
  • 8
    【GoGin】（1）上手Go Gin 基于Go语言开发的Web框架，本文介绍了各种路由的配置信息；包含各场景下请求参数的基本传入接收
    842
  • 9
    【Golang】（5）Go基础的进阶知识！带你认识迭代器与类型以及声明并使用接口与泛型！
    509
  • 10
    【Golang】（4）Go里面的指针如何？函数与方法怎么不一样？带你了解Go不同于其他高级语言的语法
    565

    • 相关课程

    更多
  • Go语言核心编程 - 数据结构和算法
  • Go语言核心编程 - 基础语法、数组、切片、Map
  • Go语言核心编程 - 面向对象、文件、单元测试、反射、TCP编程
  • Go语言完全自学手册图文教程

    • 相关电子书

    更多
  • Go语言路上踩过的坑
  • gohbase ：HBase go客户端
  • Go构建日请求千亿级微服务实践
    • 下一篇
    一条命令迁移，帮你实现 OpenClaw 与 Hermes Agent 记忆互通！