grpc在django中的使用

要调用RPC接口,python提供了叁个框架grpc,那是google开源的

gRPC 简介:

gRPC 是大器晚成款高质量、开源的 RPC 框架,产自 谷歌,基于 ProtoBuf
种类化左券实行支付,帮忙多样语言(Golang、Python、Java等卡塔尔,本篇只介绍
Python 的 gRPC 使用。因为 gRPC 对 HTTP/2 公约的扶助使其在 Android、IOS
等顾客端后端服务的开采世界具有卓绝的前程。gRPC
提供了风流洒脱种简单的艺术来定义服务,同期客商端能够丰裕利用 HTTP/2 stream
的特征,进而助长节省带宽、裁减 TCP 的连接次数、节省CPU的应用等。

明天在做微服务这一块,后端与java合作,本人是python的,所以构思采纳grpc,一点寻思是grpc是http2.0,另一些虚构是不行必要的:卡塔尔国

rpc相关文书档案:

安装:

  1. gRPC 的安装:

$ pip install grpcio

  1. 安装 ProtoBuf 相关的 python 依赖库:

$ pip install protobuf

  1. 设置 python grpc 的 protobuf 编写翻译工具:

$ pip install grpcio-tools


https://grpc.io/docs/tutorials/basic/python.html

实践:

上面我们使用 gRPC
定义二个接口,该接口达成对传播的数据实行大写的格式化管理。

  • 创立项目 python demo 工程:
![](https://upload-images.jianshu.io/upload_images/208550-bd34d08e0c12cdeb.png)

Paste_Image.png
  1. client目录下的 main.py 完结了客商端用于发送数据并打字与印刷接受到 server
    端管理后的数据
  1. server 目录下的 main.py 完成了 server
    端用于吸收接纳客商端发送的数额,并对数码进行大写管理后回来给客户端
  2. example 包用于编写 proto 文件并扭转 data 接口
  • 定义 gRPC 接口:

syntax = "proto3";
package example;
service FormatData {
  rpc DoFormat(Data) returns (Data){}
}
message Data {
  string text = 1;
}
  • 编译 protobuf:

$ python -m grpc_tools.protoc -I. –python_out=.
–grpc_python_out=. ./data.proto #在 example
目录中执行编写翻译,会扭转:data_pb2.py 与 data_pb2_grpc.py

  • 实现 server 端:

#! /usr/bin/env python
# -*- coding: utf-8 -*-
import grpc
import time
from concurrent import futures
from example import data_pb2, data_pb2_grpc

_ONE_DAY_IN_SECONDS = 60 * 60 * 24
_HOST = 'localhost'
_PORT = '8080'

class FormatData(data_pb2_grpc.FormatDataServicer):
    def DoFormat(self, request, context):
        str = request.text
        return data_pb2.Data(text=str.upper())

def serve():
    grpcServer = grpc.server(futures.ThreadPoolExecutor(max_workers=4))
    data_pb2_grpc.add_FormatDataServicer_to_server(FormatData(), grpcServer)
    grpcServer.add_insecure_port(_HOST + ':' + _PORT)
    grpcServer.start()
    try:
        while True:
            time.sleep(_ONE_DAY_IN_SECONDS)
    except KeyboardInterrupt:
        grpcServer.stop(0)

if __name__ == '__main__':
    serve()
  • 实现 client 端:

#! /usr/bin/env python
# -*- coding: utf-8 -*-
import grpc
from example import data_pb2, data_pb2_grpc

_HOST = 'localhost'
_PORT = '8080'

def run():
    conn = grpc.insecure_channel(_HOST + ':' + _PORT)
    client = data_pb2_grpc.FormatDataStub(channel=conn)
    response = client.DoFormat(data_pb2.Data(text='hello,world!'))
    print("received: " + response.text)

if __name__ == '__main__':
    run()
  • 奉行验证结果:
  1. 先运行 server,之后再实施 client
  1. client 侧调整台假若打字与印刷的结果为:“received: HELLO,WO中华VLD!” ,表明gRPC 接口定义成功

  • 沟通能够加 QQ 群:397234385
  • 抑或 QQ 扫码入群:

图片 1

qq群.jpg

初阶尝试是在python脚本中与java对接接口,平时官方文书档案的后生可畏顿学习,成功调通了接口

 

https://grpc.io/docs/quickstart/python.html
唯独在教程里clone的不胜项目实际是大,不分明哪些是须要的,经过测验后交由须要的:

亟待安装的python包如下:

  • grpcio==1.4.0
  • grpcio-tools==1.4.0
  • xxx.proto 对的,只须要那样二个文件
  • 编译xxx.proto的命令

1.grpc安装

python -m grpc_tools.protoc -I./protos –python_out=.
–grpc_python_out=. ./protos/xxx.proto

pip
install grpcio

此处解释一下,python(不解释) -m(也不解释)
grpc_tools.protoc(上边安装的三方)
-I./protos(标志当前目录下的protos文件夹,xxx.proto需求在这里个文件夹中)
–python_out=.(当前目录生成输出文件)
–grpc_python_out=.(当前目录生成grpc文件)
./protos/xxx.proto(xxx.proto的相对路线)

 

在配置好grpc的xxx.proto之后要保管java那边的这么些文件要生龙活虎致(而不是成套,service开首供给完全相通)

2.grpc的python
protobuf相关的编译工具

运作命令后会生成xxx_pb2.py 和
xxx_pb2_grpc.py五个公文,接下去入眼来了(拍桌子)

pip install
grpcio-tools

自笔者既想用django的model又想用grpc该怎么做吧,django是叁个服务,grpc是二个劳务,间接暴力把grpc代码加入django是无法使用models和views的。

 

缓慢解决形式正是在greeter_server.py中(那几个文件不知晓请看上边的链接)加载django,差不离如下:

3.protobuf相关python依赖库

import os
from concurrent import futures

import grpc
import time

import bus_pb2
import bus_pb2_grpc

import django

os.environ.setdefault("DJANGO_SETTINGS_MODULE", "xxx.settings")

django.setup()

from enterprise.views import enterprise_list, add_enterprise

_ONE_DAY_IN_SECONDS = 60 * 60 * 24


class Greeter(bus_pb2_grpc.BusInfoServicer):
    def BusMethod(self, request, context):
        if request.method == 'e':
            response = enterprise_list(request)
            return bus_pb2.BusReply(data=response['data'], code=response['code'], message=response['msg'])
        elif request.method == 'a':
            response = add_enterprise(request)
            return bus_pb2.BusReply(message=response['msg'])
        return bus_pb2.BusReply(message='')


if __name__ == '__main__':
    server = grpc.server(futures.ThreadPoolExecutor(max_workers=10))
    bus_pb2_grpc.add_BusInfoServicer_to_server(Greeter(), server)
    server.add_insecure_port('0.0.0.0:50051')
    server.start()
    try:
        while True:
            time.sleep(_ONE_DAY_IN_SECONDS)
    except KeyboardInterrupt:
        server.stop(0)

pip install
protobuf

运营时只要求周转该脚本就可以,django服务不必启用

 

4.部分多如牛毛原型的生成python类的群集:

pip install
googleapis-common-protos

 

 

编写翻译protobuf文件:使用以下命令生成Python代码:

python3 -m
grpc_tools.protoc -I<指标路线目录> –python_out=.
–grpc_python_out=<目的文件所在目录路线>
<目的文件data.proto>

python3 -m
grpc_tools.protoc -I. –python_out=. –grpc_python_out=.
data.proto

 

 

注意:protobuf文本,为定义服务接口代码文件,这里是data.proto

会生成:data_pb2.py
与 data_pb2_grpc.py

data_pb2.py是劳动接口映射

data_pb2_grpc.py方法映射

 

protobuf内容示例:

syntax = "proto3";
package grpcDemo;

message HelloRequest {
   string name = 1;
}

message HelloReply {
   string message = 1;
}


service gRPC {
  rpc SayHello (HelloRequest) returns (HelloReply) {}
}

接口调用内容示例:

# -*- coding: utf-8 -*-
import grpc
import data_pb2,data_pb2_grpc

_HOST = 'localhost'
_PORT = '8080'

def run():
    conn = grpc.insecure_channel(_HOST + ':' + _PORT)
    client = data_pb2_grpc.gRPCStub(channel=conn)
    response = client.SayHello(data_pb2.HelloRequest(name='hello,world!'))
    print("received: " + response.text)

if __name__ == '__main__':
    run()