1. 前言
之前學習的go的微服務之間還是通過REST API的方式互相調用的，但既然要學習微服務，gRPC肯定是一個繞不過去的需要學習的技術, 所以就開搞吧
2. gRPC與Protobuf簡介
gRPC是一款語言中立、平台中立、開源的遠程過程調用系統
即：
gRPC客戶端和服務端可以在多種環境中運行和交互，例如用java寫一個服務端，可以用go語言寫客戶端調用
微服務架構中，由於每個服務對應的代碼庫是獨立運行的，無法直接調用，彼此間的通信就是個大問題.
gRPC可以實現將大的項目拆分為多個小且獨立的業務模塊，也就是服務。各服務間使用高效的protobuf協議進行RPC調用，gRPC默認使用protocol buffers，這是google開源的一套成熟的結構數據序列化機制
當然也可以使用其他數據格式如JSON
可以用proto files創建gRPC服務，用message類型來定義方法參數和返回類型
3. 安裝
- 第一步：下載grpc通用編譯器
如下圖，解壓出來因平台而異會是一個protoc或者protoc.exe
- 第二步：把下載的二進制文件路徑添加到環境變量中(為了能全局訪問protoc)
- 這里以為mac為例子
# 打開存放環境變量的文件
vim ~/.bash_profile
# 添加如下，后面是路徑
alias protoc="/Users/emm/others/protoc-3.12.4-osx-x86_64/bin/protoc"
# 刷新環境變量
source ./.bash_profile
- 第三步: 安裝go專用的protoc的生成器
go get github.com/golang/protobuf/protoc-gen-go
安裝后會在GOPATH目錄下生成可執行文件，protobuf的編譯器插件protoc-gen-go，等下執行protoc命令會自動調用這個插件
4. 中間文件演示
4.1 編寫中間文件
這里新建一個pbfiles文件夾用於存放protoc文件
// 這個就是protobuf的中間文件
// 指定的當前proto語法的版本，有2和3
syntax = "proto3";
// 指定等會文件生成出來的package
package service;
// 定義request
message ProductRequest{
int32 prod_id = 1; // 1代表順序
}
// 定義response
message ProductResponse{
int32 prod_stock = 1; // 1代表順序
}
4.2 運行protoc命令編譯成go中間文件
然后運行以下的命令來生成.go結尾的文件
- 下面的命令就是我們剛剛下的
protoc包以及protoc-gen-go插件的作用
# 編譯Product.proto之后輸出到service文件夾
protoc --go_out=../service Product.proto
如下就在service文件夾自動生成了一個go文件，並且它提示我們不要去修改它
5. 創建gRPC服務端
5.1 新建Product.protoc
這個protoc文件比上面的多出了一個service的定義和里面的一個方法的定義
// 這個就是protobuf的中間文件
// 指定的當前proto語法的版本，有2和3
syntax = "proto3";
// 指定等會文件生成出來的package
package service;
// 定義request model
message ProductRequest{
int32 prod_id = 1; // 1代表順序
}
// 定義response model
message ProductResponse{
int32 prod_stock = 1; // 1代表順序
}
// 定義服務主體
service ProdService{
// 定義方法
rpc GetProductStock(ProductRequest) returns(ProductResponse);
}
5.2 運行protoc命令
注意
- 這里的protoc命令和之前的命令相比有點不一樣
protoc --go_out=plugins=grpc:../service Product.proto
然后還是會在service文件夾下生成一個.go的文件
有兩個比較需要注意的
- RegisterProdServiceServer
后面需要在server中調用這個來注冊
- ProdServiceServer的接口定義
我們需要繼承這個接口，即實現它所有的方法
5.3 實現RegisterProdServiceServer接口
上面我們在protoc文件中定義了一個ProdService中包含了一個GetProductStock的方法
這里我們要實現自動生成的go文件中的接口
package service
import "context"
type ProdService struct {
}
func (ps *ProdService) GetProductStock(ctx context.Context, request *ProductRequest) (*ProductResponse, error) {
return &ProductResponse{ProdStock: request.ProdId}, nil
}
5.4 准備工作完成，創建main函數將服務端跑起來
前面的都是准備工作，這里是真正把服務端跑起來的操作
下面是服務端代碼：
package main
import (
"gomicro-quickstart/grpc_demo/service"
"google.golang.org/grpc"
"log"
"net"
)
func main() {
// 1. new一個grpc的server
rpcServer := grpc.NewServer()
// 2. 將剛剛我們新建的ProdService注冊進去
service.RegisterProdServiceServer(rpcServer, new(service.ProdService))
// 3. 新建一個listener，以tcp方式監聽8082端口
listener, err := net.Listen("tcp", ":8082")
if err != nil {
log.Fatal("服務監聽端口失敗", err)
}
// 4. 運行rpcServer，傳入listener
_ = rpcServer.Serve(listener)
}
排坑：
- 如果遇見類似
undefined: grpc.SupportPackageIsVersion6和undefined: grpc.ClientConnInterface的錯誤，可以修改go.mod將grpc版本改到1.27.0
6. 創建gRPC客戶端
- 新建一個
grpc_client文件夾存放客戶端相關的 - 並在
grpc_client文件夾下再新建一個service文件夾
6.1 拷貝Product.pb.go到客戶端service文件夾下
6.2 編寫client的main函數
package main
import (
"context"
"fmt"
"gomicro-quickstart/grpc_client/service"
"google.golang.org/grpc"
"log"
)
func main() {
// 1. 新建連接，端口是服務端開放的8082端口
// 並且添加grpc.WithInsecure()，不然沒有證書會報錯
conn, err := grpc.Dial(":8082", grpc.WithInsecure())
if err != nil {
log.Fatal(err)
}
// 退出時關閉鏈接
defer conn.Close()
// 2. 調用Product.pb.go中的NewProdServiceClient方法
productServiceClient := service.NewProdServiceClient(conn)
// 3. 直接像調用本地方法一樣調用GetProductStock方法
resp, err := productServiceClient.GetProductStock(context.Background(), &service.ProductRequest{ProdId: 233})
if err != nil {
log.Fatal("調用gRPC方法錯誤: ", err)
}
fmt.Println("調用gRPC方法成功，ProdStock = ", resp.ProdStock)
}
6.3 運行並顯示結果
- 先把服務端運行起來
- 再把客戶端運行起來
然后客戶端輸出正確的結果，第一個go的gRPC調用運行成功
