在Python中使用gRPC的方法示例

 更新时间:2018年08月08日 08:32:09   作者:Xin Qiu  
这篇文章主要介绍了在Python中使用gRPC的方法示例,小编觉得挺不错的,现在分享给大家,也给大家做个参考。一起跟随小编过来看看吧

本文介绍了在Python中使用gRPC的方法示例,分享给大家,具体如下:

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

安装

使用 pip

pip install grpcio
pip install grpcio-tools googleapis-common-protos

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

使用

编写protocol buffer

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

syntax = "proto3";

service MsgService {
 rpc GetMsg (MsgRequest) returns (MsgResponse){}
}

message MsgRequest {
  string name = 1;
}

message MsgResponse {
  string msg = 1;
}

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

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

生成接口代码

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

python -m grpc_tools.protoc -I . --pythoout=. --grpc_python_out=. msg.proto

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

创建服务端

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

import grpc
import msg_pb2
import msg_pb2_grpc

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

from concurrent import futures
import time

_ONE_DAY_IN_SECONDS = 60 * 60 * 24

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

class MsgServicer(msg_pb2_grpc.MsgServiceServicer):

  def GetMsg(self, request, context):
    print("Received name: %s" % request.name)
    return msg_pb2.MsgResponse(msg='Hello, %s!' % request.name)

GetMsg 接收到的请求是在 request 中, msg.proto 中定义的 name 就是 request.name ,接着在 GetMsg 中设计 msg.proto 中定义的 MsgResponse

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

def serve():
  server = grpc.server(futures.ThreadPoolExecutor(max_workers=10))
  msg_pb2_grpc.add_MsgServiceServicer_to_server(MsgServicer(), server)
  server.add_insecure_port('[::]:50051')
  server.start()
  try:
    while True:
      time.sleep(_ONE_DAY_IN_SECONDS)
  except KeyboardInterrupt:
    server.stop(0)

通过并发库,将服务端放到多进程里运行。

完整 msg_server.py 代码如下

import grpc
import msg_pb2
import msg_pb2_grpc

from concurrent import futures
import time

_ONE_DAY_IN_SECONDS = 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='Hello, %s!' % request.name)


def serve():
  server = grpc.server(futures.ThreadPoolExecutor(max_workers=10))
  msg_pb2_grpc.add_MsgServiceServicer_to_server(MsgServicer(), server)
  server.add_insecure_port('[::]:50051')
  server.start()
  try:
    while True:
      time.sleep(_ONE_DAY_IN_SECONDS)
  except KeyboardInterrupt:
    server.stop(0)

if __name__ == '__main__':
  serve()

创建客户端

客户端相对简单一些,这里我写了一个简单的客户端。

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('localhost:50051') as channel:
    stub = msg_pb2_grpc.MsgServiceStub(channel)
    response = stub.GetMsg(msg_pb2.MsgRequest(name='world'))
  print("Client received: " + response.msg)


if __name__ == '__main__':
  run()

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

运行

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

总结

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

以上就是本文的全部内容,希望对大家的学习有所帮助,也希望大家多多支持脚本之家。

相关文章

  • Python作用域与名字空间原理详解

    Python作用域与名字空间原理详解

    这篇文章主要介绍了python作用域与名字空间原理详解,文中通过示例代码介绍的非常详细,对大家的学习或者工作具有一定的参考学习价值,需要的朋友可以参考下
    2020-03-03
  • python scipy求解非线性方程的方法(fsolve/root)

    python scipy求解非线性方程的方法(fsolve/root)

    今天小编就为大家分享一篇python scipy求解非线性方程的方法(fsolve/root),具有很好的参考价值,希望对大家有所帮助。一起跟随小编过来看看吧
    2018-11-11
  • 详解Numpy数组转置的三种方法T、transpose、swapaxes

    详解Numpy数组转置的三种方法T、transpose、swapaxes

    这篇文章主要介绍了详解Numpy数组转置的三种方法T、transpose、swapaxes,小编觉得挺不错的,现在分享给大家,也给大家做个参考。一起跟随小编过来看看吧
    2019-05-05
  • Python Matplotlib基本用法详解

    Python Matplotlib基本用法详解

    Matplotlib 是Python中类似 MATLAB 的绘图工具,熟悉 MATLAB 也可以很快的上手 Matplotlib,这篇文章主要介绍了Python Matplotlib基本用法,需要的朋友可以参考下
    2023-03-03
  • python基础pandas的drop()用法示例详解

    python基础pandas的drop()用法示例详解

    这篇文章主要介绍了python基础pandas的drop()用法,本文通过实例代码给大家介绍的非常详细,对大家的学习或工作具有一定的参考借鉴价值,需要的朋友可以参考下
    2023-04-04
  • 天翼开放平台免费短信验证码接口使用实例

    天翼开放平台免费短信验证码接口使用实例

    天翼开放平台提供了一个免费的短信验证码API,下面看看使用方法吧,我们用python开发接口
    2013-12-12
  • Python调用百度api实现语音识别详解

    Python调用百度api实现语音识别详解

    这篇文章主要介绍了Python通过调用百度api实现语音识别,文中通过示例代码介绍的非常详细,对大家的学习或者工作具有一定的参考学习价值,需要的朋友们下面随着小编来一起学习吧
    2021-12-12
  • 超详细Python文件操作命令知识

    超详细Python文件操作命令知识

    最近在写的程序频繁地与文件操作打交道,所以想着给大家总结下,这篇文章主要给大家介绍了关于Python文件操作命令的相关资料,文中通过代码介绍的非常详细,需要的朋友可以参考下
    2024-04-04
  • 详解Django rest_framework实现RESTful API

    详解Django rest_framework实现RESTful API

    这篇文章主要介绍了详解Django rest_framework实现RESTful API,小编觉得挺不错的,现在分享给大家,也给大家做个参考。一起跟随小编过来看看吧
    2018-05-05
  • 一文读懂Python版本管理工具Pyenv使用

    一文读懂Python版本管理工具Pyenv使用

    在开发Python程序的时候,有时候可能需要在不同版本的Python上进行测试。pyenv就是这么一个管理多版本Python的工具,今天给大家分享Python版本管理工具Pyenv使用,感兴趣的朋友一起看看吧
    2021-06-06

最新评论