gRPC入门

之前的文章记录如何通过proto文件生成对应.go文件，这篇文章就用gRPC官方例子介绍一下如何写一个helloworld的gRPC程序咯。

我的文件夹路径为:

➜  tree $GOPATH/src/proto
├── client
│   └── main.go
├── hello
│   ├── hello.pb.go
│   └── hello.proto
└── server
    └── main.go

1.创建proto原文件

首先，我们先利用proto文件定义gRPC的消息格式和gRPC服务:

syntax = "proto3";

package hello;

// 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;
}

这里我们定义了一个rpc服务的interface：Greeter并且为其添加一个methodSayHello。SayHello的入参和出参为后面定义HelloRequest和HelloReplymessage。
保存该文件，利用上篇blog的docker方法来编译一下proto文件：

➜  cd $GOPATH/proto
➜  docker run --rm -v $(PWD):$(PWD) -w $(PWD) znly/protoc -I=./hello --go_out=plugins=grpc:./hello ./hello/*.proto

编译之后，在hello文件夹中会生成对应的hello.pb.go。该文件中为我们生成gRPC对应的方法和结构体，其中一个比较重要的interface和method GreeterServer和RegisterGreeterServer：

type GreeterServer interface {
    // Sends a greeting
    SayHello(context.Context, *HelloRequest) (*HelloReply, error)
}
func RegisterGreeterServer(s *grpc.Server, srv GreeterServer) {
    s.RegisterService(&_Greeter_serviceDesc, srv)
}

2.创建服务端

这里我们任意定义一个type server，并且实现其GreeterServer的SayHello方法就可以在服务端注册一个gRPC服务：

package main

import (
    "context"
    "log"
    "net"

    "google.golang.org/grpc"
    pb "proto/hello"
)

const (
    port = ":50051"
)

// server is used to implement hello.GreeterServer.
type server struct{}

// SayHello implements hello.GreeterServer
func (s *server) SayHello(ctx context.Context, in *pb.HelloRequest) (*pb.HelloReply, error) {
    log.Printf("Received: %v", in.Name)
    return &pb.HelloReply{Message: "Hello " + in.Name + ", I'm 大雄"}, 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{})
    if err := s.Serve(lis); err != nil {
        log.Fatalf("failed to serve: %v", err)
    }
}

这里需要注意的是，实际上server可以为任意类型，你可以为任意类型注册一个server，但是gRPC不支持为同一类型注册多个server。

ok，我们可以将server运行起来：

go run server/main.go &

3.创建客户端

package main

import (
    "context"
    "log"
    "os"
    "time"

    "google.golang.org/grpc"
    pb "proto/hello"
)

const (
    address     = "localhost:50051"
    defaultName = "world"
)

func main() {
    // Set up a connection to the server.
    conn, err := grpc.Dial(address, grpc.WithInsecure())
    if err != nil {
        log.Fatalf("did not connect: %v", err)
    }
    defer conn.Close()
    c := pb.NewGreeterClient(conn)

    // Contact the server and print out its response.
    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.Message)
}

客户端代码比较简单，就不用解（tai）释（lan）了。

4.运行结果

客户端：

➜  go run client/main.go
2019/07/22 22:56:33 Greeting: Hello world, I'm 大雄

服务端：

➜  go run server/main.go &
2019/07/22 22:56:33 Received: world

总结

gRPC使用起来结构还是很清晰的，官方例子可以让我们很快入门，下一步应该就是研究一下gRPC的底层原理和debug手段，共勉。