Go 语言之 gRPC 入门

这篇文章将通过一个简单的工作示例帮助你开始在 Go 中使用 gRPC。

如果对 gRPC 不了解，可以先参考 gRPC 简介

一、先决条件

• Go ，最近三个主要版本的任意一个版本\
• Protocol buffer 编译器，protoc v3\
• Go 的 protocol 编译器插件\
  1. 使用以下命令安装 Go 的 protocol 编译插件

  $ go install google.golang.org/protobuf/cmd/protoc-gen-go@v1.28
  $ go install google.golang.org/grpc/cmd/protoc-gen-go-grpc@v1.2
  

  1. 更新 PATH 环境变量以便让 protoc 编译能够找到此插件

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

二、获取示例代码

示例代码是 grpc-go 代码仓库的一部分

1. 以 zip 方式下载整个 repo 然后解压它，或者 clone 这个 repo：

   $ git clone -b v1.48.0 --depth 1 https://github.com/grpc/grpc-go
   

2. 切换到快速启动示例的目录

   $ cd grpc-go/examples/helloworld
   

三、运行示例

从 examples/helloworld 目录：

1. 编译执行服务端代码：

   $ go run greeter_server/main.go
   

2. 从其它终端编译并执行客户端代码以查看客户端输出：

   $ go run greeter_client/main.go
   2022/08/14 21:28:51 Greeting: Hello world
   

恭喜，你刚刚使用 gRPC 运行了一个客户端-服务器应用程序。

四、更新 gRPC Service

在本节中，你将用一个额外的服务端方法来更新应用程序。gRPC服务是使用 protocol buffer 定义的，要了解更多如何在 .proto 文件中定义服务的信息，请查看基础课程的内容。现在你只需要知道服务器和客户端存根都有一个SayHello() 的 RPC 方法，它从客户端接收一个 HelloRequest 参数并从服务端返回一个 HelloReply ，该方法的定义是这样的：

// The greeting service definition.
service Greeter {
  // Sends a greeting
  rpc SayHello (HelloRequest) returns (HelloReply) {}
}

// The request message containing the user's name.
message HelloRequest {
  string name = 1;
}

// The response message containing the greetings
message HelloReply {
  string message = 1;
}

打开 helloworld/helloworld.proto 增加一个新的方法 SayHelloAgain()，相同的请求和响应类型：

// The greeting service definition.
service Greeter {
  // Sends a greeting
  rpc SayHello (HelloRequest) returns (HelloReply) {}
  // Sends another greeting
  rpc SayHelloAgain (HelloRequest) returns (HelloReply) {}
}

// The request message containing the user's name.
message HelloRequest {
  string name = 1;
}

// The response message containing the greetings
message HelloReply {
  string message = 1;
}

记得保存它！

五、生成 gRPC 代码

在使用新的 service 方法之前，你需要重新编译更新后的 .proto 文件。 仍然在 examples/helloworld 目录，运行下面的命令：

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

这将生成 helloworld/helloworld.pb.go 和 elloworld/helloworld_grp.pb.go 文件，包含：

• 用于填充、序列化和检索 HelloRequest 和 HelloReply 消息类型的代码（Code for populating, serializing, and retrieving HelloRequest and HelloReply message types.）

• 生成的客户端和服务器代码

六、更新并运行应用程序

你已经重新生成了服务器和客户端代码，但你仍然需要在示例程序的人工编译部分中实现和调用新的方法。

更新服务端

打开 greeter_server/main.go 然后向其中添加以下函数：

func (s *server) SayHelloAgain(ctx context.Context, in *pb.HelloRequest) (*pb.HelloReply, error) {
        return &pb.HelloReply{Message: "Hello again " + in.GetName()}, nil
}

更新客户端

打开 greeter_client/main.go 将以下代码添加到 main() 函数体的末尾：

r, err = c.SayHelloAgain(ctx, &pb.HelloRequest{Name: *name})
if err != nil {
        log.Fatalf("could not greet: %v", err)
}
log.Printf("Greeting: %s", r.GetMessage())

记得保存你的修改。

运行

像上面以前一样运行客户端和服务端。从 examples/helloworld 目录执行以下命令：

1. 运行服务端：

$ go run greeter_server/main.go

1. 从另一个终端运行客户端，这次添加一个 name 作为命令行参数：

$ go run greeter_client/main.go --name=Alice

你将看到下列输出：

2022/08/14 22:07:33 Greeting: Hello Alice
2022/08/14 22:07:33 Greeting: Hello again Alice

Quick start grpc.io/docs/langua… Releases of Go golang.org/doc/devel/r… Protocol buffer developers.google.com/protocol-bu… Protocol Buffer Compiler Installation grpc.io/docs/protoc… grpc-go repo github.com/grpc/grpc-g…