gRPC使用简介

概览

gRPC是一款语言中立、平台中立、开源的远程过程调用（RPC）系统。在gRPC里，客户端应用程序可以像调用本地对象一样直接调用另一台不同机器上，服务端应用的方法，使得你能够更容易的创建分布式应用和服务。与许多RPC系统类似，gRPC也是基于以下理念：定义一个服务，指定其能够被远程调用的方法（包括参数和返回类型）。在服务端实现这个接口，并运行一个gRPC服务器来处理客户端调用。

先决条件

1. 要使用gRPC，你的Go版本必须高于1.6。
2. 安装gRPC，使用命令：$ go get -u google.golang.org/grpc。
3. 安装Protocol Buffers.
4. 安装protoc的Go插件，命令$ go get -u github.com/golang/protobuf/protoc-gen-go。
5. 设置环境变量path，将$GOPATH/bin添加进去。

概念

服务定义

与其他RPC系统一样，gRPC基于定义服务的思想来注册服务。

syntax = "proto3";

package main;

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

gRPC可以让你定义四种服务方法：

• 一元RPC，客户端向服务器发送单个请求，并返回单个响应。就像正常的函数调用一样。

rpc SayHello(HelloRequest) returns (HelloResponse) {}

• 服务器流式RPC，客户端向服务器发送请求并获取流，以读取消息序列。客户端从返回的流中读取，直到没有更多消息。gRPC保证单个RPC调用中的消息排序。

rpc LostOfReplies(HelloRequest) returns (stream HelloResponse) {}

• 客户端流式RPC，客户端使用提供的流，写入一系列消息，并将其发送到服务器。一旦客户端写完消息，它就等待服务器读取它们，并返回它的响应。gRPC同样保证在单个RPC调用中的消息排序。

rpc LostOfGreetings(stream HelloRequest) returns (HelloResponse) {}

• 双向流式RPC，双发使用读写流发送一系列消息。这两个流独立运行，因此客户端和服务器可以按照自己喜欢的顺序进行读写。例如：服务器可以在写入响应之前等待接受所有客户端消息，或者它可以交替的读取消息，然后写入消息。或者其他一些读写组合，保证每个流中的消息顺序。

rpc BidiHello(stream HelloRequest) returns (stream HelloResponse) {}

生成处理消息的代码

$ protoc -I=. ./helloworld.proto --go_out=plugins=grpc:.

命令执行完成后，会在当前目录下生成helloworld.pb.go文件。

在服务端启用gRPC

package main

import (
	"context"
	"log"
	"net"

	"google.golang.org/grpc"

)

const (
	port = ":50051"
)

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

// SayHello implements helloworld.GreeterServer
func (s *server) SayHello(ctx context.Context, in *HelloRequest) (*HelloReply, error) {
	log.Printf("Received: %v", in.Name)
	return &HelloReply{Message: "Hello " + in.Name}, nil
}

func main() {
	lis, err := net.Listen("tcp", port)
	if err != nil {
		log.Fatalf("failed to listen: %v", err)
	}
	s := grpc.NewServer()
	RegisterGreeterServer(s, &server{})
	if err := s.Serve(lis); err != nil {
		log.Fatalf("failed to serve: %v", err)
	}
}

在客户端启用gRPC

package main

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

	"google.golang.org/grpc"
)

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 := 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, &HelloRequest{Name: name})
	if err != nil {
		log.Fatalf("could not greet: %v", err)
	}
	log.Printf("Greeting: %s", r.Message)
}

运行服务端：$ go run greeter_server.go。
运行客户端：$ go run greeter_client.go。
运行后，你在客户端命令行就会看到：Greeting: Hello world

更新服务

下面更新Greeter服务，让它拥有两个方法。编辑helloworld.proto文件，更新Greeter服务，让其有SayHelloAgain方法。

syntax = "proto3";

package main;

// 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代码。假设当前目录下面有helloworld.proto文件。

$ protoc -I=. ./helloworld.proto --go_out=plugins=grpc:.

命令执行完成后，会在当前目录下生成helloworld.pb.go文件。这时我们就需要更新server和client代码，在应用程序中编写部分代码实现调用新的方法。
更新服务端，编辑greeter_server.go文件，添加下面函数：

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

更新客户端，编辑greeter_client.go文件，添加下面函数：

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

运行服务端：$ go run greeter_server/main.go。
运行客户端：$ go run greeter_client/main.go。
运行，你在客户端命令行就会看到：

Greeting: Hello world
Greeting: Hello again world

参考文章

1. gRPC