歡迎訪問我的GitHub
https://github.com/zq2599/blog_demos
內容：所有原創文章分類彙總及配套原始碼，涉及Java、Docker、Kubernetes、DevOPS等；
歡迎訪問我的GitHub
這裡分類和彙總了欣宸的全部原創(含配套原始碼)：https://github.com/zq2599/blog_demos
gRPC學習系列文章連結
本篇概覽
- 本文《gRPC學習》系列的第三篇，前文已準備好gRPC開發環境，今天一起來開發一個服務端應用以及遠端gRPC呼叫它的客戶端；
- 今天實戰的內容和步驟如下圖所示：
原始碼下載
- 本篇實戰中的原始碼可在GitHub下載到，地址和連結資訊如下表所示(https://github.com/zq2599/blog_demos)：
| 名稱 | 連結 | 備註 |
|---|---|---|
| 專案主頁 | https://github.com/zq2599/blog_demos | 該專案在GitHub上的主頁 |
| git倉庫地址(https) | https://github.com/zq2599/blog_demos.git | 該專案原始碼的倉庫地址，https協議 |
| git倉庫地址(ssh) | git@github.com:zq2599/blog_demos.git | 該專案原始碼的倉庫地址，ssh協議 |
- 這個git專案中有多個資料夾，本章的應用在go-source資料夾下，如下圖紅框所示：
- go-source裡面有多個子資料夾，本篇的原始碼在helloworld中，如下圖紅框：
環境相關
- 接下來的開發都是在$GOPATH目錄下進行的，我這裡的真實目錄是/home/golang/gopath；
- 在/home/golang/gopath/src目錄下新建helloworld目錄，作為接下來的實戰用到的目錄；
- 在完成本篇的所有開發後，最終$GOPATH/src/helloworld目錄下的內容如下：
[golang@centos7 src]$ tree helloworld/
helloworld/
├── client
│ └── client.go
├── helloworld.pb.go
├── helloworld.proto
└── server
└── server.go
2 directories, 4 files
編寫proto檔案
- proto檔案用來描述遠端服務相關的資訊，如方法簽名、資料結構等，本篇的proto檔名為helloworld.proto，位置是$GOPATH/src/helloworld，內容如下：
// 協議型別
syntax = "proto3";
// 包名
package helloworld;
// 定義的服務名
service Greeter {
// 具體的遠端服務方法
rpc SayHello (HelloRequest) returns (HelloReply) {}
}
// SayHello方法的入參，只有一個字串欄位
message HelloRequest {
string name = 1;
}
// SayHello方法的返回值，只有一個字串欄位
message HelloReply {
string message = 1;
}
根據proto生成go原始碼
- 在helloworld.proto所在的目錄，執行以下命令：
protoc --go_out=plugins=grpc:. helloworld.proto
- 如果helloworld.proto沒有語法錯誤，會在當前目錄生成檔案helloworld.pb.go，這裡面是工具protoc-gen-go自動生成的程式碼，裡面生成的程式碼在開發服務端和客戶端時都會用到；
- 下面是helloworld.pb.go的程式碼片段，作用是服務註冊，入參是GreeterServer是個介面，由此可以推測：在服務端，由具體的業務程式碼來實現GreeterServer介面，並且呼叫RegisterGreeterServer方法註冊，這樣客戶端遠端呼叫的服務就可以實現業務功能了：
func RegisterGreeterServer(s *grpc.Server, srv GreeterServer) {
s.RegisterService(&_Greeter_serviceDesc, srv)
}
type GreeterServer interface {
// 具體的遠端服務方法
SayHello(context.Context, *HelloRequest) (*HelloReply, error)
}
- 藉助GoLand的Structure皮膚，可以進一步觀察helloworld.pb.go：
編寫服務端程式碼server.go並啟動
- 在$GOPATH/src/helloworld目錄下新建資料夾server，在此資料夾下新建server.go，內容如下，已經新增詳細註釋：
package main
import (
"context"
"log"
"net"
"google.golang.org/grpc"
pb "helloworld"
)
const (
port = ":50051"
)
// 定義結構體，在呼叫註冊api的時候作為入參，
// 該結構體會帶上SayHello方法，裡面是業務程式碼
// 這樣遠端呼叫時就執行了業務程式碼了
type server struct {
// pb.go中自動生成的，是個空結構體
pb.UnimplementedGreeterServer
}
// 業務程式碼在此寫，客戶端遠端呼叫SayHello時，
// 會執行這裡的程式碼
func (s *server) SayHello(ctx context.Context, in *pb.HelloRequest) (*pb.HelloReply, error) {
// 列印請求引數
log.Printf("Received: %v", in.GetName())
// 例項化結構體HelloReply，作為返回值
return &pb.HelloReply{Message: "Hello " + in.GetName()}, nil
}
func main() {
// 要監聽的協議和埠
lis, err := net.Listen("tcp", port)
if err != nil {
log.Fatalf("failed to listen: %v", err)
}
// 例項化gRPC server結構體
s := grpc.NewServer()
// 服務註冊
pb.RegisterGreeterServer(s, &server{})
log.Println("開始監聽，等待遠端呼叫...")
if err := s.Serve(lis); err != nil {
log.Fatalf("failed to serve: %v", err)
}
}
- 在server.go所在目錄執行go run server.go，控制檯提示如下：
[golang@centos7 server]$ go run server.go
2020/12/13 08:20:32 開始監聽，等待遠端呼叫...
- 此時gRPC的服務端已經啟動，可以響應遠端呼叫，接下來開發客戶端程式碼；
編寫客戶端程式碼client.go並啟動
- 再開啟一個控制檯；
- 在$GOPATH/src/helloworld目錄下新建資料夾client，在此資料夾下新建client.go，內容如下，已經新增詳細註釋：
package main
import (
"context"
"log"
"os"
"time"
"google.golang.org/grpc"
pb "helloworld"
)
const (
address = "localhost:50051"
defaultName = "world"
)
func main() {
// 遠端連線服務端
conn, err := grpc.Dial(address, grpc.WithInsecure(), grpc.WithBlock())
if err != nil {
log.Fatalf("did not connect: %v", err)
}
// main方法執行完畢後關閉遠端連線
defer conn.Close()
// 例項化資料結構
c := pb.NewGreeterClient(conn)
// 遠端呼叫的請求引數，如果沒有從命令列傳入，就用預設值
name := defaultName
if len(os.Args) > 1 {
name = os.Args[1]
}
// 超時設定
ctx, cancel := context.WithTimeout(context.Background(), time.Second)
defer cancel()
// 遠端呼叫
r, err := c.SayHello(ctx, &pb.HelloRequest{Name: name})
if err != nil {
log.Fatalf("could not greet: %v", err)
}
// 將服務端的返回資訊列印出來
log.Printf("Greeting: %s", r.GetMessage())
}
- 在client.go所在目錄執行go run client.go，會立即向服務端發起遠端呼叫，控制檯提示如下，可見得到了服務端的返回資訊Hello world：
[golang@centos7 client]$ go run client.go
2020/12/13 08:38:05 Greeting: Hello world
- 再去服務端的控制檯看一下，通過日誌發現業務程式碼被執行，收到了遠端請求的引數：
[golang@centos7 server]$ go run server.go
2020/12/13 08:20:32 開始監聽，等待遠端呼叫...
2020/12/13 08:38:05 Received: world
- 回到客戶端控制檯，在命令列帶引數試試，輸入go run client.go abc，收到服務端響應如下：
[golang@centos7 client]$ go run client.go abc
2020/12/13 08:56:36 Greeting: Hello abc
- 再去服務端的控制檯看一下，成功收到了abc：
[golang@centos7 server]$ go run server.go
2020/12/13 08:20:32 開始監聽，等待遠端呼叫...
2020/12/13 08:38:05 Received: world
2020/12/13 08:56:36 Received: abc
- 至此，一次常規的gRPC開發實戰就完成了，希望能給您一些參考，接下來的文章我們們會繼續深入學習；
你不孤單，欣宸原創一路相伴
歡迎關注公眾號：程式設計師欣宸
微信搜尋「程式設計師欣宸」，我是欣宸，期待與您一同暢遊Java世界...
https://github.com/zq2599/blog_demos