Golang 語言 gRPC 怎么使用？

作者： frank 2021-09-13 05:02:49

既然我們要介紹 gRPC 怎么在 Golang 語言中使用，那么我們必須搭建 Golang 開發環境。這部分內容比較簡單，本文就不再贅述了，如果有讀者朋友對這塊內容不清楚，建議閱讀 Golang 官網文檔。

[[423367]]

01介紹

在之前的兩篇文章中，我們已經介紹了使用 gRPC 創建 RPC 應用的前導知識。我們了解到 gRPC 支持多語言，本文我們介紹在 Golang 語言中怎么使用 gRPC。

02準備工作

此外，我們還需要安裝接口設計語言 Protocol buffer 的編譯器 protoc，我們在之前的文章「Protobuf - 更小、更快、更簡單的交互式數據語言」中也已經介紹過 protoc 的安裝方法，本文就不再贅述了，如果有需要了解的讀者朋友，可以翻閱一下這篇文章。

最后，我們介紹一下 protoc 編譯生成 pb 文件需要使用的插件 protoc-gen-go 和 protoc-gen-go-grpc。插件安裝方式，具體如下：

執行 go install 命令安裝插件

go install google.golang.org/protobuf/cmd/protoc-gen-go@v1.26 
 go install google.golang.org/grpc/cmd/protoc-gen-go-grpc@v1.1

修改 PATH

$ export PATH="$PATH:$(go env GOPATH)/bin"

完成以上兩步之后，我們就可以使用 protoc 編譯 .proto 文件，生成 pb 文件了。

03編寫 .proto 文件和生成 pb 文件

在 Golang 語言中使用 gRPC，首先編寫 .proto 文件，然后使用 protoc 編譯 .proto 文件生成 pb 文件，最后編寫剩余的 Golang 代碼。

接口設計語言 protobuf，在之前的文章「Golang 語言 gRPC 使用的接口設計語言 protobuf」中也已經介紹過了，本文不再贅述，如果有需要了解的讀者朋友，可以翻閱一下這篇文章。

示例代碼：

編寫 .proto 文件。

syntax = "proto3"; 
 
option go_package = "advanced_go/lesson06/proto/greeter"; 
 
service Greeter { 
  rpc SayHello (HelloRequest) returns (HelloReply) {} 
} 
 
message HelloRequest { 
  string name = 1; 
} 
 
message HelloReply { 
  string message = 1; 
}

使用 protoc 編譯 .proto 文件，生成 pb 文件。

$ protoc --go_out=. --go_opt=paths=source_relative \ 
--go-grpc_out=. --go-grpc_opt=paths=source_relative \ 
proto/helloworld.proto

04編寫服務端和客戶端 Golang 代碼

我們在之前的文章中介紹過 gRPC 是什么，接下來，我們通過示例代碼介紹在 Golang 語言中怎么使用 gRPC，本文先來介紹使用 gRPC 的編碼流程，限于篇幅，關于 gRPC 的更多使用方法，后續會新開篇文章介紹。

首先使用接口設計語言 protobuf 的編譯器 protoc、protoc-gen-go 和 protoc-gen-go-grpc 插件生成 pb 文件，我們通過查看生成的 pb 文件，可以看到 protoc 為我們自動生成結構體、接口和方法等 Golang 代碼。

接下來，我們只需把剩余的 Golang 代碼寫完就可以了，具體實現如下：

服務端示例代碼：

const ( 
 port = ":50051" 
) 
 
type server struct { 
 pb.UnimplementedGreeterServer 
} 
 
func (s *server) SayHello(ctx context.Context, in *pb.HelloRequest) (*pb.HelloReply, error) { 
 log.Printf("Received: %v", in.GetName()) 
 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) 
 } 
 s := grpc.NewServer() 
 pb.RegisterGreeterServer(s, &server{}) 
 log.Printf("server listening at %v", lis.Addr()) 
 if err := s.Serve(lis); err != nil { 
  log.Fatalf("failed to serve: %v", err) 
 } 
}

閱讀上面這段代碼，我們使用 Golang 語言編寫了 SayHello 方法，該方法實際上就是 pb 文件中自動生成的 SayHello 方法的具體實現，對應自動生成的 pb 文件 helloworld_grpc.pb.go 中的代碼如下：

// UnimplementedGreeterServer must be embedded to have forward compatible implementations. 
type UnimplementedGreeterServer struct { 
} 
 
func (UnimplementedGreeterServer) SayHello(context.Context, *HelloRequest) (*HelloReply, error) { 
 return nil, status.Errorf(codes.Unimplemented, "method SayHello not implemented") 
}

在 main 函數中，我們使用 grpc 調用 NewServer 函數創建一個服務，然后使用 pb 文件中的 RegisterGreeterServer 函數注冊服務，對應自動生成的 pb 文件 helloworld_grpc.pb.go 中的代碼如下：

func RegisterGreeterServer(s grpc.ServiceRegistrar, srv GreeterServer) { 
 s.RegisterService(&Greeter_ServiceDesc, srv) 
}

客戶端示例代碼：

const( 
 address = ":50051" 
 defaultName = "word" 
) 
 
func main () { 
 conn, err := grpc.Dial(address, grpc.WithInsecure(), grpc.WithBlock()) 
 if err != nil { 
  log.Fatalf("did not connect: %v", err) 
 } 
 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()) 
}

閱讀上面這段代碼，我們使用 pb 文件中的 NewGreeterClient 方法創建一個客戶端，然后就可以使用創建的客戶端直接調用服務端的 SayHello 方法，對應自動生成的 pb 文件 helloworld_grpc.pb.go 中的代碼如下：

type GreeterClient interface { 
 SayHello(ctx context.Context, in *HelloRequest, opts ...grpc.CallOption) (*HelloReply, error) 
} 
 
type greeterClient struct { 
 cc grpc.ClientConnInterface 
} 
 
func NewGreeterClient(cc grpc.ClientConnInterface) GreeterClient { 
 return &greeterClient{cc} 
} 
 
func (c *greeterClient) SayHello(ctx context.Context, in *HelloRequest, opts ...grpc.CallOption) (*HelloReply, error) { 
 out := new(HelloReply) 
 err := c.cc.Invoke(ctx, "/Greeter/SayHello", in, out, opts...) 
 if err != nil { 
  return nil, err 
 } 
 return out, nil 
}

編寫完服務端和客戶端代碼，接下來，我們分別啟動服務端和客戶端，執行結果如下：

go run grpc_server/main.go  
2021/09/11 23:02:59 server listening at [::]:50051 
2021/09/11 23:03:23 Received: word 
2021/09/11 23:03:31 Received: frank 
 
go run grpc_client/main.go  
2021/09/11 23:03:23 Greeting: Hello word 
 
go run grpc_client/main.go frank 
2021/09/11 23:03:31 Greeting: Hello frank

05總結

本文我們介紹在 Golang 語言中怎么使用 gRPC，為了方便讀者朋友們理解，文章通過一個簡單示例從零到一的實現，介紹了在 Golang 語言中使用 gRPC 的編碼流程。

建議讀者朋友們閱讀完本文，動手敲一遍示例代碼，來進一步加深理解。限于篇幅，關于 gRPC 的更多使用方法，我們后續撰文介紹。

編碼流程歸納如下：

搭建 Golang 開發環境。
安裝 protobuf 編譯器 protoc 和插件 protoc-gen-go、protoc-gen-go-grpc，設置環境變量。
初始化項目 go mod init。
編寫 protobuf，生成 pb 文件，執行 go mod tidy 整理依賴包。
編寫剩余 Golang 代碼。

責任編輯：武曉燕來源： Golang語言開發棧

Go gRPC 語言