前言
gRPC主要有4種請求和響應模式,分別是簡單模式(Simple RPC)
、服務端流式(Server-side streaming RPC)
、客戶端流式(Client-side streaming RPC)
、和雙向流式(Bidirectional streaming RPC)
。
-
簡單模式(Simple RPC)
:客戶端發起請求並等待服務端響應。 -
服務端流式(Server-side streaming RPC)
:客戶端發送請求到服務器,拿到一個流去讀取返回的消息序列。 客戶端讀取返回的流,直到里面沒有任何消息。 -
客戶端流式(Client-side streaming RPC)
:與服務端數據流模式相反,這次是客戶端源源不斷的向服務端發送數據流,而在發送結束后,由服務端返回一個響應。 -
雙向流式(Bidirectional streaming RPC)
:雙方使用讀寫流去發送一個消息序列,兩個流獨立操作,雙方可以同時發送和同時接收。
本篇文章先介紹簡單模式。
新建proto文件
主要是定義我們服務的方法以及數據格式,我們使用上一篇的simple.proto文件。
1.定義發送消息的信息
message SimpleRequest{
// 定義發送的參數,采用駝峰命名方式,小寫加下划線,如:student_name
string data = 1;//發送數據
}
2.定義響應信息
message SimpleResponse{
// 定義接收的參數
// 參數類型 參數名 標識號(不可重復)
int32 code = 1; //狀態碼
string value = 2;//接收值
}
3.定義服務方法Route
// 定義我們的服務(可定義多個服務,每個服務可定義多個接口)
service Simple{
rpc Route (SimpleRequest) returns (SimpleResponse){};
}
4.編譯proto文件
我這里使用上一篇介紹的VSCode-proto3插件,保存后自動編譯。
指令編譯方法,進入simple.proto文件所在目錄,運行:
protoc --go_out=plugins=grpc:./ ./simple.proto
創建Server端
1.定義我們的服務,並實現Route方法
import (
"context"
"log"
"net"
"google.golang.org/grpc"
pb "go-grpc-example/proto"
)
// SimpleService 定義我們的服務
type SimpleService struct{}
// Route 實現Route方法
func (s *SimpleService) Route(ctx context.Context, req *pb.SimpleRequest) (*pb.SimpleResponse, error) {
res := pb.SimpleResponse{
Code: 200,
Value: "hello " + req.Data,
}
return &res, nil
}
該方法需要傳入RPC的上下文context.Context,它的作用結束超時
或取消
的請求。更具體的說請參考該文章
2.啟動gRPC服務器
const (
// Address 監聽地址
Address string = ":8000"
// Network 網絡通信協議
Network string = "tcp"
)
func main() {
// 監聽本地端口
listener, err := net.Listen(Network, Address)
if err != nil {
log.Fatalf("net.Listen err: %v", err)
}
log.Println(Address + " net.Listing...")
// 新建gRPC服務器實例
grpcServer := grpc.NewServer()
// 在gRPC服務器注冊我們的服務
pb.RegisterSimpleServer(grpcServer, &SimpleService{})
//用服務器 Serve() 方法以及我們的端口信息區實現阻塞等待,直到進程被殺死或者 Stop() 被調用
err = grpcServer.Serve(listener)
if err != nil {
log.Fatalf("grpcServer.Serve err: %v", err)
}
}
里面每個方法的作用都有注釋,這里就不解析了。
運行服務端
go run server.go
:8000 net.Listing...
創建Client端
import (
"context"
"log"
"google.golang.org/grpc"
pb "go-grpc-example/proto"
)
const (
// Address 連接地址
Address string = ":8000"
)
func main() {
// 連接服務器
conn, err := grpc.Dial(Address, grpc.WithInsecure())
if err != nil {
log.Fatalf("net.Connect err: %v", err)
}
defer conn.Close()
// 建立gRPC連接
grpcClient := pb.NewSimpleClient(conn)
// 創建發送結構體
req := pb.SimpleRequest{
Data: "grpc",
}
// 調用我們的服務(Route方法)
// 同時傳入了一個 context.Context ,在有需要時可以讓我們改變RPC的行為,比如超時/取消一個正在運行的RPC
res, err := grpcClient.Route(context.Background(), &req)
if err != nil {
log.Fatalf("Call Route err: %v", err)
}
// 打印返回值
log.Println(res)
}
運行客戶端
go run client.go
code:200 value:"hello grpc"
成功調用Server端的Route方法並獲取返回的數據。
總結
本篇介紹了簡單RPC模式,客戶端發起請求並等待服務端響應。下篇將介紹服務端流式RPC
.
教程源碼地址:https://github.com/Bingjian-Zhu/go-grpc-example
參考:gRPC官方文檔中文版