如何用Python搭建gRPC服務

Posted on by

一、概述

一個gRPC服務的大體結構圖為：

圖一表明，grpc的服務是跨語言的，但需要遵循相同的協議（proto）。相比於REST服務，gPRC 的一個很明顯的優勢是它使用瞭二進制編碼，所以它比 JSON/HTTP 更快，且有清晰的接口規范以及支持流式傳輸，但它的實現相比rest服務要稍微要復雜一些，下面簡單介紹搭建gRPC服務的步驟。

二、安裝python需要的庫

pip install grpcio

pip install grpcio-tools  

pip install protobuf

三、定義gRPC的接口

創建 gRPC 服務的第一步是在.proto 文件中定義好接口，proto是一個協議文件，客戶端和服務器的通信接口正是通過proto文件協定的，可以根據不同語言生成對應語言的代碼文件。這個協議文件主要就是定義好服務（service）接口，以及請求參數和相應結果的數據結構，下面是一個簡單的例子。

syntax = "proto3";
​
option cc_generic_services = true;
​
//定義服務接口
service GrpcService {
    rpc hello (HelloRequest) returns (HelloResponse) {}  //一個服務中可以定義多個接口，也就是多個函數功能
}
​
//請求的參數
message HelloRequest {
    string data = 1;   //數字1,2是參數的位置順序，並不是對參數賦值
    Skill skill = 2;  //支持自定義的數據格式，非常靈活
};
​
//返回的對象
message HelloResponse {
    string result = 1;
    map<string, int32> map_result = 2; //支持map數據格式，類似dict
};
​
message Skill {
    string name = 1;
};

四、使用 protoc 和相應的插件編譯生成對應語言的代碼

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

利用編譯工具把proto文件轉化成py文件，直接在當前文件目錄下運行上述代碼即可。

1.-I 指定proto所在目錄

2.-m 指定通過protoc生成py文件

3.–python_out指定生成py文件的輸出路徑

4.hello.proto 輸入的proto文件

執行上述命令後，生成hello_pb2.py 和hello_pb2_grpc.py這兩個文件。

五、編寫grpc的服務端代碼

#! /usr/bin/env python
# coding=utf8
​
import time
from concurrent import futures
​
import grpc
​
from gRPC_example import hello_pb2_grpc, hello_pb2
​
_ONE_DAY_IN_SECONDS = 60 * 60 * 24
​
​
class TestService(hello_pb2_grpc.GrpcServiceServicer):
    '''
    繼承GrpcServiceServicer,實現hello方法
    '''
    def __init__(self):
        pass
​
    def hello(self, request, context):
        '''
        具體實現hello的方法，並按照pb的返回對象構造HelloResponse返回
        :param request:
        :param context:
        :return:
        '''
        result = request.data + request.skill.name + " this is gprc test service"
        list_result = {"12": 1232}
        return hello_pb2.HelloResponse(result=str(result),
                                       map_result=list_result)
​
def run():
    '''
    模擬服務啟動
    :return:
    '''
    server = grpc.server(futures.ThreadPoolExecutor(max_workers=10))
    hello_pb2_grpc.add_GrpcServiceServicer_to_server(TestService(),server)
    server.add_insecure_port('[::]:50052')
    server.start()
    print("start service...")
    try:
        while True:
            time.sleep(_ONE_DAY_IN_SECONDS)
    except KeyboardInterrupt:
        server.stop(0)
​
​
if __name__ == '__main__':
    run()

在服務端側，需要實現hello的方法來滿足proto文件中GrpcService的接口需求，hello方法的傳入參數，是在proto文件中定義的HelloRequest，context是保留字段，不用管，返回參數則是在proto中定義的HelloResponse，服務啟動的代碼是標準的，可以根據需求修改提供服務的ip地址以及端口號。

六、編寫gRPC客戶端的代碼

#! /usr/bin/env python
# coding=utf8
​
import grpc
​
from gRPC_example import #! /usr/bin/env python
# coding=utf8
​
import grpc
​
from gRPC_example import hello_pb2_grpc, hello_pb2
​
​
def run():
    '''
    模擬請求服務方法信息
    :return:
    '''
    conn=grpc.insecure_channel('localhost:50052')
    client = hello_pb2_grpc.GrpcServiceStub(channel=conn)
    skill = hello_pb2.Skill(name="engineer")
    request = hello_pb2.HelloRequest(data="xiao gang", skill=skill)
    respnse = client.hello(request)
    print("received:",respnse.result)
​
​
if __name__ == '__main__':
    run()
​
​
def run():
    '''
    模擬請求服務方法信息
    :return:
    '''
    conn=grpc.insecure_channel('localhost:50052')
    client = hello_pb2_grpc.GrpcServiceStub(channel=conn)
    skill = hello_pb2.Skill(name="engineer")
    request = hello_pb2.HelloRequest(data="xiao gang", skill=skill)
    response = client.hello(request)
    print("received:",response.result)
​
​
if __name__ == '__main__':
    run()

客戶端側代碼的實現比較簡單，首先定義好訪問ip和端口號，然後定義好HelloRequest數據結構，遠程調用hello即可。需要強調的是，客戶端和服務端一定要import相同proto文件編譯生成的hello_pb2_grpc, hello_pb2模塊，即使服務端和客戶端使用的語言不一樣，這也是grpc接口規范一致的體現。

七、調用測試

先啟動運行服務端的代碼，再啟動運行客戶端的代碼即可。

八、gRPC的使用總結

  • 定義好接口文檔
  • 工具生成服務端/客戶端代碼
  • 服務端補充業務代碼
  • 客戶端建立 gRPC 連接後，使用自動生成的代碼調用函數
  • 編譯、運行

以上就是如何用Python搭建gRPC服務的詳細內容，更多關於Python搭建gRPC服務的資料請關註WalkonNet其它相關文章！

推薦閱讀：