在golang中如何使用gRPC和Protocol buffers

定义

gRPC是一种在两个系统间发送和接受消息的传输机制。传统上这些系统是服务器端和客户端。
一个使用golang实现的，用于传输JSON的RPC，我们叫做JSON RPC；类似的，gRPC被设计用来以protocol buf形式来传输数据。
gRPC使创建服务变得容易和优雅。它提供了一组良好的API用于定义和运行服务。
gRPC的主要优势是它可以支持多种语言。Protocol buffers提供了一个通用的数据结构。这样的组合使得系统和不同的技术栈间可以进行无缝通信。

优势

• gRPC使用HTTP/2这个二进制的协议；
• 在HTTP/2中header是可压缩的，这样的话传输负载会比较小；
• 在一个连接中可以发送多个请求；
• 我们可以使用protocol buffers带来的强类型带来的好处；
• 除了请求、响应这种传统模式外，我可以以流的方式处理请求和响应；

安装

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

使用

一个gRPC中的服务就是RPC中的一个合约。它接受一个消息，返回另一个消息。
实现一个服务的步骤如下：

1. 创建服务和消息的protocol buffer文件；
2. 编译protocol buffer文件；
3. 使用产生的golang文件来创建一个gRPC服务器；
4. 创建gRPC客户端，用来与服务器通信；

定义服务和消息

syntax = "proto3";
package protofiles;

message TransactionRequest {
  string from = 1;
  string to = 2;
  float amount = 3;
}

message TransactionResponse {
  bool confirm = 1;
}

service MoneyTransaction {
  rpc MakeTransaction(TransactionRequest) returns (TransactionResponse) {}
}

在这里，service这个关键字定义了一个gRPC服务。这个关键字只是和gRPC有关，在protoc编译器编辑此文件时，protoc-gen-go这个插件会把service定义转化为一个可理解的底层结构。

编译

在我们定义完我们的消息和服务后，我们可以使用如下的命令编译protocol buffers文件，形成golang文件：

protoc -I protofiles/ protofiles/transaction.proto --go_out=plugins=grpc:protofiles

使用

创建服务器端

当我们打开编译protocol buffers后产生的golang文件，我们会看到两个比较重要的内容：

1. MakeTransaction函数，它是MoneyTransactionServer接口的一部分
2. RegisterMoneyTransactionServer函数
   MakeTransaction用于实现一个服务，下面是一个具体的实现：

type server struct{}
// MakeTransaction implements MoneyTransactionServer.MakeTransaction
func (s *server) MakeTransaction(ctx context.Context, in *pb.TransactionRequest) (*pb.TransactionResponse, error) {
	// Use in.Amount, in.From, in.To and perform transaction logic
	return &pb.TransactionResponse{Confirm: true}, nil
}

下面我们就会创建一个gRPC服务器的实例，然后注册我们实现MoneyTransactionServer接口的类实例：

const (
	port = ":50051"
)

func main() {
	lis, err := net.Listen("tcp", port)
	if err != nil {
		log.Fatal(err.Error())
	}
	s := grpc.NewServer()
	pb.RegisterMoneyTransactionServer(s, &server{})
	reflection.Register(s)
	if err := s.Serve(lis); err != nil {
		log.Fatalf("Failed to serve: %v", err)
	}
}

创建客户端

客户端可以连接服务器，获取一个连接。使用连接，我们可以调用远程函数来获取结果。一个gRPC客户端需要使用与服务器端同步的protobuf脚手架类，下面是一个客户端代码的实例：

package main

import (
	"golang.org/x/net/context"
	"google.golang.org/grpc"
	pb "grpcdemo/protofiles"
	"log"
)

const (
	address = "localhost:50051"
)

func main() {
	conn, err := grpc.Dial(address, grpc.WithInsecure())
	if err != nil {
		log.Fatal(err.Error())
	}
	c := pb.NewMoneyTransactionClient(conn)
	from := "1234"
	to := "5678"
	amount := float32(1250.75)
	r, err := c.MakeTransaction(context.Background(), &pb.TransactionRequest{
		From:                 from,
		To:                   to,
		Amount:               amount,
	})
	log.Println(r.Confirm)
}

运行

我们通过go run命令可以分别运行服务器端代码和客户端代码。在客户端代码运行完成后会显示如下信息：