Google Protobuf(节选翻译)
原文地址: https://developers.google.com/protocol-buffers/docs/overview
欢迎来到Protocol buffers的文档,它是一个语言无关、平台无关,具有高灵活性的序列化结构数据的方式。它可以用于通信协议,数据存储等方面。
这篇文档的预期读者是想在Java,C++或Python中使用Protocol buffers的开发者。这篇文档介绍了Protocol buffers,并且会告诉你可以从哪里学起——之后,你可以跟着教程进行学习,或者更深入地学习Protocol buffers encoding。API参考文档也有这三个语言的不同版本。同样有三个语言的不同版本的,还有撰写.proto
文件时的语言和样式导引。
什么是Protocol buffers?
Protocol buffers是一种灵活、高效、自动的序列化结构数据的机制——与XML类似,但是比其更小、更快、更简单。你只需要一次定义你的数据需要被如何结构化,之后你就可以使用特别生成的源代码对各种各样的数据流读写结构化数据,并且你可以使用很多中语言。你甚至可以更新你的数据结构而不需要破坏你为旧的结构格式而部署的程序。
运行的机制是?
你在.proto
文件中指出你期望的序列化信息该如何格式化。每一个Protocol buffers消息是一小段信息的逻辑记录,包含一系列的“名字-值”对。下面是一个.proto
文件的非常基础的例子,它定义了一个人的信息。
message Person {
required string name = 1;
required int32 id = 2;
optional string email = 3;
enum PhoneType {
MOBILE = 0;
HOME = 1;
WORK = 2;
}
message PhoneNumber {
required string number = 1;
optional PhoneType type = 2 [default = HOME];
}
repeated PhoneNumber phone = 4;
}
正如你所看到的,消息的格式很简单——每一个消息有一个或多个被标了不重复的序号的域,每个域有一个名字和一个值类型,其中值类型可以是数字(整数或浮点型)、布尔值、字符串、原始字节,甚至是其它的proto buffer消息。你还可以指定哪些是可选择的域,哪些是必须的域,以及可重复的域。可以在Protocol Buffer Language Guide中找到更多的关于撰写.proto
文件的信息。
一旦你定义了你的消息,你可以用你的应用的那种语言运行protocol buffer的编译器来将.proto
文件生成为数据访问类。它们会提供每个域的简单访问器以及序列化/解析整个结构的方法——因此,例如你选择的语言为C++,运行编译器来编译上面的例子会产生一个叫做Person的类。之后你可以在你的应用中使用这个类来填写、序列化、获取Person
的protocol buffer消息。你可能会写类似于下面的代码:
Person person;
person.set_name("John Doe");
person.set_id(1234);
person.set_email("jdoe@example.com");
fstream output("myfile", ios::out | ios::binary);
person.SerializeToOstream(&output);
之后,你可以这样把你的消息再读回来:
fstream input("myfile", ios::in | ios::binary);
Person person;
person.ParseFromIstream(&input);
cout << "Name: " << person.name() << endl;
cout << "E-mail: " << person.email() << endl;
你可以向你的消息格式中添加新的域而不破坏向下兼容性;旧的可执行文件在解析时会直接忽视新的域。因此如果你的通信协议使用了protocol buffers作为传送数据的方式,那么你可以扩展你的协议,而不需要担心损害了已有的代码。
在API Reference section中,你会找到完整的关于使用生成的protocol buffer代码 的参考文档;在Protocol Buffer Encoding中,你会找到更多的关于protocol buffer messages是如何被编码的信息。
为什么不就使用XML?
Protocol buffers在序列化结构数据时有比XML优越的地方。Protocol buffers:
- 更简单
- 小3到10倍
- 快20到100倍
- 更少的歧义
- 生成数据访问类,使得更方便编程
例如,如果你想要把一个人的名字和email模型化。在XML中,你可能会这么做:
<person>
<name>John Doe</name>
<email>jdoe@example.com</email>
</person>
而对应的protocol buffers message为:
# Textual representation of a protocol buffer.
# This is *not* the binary format used on the wire.
person {
name: "John Doe"
email: "jdoe@example.com"
}
当这个消息被编码为protocol buffer二进制形式,它很有可能只有28字节的长度,并且只需要100-200纳秒来解析。而XML的版本至少要69字节,并且需要5000-10000纳秒来解析。
同样的,操作protocol buffer也更为简单:
cout << "Name: " << person.name() << endl;
cout << "E-mail: " << person.email() << endl;
而你用XML的话会需要这么做:
cout << "Name: "
<< person.getElementsByTagName("name")->item(0)->innerText()
<< endl;
cout << "E-mail: "
<< person.getElementsByTagName("email")->item(0)->innerText()
<< endl;
然而,protocol buffers并不总是比XML更优——比如,protocol buffers并不太擅长给带有标记的文本文档建模(e.g. HTML),因为你不太容易轻易地对文本进行结构化。另外,XML是适于人类阅读域编辑的;protocol buffers,至少它们的最底层的格式,是不适合人类阅读的。XML在一定程度上也是自描述的,而protocol buffer仅仅在你具有消息定义(.proto
文件)时才变得有意义。
proto3简介
我们最新的版本引入了一个新的语言版本——Protocol Buffers language version 3(aka proto3),同时也在我们已有的语言版本(aka proto2)中添加了一些新的特性。Proto3简化了protocol buffer语言,既是为了使用起来更方便,也是为了使得它可以为更多的语言服务:我们目前的版本可以让你用Java、C++、Python、Java Lite、Ruby、JavaScript、Objective-C以及C#生成rptotocol buffer 代码。另外你可以为Go语言生成proto3代码使用最新的Go protoc插件。更多的语言正在计划之中。