1. 小案例

按照惯例，这里也从一个Hello项目开始，本项目定义了一个Hello Service，客户端发送包含字符串名字的请求，服务端返回Hello消息。

流程：

  • 编写.proto描述文件
  • 编译生成.pb.go文件
  • 服务端实现约定的接口并提供服务
  • 客户端按照约定调用.pb.go文件中的方法请求服务

项目结构：

  1. |—— hello/
  2.     |—— client/
  3.         |—— main.go   // 客户端
  4.     |—— server/
  5.         |—— main.go   // 服务端
  6. |—— proto/
  7.     |—— hello/
  8.         |—— hello.proto   // proto描述文件
  9.         |—— hello.pb.go   // proto编译后文件

Step1：编写描述文件：hello.proto

  1. syntax = "proto3"; // 指定proto版本
  2. package hello;     // 指定默认包名
  4. // 指定golang包名
  5. option go_package = "hello";
  7. // 定义Hello服务
  8. service Hello {
  9.     // 定义SayHello方法
  10.     rpc SayHello(HelloRequest) returns (HelloResponse) {}
  11. }
  13. // HelloRequest 请求结构
  14. message HelloRequest {
  15.     string name = 1;
  16. }
  18. // HelloResponse 响应结构
  19. message HelloResponse {
  20.     string message = 1;
  21. }

hello.proto文件中定义了一个Hello Service，该服务包含一个SayHello方法，同时声明了HelloRequest和HelloResponse消息结构用于请求和响应。客户端使用HelloRequest参数调用SayHello方法请求服务端，服务端响应HelloResponse消息。一个最简单的服务就定义好了。

Step2：编译生成.pb.go文件

  1. $ cd proto/hello
  3. # 编译hello.proto
  4. $ protoc -I . --go_out=plugins=grpc:. ./hello.proto

在当前目录内生成的hello.pb.go文件，按照.proto文件中的说明，包含服务端接口HelloServer描述，客户端接口及实现HelloClient，及HelloRequest、HelloResponse结构体。

注意：不要手动编辑该文件

Step3：实现服务端接口 server/main.go

  1. package main
  3. import (
  4.     "fmt"
  5.     "net"
  7.     pb "github.com/jergoo/go-grpc-example/proto/hello" // 引入编译生成的包
  8.     "golang.org/x/net/context"
  9.     "google.golang.org/grpc"
  10.     "google.golang.org/grpc/grpclog"
  11. )
  13. const (
  14.     // Address gRPC服务地址
  15.     Address = "127.0.0.1:50052"
  16. )
  18. // 定义helloService并实现约定的接口
  19. type helloService struct{}
  21. // HelloService Hello服务
  22. var HelloService = helloService{}
  24. // SayHello 实现Hello服务接口
  25. func (h helloService) SayHello(ctx context.Context, in *pb.HelloRequest) (*pb.HelloResponse, error) {
  26.     resp := new(pb.HelloResponse)
  27.     resp.Message = fmt.Sprintf("Hello %s.", in.Name)
  29.     return resp, nil
  30. }
  32. func main() {
  33.     listen, err := net.Listen("tcp", Address)
  34.     if err != nil {
  35.         grpclog.Fatalf("Failed to listen: %v", err)
  36.     }
  38.     // 实例化grpc Server
  39.     s := grpc.NewServer()
  41.     // 注册HelloService
  42.     pb.RegisterHelloServer(s, HelloService)
  44.     grpclog.Println("Listen on " + Address)
  45.     s.Serve(listen)
  46. }

服务端引入编译后的proto包，定义一个空结构用于实现约定的接口，接口描述可以查看hello.pb.go文件中的HelloServer接口描述。实例化grpc Server并注册HelloService，开始提供服务。

运行：

  1. $ go run main.go
  2. Listen on 127.0.0.1:50052  //服务端已开启并监听50052端口

Step4：实现客户端调用 client/main.go

  1. package main
  3. import (
  4.     pb "github.com/jergoo/go-grpc-example/proto/hello" // 引入proto包
  5.     "golang.org/x/net/context"
  6.     "google.golang.org/grpc"
  7.     "google.golang.org/grpc/grpclog"
  8. )
  10. const (
  11.     // Address gRPC服务地址
  12.     Address = "127.0.0.1:50052"
  13. )
  15. func main() {
  16.     // 连接
  17.     conn, err := grpc.Dial(Address, grpc.WithInsecure())
  18.     if err != nil {
  19.         grpclog.Fatalln(err)
  20.     }
  21.     defer conn.Close()
  23.     // 初始化客户端
  24.     c := pb.NewHelloClient(conn)
  26.     // 调用方法
  27.     req := &pb.HelloRequest{Name: "gRPC"}
  28.     res, err := c.SayHello(context.Background(), req)
  30.     if err != nil {
  31.         grpclog.Fatalln(err)
  32.     }
  34.     grpclog.Println(res.Message)
  35. }

客户端初始化连接后直接调用hello.pb.go中实现的SayHello方法，即可向服务端发起请求，使用姿势就像调用本地方法一样。

运行：

  1. $ go run main.go
  2. Hello gRPC.    // 接收到服务端响应

如果你收到了"Hello gRPC"的回复，恭喜你已经会使用github.com/jergoo/go-grpc-example/proto/hello了。

建议到这里仔细看一看hello.pb.go文件中的内容，对比hello.proto文件，理解protobuf中的定义转换为golang后的结构。