grpc python 教學

紀錄 gRPC 也可以稱 Google RPC, 今天來用 python 把玩😀

介紹

官網架構圖

簡單說, RPC 就像你 call 本機的 function,

然後這邊就只是你要先去 stub remote,

接著 call function

好處以及適合使用時機

支援 HTTP/2 效能更好
Protocol Buffers 輕量, 本身就可以當作文件, 不用另外寫文件
自帶簡單的驗證
跨語法開發
適合使用在微服務(microservices)內部溝通

環境安裝

pip install grpcio grpcio-tools grpc-interceptor

定義 proto

很重要, 他就是文檔

protos/user.proto

編譯

範例

python -m grpc_tools.protoc -I./protos --python_out=. --pyi_out=. --grpc_python_out=. ./protos/user.proto

--python_out=. --pyi_out=. --grpc_python_out=.

這裡的意思都是放在當前目錄底下,

但我們統一把編譯出來的放到 service_protos 資料夾底下

python -m grpc_tools.protoc -I./protos --python_out=./service_protos --pyi_out=./service_protos --grpc_python_out=./service_protos ./protos/user.proto

這邊會有 import 問題, 請將 user_pb2_grpc.py 第5行修改,

原本

import user_pb2 as user__pb2

改成以下任一種你喜歡的

import service_protos.user_pb2 as user__pb2

# or
# from service_protos import user_pb2 as user__pb2

# or
# from . import user_pb2 as user__pb2

如果你不想修改, 建議就是 server.py 和 clint.py 放在同一層

grpc server

✍ server 和 client 都需要編譯後的檔案.

先開啟一個 terminal 執行 server

python3 server.py

grpc client

✍ server 和 client 都需要編譯後的檔案.

再開啟一個 terminal 執行 client

❯ python3 client.py
details {
  id: 2
  value: "twtrubiks"
}
details {
  id: 2
  value: "twtrubiks"
}

grpc interceptor

幫助你更好的管理 grpc log

pip install grpc-interceptor

在 server.py 中, 加入底下

interceptors = [ExceptionToStatusInterceptor()]
server = grpc.server(
        concurrent.futures.ThreadPoolExecutor(max_workers=10),
        interceptors=interceptors
    )