2.1 gRPC環(huán)境安裝
2.1.1 golang環(huán)境安裝
接下來(lái)的所有的教程以及代碼都是golang代碼進(jìn)行演示拟杉,所以我們需要安裝golang環(huán)境:
下載地址:golang 官網(wǎng)
安裝完在你的命令行工具輸入
go version
就可以看到對(duì)應(yīng)的下載版本
然后就可以了胚吁。
2.1.2 protoc 安裝
在 gRPC 開(kāi)發(fā)中,我們常常需要與 Protobuf 進(jìn)行打交道,而在編寫了.proto 文件后,我們會(huì)需要到一個(gè)編譯器,就是protoc点寥。這個(gè)工具呢可以在GitHub上直接下載
https://github.com/protocolbuffers/protobuf/releases
大家可以在這個(gè)網(wǎng)站自行下載安裝(因?yàn)橹斑@里安裝完了,也不想重裝了来吩,可能記得不太清了敢辩,你們直接試一試就好了,等下次重裝再豐富這里)
一般操作是把protoc編譯文件所在的目錄配到環(huán)境變量里就好了
安裝完后:
運(yùn)行
protoc --version
就可以看見(jiàn)版本信息了
2.1.2 安裝相關(guān)依賴包
安裝 golang 的proto工具包
go get -u github.com/golang/protobuf/proto
安裝 goalng 的proto編譯支持
go get -u github.com/golang/protobuf/protoc-gen-go
安裝 gRPC 包
go get -u google.golang.org/grpc
這樣子就基本上結(jié)束對(duì)于環(huán)境的安裝了
2.2 gRPC簡(jiǎn)單demo
2.2.1 protocol buffer 語(yǔ)法
在gRPC中主要以protocol buffer來(lái)定義api以及服務(wù)误褪,所以我們需要先了解一下protocol buffer的語(yǔ)法。protocol buffer主要使用中有兩個(gè)版本:proto2和proto3碾褂,這里呢兽间,推薦大家使用proto3進(jìn)行日常開(kāi)發(fā)。
首先:一切的學(xué)習(xí)都要學(xué)會(huì)看文檔:這里是谷歌對(duì)于protocol buffer proto3版本的的文檔Language Guide (proto3)
當(dāng)然你要是覺(jué)得英文看不過(guò)去的話正塌,這里還有鳥(niǎo)窩大大轉(zhuǎn)發(fā)的千念飛羽大大翻譯的Protobuf3語(yǔ)言指南可以讓大家學(xué)習(xí)嘀略。
接下來(lái)是一個(gè)最最最簡(jiǎn)單protocol buffer demo,可搭配注釋食用:
//指定proto3語(yǔ)法
syntax = "proto3";
//包名
package helloworld;
//一個(gè)為Hello的服務(wù)(可定義多個(gè)服務(wù),每個(gè)服務(wù)可定義多個(gè)方法)
service Hello {
//一個(gè)SayHello的方法
rpc SayHello (HelloRequest) returns (HelloResp) {}
}
// 定義發(fā)送請(qǐng)求信息
message HelloRequest {
// 定義發(fā)送的參數(shù)
// 參數(shù)類型 參數(shù)名 標(biāo)識(shí)號(hào)(不可重復(fù))
string name = 1;
}
// 定義響應(yīng)信息
message HelloResp {
string message = 1;
}
2.2.2 編譯proto文件
在編譯文件前乓诽,我們先搭建一個(gè)最簡(jiǎn)單的項(xiàng)目目錄帜羊,用來(lái)具體演示相關(guān)操作:
client:gRPC客戶端代碼
pb:存放公共pb文件以及編譯文件
server:gRPC服務(wù)端代碼
接下來(lái)可以編譯編寫好的代碼
通過(guò)下面的命令就可以直接生成對(duì)應(yīng)語(yǔ)言的代碼,具體代碼可見(jiàn):這里
protoc --go_out=plugins=grpc:. *.proto
2.2.3 編寫服務(wù)端代碼
接下來(lái)便可以編寫服務(wù)端代碼(結(jié)合注釋食用即可)
import (
"context"
pb "github.com/CodeFish-xiao/blogs/gRPCAction/code/grpc-2/pb"
"google.golang.org/grpc"
"log"
"net"
)
// HelloService 定義我們的服務(wù)
type HelloService struct {
}
// SayHello 實(shí)現(xiàn)SayHello方法
func (s *HelloService) SayHello(ctx context.Context, req *pb.HelloRequest) (*pb.HelloResp, error) {
log.Println(req.Name)
return &pb.HelloResp{Message: "hello ,I'm codefish "},nil
}
const (
// Address 監(jiān)聽(tīng)地址
Address string = ":8000"
// Network 網(wǎng)絡(luò)通信協(xié)議
Network string = "tcp"
)
func main() {
// 監(jiān)聽(tīng)本地端口
listener, err := net.Listen(Network, Address)
if err != nil {
log.Panic("net.Listen err: %v", err)
}
log.Println(Address + " net.Listing...")
// 新建gRPC服務(wù)器實(shí)例
grpcServer := grpc.NewServer()
// 在gRPC服務(wù)器注冊(cè)我們的服務(wù)
pb.RegisterHelloServer(grpcServer,&HelloService{})
//用服務(wù)器 Serve() 方法以及我們的端口信息區(qū)實(shí)現(xiàn)阻塞等待鸠天,直到進(jìn)程被殺死或者 Stop() 被調(diào)用
err = grpcServer.Serve(listener)
if err != nil {
log.Panic("grpcServer.Serve err: %v", err)
}
}
運(yùn)行客戶端可見(jiàn):
這就是運(yùn)行成功了
2.2.4 編寫客戶端代碼
接下來(lái)編寫客戶端代碼:結(jié)合注釋食用:
import (
"context"
pb "github.com/CodeFish-xiao/blogs/gRPCAction/code/grpc-2/pb"
"google.golang.org/grpc"
"log"
)
const (
// ServerAddress 連接地址
ServerAddress string = ":8000"
)
func main() {
// 連接服務(wù)器
conn, err := grpc.Dial(ServerAddress, grpc.WithInsecure())
if err != nil {
log.Fatalf("net.Connect err: %v", err)
}
defer conn.Close()
// 建立gRPC連接
grpcClient := pb.NewHelloClient(conn)
// 創(chuàng)建發(fā)送結(jié)構(gòu)體
req := pb.HelloRequest{
Name: "grpc",
}
// 調(diào)用我們的服務(wù)(SayHello方法)
// 同時(shí)傳入了一個(gè) context.Context 讼育,在有需要時(shí)可以讓我們改變RPC的行為,比如超時(shí)/取消一個(gè)正在運(yùn)行的RPC
res, err := grpcClient.SayHello(context.Background(), &req)
if err != nil {
log.Fatalf("Call SayHelloerr: %v", err)
}
// 打印返回值
log.Println(res)
}
運(yùn)行后可見(jiàn):
并且在server的控制臺(tái)可以看到打印的參數(shù):
總結(jié)
這樣子便可以搭建一個(gè)簡(jiǎn)單的gRPC服務(wù)了稠集,可以讓客戶端和服務(wù)端進(jìn)行簡(jiǎn)單的業(yè)務(wù)交互了奶段,當(dāng)然這才剛剛開(kāi)始。剥纷。痹籍。
本章代碼可見(jiàn)codefish的github