Python和Go實現簡單Grpc服務
一、簡介
Grpc 使用了 Google 的 Protocol Buffers 作為接口定義語言(IDL),并使用 HTTP/2 作為傳輸協議。它支持多種編程語言,包括 C++、Java、Python、Go、Node.js 等。Grpc 提供了強大的功能,如雙向流、流式處理、身份驗證和攔截器等。
Grpc 的核心概念是服務和消息。服務定義了一組方法,客戶端可以通過這些方法與服務端進行交互。消息定義了數據的結構,用于在服務和客戶端之間傳遞。
二、安裝proto
下載proto文件:
安裝后設置系統環境變量,然后打開控制臺,執行protoc -h命令驗證是否安裝成功。
三、初始化工程
Python中使用Grpc
初始化工程
mkdir grpc_demo
cd grpc_demo
pdm init
安裝Python工具庫
pdm add grpcio
pdm add grpcio-tools
Go中使用Grpc
初始化工程
mkdir grpc_demo
cd grpc_demo
go mod init grpc_demo
安裝Go工具庫
go install github.com/golang/protobuf/protoc-gen-go@latest
go install google.golang.org/grpc/cmd/protoc-gen-go-grpc@latest
四、定義服務和消息
在 Grpc 中,使用 Protocol Buffers(簡稱 Protobuf)來定義服務和消息的結構。Protobuf 是一種輕量級的數據交換格式,它可以定義結構化數據的模式,并生成相應的代碼用于序列化和反序列化。
定義服務和消息的步驟如下:
- 創建proto文件夾:proto,將對應的proto文件創建在里面
syntax = "proto3";
option go_package = ".;proto";
service Greeter {
rpc SayHello (HelloRequest) returns (HelloReply) {}
}
message HelloRequest {
string name = 1;
}
message HelloReply {
string message = 1;
}
- 使用 Protobuf 編譯器將 .proto 文件編譯成所需語言的代碼。
- 在Python中運行以下命令:
pdm run python -m grpc_tools.protoc --python_out=. --grpc_python_out=. -I . hello.proto
- —python_out:生成的Python文件存儲目錄。
- —grpc_python_out:生成的Grpc使用的Python文件存儲目錄。
- -I:proto文件的目錄,這里的目錄地址將影響proto文件相互引用的路徑。
執行完以上命令后,會在指定目錄下生成:`hello_pb2.py`和`hello_pb2_grpc.py` 兩個文件。
- 在Go中運行以下命令:
protoc --go_out=. --go-grpc_out=. -I . hello.proto
- —go_out:生成的Go文件存儲目錄。
- —go-grpc_out:生成的Grpc使用的Go文件存儲目錄。
- -I:proto文件的目錄。
執行完以上命令后,會在指定目錄下生成:`hello_pb.g`o和`hello_grpc.pb.go` 兩個文件。
五、編寫服務端
在 Grpc 中,編寫服務端需要執行以下幾個步驟:
- 導入所需的庫和生成的消息定義文件:
Go實現:
package main
import (
"context"
"go_demo/proto"
"google.golang.org/grpc"
"net"
)
Python實現:
import grpc
from concurrent import futures
from proto import hello_pb2_grpc, hello_pb2
- 創建一個類繼承自自動生成的服務定義類,并實現其中定義的方法:
Go實現:
type Server struct {
proto.UnimplementedGreeterServer
}
func (s *Server) SayHello(ctx context.Context, in *proto.HelloRequest) (*proto.HelloReply, error) {
return &proto.HelloReply{Message: "Hello Go " + in.Name}, nil
}
Python實現:
class GreeterServicer(hello_pb2_grpc.GreeterServicer):
def SayHello(self, request, context):
return hello_pb2.HelloReply(message='Hello, %s!' % request.name)
- 創建一個 gRPC 服務器并將服務實現添加到服務器中:
Go實現:
func serve() {
g := grpc.NewServer()
proto.RegisterGreeterServer(g, &Server{})
lis, err := net.Listen("tcp", ":50051")
if err != nil {
panic("failed to listen: " + err.Error())
}
err = g.Serve(lis)
if err != nil {
panic("failed to start serve: " + err.Error())
}
}
Python實現:
def serve():
server = grpc.server(futures.ThreadPoolExecutor(max_workers=10))
hello_pb2_grpc.add_GreeterServicer_to_server(Greeter(), server)
server.add_insecure_port('0.0.0.0:50051')
server.start()
server.wait_for_termination()
- 啟動服務器:
Go實現:
func main() {
serve()
}
Python實現:
if __name__ == '__main__':
serve()
以上代碼實現一個簡單的Grpc服務端,其中SayHello是在服務定義中聲明的方法,我們可以根據需求添加更多的方法和邏輯。
六、編寫客戶端
編寫 Grpc 客戶端的步驟如下:
- 導入所需的庫和生成的消息定義文件:
Go實現:
package main
import (
"context"
"fmt"
"go_demo/proto"
"google.golang.org/grpc"
"google.golang.org/grpc/credentials/insecure"
)
Python實現:
import grpc
from proto import hello_pb2_grpc, hello_pb2
- 創建一個Grpc通道:
Go實現:
conn, err := grpc.Dial("127.0.0.1:50051", grpc.WithTransportCredentials(insecure.NewCredentials()))
if err != nil {
panic("failed to dial: " + err.Error())
}
defer conn.Close()
Python實現:
channel = grpc.insecure_channel('localhost:50051')
- 創建一個 Stub 對象,用于調用服務端的方法:
Go實現:
stub := proto.NewGreeterClient(conn)
Python實現:
stub = hello_pb2_grpc.GreeterStub(channel)
- 調用服務端的方法:
Go實現:
response, err := stub.SayHello(context.Background(), &proto.HelloRequest{Name: "world"})
if err != nil {
panic("failed to say hello: " + err.Error())
}
fmt.Println(response.Message)
Python實現:
response = stub.SayHello(hello_pb2.HelloRequest(name='tom'))
print(response.message)
以上分別用Python和Go實現了簡單的Grpc服務端和客戶端。