gRPC入门学习

向右看齐 2021-09-23 09:26 389阅读 0赞

### gRPC入门学习 ###

*  什么是gRPC
 *  简单的远程调用架构
 *  数据结构以及函数接口的定义-- protocol buffer
 *   *  二维列表的定义

# 什么是gRPC #

一个远程调用的框架，基于Client-Server模型，用protocol buffer来定义传递数据的数据类型  
（自己的理解，官方定义请查看gRPC官网）  
以下学习基于Python，因为配环境比较简单。

# 简单的远程调用架构 #

以hello world为例

*  helloworld.proto：用于定义需要实现的service（服务，即一些写在server的方法，可被client调用），定义client和server间传递的**数据类型**。
 *  helloword\_server.py：服务器端，定义可供客户端调用的方法
 *  helloword\_client.py：客户端，可以调用方法，获得服务器端返回的结果

# 数据结构以及函数接口的定义-- protocol buffer #

[protocol buffer 参考网址][protocol buffer]

protocol buffer定义在.proto文件中，可以用vscode编辑，vscode可以下载proto的高亮插件。

经过protocol buffer compiler编译后可以生成data access classes类即客户端和服务器可以访问的类。这个类中提供了对你定义的变量的访问。假如你有变量`name`，那么你生成的类中就有`name()`和`set_name()`，分别提供对name的访问和修改。  
这个类还可以提供将类保存成字节，同时也提供将其从字节转换成类。如：

person.SerializeToOstream(&output)
    person.ParseFromIstream(&input)

接下来说明protocol buffer定义的两种结构：message（数据类型）以及service（函数接口）

*  message:  
    包含一系列数据类型的数据结构  
    基本的数据类型：bool, int32, float, double, string, enum  
    每个元素旁的"=1, =2"确定了这个域在二进制编码中使用的唯一的“tag”  
    每一个field（变量）必须使用下列几种修饰符:
    
     *  required：该变量的值必须要被指定
     *  optional：变量的值可有可无
     *  repeated：域可以被重复任何次数
 *  service  
    service的名字就是在server里面的类的名字  
    service里面定义的rpc即在server里面的类里需要定义的方法，service指定了函数的名称，参数类型以及返回的参数类型  
    注意参数只能是一个，且必须为message，返回也是一样
 *  产生client和server的代码（指这两个文件需要使用到的类，可以理解为编译Protocol Buffer）

> python -m grpc\_tools.protoc -I…/…/protos --python\_out=. --grpc\_python\_out=. …/…/protos/route\_guide.proto

\-m 将库中的python模块用作脚本去运行  
\-I 指定当前的目录

假如protocol buffer的名字是 `helloworld.proto`  
那么产生两个文件  
`helloworld_pb2.py`：主要包括在proto定义的数据类型  
`helloworld_pb2_grpc.py`：主要包括grpc的一些操作，如添加server，添加stub等

## 二维列表的定义 ##

二维数据可以看作是许多一维列表的集合

因此可先定义一维的数据，repeated修饰符表示数据类型可以重复多次，因此加上repeated就相当于创建了列表，如下：

message Data{
        repeated double data=1;
    }

上述代码创建了一维的列表,二维列表即是许多一维列表的的集合，因此可定义如下

message two_dimension_list{
        repeated Data list=1;
    }

[protocol buffer]: https://developers.google.com/protocol-buffers/docs/overview