快捷導(dǎo)航

如何用Python搭建gRPC服務(wù)

更新時間：2021年06月30日 08:37:18 作者：華為云開發(fā)者社區(qū)

gRPC是一個高性能、通用的開源RPC框架，其由Google主要面向移動應(yīng)用開發(fā)并基于HTTP/2協(xié)議標(biāo)準(zhǔn)而設(shè)計，基于ProtoBuf序列化協(xié)議開發(fā)，且支持眾多開發(fā)語言

一、概述

一個gRPC服務(wù)的大體結(jié)構(gòu)圖為：

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

二、安裝python需要的庫

pip install grpcio

pip install grpcio-tools

pip install protobuf

三、定義gRPC的接口

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

syntax = "proto3";

option cc_generic_services = true;

//定義服務(wù)接口
service GrpcService {
    rpc hello (HelloRequest) returns (HelloResponse) {}  //一個服務(wù)中可以定義多個接口，也就是多個函數(shù)功能
}

//請求的參數(shù)
message HelloRequest {
    string data = 1;   //數(shù)字1,2是參數(shù)的位置順序，并不是對參數(shù)賦值
    Skill skill = 2;  //支持自定義的數(shù)據(jù)格式，非常靈活
};

//返回的對象
message HelloResponse {
    string result = 1;
    map<string, int32> map_result = 2; //支持map數(shù)據(jù)格式，類似dict
};

message Skill {
    string name = 1;
};

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

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

利用編譯工具把proto文件轉(zhuǎn)化成py文件，直接在當(dāng)前文件目錄下運(yùn)行上述代碼即可。

1.-I 指定proto所在目錄

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

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

4.hello.proto 輸入的proto文件

執(zhí)行上述命令后，生成hello_pb2.py 和hello_pb2_grpc.py這兩個文件。

五、編寫grpc的服務(wù)端代碼

#! /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,實現(xiàn)hello方法
    '''
    def __init__(self):
        pass

    def hello(self, request, context):
        '''
        具體實現(xiàn)hello的方法，并按照pb的返回對象構(gòu)造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():
    '''
    模擬服務(wù)啟動
    :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()

在服務(wù)端側(cè)，需要實現(xiàn)hello的方法來滿足proto文件中GrpcService的接口需求，hello方法的傳入?yún)?shù)，是在proto文件中定義的HelloRequest，context是保留字段，不用管，返回參數(shù)則是在proto中定義的HelloResponse，服務(wù)啟動的代碼是標(biāo)準(zhǔn)的，可以根據(jù)需求修改提供服務(wù)的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():
    '''
    模擬請求服務(wù)方法信息
    :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():
    '''
    模擬請求服務(wù)方法信息
    :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()

客戶端側(cè)代碼的實現(xiàn)比較簡單，首先定義好訪問ip和端口號，然后定義好HelloRequest數(shù)據(jù)結(jié)構(gòu)，遠(yuǎn)程調(diào)用hello即可。需要強(qiáng)調(diào)的是，客戶端和服務(wù)端一定要import相同proto文件編譯生成的hello_pb2_grpc, hello_pb2模塊，即使服務(wù)端和客戶端使用的語言不一樣，這也是grpc接口規(guī)范一致的體現(xiàn)。