Go gRPC + Protocol Buffers 完整指南

2024-01-11 20:51:27

简介

gRPC（gRPC远程过程调用）是一种由 Google 开发的开放源代码框架，用于构建高性能 RPC 应用程序。它使用 Protocol Buffers（Protobuf）作为其数据序列化格式，Protobuf 是一种轻量级、高效且语言无关的数据交换格式。本文将提供一个全面的 Go gRPC + Protocol Buffers 指南，从基础知识到高级用法。

先决条件

Go 语言基础知识
gRPC 和 Protocol Buffers 基础知识
文本编辑器或 IDE

设置

首先，您需要在项目中安装 gRPC 和 Protocol Buffers 库。您可以使用以下命令：

go get google.golang.org/grpc
go get github.com/golang/protobuf/protoc-gen-go

创建 gRPC 服务

要创建 gRPC 服务，您需要定义一个 protobuf 文件（通常以 .proto 为扩展名），其中定义了服务及其方法。下面是一个示例 protobuf 文件：

syntax = "proto3";

package helloworld;

service Greeter {
  rpc SayHello(HelloRequest) returns (HelloResponse);
}

message HelloRequest {
  string name = 1;
}

message HelloResponse {
  string message = 1;
}

生成 gRPC 代码

一旦您定义了 protobuf 文件，您需要使用 Protocol Buffers 编译器生成 gRPC 代码。您可以使用以下命令：

protoc --go_out=plugins=grpc:. helloworld.proto

这将在您的项目中生成 helloworld.pb.go 和 helloworld_grpc.pb.go 文件，其中包含 gRPC 服务的接口和实现。

实现 gRPC 服务

下一步是实现 gRPC 服务。您可以通过创建实现服务接口的结构来实现此目的。例如：

type GreeterServer struct {}

func (s *GreeterServer) SayHello(ctx context.Context, req *helloworldpb.HelloRequest) (*helloworldpb.HelloResponse, error) {
  return &helloworldpb.HelloResponse{
    Message: "Hello, " + req.GetName(),
  }, nil
}

运行 gRPC 服务器

现在您已经实现了 gRPC 服务，您可以运行服务器以使其可供客户端访问。您可以使用以下代码：

func main() {
  lis, err := net.Listen("tcp", ":50051")
  if err != nil {
    log.Fatalf("failed to listen: %v", err)
  }

  s := grpc.NewServer()
  helloworldpb.RegisterGreeterServer(s, &GreeterServer{})
  if err := s.Serve(lis); err != nil {
    log.Fatalf("failed to serve: %v", err)
  }
}

创建 gRPC 客户端

要调用 gRPC 服务，您需要创建 gRPC 客户端。您可以使用以下代码：

func main() {
  conn, err := grpc.Dial("localhost:50051", grpc.WithInsecure())
  if err != nil {
    log.Fatalf("failed to dial: %v", err)
  }

  defer conn.Close()

  c := helloworldpb.NewGreeterClient(conn)
  resp, err := c.SayHello(context.Background(), &helloworldpb.HelloRequest{
    Name: "John",
  })
  if err != nil {
    log.Fatalf("failed to call SayHello: %v", err)
  }

  fmt.Println(resp.Message)
}

使用 gRPC 流

gRPC 还支持流，您可以使用它们来处理数据流。以下是如何使用 gRPC 流：

func main() {
  conn, err := grpc.Dial("localhost:50051", grpc.WithInsecure())
  if err != nil {
    log.Fatalf("failed to dial: %v", err)
  }

  defer conn.Close()

  c := helloworldpb.NewGreeterClient(conn)

  stream, err := c.SayHelloStream(context.Background())
  if err != nil {
    log.Fatalf("failed to call SayHelloStream: %v", err)
  }

  go func() {
    for {
      req := &helloworldpb.HelloRequest{
        Name: "John",
      }
      if err := stream.Send(req); err != nil {
        log.Fatalf("failed to send: %v", err)
      }
      time.Sleep(time.Second)
    }
  }()

  for {
    resp, err := stream.Recv()
    if err == io.EOF {
      break
    }
    if err != nil {
      log.Fatalf("failed to receive: %v", err)
    }

    fmt.Println(resp.Message)
  }
}