如何用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访问纯真IP数据库脚本分享
Jun 29 Python
python 多线程实现检测服务器在线情况
Nov 25 Python
Python编程中的文件读写及相关的文件对象方法讲解
Jan 19 Python
Linux RedHat下安装Python2.7开发环境
May 20 Python
Python贪心算法实例小结
Apr 22 Python
Django forms组件的使用教程
Oct 08 Python
利用python和ffmpeg 批量将其他图片转换为.yuv格式的方法
Jan 08 Python
python多继承(钻石继承)问题和解决方法简单示例
Oct 21 Python
将python依赖包打包成window下可执行文件bat方式
Dec 26 Python
Python3 Click模块的使用方法详解
Feb 12 Python
python Canny边缘检测算法的实现
Apr 24 Python
python 逆向爬虫正确调用 JAR 加密逻辑
Jan 12 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
jQuery 事件队列调整方法
2009/09/18 Javascript
JavaScript EasyPager 分页函数
2011/05/25 Javascript
常见效果实现之返回顶部(结合淡入、淡出、减速滚动)
2012/01/04 Javascript
nodejs实现HTTPS发起POST请求
2015/04/23 NodeJs
跟我学习javascript的浮点数精度
2015/11/16 Javascript
javascript创建对象、对象继承的实用方式详解
2016/03/08 Javascript
Web制作验证码功能实例代码
2017/06/19 Javascript
Node.js实现文件上传的示例
2017/06/28 Javascript
webpack中CommonsChunkPlugin详细教程(小结)
2017/11/09 Javascript
初识 Vue.js 中的 *.Vue文件
2017/11/22 Javascript
VUE重点问题总结
2018/03/19 Javascript
详解vue-loader在项目中是如何配置的
2018/06/04 Javascript
axios对请求各种异常情况处理的封装方法
2018/09/25 Javascript
史上最为详细的javascript继承(推荐)
2019/05/18 Javascript
JavaScript工具库之Lodash详解
2019/06/15 Javascript
python访问纯真IP数据库的代码
2011/05/19 Python
python获取糗百图片代码实例
2013/12/18 Python
详解tensorflow载入数据的三种方式
2018/04/24 Python
Python面向对象之类的内置attr属性示例
2018/12/14 Python
详解Python学习之安装pandas
2019/04/16 Python
python机器学习库scikit-learn:SVR的基本应用
2019/06/26 Python
Django中的FBV和CBV用法详解
2019/09/15 Python
简单了解python字符串前面加r,u的含义
2019/12/26 Python
Python 将json序列化后的字符串转换成字典(推荐)
2020/01/06 Python
Tensorflow实现将标签变为one-hot形式
2020/05/22 Python
python报错: 'list' object has no attribute 'shape'的解决
2020/07/15 Python
美国领先的奢侈美容零售商:Bluemercury
2017/07/26 全球购物
通信工程毕业生自荐信
2013/11/01 职场文书
银行见习期自我鉴定
2014/01/29 职场文书
中学生操行评语
2014/04/24 职场文书
不听老师话的万能检讨书
2014/10/04 职场文书
对学校的意见和建议
2015/06/04 职场文书
运动会通讯稿200字
2015/07/20 职场文书
详解MySQL的Seconds_Behind_Master
2021/05/18 MySQL
MySQL 不等于的三种使用及区别
2021/06/03 MySQL
DSP接收机前端设想
2022/04/05 无线电