《Go-micro微服务框架入门教程》学习笔记 | Protobuf

Posted 2021-07-08 COCOgsta

protobuf是google旗下的一款平台无关，语言无关，可扩展的序列化结构数据格式。所以很适合用做数据存储和作为不同应用，不同语言之间相互通信的数据交换格式，只要实现相同的协议格式即同一proto文件被编译成不同的语言版本，加入到各自的工程中去。这样不同语言就可以解析其他语言通过protobuf序列化的数据。目前官网提供了C++，Python，JAVA，GO等语言的支持。google在2008年7月7号将其作为开源项目对外发布。

protoBuf简介

Google Protocol Buffer（简称Protobuf）是一种轻便高效的结构化数据存储格式，平台无关、语言无关、可扩展，可用于通讯协议和数据存储等领域。

数据交互的格式比较

数据交互xml、json、protobuf格式比较

• json：一般的web项目中，最流行的主要还是json。因为浏览器对于json数据支持非常好，有很多内建的函数支持。
• xml：在webservice中应用最为广泛，但是相比于json，它的数据更加冗余，因为需要对的闭合标签。json使用了键值对的方式，不仅压缩了一定的数据空间，同时也具有可读性。
• protobuf：是后起之秀，是谷歌开源的一种数据格式，适合高性能，对响应速度有要求的数据传输场景。因为protobuf是二进制数据格式，需要编码和解码。数据本身不具有可读性。因此只能反序列化之后得到真正可读的数据。

相对于其他protobuf更具有优势

• 序列化后体积相比json和XML很小，适合网络传输
• 支持跨平台多语言
• 消息格式升级和兼容性还不错
• 序列化反序列化速度很快，快于json的处理速度

protoBuf的优点

Protobuf有如XML，不过它更小、更快、也更简单。你可以定义自己的数据结构，然后使用代码生成器生成的代码来读写这个数据结构。你甚至可以在无需重新部署程序的情况下更新数据结构。只需使用Protobuf对数据结构进行一次描述，即可利用各种不同语言或从各种不同数据流中对你的结构化数据轻松读写。它有一个非常棒的特性，即“向后”兼容性好，人们不必破坏已部署的、依靠“老”数据格式的程序就可以对数据结构进行升级。Protobuf语言更清晰，无需类似XML解析器的东西（因为Protobuf编译器会将.proto文件编译生成对应的数据访问类以对Protobuf数据机型序列化、反序列化操作）。使用Protobuf无需学习复杂的文档对象模型，Protobuf的编程模式比较友好，简单易学，同时它拥有良好的文档和示例，对于喜欢简单事物的人们而言，Protobuf比其他的技术更加有吸引力。

ProtoBuf的不足

Protobuf与XML相比也有不足之处。它功能简单，无法用来表示复杂的概念。XML已经成为多种行业标准的编写工具，Protobuf只是Google公司内部使用的工具，在通用性上还差很多。由于文本并不适合用来描述数据结构，所以Protobuf也不适合用来对基于文本的标记文档（如html）建模。另外，由于XML具有某种程度上的自解释性，它可以被人直接读取编辑，在这一点上Protobuf不行，它以二进制的方式存储，除非你有.proto定义，否则你没法直接读取Protobuf的任何内容。

Protobuf安装

安装protobuf（Ubuntu1804）

apt-get install git
安装GOLANG（不要使用apt-get install golang，因为只能安装1.10版本），可在官网下载linux版本后安装
git clone https://github.com.cnpmjs.org/protocolbuffers/protobuf.git
apt-get install autoconf automake libtool curl make g++ unzip
cd protobuf/
./autogen.sh
./configure
make
make install
ldconfig

获取proto包

cd /home/guoliang
git clone https://github.com/protocolbuffers/protobuf-go

安装protoc-gen-go插件

cd protobuf-go/cmd/protoc-gen-go
go build
cp protoc-gen-go /usr/local/bin，将生成的文件移到系统bin目录下

protoc -h，如果可以看到内容表示安装完成

protoc-gen-go，可以自动补全说明安装完成

protobuf的语法

要想使用protobuf必须得先定义proto文件。所以得先熟悉protobuf的消息定义的相关语法。

定义一个消息类型

syntax = "proto3"
message PandaRequest {
	string name = 1;
	int32 shengao = 2;
	repeated int32 tizhong = 3;
}

PandaRequest消息格式有3个字段，在消息中承载的数据分别对应于每一个字段。其中每个字段都有一个名字核一种类型。文件的第一行指定了你正在使用proto3语法：如果你没有指定这个，编译器会使用proto2.这个指定语法行必须是文件的非空注释的第一个行。在上面的例子中，所有字段都是标量类型：两个整型（shengao和tizhong），一个string类型（name）。Repeated关键字表示重复的那么在go语言中用切片进行代表。正如上述文件格式，在消息定义中，每个字段都有唯一的一个标识符。

添加更多消息类型

在一个.proto文件中可以定义多个消息类型。在定义多个相关的消息的时候，这一点特别有用--例如，如果想定义与SearchResponse消息类型对应的回复消息格式的话，你可以将它添加到相同的.proto文件中

syntax = "proto3"
message PandaRequest {
	string name = 1;
	int32 shengao = 2;
	repeated int32 tizhong = 3;
}
message PandaResponse {
	...
}

添加注释

向.proto文件添加注释，可以使用C/C++/java/Go风格的双斜杠（//）语法格式，如：

syntax = "proto3"
message PandaRequest {
	string name = 1;			//姓名
	int32 shengao = 2;			//身高
	repeated int32 tizhong = 3;	//体重
}
message PandaResponse {
	...
}

从.proto文件生成了什么？

当用protocol buffer编译器来运行.proto文件时，编译器将生成所选择语言的代码，这些代码可以操作在.proto文件中定义的消息类型，包括获取、设置字段值，将消息序列化到一个输出流中，以及从一个输入流中解析消息。

对C++来说，编译器会为每个.proto文件生成一个.h文件和一个.cc文件，.proto文件中的每一个消息有一个对应的类。对Python来说，有点不一样--Python编译器为.proto文件中的每个消息类型生成一个含有静态描述符的模块，该模块与一个元类（metaclass）在运行时（runtime）被用来创建所需的Python数据访问类。对go来说，编译器会为每个消息类型生成一个.pd.go文件。

标准数据类型

一个标量消息字段可以含有一个如下的了性--该表格展示了定义域.proto文件中的类型，以及与之对应的，在自动生成的访问类中定义的类型：

默认值

当一个消息被解析的时候，如果被编码的信息不包含一个特定的元素，被解析的对象锁对应的域被设置为一个默认值，对于不同类型指定如下：对于strings，默认是一个空string，对于bytes，默认是一个空的bytes，对于bools，默认是false，对于数值类型，默认是0

使用其它消息类型

你可以将其他消息类型用做字段类型。例如，假设在每一个PersonInfo消息中包含Person消息，此时可以在相同的.proto文件中定义一个Result消息类型，然后在PersonInfo消息中指定一个Person类型的字段

message PersonInfo {
        repeated Person info = 1;
}
message Person {
        string name = 1;
        int32 shengao = 2;
        repeated int32 tizhong = 3;
}

使用proto2消息类型

在你的proto3消息中导入proto2的消息类型也是可以的，反之亦然，然后proto2枚举不可以直接在proto3的标识符中使用（如果仅仅在proto2消息中使用是可以的）。

嵌套类型

你可以在其他消息类型中定义、使用消息类型，在下面的例子中，Person消息就定义在PersonInfo消息内，如：

message PersonInfo {
        message Person {
                string name = 1;
                int32 shengao = 2;
                repeated int32 tizhong = 3;
        }
        repeated Person info = 1;
}

如果你想在它的父消息类型的外部重用这个消息类型，你需要以PersonInfo.Person的形式使用它，如：

message PersonMessage {
        PersonInfo.Person info = 1;
}

当然，你也可以将消息嵌套任意多层，如：

message Grandpa {				//Level 0
       message Father {			//Level 1
               message son {			//Level 2
                        string name = 1;
                        int32 age = 2;
                }
        }
        message Uncle {				//Level 1
               message Son {			//Level 2
                        string name = 1;
                        int32 age = 2;
                }
        }
}

定义服务（Service）

如果想要将消息类型用在RPC（远程方法调用）系统中，可以在.proto文件中定义个RPC服务接口，protocol buffer编译器将会根据所选择的不同语言生成服务接口代码及存根。如，想要定义一个RPC服务并具有一个方法，该方法能够接收SearchRequest并返回一个SearchResponse，此时可以在.proto文件中进行如下定义：

service SearchServcie {
        //rpc 服务的函数名（传入参数）返回（返回参数）
        rpc  Search (SearchRequest) returns (SearchResponse);
}

最直观的使用protocol buffer的RPC系统是gRPC，一个由谷歌开发的语言和平台中的开源的RPC系统，gRPC在使用protocol buffer时非常有效，如果使用特殊的protocol buffer插件可以直接为您从.proto文件中产生相关的RPC代码。

如果你不想使用gRPC，也可以使用protocol buffer用于自己的RPC实现，你可以从proto2语言指南中找到更多信息

生成访问类（了解）

可以通过定义好的.proto文件来生成java,Python,C++,Ruby,JavaNano,Objective-C,或者C#代码，需要基于.proto文件运行protocol buffer编译器protoc。如果你没有安装编译器，下载安装包并遵照README安装。对于Go，你还需要安装一个特殊的代码生成器插件。你可以通过Github上的protobuf库找到安装过程

通过如下方式调用protocol编译器：

protoc --proto_path=IMPORT_PATH --cpp_out=DST_DIR --python_out=DST_DIR --go_out=DST_DIR path/to/file.proto

IMPORT_PATH声明了一个.proto文件所在的解析import具体目录。如果忽略该值，则使用当前目录。如果有多个目录则可以多次调用--proto_path。它们将会顺序的被访问并执行导入。-I=IMPORT_PATH是--proto_path的简化形式。

当然也可以提供一个或多个输出路径：--cpp_out在目标目录DST_DIR中产生c++代码，可以在C++代码生成参考中查看更多。--python_out在目标目录DST_DIR中产生Python代码，可以在Python代码生成参考中查看更多。--go_out在目标目录DST_DIR中产生GO代码，可以在GO代码生成器中查看更多。作为一个方便的拓展，如果DST_DIR以.zip或者.jar结尾，编译器会将输出写到一个ZIP格式文件或者符合JAR标准的.jar文件中。注意如果输出已经存在则会被覆盖，编译器还没有智能到可以追加文件。你必须提取一个或多个.proto文件作为输入，多个.proto文件可以只指定一次。虽然文件路径是相对于当前目录的，每个文件必须位于其IMPORT_PATH下，以便每个文件可以确定其规范的名称多功能。

测试

protobuf的使用方法是将数据结构写入到.proto文件中，使用protoc编译器编译（间接使用了插件）得到一个新的go包，里面包含go中可以使用的数据结构和一些辅助方法。

创建text.proto

syntax = "proto3";
package prototext;
option go_package = ".;prototext";
message Test{
  //姓名
  string name = 1;
  //体重
  repeated int32 tizhong = 2;
  //身高
  int32 shengao = 3;
  //格言
  string motto = 4;
}

terminal运行protoc --go_out=./ *.proto，生成pb.go文件

创建text.go

package main
import (
	"awesomeProject/prototext"
	"fmt"
	"google.golang.org/protobuf/proto"
)
func main() {
	text := &prototext.Test{
		Name:"panda",
		Tizhong:[]int32{120,125,198,180,150,195},
		Shengao:180,
		Motto:"知足常乐",
	}
	fmt.Println(text)
	//proto encode
	data, err := proto.Marshal(text)
	if err != nil {
		fmt.Println("encode failed!")
	}
	//Print after encode
	fmt.Println(data)
	newtext := &prototext.Test{}
	//proto decode
	err = proto.Unmarshal(data, newtext)
	if err != nil {
		fmt.Println("decode failed!")
	}
	//Print after decode
	fmt.Println(newtext)
	fmt.Println(newtext.String())
	fmt.Println(newtext.Name)
	fmt.Println(newtext.Shengao)
	fmt.Println(newtext.Tizhong)
	fmt.Println(newtext.Motto)
}

运行，可以看到序列化后的结果