【微服務測試教程】使用Python測試gRPC接口案例

微服務離不開gRPC

現在大多數企業都會采用微服務作為軟件的架構，在這種架構的大背景下，微服務框架和協議廣泛流行，而RPC也開始流行。 grpc 是基於RPC的框架，性能高，使用非常廣泛。
grpc 由谷歌公司開發和維護，支持幾乎所有的主流編程語言。 不管你用的是 Java， 還是 Python, 還是 Go, 還是 Ruby 等等，都可以使用他來實現遠程的服務。

Protocol Buffers

grpc 默認使用 protocol buffers 作為序列化傳輸格式，通常會把傳輸的數據類型用一個帶有.proto擴展名的普通文本文件來存儲，不管是請求還是響應的數據都需要符合這裡面定義的數據要求。
比如在進行用戶驗證時往往需要傳入登錄的用戶信息，服務端返回 token 值，對應的 proto 文件描述， 如果請求或者響應數據太大，不能一次獲取完，可以通過 stream 流信息持續傳輸，此時在類前面加 stream 關鍵字。

 // login.proto
service User{
// login
rpc Login (LoginReqeust ) returns (LoginReply ) {}
// stream
rpc GetImage(LoginRequest) return (stream LoginReply ){}
}
// 登錄請求數據
message LoginReqeust {
string username = 1;
string passwd = 2;
}
//登錄響應數據
message LoginReply {
string token = 1;
string msg = 2;
}

proto 文件生成 gPRC 代碼

以Python為例，首先需要安裝 Python 相關的包。

 pip install grpcio
pip install grpcio-tools

對應生成Python代碼的命令， 注意 -I 表示 proto 文件所在的子目錄：

 python -m grpc_tools.protoc --python_out=. --grpc_python_out=. -I protos login.proto

輸入完命令以後，在目錄下會多兩個文件，一個叫 login_pb2.py， 裡面報告了請求和響應相關的數據格式，還有一個叫 login_pb2_grpc.py， 包含了客戶端和響應端的類。
生成的 login_pb2.grpc.py 中的代碼…
[外鏈圖片轉存失敗,源站可能有防盜鏈機制,建議將圖片保存下來直接上傳(img-f6pu4PtL-1658989710154)(C:\Users\muji\Desktop\logseq_local_D__logseq筆記_markdown_1658920736\logseq筆記_markdown_1658920736\assets\image_1658915681955_0.png)]

創建gRPC服務

創建接口需要用到上面生成的 UserServicer 類。

 import login_pb2_grpc
import login_pb2
class User(login_pb2_grpc.UserServicer):
def Login(self, request, context):
return login_pb2.LoginReply(msg=f"hello, {
request.username}",
token="It is my token")

運行服務：

 import grpc
from concurrent import futures
def serve():
server = grpc.server(futures.ThreadPoolExecutor(max_workers=10))
login_pb2_grpc.add_UserServicer_to_server(
User(), server)
server.add_insecure_port('[::]:50051')
server.start()
server.wait_for_termination()
serve()

創建gRPC客戶端

一個例子：

 import grpc
def run():
with grpc.insecure_channel('localhost:50051') as channel:
stub = login_pb2_grpc.UserStub(channel)
response = stub.Login(login_pb2.LoginRequest(username='you', passwd="123"))
print("Client received: " + response.msg)

protocol buffer 轉成 json

客戶端拿到響應結果之後，可以通過類屬性獲取字段：

 response.msg
response.token

有時候我們會把它轉換成 json 格式，方便獲取整個響應。此時可以使用 protobuf 這個庫，先安裝：

 pip install protobuf

接下來使用轉換成 json 格式的方法就可以了。

 from google.protobuf.json_format import MessageToJson
import json
def run():
with grpc.insecure_channel('localhost:50051') as channel:
stub = login_pb2_grpc.UserStub(channel)
response = stub.Login(login_pb2.LoginRequest(username='you', passwd="123"))
print(json.loads(MessageToJson(response)))