gRPC双向数据流的交互控制(go语言实现)

​​点击关注异步图书,置顶公众号

每天与你分享IT好书 技术干货 职场知识

​gRPC简介

gRPC (https://grpc.io) 是一个由Google开发的高性能、开源、跨多种编程语言和通用的远程过程调用协议(RPC) 框架,用于客户端和服务器端之间的通信,使用HTTP/2协议并将 ProtoBuf (https://developers.google.com/protocol-buffers)作为序列化工具。

gRPC模式

gRPC主要有4种请求/响应模式,分别是:

(1) 简单模式(Simple RPC)

这种模式最为传统,即客户端发起一次请求,服务端响应一个数据,这和大家平时熟悉的RPC没有什么大的区别,所以不再详细介绍。

(2) 服务端数据流模式(Server-side streaming RPC)

这种模式是客户端发起一次请求,服务端返回一段连续的数据流。典型的例子是客户端向服务端发送一个股票代码,服务端就把该股票的实时数据源源不断的返回给客户端。

(3) 客户端数据流模式(Client-side streaming RPC)

与服务端数据流模式相反,这次是客户端源源不断的向服务端发送数据流,而在发送结束后,由服务端返回一个响应。典型的例子是物联网终端向服务器报送数据。

(4) 双向数据流模式(Bidirectional streaming RPC)

顾名思义,这是客户端和服务端都可以向对方发送数据流,这个时候双方的数据可以同时互相发送,也就是可以实现实时交互。典型的例子是聊天机器人。

双向数据流实战

在gRPC中文文档(http://doc.oschina.net/grpc?t=60133)中有上述4种模式的实例,但是其中双向数据流的例子过于简单,没有体现出双向控制的特点,所以本文创建一个新的例子(用golang实现),用以展示gRPC双向数据流的交互(关于proto如何定义、相关包如何安装,在文档中都有介绍,所以本文略去此部分)。

1、proto定义

1syntax = "proto3"; // 语法使用 protocol buffer proto3

2// 包名: chat

3package chat; 

4/*

5    服务名: Chat,

6    其中只有 名为“BidStream”的一个RPC服务,

7    输入是 Request格式的数据流, 输出是 Response 格式的数据流

8*/

9service Chat {

10    rpc BidStream(stream Request) returns (stream Response) {}

11}

12// 请求数据 Request格式定义

13message Request {

14    string input = 1;

15}

16// 响应数据Response格式定义

17message Response {

18    string output = 1;

19}

服务端程序 server.go

1package main

2import (

3    "io"

4    "log"

5    "net"

6    "strconv"

7    "google.golang.org/grpc"

8    proto "chat" // 自动生成的 proto代码

9)

10// Streamer 服务端

11type Streamer struct{}

12// BidStream 实现了 ChatServer 接口中定义的 BidStream 方法

13func (s *Streamer) BidStream(stream proto.Chat_BidStreamServer) error {

14    ctx := stream.Context()

15    for {

16        select {

17        case <-ctx.Done():

18            log.Println("收到客户端通过context发出的终止信号")

19            return ctx.Err()

20        default:

21            // 接收从客户端发来的消息

22            输入, err := stream.Recv()

23            if err == io.EOF {

24                log.Println("客户端发送的数据流结束")

25                return nil

26            }

27            if err != nil {

28                log.Println("接收数据出错:", err)

29                return err

30            }

31            // 如果接收正常,则根据接收到的 字符串 执行相应的指令

32            switch 输入.Input {

33            case "结束对话 ":

34                log.Println("收到'结束对话'指令")

35                if err := stream.Send(&proto.Response{Output: "收到结束指令"}); err != nil {

36                    return err

37                }

38                // 收到结束指令时,通过 return nil 终止双向数据流

39                return nil

40            case "返回数据流 ":

41                log.Println("收到'返回数据流'指令")

42                // 收到 收到'返回数据流'指令, 连续返回 10 条数据

43                for i := 0; i < 10; i++ {

44                    if err := stream.Send(&proto.Response{Output: "数据流 #" + strconv.Itoa(i)}); err != nil {

45                        return err

46                    }

47                }

48            default:

49                // 缺省情况下, 返回 '服务端返回: ' + 输入信息

50                log.Printf("[收到消息]: %s", 输入.Input)

51                if err := stream.Send(&proto.Response{Output: "服务端返回: " + 输入.Input}); err != nil {

52                    return err

53                }

54            }

55        }

56    }

57}

58func main() {

59    log.Println("启动服务端...")

60    server := grpc.NewServer()

61    // 注册 ChatServer

62    proto.RegisterChatServer(server, &Streamer{})

63    address, err := net.Listen("tcp", ":3000")

64    if err != nil {

65        panic(err)

66    }

67    if err := server.Serve(address); err != nil {

68        panic(err)

69    }

70}

客户端程序 client.go

1package main

2import (

3    "bufio"

4    "context"

5    "io"

6    "log"

7    "os"

8    "google.golang.org/grpc"

9    proto "chat" // 根据proto文件自动生成的代码

10)

11func main() {

12    // 创建连接

13    conn, err := grpc.Dial("localhost:3000", grpc.WithInsecure())

14    if err != nil {

15        log.Printf("连接失败: [%v] ", err)

16        return

17    }

18    defer conn.Close()

19    // 声明客户端

20    client := proto.NewChatClient(conn)

21    // 声明 context

22    ctx := context.Background()

23    // 创建双向数据流

24    stream, err := client.BidStream(ctx)

25    if err != nil {

26        log.Printf("创建数据流失败: [%v] ", err)

27    }

28    // 启动一个 goroutine 接收命令行输入的指令

29    go func() {

30        log.Println("请输入消息...")

31        输入 := bufio.NewReader(os.Stdin)

32        for {

33            // 获取 命令行输入的字符串, 以回车 作为结束标志

34            命令行输入的字符串, _ := 输入.ReadString(' ')

35            // 向服务端发送 指令

36            if err := stream.Send(&proto.Request{Input: 命令行输入的字符串}); err != nil {

37                return

38            }

39        }

40    }()

41    for {

42        // 接收从 服务端返回的数据流

43        响应, err := stream.Recv()

44        if err == io.EOF {

45            log.Println("⚠️ 收到服务端的结束信号")

46            break    //如果收到结束信号,则退出“接收循环”,结束客户端程序

47        }

48        if err != nil {

49            // TODO: 处理接收错误

50            log.Println("接收数据出错:", err)

51        }

52        // 没有错误的情况下,打印来自服务端的消息

53        log.Printf("[客户端收到]: %s", 响应.Output)

54    }

55}​

运行效果

先启动服务端程序 server.go

再启动客户端程序 client.go

输入消息,结果类似下图:

总结

gRPC是个很强大的RPC框架,而且支持多语言编程,上面的服务端、客户端程序我们完全可以用不同的语言实现,比如服务端用JAVA,客户端用Python...

gRPC的四种交互模式也给我们提供了很大的发挥空间,最近Nginx宣布支持gRPC,这可能也预示着某种趋势...

异步社区是一个有料、有货,又专业的IT专业图书社区,在这里可以读到最新、最热的IT类图书!

我想要社区的《Git高手之路》这本书,这本书是网络编程的经典图书,请大家帮我点赞!

本文摘自异步社区,作者:阿狸不歌作品:《gRPC双向数据流的交互控制(go语言实现)》

​推荐阅读

2018年5月新书书单(文末福利)

2018年4月新书书单

异步图书最全Python书单

一份程序员必备的算法书单

第一本Python神经网络编程图书

​长按二维码,可以关注我们哟

每天与你分享IT好文。

在“异步图书”后台回复“关注”,即可免费获得2000门在线视频课程;推荐朋友关注根据提示获取赠书链接,免费得异步e读版图书一本。赶紧来参加哦!

点击阅读原文,查看更多

​阅读原文

推荐阅读更多精彩内容