如何用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抓取某汽车网数据解析html存入excel示例
Dec 04 Python
Python基础教程之正则表达式基本语法以及re模块
Mar 25 Python
解读! Python在人工智能中的作用
Nov 14 Python
python提取具有某种特定字符串的行数据方法
Dec 11 Python
Python 利用pydub库操作音频文件的方法
Jan 09 Python
Django+zTree构建组织架构树的方法
Aug 21 Python
python3中rank函数的用法
Nov 27 Python
Python pyautogui模块实现鼠标键盘自动化方法详解
Feb 17 Python
10个示例带你掌握python中的元组
Nov 23 Python
Django中使用Celery的方法步骤
Dec 07 Python
Python3.9.1中使用split()的处理方法(推荐)
Feb 07 Python
Python闭包的定义和使用方法
Apr 11 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
php学习 字符串课件
2008/06/15 PHP
探讨php中遍历二维数组的几种方法详解
2013/06/08 PHP
php 如何获取数组第一个值
2013/08/06 PHP
PHP中使用虚代理实现延迟加载技术
2014/11/05 PHP
Yii2框架dropDownList下拉菜单用法实例分析
2016/07/18 PHP
php框架CodeIgniter主从数据库配置方法分析
2018/05/25 PHP
swoole_process实现进程池的方法示例
2018/10/29 PHP
js 表单验证方法(实用)
2009/04/28 Javascript
jquery radio 操作代码
2011/03/16 Javascript
jquery1.5.1中根据元素ID获取元素对象的代码
2011/04/02 Javascript
Node.js插件安装图文教程
2016/05/06 Javascript
jQuery 判断是否包含在数组中Array[]的方法
2016/08/03 Javascript
JS调用Android、Ios原生控件
2017/01/06 Javascript
移动端基础事件总结与应用
2017/01/12 Javascript
canvas实现简易的圆环进度条效果
2017/02/28 Javascript
Web开发中客户端的跳转与服务器端的跳转的区别
2017/03/05 Javascript
NodeJs模拟登陆正方教务
2017/04/28 NodeJs
移动端图片上传旋转、压缩问题的方法
2018/10/16 Javascript
微信小程序实现多个按钮的颜色状态转换
2019/02/15 Javascript
微信小程序实现弹出菜单动画
2019/06/21 Javascript
[02:16]DOTA2超级联赛专访Burning 逆袭需要抓住机会
2013/06/24 DOTA
[44:01]2018DOTA2亚洲邀请赛3月30日 小组赛B组 EG VS paiN
2018/03/31 DOTA
[38:39]完美世界DOTA2联赛循环赛 IO vs GXR BO2第二场 11.04
2020/11/05 DOTA
详解Django 时间与时区设置问题
2019/07/23 Python
Django 实现admin后台显示图片缩略图的例子
2019/07/28 Python
python的faker库用法
2019/11/28 Python
Pygame的程序开始示例代码
2020/05/07 Python
python中实现词云图的示例
2020/12/19 Python
《鸟的天堂》教学反思
2014/02/27 职场文书
煤矿安全生产责任书
2014/04/15 职场文书
土建工程师岗位职责
2014/06/10 职场文书
工会积极分子个人总结
2015/03/03 职场文书
无罪辩护词范文
2015/05/21 职场文书
会计岗位工作总结
2015/08/12 职场文书
《生物入侵者》教学反思
2016/02/16 职场文书
vue使用节流函数的踩坑实例指南
2021/05/20 Vue.js