0%

前言#

上一篇介绍了简单模式RPC,当数据量大或者需要不断传输数据时候,我们应该使用流式RPC,它允许我们边处理边传输数据。本篇先介绍服务端流式RPC

服务端流式RPC:客户端发送请求到服务器,拿到一个流去读取返回的消息序列。 客户端读取返回的流,直到里面没有任何消息。

情景模拟:实时获取股票走势。

1.客户端要获取某原油股的实时走势,客户端发送一个请求

2.服务端实时返回该股票的走势

新建proto文件#

新建server_stream.proto文件

1.定义发送信息

Copy

// 定义发送请求信息 message SimpleRequest{ // 定义发送的参数,采用驼峰命名方式,小写加下划线,如:student_name // 请求参数 string data = 1; }

2.定义接收信息

Copy

// 定义流式响应信息 message StreamResponse{ // 流式响应数据 string stream_value = 1; }

3.定义服务方法ListValue

服务端流式rpc,只要在响应数据前添加stream即可

Copy

// 定义我们的服务(可定义多个服务,每个服务可定义多个接口) service StreamServer{ // 服务端流式rpc,在响应数据前添加stream rpc ListValue(SimpleRequest)returns(stream StreamResponse){}; }

4.编译proto文件

进入server_stream.proto所在目录,运行指令:

protoc --go_out=plugins=grpc:./ ./server_stream.proto

创建Server端#

1.定义我们的服务,并实现ListValue方法

Copy

`type StreamService struct{}

func (s *StreamService) ListValue(req *pb.SimpleRequest, srv pb.StreamServer_ListValueServer) error {
for n := 0; n < 5; n++ {

    err := srv.Send(&pb.StreamResponse{
        StreamValue: req.Data + strconv.Itoa(n),
    })
    if err != nil {
        return err
    }
}
return nil

}`

初学者可能觉得比较迷惑,ListValue的参数和返回值是怎样确定的。其实这些都是编译proto时生成的.pb.go文件中有定义,我们只需要实现就可以了。

2.启动gRPC服务器

Copy

`const (

Address string = ":8000"

Network string = "tcp"

)

func main() {

listener, err := net.Listen(Network, Address)
if err != nil {
    log.Fatalf("net.Listen err: %v", err)
}
log.Println(Address + " net.Listing...")



grpcServer := grpc.NewServer()

pb.RegisterStreamServerServer(grpcServer, &StreamService{})


err = grpcServer.Serve(listener)
if err != nil {
    log.Fatalf("grpcServer.Serve err: %v", err)
}

}`

运行服务端

Copy

go run server.go :8000 net.Listing...

创建Client端#

1.创建调用服务端ListValue方法

Copy

`func listValue() {

req := pb.SimpleRequest{
    Data: "stream server grpc ",
}

stream, err := grpcClient.ListValue(context.Background(), &req)
if err != nil {
    log.Fatalf("Call ListStr err: %v", err)
}
for {
    
    res, err := stream.Recv()
    
    if err == io.EOF {
        break
    }
    if err != nil {
        log.Fatalf("ListStr get stream err: %v", err)
    }
    
    log.Println(res.StreamValue)
}

}`

2.启动gRPC客户端

Copy

`const Address string = “:8000”

var grpcClient pb.StreamServerClient

func main() {

conn, err := grpc.Dial(Address, grpc.WithInsecure())
if err != nil {
    log.Fatalf("net.Connect err: %v", err)
}
defer conn.Close()


grpcClient = pb.NewStreamServerClient(conn)
route()
listValue()

}`

运行客户端

Copy

go run client.go stream server grpc 0 stream server grpc 1 stream server grpc 2 stream server grpc 3 stream server grpc 4

客户端不断从服务端获取数据

思考#

假如服务端不停发送数据,类似获取股票走势实时数据,客户端能自己停止获取数据吗?

答案:可以的

1.我们把服务端的ListValue方法稍微修改

Copy

`func (s *StreamService) ListValue(req *pb.SimpleRequest, srv pb.StreamServer_ListValueServer) error {
for n := 0; n < 15; n++ {

    err := srv.Send(&pb.StreamResponse{
        StreamValue: req.Data + strconv.Itoa(n),
    })
    if err != nil {
        return err
    }
    log.Println(n)
    time.Sleep(1 * time.Second)
}
return nil

}`

2.再把客户端调用ListValue方法的实现稍作修改,就可以得到结果了

Copy

`func listValue() {

req := pb.SimpleRequest{
    Data: "stream server grpc ",
}


stream, err := grpcClient.ListValue(context.Background(), &req)
if err != nil {
    log.Fatalf("Call ListStr err: %v", err)
}
for {
    
    res, err := stream.Recv()
    
    if err == io.EOF {
        break
    }
    if err != nil {
        log.Fatalf("ListStr get stream err: %v", err)
    }
    
    log.Println(res.StreamValue)
    break
}


stream.CloseSend()

}`

只需要调用CloseSend()方法,就可以关闭服务端的stream,让它停止发送数据。值得注意的是,调用CloseSend()后,若继续调用Recv(),会重新激活stream,接着当前的结果继续获取消息。

这能完美解决客户端暂停->继续获取数据的操作。

总结#

本篇介绍了服务端流式RPC的简单使用,客户端发起一个请求,服务端不停返回数据,直到服务端停止发送数据或客户端主动停止接收数据为止。下篇将介绍客户端流式RPC

教程源码地址:https://github.com/Bingjian-Zhu/go-grpc-example
参考:gRPC官方文档中文版