如何用Python搭建gRPC服务


Posted in Python onJune 30, 2021
目录
  • 一、概述
  • 二、安装python需要的库
  • 三、定义gRPC的接口
  • 四、使用 protoc 和相应的插件编译生成对应语言的代码
  • 五、编写grpc的服务端代码
  • 六、编写gRPC客户端的代码
  • 七、调用测试
  • 八、gRPC的使用总结

一、概述

一个gRPC服务的大体结构图为:

如何用Python搭建gRPC服务

图一表明,grpc的服务是跨语言的,但需要遵循相同的协议(proto)。相比于REST服务,gPRC 的一个很明显的优势是它使用了二进制编码,所以它比 JSON/HTTP 更快,且有清晰的接口规范以及支持流式传输,但它的实现相比rest服务要稍微要复杂一些,下面简单介绍搭建gRPC服务的步骤。

二、安装python需要的库

pip install grpcio

pip install grpcio-tools  

pip install protobuf

三、定义gRPC的接口

创建 gRPC 服务的第一步是在.proto 文件中定义好接口,proto是一个协议文件,客户端和服务器的通信接口正是通过proto文件协定的,可以根据不同语言生成对应语言的代码文件。这个协议文件主要就是定义好服务(service)接口,以及请求参数和相应结果的数据结构,下面是一个简单的例子。

syntax = "proto3";
​
option cc_generic_services = true;
​
//定义服务接口
service GrpcService {
    rpc hello (HelloRequest) returns (HelloResponse) {}  //一个服务中可以定义多个接口,也就是多个函数功能
}
​
//请求的参数
message HelloRequest {
    string data = 1;   //数字1,2是参数的位置顺序,并不是对参数赋值
    Skill skill = 2;  //支持自定义的数据格式,非常灵活
};
​
//返回的对象
message HelloResponse {
    string result = 1;
    map<string, int32> map_result = 2; //支持map数据格式,类似dict
};
​
message Skill {
    string name = 1;
};

四、使用 protoc 和相应的插件编译生成对应语言的代码

python -m grpc_tools.protoc -I ./ --python_out=./ --grpc_python_out=. ./hello.proto

利用编译工具把proto文件转化成py文件,直接在当前文件目录下运行上述代码即可。

1.-I 指定proto所在目录

2.-m 指定通过protoc生成py文件

3.--python_out指定生成py文件的输出路径

4.hello.proto 输入的proto文件

执行上述命令后,生成hello_pb2.py 和hello_pb2_grpc.py这两个文件。

五、编写grpc的服务端代码

#! /usr/bin/env python
# coding=utf8
​
import time
from concurrent import futures
​
import grpc
​
from gRPC_example import hello_pb2_grpc, hello_pb2
​
_ONE_DAY_IN_SECONDS = 60 * 60 * 24
​
​
class TestService(hello_pb2_grpc.GrpcServiceServicer):
    '''
    继承GrpcServiceServicer,实现hello方法
    '''
    def __init__(self):
        pass
​
    def hello(self, request, context):
        '''
        具体实现hello的方法,并按照pb的返回对象构造HelloResponse返回
        :param request:
        :param context:
        :return:
        '''
        result = request.data + request.skill.name + " this is gprc test service"
        list_result = {"12": 1232}
        return hello_pb2.HelloResponse(result=str(result),
                                       map_result=list_result)
​
def run():
    '''
    模拟服务启动
    :return:
    '''
    server = grpc.server(futures.ThreadPoolExecutor(max_workers=10))
    hello_pb2_grpc.add_GrpcServiceServicer_to_server(TestService(),server)
    server.add_insecure_port('[::]:50052')
    server.start()
    print("start service...")
    try:
        while True:
            time.sleep(_ONE_DAY_IN_SECONDS)
    except KeyboardInterrupt:
        server.stop(0)
​
​
if __name__ == '__main__':
    run()

在服务端侧,需要实现hello的方法来满足proto文件中GrpcService的接口需求,hello方法的传入参数,是在proto文件中定义的HelloRequest,context是保留字段,不用管,返回参数则是在proto中定义的HelloResponse,服务启动的代码是标准的,可以根据需求修改提供服务的ip地址以及端口号。

六、编写gRPC客户端的代码

#! /usr/bin/env python
# coding=utf8
​
import grpc
​
from gRPC_example import #! /usr/bin/env python
# coding=utf8
​
import grpc
​
from gRPC_example import hello_pb2_grpc, hello_pb2
​
​
def run():
    '''
    模拟请求服务方法信息
    :return:
    '''
    conn=grpc.insecure_channel('localhost:50052')
    client = hello_pb2_grpc.GrpcServiceStub(channel=conn)
    skill = hello_pb2.Skill(name="engineer")
    request = hello_pb2.HelloRequest(data="xiao gang", skill=skill)
    respnse = client.hello(request)
    print("received:",respnse.result)
​
​
if __name__ == '__main__':
    run()
​
​
def run():
    '''
    模拟请求服务方法信息
    :return:
    '''
    conn=grpc.insecure_channel('localhost:50052')
    client = hello_pb2_grpc.GrpcServiceStub(channel=conn)
    skill = hello_pb2.Skill(name="engineer")
    request = hello_pb2.HelloRequest(data="xiao gang", skill=skill)
    response = client.hello(request)
    print("received:",response.result)
​
​
if __name__ == '__main__':
    run()

客户端侧代码的实现比较简单,首先定义好访问ip和端口号,然后定义好HelloRequest数据结构,远程调用hello即可。需要强调的是,客户端和服务端一定要import相同proto文件编译生成的hello_pb2_grpc, hello_pb2模块,即使服务端和客户端使用的语言不一样,这也是grpc接口规范一致的体现。

七、调用测试

先启动运行服务端的代码,再启动运行客户端的代码即可。

八、gRPC的使用总结

  • 定义好接口文档
  • 工具生成服务端/客户端代码
  • 服务端补充业务代码
  • 客户端建立 gRPC 连接后,使用自动生成的代码调用函数
  • 编译、运行

以上就是如何用Python搭建gRPC服务的详细内容,更多关于Python搭建gRPC服务的资料请关注三水点靠木其它相关文章!

Python 相关文章推荐
详解Python中dict与set的使用
Aug 10 Python
Python实现利用最大公约数求三个正整数的最小公倍数示例
Sep 30 Python
Python实现矩阵加法和乘法的方法分析
Dec 19 Python
python将文本中的空格替换为换行的方法
Mar 19 Python
Python使用requests提交HTTP表单的方法
Dec 26 Python
Python mutiprocessing多线程池pool操作示例
Jan 30 Python
python网络编程 使用UDP、TCP协议收发信息详解
Aug 29 Python
Django自定义用户表+自定义admin后台中的字段实例
Nov 18 Python
Keras之自定义损失(loss)函数用法说明
Jun 10 Python
Python2手动安装更新pip过程实例解析
Jul 16 Python
基于tensorflow __init__、build 和call的使用小结
Feb 26 Python
pytorch 实现多个Dataloader同时训练
May 29 Python
python not运算符的实例用法
Jun 30 #Python
pycharm部署django项目到云服务器的详细流程
Python快速实现一键抠图功能的全过程
总结python多进程multiprocessing的相关知识
Jun 29 #Python
python 字典和列表嵌套用法详解
Jun 29 #Python
Python连接Postgres/Mysql/Mongo数据库基本操作大全
5行Python代码实现一键批量扣图
You might like
人工智能开始玩《星际争霸2》 你的操作跟得上吗?
2017/08/11 星际争霸
《被神捡到的男人》动画化计划进行中!
2020/03/06 日漫
Ha0k 0.3 PHP 网页木马修改版
2009/10/11 PHP
php存储过程调用实例代码
2013/02/03 PHP
基于php iconv函数的使用详解
2013/06/09 PHP
php遍历树的常用方法汇总
2015/06/18 PHP
Smarty简单生成表单元素的方法示例
2016/05/23 PHP
PHP打印输出函数汇总
2016/08/28 PHP
new Date()问题在ie8下面的处理方法
2014/07/31 Javascript
jQuery带箭头提示框tooltips插件集锦
2014/11/17 Javascript
JavaScript拖动层Div代码
2017/03/01 Javascript
详解Vue 动态添加模板的几种方法
2017/04/25 Javascript
Vue之Vue.set动态新增对象属性方法
2018/02/23 Javascript
JS同步、异步、延迟加载的方法
2018/05/05 Javascript
vue 监听屏幕高度的实例
2018/09/05 Javascript
微信小程序自定义组件传值 页面和组件相互传数据操作示例
2019/05/05 Javascript
jQuery zTree树插件的使用教程
2019/08/16 jQuery
layui清除radio的选中状态实例
2019/11/14 Javascript
Python中使用装饰器时需要注意的一些问题
2015/05/11 Python
Python的GUI框架PySide的安装配置教程
2016/02/16 Python
python脚本设置超时机制系统时间的方法
2016/02/21 Python
python中requests使用代理proxies方法介绍
2017/10/25 Python
Python+matplotlib实现计算两个信号的交叉谱密度实例
2018/01/08 Python
Python实现随机漫步功能
2018/07/09 Python
Python爬取商家联系电话以及各种数据的方法
2018/11/10 Python
python url 参数修改方法
2018/12/26 Python
Python 实现自动完成A4标签排版打印功能
2020/04/09 Python
基于python实现简单C/S模式代码实例
2020/09/14 Python
CSS实现进度条和订单进度条的示例
2020/11/05 HTML / CSS
DJI大疆德国官方商城:大疆无人机
2018/09/01 全球购物
自荐信包含哪些内容
2013/10/30 职场文书
进步之星获奖感言
2014/02/22 职场文书
2015暑假假期总结
2015/07/13 职场文书
演讲稿之感恩老师(三篇范文)
2019/09/06 职场文书
pytorch常用数据类型所占字节数对照表一览
2021/05/17 Python
教你使用pyinstaller打包Python教程
2021/05/27 Python