Golang gRPC笔记

Posted on Edited on

gRPC 简介：

gRPC 是一款高性能、开源的 RPC（Remote Procedure Call）框架，产自 Google，基于 ProtoBuf 序列化协议进行开发，支持多种语言（Golang、Python、Java等），本篇只介绍 Golang 的 gRPC 使用。因为 gRPC 对 HTTP/2 协议的支持使其在 Android、IOS 等客户端后端服务的开发领域具有良好的前景。gRPC 提供了一种简单的方法来定义服务，同时客户端可以充分利用 HTTP/2 stream 的特性，从而有助于节省带宽、降低 TCP 的连接次数、节省CPU的使用等。

安装：

gRPC 的安装：

1
$ go get -u google.golang.org/grpc

因为 gRPC 是基于 protobuf 实现的接口序列化，所以也要安装 protobuf： 安装及简介教程(Golang 序列化之 ProtoBuf)。

实验：

下面我们使用 gRPC 定义一个接口，该接口实现对传入的数据进行大写的格式化处理。

  1. 创建项目 golang Demo 工程：

client目录下的 main.go 实现了客户端用于发送数据并打印接收到 server 端处理后的数据

  1. server 目录下的 main.go 实现了服务端用于接收客户端发送的数据，并对数据进行大写处理后返回给客户端
  2. example 包用于编写 proto 文件并生成 data 接口
  3. 定义 gRPC 接口：
1
2
3
4
5
6
7
8
9
syntax = "proto3";
package example;
service FormatData {
    rpc DoFormat(Data) returns (Data){} 
    // 此处定义的方法为简单RPC。其余的服务器端流式 RPC，客户端流式 RPC，双向流式 RPC请查询参考链接
}
message Data {
    string text = 1;
}

编译 protobuf：

1
protoc --go_out=plugins=grpc:. *.proto // 在 example 目录中执行编译，会生成：data.pb.go

实现 server 端：

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
package main
import (
	"gRPCDemo/example"
	"net"
	"google.golang.org/grpc"
	"google.golang.org/grpc/reflection"
	"golang.org/x/net/context"
	"strings"
	"log"
)
// 定义监听地址
const (
	HOST string = "localhost"
	PORT string = "8080"
)
// 定义接口
type FormatData struct{}
func (fd *FormatData) DoFormat(ctx context.Context, in *example.Data) (out *example.Data, err error) {
	str := in.Text
	out = &example.Data{Text: strings.ToUpper(str)}
	return out, nil
}
// 直接在 main 方法中注册接口
func main() {
	// 启动服务器
	// 指定我们期望客户端请求的监听端口
	listener, err := net.Listen("tcp", HOST+":"+PORT)
	if err != nil {
		log.Fatalln("faile listen at: " + HOST + ":" + PORT)
	} else {
		log.Println("Demo server is listening at: " + HOST + ":" + PORT)
	}
	// 创建 gRPC 服务器的一个实例
	rpcServer := grpc.NewServer()
	// 在 gRPC 服务器注册我们的服务实现
	example.RegisterFormatDataServer(rpcServer, &FormatData{})
	reflection.Register(rpcServer)
	// 实现阻塞等待，直到进程被杀死或者 Stop() 被调用
	if err = rpcServer.Serve(listener); err != nil {
		log.Fatalln("faile serve at: " + HOST + ":" + PORT)
	}
}

实现 client 端：

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
package main
import (
	"google.golang.org/grpc"
	"log"
	"gRPCDemo/example"
	"golang.org/x/net/context"
)
// 定义请求地址
const (
	ADDRESS string = "localhost:8080"
)
// main 方法实现对 gRPC 接口的请求
func main() {
	// 为了调用服务方法，我们首先创建一个 gRPC channel 和服务器交互。
	// 可以使用 DialOptions 在 grpc.Dial 中设置授权认证（如， TLS，GCE认证，JWT认证）
	conn, err := grpc.Dial(ADDRESS, grpc.WithInsecure())
	if err != nil {
		log.Fatalln("Can't connect: " + ADDRESS)
	}
	defer conn.Close()
	// 一旦 gRPC channel 建立起来，我们需要一个客户端 存根 去执行 RPC
	client := example.NewFormatDataClient(conn)
	// 调用简单 RPC
	resp,err := client.DoFormat(context.Background(), &example.Data{Text:"hello,world!"})
	// 如果调用没有返回错误，那么我们就可以从服务器返回的第一个返回值中读到响应信息
	if err != nil {
		log.Fatalln("Do Format error:" + err.Error())
	}
	log.Println(resp.Text)
}

执行验证结果：
先启动 server，之后再执行 client
client 侧控制台如果打印的结果为： HELLO,WORLD! ，证明 gRPC 接口定义成功。

参考

http://doc.oschina.net/grpc?t=60133

https://github.com/grpc/grpc-go

https://grpc.io/