如何用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中的高级数据结构详解
Mar 27 Python
使用Python的Django框架结合jQuery实现AJAX购物车页面
Apr 11 Python
Python中的with语句与上下文管理器学习总结
Jun 28 Python
python中的字典操作及字典函数
Jan 03 Python
Python基于csv模块实现读取与写入csv数据的方法
Jan 18 Python
Python hashlib模块用法实例分析
Jun 12 Python
python实现可视化动态CPU性能监控
Jun 21 Python
为什么str(float)在Python 3中比Python 2返回更多的数字
Oct 16 Python
python数据库编程 ODBC方式实现通讯录
Mar 27 Python
Python模拟登入的N种方式(建议收藏)
May 31 Python
python如何进入交互模式
Jul 06 Python
Python 中 sorted 如何自定义比较逻辑
Feb 02 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和js如何通过json互相传递数据相关问题探讨
2013/02/26 PHP
支持中文的PHP按字符串长度分割成数组代码
2015/05/17 PHP
PHP 的Opcache加速的使用方法
2017/12/29 PHP
JavaScript面向对象之体会[总结]
2008/11/13 Javascript
Jquery Ajax 学习实例2 向页面发出请求 返回JSon格式数据
2010/03/15 Javascript
jQuery bxCarousel实现图片滚动切换效果示例代码
2013/05/15 Javascript
Jquery AJAX POST与GET之间的区别
2013/11/14 Javascript
javasciprt下jquery函数$.post执行无响应的解决方法
2014/03/13 Javascript
JS高级调试技巧:捕获和分析 JavaScript Error详解
2014/03/16 Javascript
JavaScript中的Repaint和Reflow用法详解
2015/07/27 Javascript
浅谈js数据类型判断与数组判断
2016/08/29 Javascript
javascript实现去除HTML标签的方法
2016/12/26 Javascript
详解vue跨组件通信的几种方法
2017/06/15 Javascript
详谈表单重复提交的三种情况及解决方法
2017/08/16 Javascript
如何以Angular的姿势打开Font-Awesome详解
2018/04/22 Javascript
jQuery实现每隔一段时间自动更换样式的方法分析
2018/05/03 jQuery
vue中上传视频或图片或图片和文字一起到后端的解决方法
2019/12/01 Javascript
如何利用nodejs实现命令行游戏
2020/11/24 NodeJs
[47:55]Ti4第二日主赛事败者组 NaVi vs EG 1
2014/07/20 DOTA
[48:20]OpTic vs Serenity 2018国际邀请赛小组赛BO2 第二场 8.18
2018/08/19 DOTA
python判断端口是否打开的实现代码
2013/02/10 Python
ptyhon实现sitemap生成示例
2014/03/30 Python
Python 数据处理库 pandas进阶教程
2018/04/21 Python
用Anaconda安装本地python包的方法及路径问题(图文)
2019/07/16 Python
使用Python画出小人发射爱心的代码
2019/11/23 Python
Python socket服务常用操作代码实例
2020/06/22 Python
canvas实现图片马赛克的示例代码
2018/03/26 HTML / CSS
荷兰家电购物网站:Expert.nl
2020/01/18 全球购物
武汉世纪畅想数字传播有限公司.NET笔试题
2014/07/22 面试题
土木工程毕业生自荐信
2013/11/12 职场文书
检察官就职演讲稿
2014/01/13 职场文书
小学安全教育材料
2014/02/17 职场文书
期终自我鉴定
2014/02/17 职场文书
2015年春节标语口号
2014/12/09 职场文书
校友回访母校寄语
2015/02/26 职场文书
Java获取e.printStackTrace()打印的信息方式
2021/08/07 Java/Android