在Python中使用gRPC的方法示例

更新時(shí)間：2018年08月08日 08:32:09 作者：Xin Qiu

這篇文章主要介紹了在Python中使用gRPC的方法示例，小編覺得挺不錯(cuò)的，現(xiàn)在分享給大家，也給大家做個(gè)參考。一起跟隨小編過來看看吧

本文介紹了在Python中使用gRPC的方法示例，分享給大家，具體如下：

使用Protocol Buffers的跨平臺(tái)RPC系統(tǒng)。

安裝

使用 pip

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

gRPC由兩個(gè)部分構(gòu)成，grpcio 和 gRPC 工具，后者是編譯 protocol buffer 以及提供生成代碼的插件。

使用

編寫protocol buffer

使用 gRPC 首先需要做的是設(shè)計(jì) protocol buffer。新建一個(gè) msg.proto 文件。

syntax = "proto3";

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

message MsgRequest {
  string name = 1;
}

message MsgResponse {
  string msg = 1;
}

以上面的這個(gè)消息服務(wù)為例，首先是規(guī)定語法，這里使用的是 proto3 的語法。接著使用 service 關(guān)鍵字定義服務(wù)，gRPC 提供4種 RPC 類型的服務(wù)，這里定義的是第一種單一請(qǐng)求單一回應(yīng)，類似普通的函數(shù)調(diào)用，其他的使用到了 stream 關(guān)鍵字，將其放在括號(hào)里，代表這個(gè)數(shù)據(jù)是流數(shù)據(jù)。這個(gè)以后再來研究，本次先設(shè)計(jì)一個(gè)簡單的RPC。

之后定義兩個(gè) message ，一個(gè)是請(qǐng)求的結(jié)構(gòu)，一個(gè)是回應(yīng)的結(jié)果。這里表示這個(gè)數(shù)據(jù)結(jié)構(gòu)是字符串，protocol buffer 還可以定義為 int32，int64，double，float 等等。這里賦予的初值可以隨便填寫，實(shí)際使用中，會(huì)被賦予新的值。

生成接口代碼

因?yàn)橹鞍惭b好了一些輔助插件，使用這里直接可以生成。

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

這里會(huì)生成兩個(gè)文件， msg_pb2.py 和 msg_pb2_grpc.py 。這兩個(gè)文件是為后續(xù)的服務(wù)端和客戶端所用。前者是定義了一些變量，例如 _MSGREQUEST 中就包含了請(qǐng)求函數(shù)的名字，可接受的變量，實(shí)際上還是 msg.proto 里定義的東西。

創(chuàng)建服務(wù)端

首先需要導(dǎo)入 RPC 必備的包，以及剛才生成的兩個(gè)文件。

import grpc
import msg_pb2
import msg_pb2_grpc

因?yàn)?RPC 應(yīng)該長時(shí)間運(yùn)行，考慮到性能，還需要用到并發(fā)的庫。

from concurrent import futures
import time

_ONE_DAY_IN_SECONDS = 60 * 60 * 24

在 Server 中，主要是實(shí)現(xiàn)服務(wù)，按照 msg.proto 定義的，這里需要寫一個(gè)服務(wù)類 MsgServicer ，這個(gè)類需要實(shí)現(xiàn)之前定義的 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 接收到的請(qǐng)求是在 request 中， msg.proto 中定義的 name 就是 request.name ，接著在 GetMsg 中設(shè)計(jì) msg.proto 中定義的 MsgResponse 。

之后實(shí)現(xiàn)啟動(dòng)服務(wù)的部分即可。

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)

通過并發(fā)庫，將服務(wù)端放到多進(jìn)程里運(yùn)行。

完整 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()

創(chuàng)建客戶端

客戶端相對(duì)簡單一些，這里我寫了一個(gè)簡單的客戶端。

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') 進(jìn)行連接服務(wù)端，接著在這個(gè) channel 上創(chuàng)建 stub ，在 msg_pb2_grpc 里可以找到 MsgServiceStub 這個(gè)類相關(guān)信息。這個(gè) stub 可以調(diào)用遠(yuǎn)程的 GetMsg 函數(shù)。 MsgRequest 中的 name 即 msg.proto 中定義的數(shù)據(jù)。在回應(yīng)里可以得到 msg.proto 中定義的 msg 。