python如何实现GRPC服务，python实现简单的grpc通信

😘引流个人主页：尚拙谨言的博客_CSDN博客-技术实战,学习经验分享,大道至简系列领域博主

grpc是一种基于某种协议实现不同机器间进行通信的服务框架。不同机器可以是不同的服务端、客户端，当服务端实现好某些功能后，提供一个服务接口，供不同客户端进行接口调用，从而让不同客户端都能够“享用”到服务端提供的功能。

在实际业务场景，比如我是做算法的，那么当我的模型训练完成后，要放到线上让别人调用，则经常是以grpc的方式进行实现的。简单流程就是我写个服务端，实现接收客户端传来的数据，并进行模型推理计算，计算结果再返回客户端，那么客户端实际只需要提供数据即可得到它们想要的结果，中间数据的处理过程均由服务端来完成，因此，它还是很方便的有木有~

目录

1. 定义protobuf文件

2. 服务端实现

2. 客户端实现

3. 总结

---

本文将简单介绍一下如何使用Python来实现一个简单的grpc服务。由于涉及到数据的传输，因此必然涉及到数据格式化问题，就是需要有一种通用的协议将数据格式化，方便在不同机器间都能够高效传输。grpc这里用protobuf（Protocol Buffers）作为通信协议，它是一种高效便捷的数据存储格式，与平台和编程语言无关，因此，只要定义好protobuf协议，用Python也好用Java也好，都可以相互通信，十分方便。

1. 定义protobuf文件

文件命名为ReceiveData.proto，注意，我本人试验过，你并不能创建一个.txt文件后强行将后缀改为.proto，用pycharm的同学可以参考这篇博客：pycharm添加proto格式文件插件，就是你需要在pycharm中添加相应能够兼容.proto格式文件的插件。

创建一个空白的proto文件，添加以下内容：

// 这里我们用的是proto3版本，版本号是一定要指定的哦！
syntax = "proto3";

import "google/protobuf/wrappers.proto";

//这是供java端调用时用到的，咱们python的不用管
//option java_package = "xx.xx.core.grpc.lib.label";
//option java_multiple_files = true;

//package label;

service LabelService {
  /**
  样本集接口
   */
  rpc receiveSample(SampleRequestList) returns (google.protobuf.BoolValue) {}
}
message SampleRequestList {
  repeated SampleRequest reqList = 1;
}

message SampleRequest {
  /**
  标签值
   */
  string labelValue = 1;
  /**
  样本集数据
   */
  string text = 2;
}

我们定义一个简单的接收数据的服务，客户端传labelValue和text数据，服务端接收数据并进行清洗和分词，我们可以打印出来看结果。数据接收成功后向客户端返回BoolValue类型的响应，true或false。

文件定义好后，我们进入到proto文件所在目录，执行

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

执行以上脚本后，会在grpc_file文件夹下生成两个.py文件：

2. 服务端实现

我们实现一个服务端，用于接收客户端发来的请求，并将接收到的数据进行清洗、分词等处理，请求格式为List，在proto文件中用repeated关键词修饰。

新建python文件，命名receive.py，编写以下内容：

import logging
import sys

sys.path.append('..')
import time
import datetime
from concurrent import futures

import grpc_file
import jieba
import re
import grpc

from grpc_file import ReceiveData_pb2_grpc
# 这个地方的BoolValue可能会飘红，不用管，用就行了
from google.protobuf.wrappers_pb2 import BoolValue

jieba.setLogLevel(log_level=0)
pattern = re.compile('(?:https?|ftp|file)://[-A-Za-z0-9+&@#/%?=~_|!:,.;]+[-A-Za-z0-9+&@#/%=~_|]')
logger = logging.getLogger('logger')
# 设置日志等级_
logger.setLevel(logging.INFO)


class ReceiveDataServer:
    def __init__(self, host, port):
        self.host = host
        self.port = port

    def match_url(self, text):
        """
        去除url
        :param text:
        :return:
        """
        clear = pattern.sub('', text)
        return clear

    def seg_sentence(self, data):
        """
        分词
        :param data:
        :return:
        """
        data = self.match_url(data)
        seg_text = jieba.cut(data.replace('\t', '').replace('\n', '').replace(' ', ''))
        context = ' '.join(seg_text)
        return context

    def receiveSample(self, request, context):
        """
        接收数据的grpc服务接口，该函数的名称要和proto文件中定义的接口名保持一致
        :param request:
        :param context:
        :return:
        """
        requestlist = request.reqList
        try:
            for item in requestlist:
                text = item.text.replace('\n', '。').replace('\r', '。')
                text = self.seg_sentence(text)
                print(datetime.datetime.strftime(datetime.datetime.now(), '%Y-%m-%d %H:%M:%S'),
                  '*** 添加标签：{}，添加文本：{}... ***'.format(item.labelValue, text[:10]))
            return BoolValue(value=True)
        except:
            return BoolValue(value=False)


def serve(host, port):
    # 启动 rpc 服务
    server = grpc.server(futures.ThreadPoolExecutor(max_workers=8))
    ReceiveData_pb2_grpc.add_LabelServiceServicer_to_server(ReceiveDataServer(host, port), server)
    server.add_insecure_port('{}:{}'.format(host, port))
    server.start()
    print('Grpc server connect successful!')

    try:
        while True:
            time.sleep(600)
            print(datetime.datetime.strftime(datetime.datetime.now(), '%Y-%m-%d %H:%M:%S'))
    except KeyboardInterrupt:
        print(datetime.datetime.strftime(datetime.datetime.now(), '%Y-%m-%d %H:%M:%S'))
        server.stop(0)


if __name__ == '__main__':
    # host和port写上服务端运行的机器ip和端口；
    serve(host='172.xxx.xxx.xxx', port=50001)

 我们运行一下这个py：

python receive.py

只要ip地址正确，发现服务启动成功！

2. 客户端实现

启动Server.py，我们再实现一个客户端，命名为client.py，让它能够连接服务端并发送数据：

import sys

sys.path.append('..')
import grpc
from grpc_file import ReceiveData_pb2, ReceiveData_pb2_grpc


def run():
    # 连接 rpc 服务器，ip和端口号必须和服务端设置的一致
    channel = grpc.insecure_channel('192.xxx.xxx.xx:50001')
    # 调用 rpc 服务
    stub = ReceiveData_pb2_grpc.LabelServiceStub(channel)
    requestlist = ReceiveData_pb2.SampleRequestList()
    for data in range(10):
        label = str(data)
        text = '第{}个标签的数据'.format(label)
        # 由于我们在proto文件中定义的接收数据格式为List，所以这里我们需要先定义一个向List中添加数据的对象
        request = requestlist.reqList.add()
        request.labelValue = label
        request.text = text
    response = stub.receiveSample(requestlist)
    print(response)

if __name__ == '__main__':
    run()

我们再运行一下客户端：

python client.py

数据发送给服务端成功！

 当服务端成功接收数据后，会返回给客户端一个 value: true。现在我们再来看下服务端有什么反应，切换回刚才启服务端所在的终端界面：

 从我们打印的日志中可以看出，服务端成功接收来自客户端发送的数据，而且我们可以看到添加文本后的字符串，已经进行了分词处理，这里为了演示，所以没加入url验证，且只取了前10个字符展示。其实大家可以根据自己的需求，从客户端接收数据后，在服务端代码里添加自己的业务逻辑，实现自己的业务需求，甚至可以做一系列处理后，将数据返回给客户端，只要定义好proto文件的返回值和返回格式即可。例如我们服务端的算法模型接收客户端数据，并对数据进行标签预测和打分，最后将标签和分数返回给客户端，那么proto中相应位置的定义可以如下：

syntax = "proto3";

service Predict {
  rpc predict(LabelRequest) returns (ResultReply) {}
}

message LabelRequest {
  string text = 1;
}

message ResultReply {
  string label = 1;
  string score = 2;
}

在服务端中，接口函数应当做如下返回：

return PredictServer_pb2.ResultReply(label=str(labels), score=str(probs))

在客户端中，应当做如下请求与接收相应：

response = stub.predict(PredictServer_pb2.LabelRequest(text='我热爱自然语言处理算法'))
print("预测类别：{}， 预测得分：{}: ".format(response.label, response.score))

3. 总结

通常我们利用grpc来接收不同客户端的请求，并将请求数据做业务逻辑处理，最后再返回给客户端。就好像通信基站一样，接收四面八方传来的手机通信请求，基站将这些请求做相应的处理，再返回给不同客户端，达到互联的目的。

总的来说，python实现简单的grpc需要以下步骤：定义protobuf——>通过protobuf生成2份方法文件——>定义服务端——>定义客户端。