Go gRPC 入门与实践

一. gRPC 是什么

1. 官网简介: A high-performance, open-source universal RPC framework
   • gRPC 是一个高性能的, 开源统一的 RPC 框架
2. RPC (Remote Procedure Calls), 是指远程过程调用
   • 包含了传输协议和编码 (对象序列号) 协议
   • 服务的程序 A 调用另一台服务的程序 B
3. 除了 gRPC 框架之外, 还有 net/rpc (go 标准库), Thrift (C++), Motan, Dubbo (Java) 等 RPC 框架.
   • 衍生出来的框架一般都具备简单, 通用, 安全, 效率等特点
4. 是基于 http 开发的, 不同的是 RPC:
   • 是长链接, 不必每次通信都要像 HTTP 一样去 3 次握手什么的, 减少了网络开销
   • 对数据进行深度编码和解码, 减少了对网络带宽的压力
   • 一般都有注册中心, 有丰富的监控管理
   • 发布、下线接口、动态扩展等, 对调用方来说是无感知、统一化的操作
   • 参考: 有了HTTP，为什么还要RPC？

二. gRPC 的用途

1. 一般应用于大型的系统, 提高性能和效率
2. gRPC 是微服务架构中, 首选的 RPC 框架之一

三. gRPC 的特点有哪些特点, 为什么要使用它

1. 支持多种语言
2. 轻量级, 高性能
   • 序列化支持 Protocol Buffer 和 Json
   • Json 是由 JavaScript 动态语言推广出来的, 特性是随着 JavaScript, 字段和数据类型是可以随意定义的
   • Protocol Buffer 的字段和数据类型是预定义的, 更适合静态语言, 更安全. 另外 Protocol Buffer 是一种语言无关的高性能序列化框架
   • Protocol Buffer 可以加速站点之间数据传输速度, 解决数据传输不规范的问题
3. 可插拔
4. IDL
   • 基于文件定义服务, 通过 proto3 工具生成指定语言的数据结构、服务端接口以及客户端 Stub
5. 基于标准的 HTTP2 设计
   • 支持双向流、消息头压缩、单 TCP 的多路复用、服务端推送等特性
   • 这些特性使得 gRPC 在移动端设备上更加省电和节省网络流量
6. 服务而非对象、消息而非引用
   • 有利于解耦
   • 促进微服务的系统间, 粗粒度的消息交互
7. 负载无关
   • 不同的服务需要使用不同的消息类型和编码
8. 阻塞式和非阻塞式
   • 支持异步和同步处理在客户端和服务端间交互的消息序列
9. 元数据交换
   • 常见的横切关注点, 依赖数据交换
10. 标准化状态码
    • 客户端通常以有限的方式响应 API 调用返回的错误
11. 良好的设计理念
    • 生态好

四. gRPC 实践

目标: 一步一步实现一个简单的 gRPC 示例

1. 开发环境

• macOS
• go 1.15

2. 安装依赖和环境配置

• 安装 protobuf 工具

# 使用 brew 命令
# 安装 protobuf, 即安装 protoc 可执行文件/命令
brew install protobuf

• 安装 go-gRPC 工具, 配置环境

参考: Quick start | Go | gRPC

# 安装 Go-gRPC 的编译器插件
# 用于生成 *.pb.go 和 *_grpc.pb.go 两个文件所需的 (在 $GOPATH/bin 下)
go get google.golang.org/protobuf/cmd/protoc-gen-go \
         google.golang.org/grpc/cmd/protoc-gen-go-grpc

# go mod
export GO111MODULE=on  # Enable module mode
# protoc 编译器可以找到的插件路径
export PATH="$PATH:$(go env GOPATH)/bin"

3. 编写和编译 proto

• sayhello.proto

// 指定使用 proto3 版本
syntax = "proto3";

// 随便定义一个报名
package grpc.service.sayhello;

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

• 编译

# --go_out 参数是指定生成 *.pb.go 文件的路径
# --go-grpc_out 参数是指定生成 *_grpc.pb.go 文件的路径
# -I, 相当于 -IPATH 和 --proto_path, 指定 proto 文件依赖的包所要搜索的路径 (这里没有依赖, 可以不写)
protoc -I. --go_out=. --go-grpc_out=. *.proto

• 编译报错

protoc-gen-go: unable to determine Go import path for

Please specify either:
    • a "go_package" option in the .proto source file, or
    • a "M" argument on the command line.

See https://developers.google.com/protocol-buffers/docs/reference/go-generated#package for more information.

--go_out: protoc-gen-go: Plugin failed with status code 1.

要我们定义 go_package 或者 M 命令行参数

• 选择修改 proto, 定义 go_package

syntax = "proto3";

// ./ 是文件生成的路径
// sayhello_proto 是生成的 .go 文件的包名
// 两者之间, 用 ; 号分隔
// 参考: https://blog.csdn.net/raoxiaoya/article/details/109533734
option go_package = "./;sayhello_proto";

package grpc.service.sayhello;

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

• 重新编译 proto

protoc -I. --go_out=. --go-grpc_out=. *.proto

编译成功

4. 实现服务端

package main

import (
    "context"
    "log"
    "net"

    proto "github.com/-/sayhellogrpc/proto" // 此处隐姓埋名
    "google.golang.org/grpc"
)

const (
    // 绑定的端口
    port = ":8080"
)

type server struct {
    proto.UnimplementedGreeterServer
}

// 实现定义的 SayHello API
// 参数和返回类型, 参考生成的 sayhello_grpc.pb.go 的
func (s *server) SayHello(ctx context.Context, in *proto.HelloRequest) (*proto.HelloReply, error) {
    log.Printf("Received: %v", in.GetName())
    msg := in.GetName() + " say hello for gRPC"
    reply := &proto.HelloReply{
        Message: msg,
    }
    return reply, nil
}

func main() {
    lis, err := net.Listen("tcp", port)
    if err != nil {
        log.Fatalf("failed to listen: %v", err)
    }

    srv := grpc.NewServer()
    // 注册服务
    proto.RegisterGreeterServer(srv, &server{})

    log.Println("gRPC server is running...")
    // 起服务
    if err := srv.Serve(lis); err != nil {
        log.Fatalf("failed to serve: %v", err)
    }
}

5. 实现客户端

package main

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

    proto "github.com/-/sayhellogrpc/proto" // 此处隐姓埋名
    "google.golang.org/grpc"
)

const (
    address = "localhost:8080"
    content = "xxxx"
)

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

    c := proto.NewGreeterClient(conn)

    // Contact the server and print out its response.
    name := content
    if len(os.Args) > 1 {
        // 通过命令行获取发送的内容
        name = os.Args[1]
    }
    ctx, cancel := context.WithTimeout(context.Background(), time.Second)
    defer cancel()
    r, err := c.SayHello(ctx, &proto.HelloRequest{Name: name})
    if err != nil {
        log.Fatalf("could not greet: %v", err)
    }
    log.Printf("Greeting: %s", r.GetMessage())
}

go.mod

如果报 undefined: grpc.SupportPackageIsVersion7 这样的错误, 则要修改 google.golang.org/grpc 的版本, v1.32.0 及以上

module github.com/-/sayhellogrpc // 此处隐姓埋名

go 1.15

require (
    github.com/golang/protobuf v1.5.0
    google.golang.org/grpc v1.37.0
    google.golang.org/grpc/cmd/protoc-gen-go-grpc v1.1.0 // indirect
    google.golang.org/protobuf v1.26.0
)

文件结构

.
├── client
│   └── main.go
├── go.mod
├── go.sum
├── proto
│   ├── sayhello.pb.go
│   ├── sayhello.proto
│   └── sayhello_grpc.pb.go
└── server
    └── main.go

6. 验证

go run server/main.go

go run client/main.go

go run client/main.go abc

实现参考: https://github.com/grpc/grpc-go/tree/master/examples