Go gRPC教程-簡單RPC（二）

前言

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官方文檔中文版

看完之後若覺得對自己有幫助，懇請點贊或評論。這是對我最大的鼓勵！