python-grpc

• 2022 年 4 月 12 日
• 筆記

1. python下protobuf使用

1.1 安裝protobuf

pip3.6 install grpcio #安裝grpc
pip3.6 install grpcio-tools #安裝grpc tools

1.2 protobuf3定義格式

新建protobuf文件名：hello.proto

syntax = "proto3";

message HelloRequest {
  string name = 1;
}

1.3 生成proto的python文件

cd hello.proto文件路徑下
命令：python3.6 -m grpc_tools.protoc --python_out=. --grpc_python_out=. -I. hello.proto

注意：只有python生成兩個文件
命令解釋：
python3.6 -m grpc_tools.protoc:實際需要使用grpc_tools.protoc這裡面的命令
--python_out=. :生成的python文件放在當前路徑下，這是給rpc用的文件
--grpc_python_out=. :生成的python文件放在當前路徑下，這是給grpc用的文件
-I.:指import，當前目錄下找hello.proto文件

1.4 對比一下protobuf生成的效果

res.SerializeToString() # 序列化二進位
res2.ParseFromString(res_str) # 反序列化二進位

import json

from python_grpc.proto import hello_pb2

def main():
    res = hello_pb2.HelloRequest()
    res.name = "jeff"
    res_str = res.SerializeToString() # 序列化二進位
    print(res_str) # b'\n\x04jeff'
    print(len((res_str))) # 6，和json對比，josn長度為：16

    res2 = hello_pb2.HelloRequest()
    res2.ParseFromString(res_str) # 反序列化二進位
    print(res2.name) # jeff

    res_json = {
        "name":"jeff"
    }
    print(len(json.dumps(res_json))) # 16,json和proto壓縮對比，proto壓縮後：6

if __name__ == '__main__':
    main()

2.python下grpc使用

2.1編寫hello.proto文件

syntax = "proto3";
package services;
option go_package = "./;proto";
service Greeter {
    // 定義SayHello方法
    rpc SayHello (HelloRequest) returns (HelloReply);
}

message HelloRequest {
    string name = 1; //編號
}

message HelloReply {
    string message = 1; //編號
}

2.2 生成proto的python文件

cd hello.proto文件路徑下
命令：python3.6 -m grpc_tools.protoc --python_out=. --grpc_python_out=. -I. hello.proto

注意：只有python生成兩個文件
命令解釋：
python3.6 -m grpc_tools.protoc:實際需要使用grpc_tools.protoc這裡面的命令
--python_out=. :生成的python文件放在當前路徑下，這是給rpc用的文件
--grpc_python_out=. :生成的python文件放在當前路徑下，這是給grpc用的文件
-I.:指import，當前目錄下找hello.proto文件

注意：生成的*_grpc.py文件的導包需要修改，否則報錯：要讓python找到hello_pb2
import hello_pb2 as hello__pb2 改為：
from python_grpc.proto import hello_pb2 as hello__pb2

2.3 編寫server端

from concurrent import futures
import grpc
from python_grpc.proto import hello_pb2, hello_pb2_grpc

# 業務處理
class Greeter(hello_pb2_grpc.GreeterServicer):
    def SayHello(self, request, context):
        return hello_pb2.HelloReply(message=f"你好，{request.name}")

# 啟動
def start():
    # 1.實例化server
    Thread = futures.ThreadPoolExecutor(max_workers=10)  ## 設置執行緒池，並發大小
    server = grpc.server(Thread)

    # 2.註冊邏輯到server中
    hello_pb2_grpc.add_GreeterServicer_to_server(Greeter(), server)

    # 3.啟動server
    server.add_insecure_port("127.0.0.1:8888")
    server.start()
    server.wait_for_termination()


if __name__ == '__main__':
    start()

2.4 編寫cilent端

import grpc
from python_grpc.proto import hello_pb2, hello_pb2_grpc


# rpc調用
def main():
    # 這裡使用with，調用完會自動關閉。優雅寫法
    with grpc.insecure_channel("127.0.0.1:8888") as channel:
        stub = hello_pb2_grpc.GreeterStub(channel)
        # 調用定義的SayHello方法
        rep = stub.SayHello(
            hello_pb2.HelloRequest(name="jeff")  # 傳遞定義的HelloRequest類型參數
        )
        return rep


# 業務程式碼
def start():
    rep = main()
    print(rep.message)  # 你好，jeff


if __name__ == '__main__':
    start()