go语言中的gRPC（一）

初识protobuf

1、protobuf 介绍

Protobuf是Protocol Buffer的简称，它是Google公司于2008年开源的一种高效的平台无关、语言无关、可扩展的数据格式，目前Protobuf作为接口规范的描述语言。是一种轻便高效的结构化数据存储格式，可以用于结构化数据序列化，很适合做数据存储或 RPC 数据交换格式。

2、protobuf 对应go数据类型

.proto Type	Go Type
double	float64
float	float32
int32	int32
uint32	uint32
uint64	uint64
sint32	int32
sint64	int64
fixed32	uint32
fixed64	uint64
sfixed32	int32
sfixed64	int64
bool	bool
string	string
bytes	[]byte
repeated string	[]string

使用protobuf

1、相关工具安装（windows）

1.1安装 protoc

下载地址：https://github.com/protocolbuffers/protobuf/releases/tag/v3.15.5

下载完成后，解压，bin目录下有个 protoc.exe 文件，将这个目录加入环境变量

测试是否安装成功

protoc --version

显示版本号代表安装成功

1.2安装 protoc-gen-go

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

运行完了后在你的 GOPATH/bin 目录会下生成 protoc-gen-go.exe 文件

1.3配置环境变量

要想在全局使用，需要把 GOPATH/bin目录配置到环境变量中

2、Linux安装

1.下载protoc

https://github.com/protocolbuffers/protobuf/releases/download/v21.5/protoc-21.5-linux-x86_64.zip
更多下载地址：https://github.com/protocolbuffers/protobuf/releases

简单说就是下载到服务器，解压，如果下载不了，就采取科学上网
下载解压过程略过

文件移动到对应目录

# 移动protoc文件
cd protoc-21.5-linux-x86_64/bin
cp protoc /usr/local/bin
# 给文件添加可执行权限
cd /usr/local/bin
chmod +x protoc

# 移动google文件夹
cd protoc-21.5-linux-x86_64/include
cp -r google /usr/local/include

检查

# 输入
protoc --version
# 输出
libprotoc 3.21.5

2.安装protoc-gen-go

参考文档：https://grpc.io/docs/languages/go/quickstart/

简单的说就是执行下面几个命令

go install google.golang.org/protobuf/cmd/protoc-gen-go@v1.28
go install google.golang.org/grpc/cmd/protoc-gen-go-grpc@v1.2

export PATH="$PATH:$(go env GOPATH)/bin"

到这里就大功告成啦

3、简单介绍

gRPC有四种交换模式，分别是：

• 简单模式
• 服务端流式
• 客户端流式
• 双向流式

4、简单模式的gPRC示例

4.1创建 *.proto 文件

新建 simple.proto 文件

syntax = "proto3";

package proto;

// 定义发送请求信息
message SimpleRequest{
  // 参数类型 参数名称 标识号
  string name = 1;
  repeated string data = 2;
}

// 定义响应信息
message SimpleResponse{
  int32 code = 1;
  string msg = 2;
}

// 定义我们的服务(可以定义多个服务，每个服务可以定义多个接口)
service Simple{
  rpc GetSimpleInfo(SimpleRequest) returns (SimpleResponse){};
}

4.2编译 *.proto 文件

# protoc --go_out=plugins=grpc:. 文件名
protoc --go_out=plugins=grpc:. simple.proto

# 或
protoc --go_out=./ simple.proto

编译完成后会出现一下个 simple.pb.go 文件
扩展：编译时如果出现一下错误，可以尝试下面的方法

① 在*.proto文件中加上： option go_package = "/proto;simple"
option go_package 的两个参数分别是指定将其输入到哪个文件和包的名称（推荐使用）
~
② 老版本的proto-gen-go，使用命令切换为 v1.3.2 版本（不推荐）
go get -u github.com/golang/protobuf/protoc-gen-go@v1.3.2

打开simple.pb.go文件如果文件报错就用go mod tidy加载一下依赖包

4.3创建服务端文件

新建一个server.go文件

package main

import (
	"context"
	"google.golang.org/grpc"
	"log"
	"net"
	pb "simple/proto"
)

const (
	Addr string = ":50001"
	Network string = "tcp"
)

// 定义我们的服务
type SimpleService struct{}

// 实现 GetSimpleInfo 方法
func (s *SimpleService) GetSimpleInfo(ctx context.Context, req *pb.SimpleRequest) (*pb.SimpleResponse, error) {
	name := req.Name
	data := req.Data
	log.Println("获取来自客户端的：我是", name, data)
	resp := &pb.SimpleResponse{
		Code:  200,
		Msg: "grpc",
	}
	return resp, nil
}

func main() {
	// 1.监听端口
	listener, err := net.Listen(Network, Addr)
	if err != nil {
		log.Fatalf("net.listen err: %v", err)
	}
	log.Println(Addr, " net listening...")
	// 2.实例化gRPC服务端
	grpcServer := grpc.NewServer()
	// 3.注册我们实现的服务 SimpleService
	pb.RegisterSimpleServer(grpcServer, &SimpleService{})
	// 4.启动gRPC服务端
	err = grpcServer.Serve(listener)
	if err != nil {
		log.Fatalf("grpc server err: %v",err)
	}
}

4.4创建客户端文件

新建一个client.go文件

package main

import (
	"context"
	"google.golang.org/grpc"
	"log"
	pb "simple/proto"
)

const (
	Address string = ":50001"
)

func main() {
	// 1.创建于gRPC服务端的连接
	conn, err := grpc.Dial(Address, grpc.WithInsecure())
	if err != nil {
		log.Fatalf("dial conn err: %v", err)
	}
	defer conn.Close()
	// 2.创建grpc客户端
	client := pb.NewSimpleClient(conn)
	// 3.调用服务端提供的服务
	req := pb.SimpleRequest{
		Name: "客户端",
		Data: []string{"Hello word"},
	}
	resp, err := client.GetSimpleInfo(context.Background(), &req)
	if err != nil {
		log.Fatalf("resp err: %v", err)
	}
	log.Printf("获取服务端的响应,code: %v,msg: %v", resp.Code, resp.Msg)
}

4.5运行测试

1.启动服务端

2.启动客户端

看到服务端能接收到客户端的请求并响应就成功了。