python gRPC接口调用

gRPC

gRPC 是 Google 开源的基于 Protobuf 和 Http2.0 协议的通信框架。

• gRPC官网

https://www.grpc.io/docs/quickstart/python/

grpc-git：https://github.com/grpc/grpc

  

•  python实现gRPC接口调用的方法步骤

2.1 安装第三方包：grpcio、protobuf、grpcio_tools

pip install grpcio
pip install protobuf
pip install grpcio_tools    # python下的protoc编译器

2.2 编写proto文件

参考protobuf语法编写.proto文件

2.3 编译proto文件

将protoc文件转化为pb2和pb2_grpc文件，操作步骤如下：

• 命令：

python3  -m  grpc_tools.protoc  --python_out=.  --grpc_python_out=.  -I. xxx.proto  -I=/workspace  -I=xxx/yyy/

#说明：
-I=：在proto文件中远程调用的内容，导入路径为实际调用的上一级目录即可。
python_out：指定xxx_pb2.py的输出路径，编译生成处理protobuf相关的代码路径。传入.，则默认生成到当前目录。
grpc_python_out：指定xxx_pb2_grpc.py的输出路径，编译生成处理grpc相关的代码路径，传入.，则默认生成到当前目录。
grpc_tools.protoc：工具包，刚安装的。
-I：这个参数指定协议文件的查找目录。
 
# 生成的文件中：
xxx_pb2.py：里面有消息序列化类。是用来和protobuf数据进行交互。
xxx_pb2_grpc.py：包含了服务器Stub类和客户端Stub类，以及待实现的服务RPC接口。是用来和grpc进行交互。

# 若报错-缺少文件，则需要找对应文件，然后使用 "-I=" 导入

2.4 写server端代码

demo如下：

# coding:utf-8

import grpc
import json
from concurrent import futures
import xxx_pb2,yyy_pb2_grpc

_HOST = ''  # todo
_PORT = ''  # todo


# 实现 proto 文件中定义的 xxxServicer
class xxxServer(yyy_pb2_grpc.xxxServicer):
    # 实现 proto 文件中定义的GRPC调用
    def SendRequest(self, request, context):
        json_response = xxx_pb2.xxxResponse()
        json_response.rst_string = json.dumps({"ret": "Hi grpc"})
        return json_response


def serve():
    # 启动GRPC服务,监听特定的端口
    server = grpc.server(futures.ThreadPoolExecutor(max_workers=10))  # 多线程服务器
    yyy_pb2_grpc.add_xxxServicer_to_server(xxxServer(), server)  # 注册本地服务
    server.add_insecure_port("{0}:{1}".format(_HOST, _PORT))  # 监听端口
    server.start()  # 开始接收请求进行服务
    try:
        while True:
            time.sleep(60 * 60 * 24)  # one day in seconds
    except KeyboardInterrupt:
        server.stop(0)


if __name__ == '__main__':
    serve()

 

2.5 写client端代码

demo如下：

# coding:utf-8

import grpc
import xxx_pb2, yyy_pb2_grpc

_HOST = ''  # todo
_PORT = ''  # todo


def main():
    with grpc.insecure_channel("{0}:{1}".format(_HOST, _PORT)) as channel:
        client = yyy_pb2_grpc.xxxStub(channel=channel)
        response = client.xxxMessage(xxx_pb2.xxxRequest())
    print("received: " + response.message + response.result)


if __name__ == '__main__':
    main()

 

2.6 完成

参考demo实际过程：https://blog.csdn.net/sunt2018/article/details/90176015

 

 

• gRPC四种通信方式

根据不同的业务场景, grpc 支持 4 种通信方式:

• 客服端一次请求, 服务器一次应答
• 客服端一次请求, 服务器多次应答(流式)
• 客服端多次请求(流式), 服务器一次应答
• 客服端多次请求(流式), 服务器多次应答(流式)

参考demo实际过程： https://www.jianshu.com/p/43fdfeb105ff?from=timeline&isappinstalled=0

 

 

protoc

• protoc3官网

https://developers.google.com/protocol-buffers/docs/proto3

 

• protobuf数据格式

protobuf是Google开源的一款类似于Json,XML数据交换格式，其内部数据是纯二进制格式，不依赖于语言和平台，具有简单，数据量小，快速等优点。（是使用google规定的proto协议定义语言，之后使用proto的工具对代码进行‘编译’，生成对应的各个平台的源代码，后续可以使用这些源代码进行工作。）目前用于序列化于反序列化官方支持的语言有C++，C#，JAVA，PYTHON。适用于大小在1M以内的数据。可以使用prorobuf将内容序列化后保存在文件中，下次使用的时候，加载文件，反序列化后就可以直接使用了。

 

• python-protobuf

1. 在python里也需要proto文件生成对应的代码，才能通过grpc/restful协议调后端的代码
2. pb其实就是协议格式/内容，restful/rpc是协议
3. 无关乎语言， 前端(python或go)， 跟后端(go或者c++) 通信的时候，都要告知发送的内容的格式--这个格式就是pb