protobuf文本格式是什么样的？

74

Google协议缓冲区不仅可以以二进制格式序列化，还可以以text序列化。但是，我很难找到此类文本的示例。它会是什么样子？

预期答案：一个示例，涵盖protobuf IDL / proto文件允许的所有功能，包括文本格式的protobuf样本包。

serialization  text  protocol-buffers 
— 六
source
2
坦白地说，我只会将其用于调试-我不清楚这样做会有什么好处。如果您想输入文字，则可以在大多数平台上使用十二种json实现。发短信失去了protobufs的大部分优势……只是说……
— Marc Gravell
20
回答这个问题的模棱两可的收益：0.我的好奇心得到满足；1.更多的人了解此调试工具；2.其他人将某些以前无法识别的文本块识别为protobuf文本；3.在此处链接的官方文档中添加示例的步骤（应放在第一位）；4. Google在此处搜索“ protobuf文本示例”并提供有用的结果...
— Vi。
2
@MarcGravell文本格式不支持json的一件事：枚举。您可以my_field: MY_ENUM在文件中添加文件，但json不接受
— 托马斯
它的使用遍布在巴泽尔的地方
— 哈桑·赛义德
2
另一个可能的好处是传统的unix工具（例如grep和）的适用性awk。例如，如果某人将有关文件的元数据存储在protobuf中，并希望提供一种通过该元数据进行grep的方法，则只需在管道中添加proto2text转换器过滤器即可轻松实现。
— beemtee

Answers:

89

自己做：

测试原型

enum MyEnum
{
    Default = 0;
    Variant1 = 1;
    Variant100 = 100;
}

message Test {
    required string f1 = 1;
    required int64 f2 = 2;
    repeated uint64 fa = 3;
    repeated int32 fb = 4;
    repeated int32 fc = 5 [packed = true];
    repeated Pair pairs = 6;
    optional bytes bbbb = 7;

    extensions 100 to max;
}

message Pair {
    required string key = 1;
    optional string value = 2;
}



extend Test {
    optional bool gtt = 100;
    optional double gtg = 101;
    repeated MyEnum someEnum = 102;
}

示例输出：

f1: "dsfadsafsaf"
f2: 234
fa: 2342134
fa: 2342135
fa: 2342136
fb: -2342134
fb: -2342135
fb: -2342136
fc: 4
fc: 7
fc: -12
fc: 4
fc: 7
fc: -3
fc: 4
fc: 7
fc: 0
pairs {
  key: "sdfff"
  value: "q\"qq\\q\n"
}
pairs {
  key: "   sdfff2  \321\202\320\265\321\201\321\202 "
  value: "q\tqq<>q2&\001\377"
}
bbbb: "\000\001\002\377\376\375"
[gtt]: true
[gtg]: 20.0855369
[someEnum]: Variant1

该程序：

#include <google/protobuf/text_format.h>

#include <stdio.h>
#include "test.pb.h"

int main() {
    Test t;
    t.set_f1("dsfadsafsaf");
    t.set_f2(234);
    t.add_fa(2342134);
    t.add_fa(2342135);
    t.add_fa(2342136);
    t.add_fb(-2342134);
    t.add_fb(-2342135);
    t.add_fb(-2342136);
    t.add_fc(4);
    t.add_fc(7);
    t.add_fc(-12);
    t.add_fc(4);
    t.add_fc(7);
    t.add_fc(-3);
    t.add_fc(4);
    t.add_fc(7);
    t.add_fc(0);
    t.set_bbbb("\x00\x01\x02\xff\xfe\xfd",6);

    Pair *p1 = t.add_pairs(), *p2 = t.add_pairs();
    p1->set_key("sdfff");
    p1->set_value("q\"qq\\q\n");
    p2->set_key("   sdfff2  тест ");
    p2->set_value("q\tqq<>q2&\x01\xff");

    t.SetExtension(gtt, true);
    t.SetExtension(gtg, 20.0855369);
    t.AddExtension(someEnum, Variant1);

    std::string str;
    google::protobuf::TextFormat::PrintToString(t, &str);
    printf("%s", str.c_str());

    return 0;
}

此样本的二进制protobuf（出于完整性考虑）：

00000000  0a 0b 64 73 66 61 64 73  61 66 73 61 66 10 ea 01  |..dsfadsafsaf...|
00000010  18 f6 f9 8e 01 18 f7 f9  8e 01 18 f8 f9 8e 01 20  |............... |
00000020  8a 86 f1 fe ff ff ff ff  ff 01 20 89 86 f1 fe ff  |.......... .....|
00000030  ff ff ff ff 01 20 88 86  f1 fe ff ff ff ff ff 01  |..... ..........|
00000040  2a 1b 04 07 f4 ff ff ff  ff ff ff ff ff 01 04 07  |*...............|
00000050  fd ff ff ff ff ff ff ff  ff 01 04 07 00 32 10 0a  |.............2..|
00000060  05 73 64 66 66 66 12 07  71 22 71 71 5c 71 0a 32  |.sdfff..q"qq\q.2|
00000070  23 0a 14 20 20 20 73 64  66 66 66 32 20 20 d1 82  |#..   sdfff2  ..|
00000080  d0 b5 d1 81 d1 82 20 12  0b 71 09 71 71 3c 3e 71  |...... ..q.qq<>q|
00000090  32 26 01 ff 3a 06 00 01  02 ff fe fd a0 06 01 a9  |2&..:...........|
000000a0  06 ea 19 0c bf e5 15 34  40 b0 06 01              |.......4@...|
000000ac

请注意，它的示例并不完全可以： libprotobuf ERROR google/protobuf/wire_format.cc:1059] Encountered string containing invalid UTF-8 data while parsing protocol buffer. Strings must contain only UTF-8; use the 'bytes' type for raw bytes.

请注意，该protoc工具还可以使用原始文件和不使用以下文件将消息解码为文本：

$ protoc --decode=Test test.proto < test.bin 
[libprotobuf ERROR google/protobuf/wire_format.cc:1091] String field 'value' contains invalid UTF-8 data when parsing a protocol buffer. Use the 'bytes' type if you intend to send raw bytes. 
f1: "dsfadsafsaf"
f2: 234
fa: 2342134
fa: 2342135
fa: 2342136
fb: -2342134
fb: -2342135
fb: -2342136
fc: 4
fc: 7
fc: -12
fc: 4
fc: 7
fc: -3
fc: 4
fc: 7
fc: 0
pairs {
  key: "sdfff"
  value: "q\"qq\\q\n"
}
pairs {
  key: "   sdfff2  \321\202\320\265\321\201\321\202 "
  value: "q\tqq<>q2&\001\377"
}
bbbb: "\000\001\002\377\376\375"
[gtt]: true
[gtg]: 20.0855369
[someEnum]: Variant1
$ protoc --decode_raw  < test.bin 
1: "dsfadsafsaf"
2: 234
3: 2342134
3: 2342135
3: 2342136
4: 18446744073707209482
4: 18446744073707209481
4: 18446744073707209480
5: "\004\007\364\377\377\377\377\377\377\377\377\001\004\007\375\377\377\377\377\377\377\377\377\001\004\007\000"
6 {
  1: "sdfff"
  2: "q\"qq\\q\n"
}
6 {
  1: "   sdfff2  \321\202\320\265\321\201\321\202 "
  2: "q\tqq<>q2&\001\377"
}
7: "\000\001\002\377\376\375"
100: 1
101: 0x403415e5bf0c19ea
102: 1
— 六
source
15
如果您要进行教育，则可以提及protoc命令的--encode /-decode选项。这些应该在bin / text格式之间转换。还有--decode_raw选项。
— 布鲁斯·马丁
4
很棒的答案。在看到这一点之前，我真的很难想象如何通过原型缓冲区对数据进行编码，即使将数据作为字符串传递（如此处所示）实际上没有任何意义，但我现在已经有了足够好的思维方式来了解数据以二进制格式编码。谢谢！
— 克里斯·卡洛
3
我发现protobufs支持输入重复值的快捷方式。可以将fc值输入为fc：[
— 4、7，-12、4、7，-3、4、7、0
您能否提供一个Makefile和.h文件？
— silvalli
@silvalli，是的。您是否建议重做此部分以使其更清洁？
— 六。
16

简化，在window7 + cygwin上从protoc.exe版本3.0.0输出

示范讯息

$ cat demo.proto
   syntax = "proto3";  package demo;  message demo { repeated int32 n=1; }

创建一个protobuf二进制数据

$ echo n : [1,2,3]  | protoc --encode=demo.demo demo.proto > demo.bin

将原始数据作为文本转储

 $ protoc --decode=demo.demo demo.proto < demo.bin
    n: 1
    n: 2
    n: 3

即使您没有原始定义，也要转储

    $ protoc --decode_raw < demo.bin  
    1: "\001\002\003"
— sh
source
By using our site, you acknowledge that you have read and understand our Cookie Policy and Privacy Policy.
Licensed under cc by-sa 3.0 with attribution required.