python中使用grpc方法示例_在Python中使用gRPC的方法示例

本文介绍了在Python中使用gRPC的方法示例&＃xff0c;分享给大家&＃xff0c;具体如下&＃xff1a;

使用Protocol Buffers的跨平台RPC系统。

安装

使用 pip

pip install grpcio

pip install grpcio-tools googleapis-common-protos

gRPC由两个部分构成&＃xff0c;grpcio 和 gRPC 工具&＃xff0c; 后者是编译 protocol buffer 以及提供生成代码的插件。

使用

编写protocol buffer

使用 gRPC 首先需要做的是设计 protocol buffer。新建一个 msg.proto 文件。

syntax &＃61; "proto3";

service MsgService {

rpc GetMsg (MsgRequest) returns (MsgResponse){}

}

message MsgRequest {

string name &＃61; 1;

}

message MsgResponse {

string msg &＃61; 1;

}

以上面的这个消息服务为例&＃xff0c;首先是规定语法&＃xff0c;这里使用的是 proto3 的语法。接着使用 service 关键字定义服务&＃xff0c;gRPC 提供4种 RPC 类型的服务&＃xff0c;这里定义的是第一种单一请求单一回应&＃xff0c;类似普通的函数调用&＃xff0c;其他的使用到了 stream 关键字&＃xff0c;将其放在括号里&＃xff0c;代表这个数据是流数据。这个以后再来研究&＃xff0c;本次先设计一个简单的RPC。

之后定义两个 message &＃xff0c;一个是请求的结构&＃xff0c;一个是回应的结果。 这里表示这个数据结构是字符串&＃xff0c;protocol buffer 还可以定义为 int32&＃xff0c;int64&＃xff0c;double&＃xff0c;float 等等。这里赋予的初值可以随便填写&＃xff0c;实际使用中&＃xff0c;会被赋予新的值。

生成接口代码

因为之前安装好了一些辅助插件&＃xff0c;使用这里直接可以生成。

python -m grpc_tools.protoc -I . --pythoout&＃61;. --grpc_python_out&＃61;. msg.proto

这里会生成两个文件&＃xff0c; msg_pb2.py 和 msg_pb2_grpc.py 。这两个文件是为后续的服务端和客户端所用。前者是定义了一些变量&＃xff0c;例如 _MSGREQUEST 中就包含了请求函数的名字&＃xff0c;可接受的变量&＃xff0c;实际上还是 msg.proto 里定义的东西。

创建服务端

首先需要导入 RPC 必备的包&＃xff0c;以及刚才生成的两个文件。

import grpc

import msg_pb2

import msg_pb2_grpc

因为 RPC 应该长时间运行&＃xff0c;考虑到性能&＃xff0c;还需要用到并发的库。

from concurrent import futures

import time

_ONE_DAY_IN_SECONDS &＃61; 60 * 60 * 24

在 Server 中&＃xff0c;主要是实现服务&＃xff0c;按照 msg.proto 定义的&＃xff0c;这里需要写一个服务类 MsgServicer &＃xff0c;这个类需要实现之前定义的 GetMsg 。

class MsgServicer(msg_pb2_grpc.MsgServiceServicer):

def GetMsg(self, request, context):

print("Received name: %s" % request.name)

return msg_pb2.MsgResponse(msg&＃61;&＃39;Hello, %s!&＃39; % request.name)

GetMsg 接收到的请求是在 request 中&＃xff0c; msg.proto 中定义的 name 就是 request.name &＃xff0c;接着在 GetMsg 中设计 msg.proto 中定义的 MsgResponse 。

之后实现启动服务的部分即可。

def serve():

server &＃61; grpc.server(futures.ThreadPoolExecutor(max_workers&＃61;10))

msg_pb2_grpc.add_MsgServiceServicer_to_server(MsgServicer(), server)

server.add_insecure_port(&＃39;[::]:50051&＃39;)

server.start()

try:

while True:

time.sleep(_ONE_DAY_IN_SECONDS)

except KeyboardInterrupt:

server.stop(0)

通过并发库&＃xff0c;将服务端放到多进程里运行。

完整 msg_server.py 代码如下

import grpc

import msg_pb2

import msg_pb2_grpc

from concurrent import futures

import time

_ONE_DAY_IN_SECONDS &＃61; 60 * 60 * 24

class MsgServicer(msg_pb2_grpc.MsgServiceServicer):

def GetMsg(self, request, context):

print("Received name: %s" % request.name)

return msg_pb2.MsgResponse(msg&＃61;&＃39;Hello, %s!&＃39; % request.name)

def serve():

server &＃61; grpc.server(futures.ThreadPoolExecutor(max_workers&＃61;10))

msg_pb2_grpc.add_MsgServiceServicer_to_server(MsgServicer(), server)

server.add_insecure_port(&＃39;[::]:50051&＃39;)

server.start()

try:

while True:

time.sleep(_ONE_DAY_IN_SECONDS)

except KeyboardInterrupt:

server.stop(0)

if __name__ &＃61;&＃61; &＃39;__main__&＃39;:

serve()

创建客户端

客户端相对简单一些&＃xff0c;这里我写了一个简单的客户端。

import grpc

import msg_pb2

import msg_pb2_grpc

def run():

# NOTE(gRPC Python Team): .close() is possible on a channel and should be

# used in circumstances in which the with statement does not fit the needs

# of the code.

with grpc.insecure_channel(&＃39;localhost:50051&＃39;) as channel:

stub &＃61; msg_pb2_grpc.MsgServiceStub(channel)

response &＃61; stub.GetMsg(msg_pb2.MsgRequest(name&＃61;&＃39;world&＃39;))

print("Client received: " &＃43; response.msg)

if __name__ &＃61;&＃61; &＃39;__main__&＃39;:

run()

使用 grpc.insecure_channel(&＃39;localhost:50051&＃39;) 进行连接 服务端&＃xff0c; 接着在这个 channel 上创建 stub &＃xff0c; 在 msg_pb2_grpc 里可以找到 MsgServiceStub 这个类相关信息。这个 stub 可以调用远程的 GetMsg 函数。 MsgRequest 中的 name 即 msg.proto 中定义的数据。在回应里可以得到 msg.proto 中定义的 msg 。

运行

首先运行 python msg_server.py 启动服务端&＃xff0c;接着运行 python msg_client.py 机会看到客户端接收到了服务端传来的消息。以上就是一个简单的 RPC 的使用。

总结

这里只是简单的用了一下 gRPC&＃xff0c;关于另外三种模式&＃xff0c;还在摸索。比起gRPC&＃xff0c;我感觉简单 RestFul 更讨我喜欢。

以上就是本文的全部内容&＃xff0c;希望对大家的学习有所帮助&＃xff0c;也希望大家多多支持我们。

时间&＃xff1a; 2018-08-06