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 . --python_out=. --grpc_python_out=. msg.proto

這里會生成兩個文件， msg_pb2.py 和 msg_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 中的 name 即 msg.proto 中定義的數據。在回應里可以得到 msg.proto 中定義的 msg 。

 

運行

首先運行 

python msg_server.py

啟動服務端，接着運行

 python msg_client.py

就會看到客戶端接收到了服務端傳來的消息。

以上就是一個簡單的 RPC 的使用。

 

文章轉自： https://www.jb51.net/article/145229.htm