為什么需要這個工具
數(shù)據(jù)庫中存儲的protobuf序列化的內(nèi)容单旁，有時候查問題想直接解析查看內(nèi)容。很多編碼在網(wǎng)上很容易找到編解碼工具漾肮，但protobuf沒有找到編解碼工具清焕，可能這樣的需求比較少吧，那就自己用C++實現(xiàn)一個蝠猬。
需求描述
我們知道切蟋，要解析protobuf，需要有proto定義榆芦，所以我們的輸入?yún)?shù)需要包含序列化的數(shù)據(jù)以及proto定義柄粹，如果proto中包含多個message喘鸟，還需要指定解析到哪個message。所以一共是三個輸入?yún)?shù)驻右。
此外什黑，為了方便使用，我們的工具不要求給出完整的proto定義堪夭，如果有嵌套的message沒有定義愕把，不應(yīng)影響其他字段解析。
開發(fā)
搜索現(xiàn)成方案
網(wǎng)上搜索了一圈森爽，找到的類似方案大多需要導(dǎo)入完整的proto文件：
int DynamicParseFromPBFile(const std::string& file, const std::string& classname,
const std::string& pb_str) {
// ...
// 導(dǎo)入proto文件
::google::protobuf::compiler::Importer importer(&sourceTree, NULL);
importer.Import(file);
// 找到要解析的message
auto descriptor = importer.pool()->FindMessageTypeByName(classname);
::google::protobuf::DynamicMessageFactory factory;
auto message = factory.GetPrototype(descriptor);
// 動態(tài)創(chuàng)建message對象
auto msg = message->New();
msg->ParseFromString(pb_str);
// msg即為解析到的結(jié)構(gòu)
}
這樣可以實現(xiàn)動態(tài)解析恨豁，但仍不滿足我們的需求——即使proto不完整，也希望能解析拗秘。
舉個例子：
message MyMsg {
optional uint64 id = 1;
optional OtherMsg other = 2;
}
MyMsg中包含OtherMsg類型圣絮，但并沒有給出OtherMsg的定義，所以無法正常解析雕旨。
AST在哪里
事實上扮匠，在解析proto文件時，肯定需要先將其解析為抽象語法樹(AST)凡涩，在AST中棒搜，我們可以很容易修改proto的定義，例如將other字段刪掉活箕，或者將其類型改為bytes力麸，這樣就可以正常解析了。
那么育韩，proto文件解析成的AST結(jié)構(gòu)在哪里呢克蚂？只能從源碼中尋找答案了。
一番查找后筋讨，終于看到了FindFileByName方法的這段代碼：
bool SourceTreeDescriptorDatabase::FindFileByName(const std::string& filename,
FileDescriptorProto* output) {
// ...
io::Tokenizer tokenizer(input.get(), &file_error_collector);
Parser parser;
// Parse it.
output->set_name(filename);
return parser.Parse(&tokenizer, output) && !file_error_collector.had_errors();
}
從這段代碼中可以看到埃叭，F(xiàn)ileDescriptorProto就是我們要找的AST結(jié)構(gòu)。那么這到底是個什么結(jié)構(gòu)呢悉罕？
其實赤屋，F(xiàn)ileDescriptorProto本身也是一個proto定義的message：
message FileDescriptorProto {
optional string name = 1; // file name, relative to root of source tree
optional string package = 2; // e.g. "foo", "foo.bar", etc.
// All top-level definitions in this file.
repeated DescriptorProto message_type = 4;
repeated EnumDescriptorProto enum_type = 5;
repeated ServiceDescriptorProto service = 6;
repeated FieldDescriptorProto extension = 7;
// ...
}
從它的字段中可以看到，其代表的是整個proto文件壁袄，包括文件中的所有message类早、enum等定義。
開始寫代碼
第一步
仿照上面的源碼嗜逻，將輸入的proto定義解析為FileDescriptorProto對象：
// proto輸入
istringstream ss(proto);
istream* is = &ss;
io::IstreamInputStream input(is);
// 解析到FileDescriptorProto AST
io::Tokenizer tokenizer(&input, nullptr);
FileDescriptorProto output;
compiler::Parser parser;
if (!parser.Parse(&tokenizer, &output)) {
err_msg = "parse proto failed";
return -1;
}
output.set_name("proto");
output.clear_source_code_info();
printf("MSG: proto parsed output: %s\n", output.DebugString().c_str());
第2步
處理FileDescriptorProto對象涩僻，將沒有給定義的字段類型都改成bytes，保證proto可以正常解析：
int ConvertUnknownType2Bytes(FileDescriptorProto& file_descriptor_proto) {
// 找出所有給出定義的message類型名
set<string> typename_set;
for (auto const& msgtype : file_descriptor_proto.message_type()) {
typename_set.insert(msgtype.name());
// message內(nèi)嵌套定義的message也要包含在內(nèi)
for (auto const& subtype : msgtype.nested_type()) {
typename_set.insert(subtype.name());
}
}
// 遍歷所有field，檢查其類型是否存在定義
for (auto& msgtype : *file_descriptor_proto.mutable_message_type()) {
for (auto& field : *msgtype.mutable_field()) {
auto type_name = field.type_name();
// 基本類型的type_name是空的
if (!type_name.empty()) {
// 如果typename_set中找不到該類型名逆日，則轉(zhuǎn)為bytes類型
if (typename_set.find(type_name) == typename_set.end()) {
field.clear_type_name();
field.set_type(FieldDescriptorProto_Type_TYPE_BYTES);
}
}
}
}
return 0;
}
第3步
解析修改后的FileDescriptorProto對象恼琼，創(chuàng)建指定message類型對象。
// 解析proto并檢查錯誤
SimpleDescriptorDatabase db;
db.Add(output);
DescriptorPool pool(&db);
auto descriptor = pool.FindMessageTypeByName(msg_type_name);
if (descriptor == nullptr) {
// proto結(jié)構(gòu)有錯
err_msg = "parse proto failed. FindMessageTypeByName result is null";
return -1;
}
DynamicMessageFactory factory;
auto message = factory.GetPrototype(descriptor);
unique_ptr<Message> msg(message->New());
第4步
將序列化的數(shù)據(jù)解析到msg中：
msg->ParseFromString(serilized_pb);
cout << "proto msg: " << msg->ShortDebugString().c_str() << endl;
這樣屏富，我們就成功實現(xiàn)了動態(tài)解析，也成功將不可讀的二進制數(shù)據(jù)serilized_pb以可讀的形式打印出來了蛙卤。
總結(jié)
我們?yōu)榱藢崿F(xiàn)動態(tài)解析不完整的proto狠半，我們首先從源碼中找到了將proto定義轉(zhuǎn)化為AST——也就是FileDescriptorProto——的方法。
接著颤难，我們將AST對象進行修改神年，將不合法的proto改成合法的。
最后行嗤，我們再利用修改后的FileDescriptorProto構(gòu)造出需要的message對象已日，解析序列化的數(shù)據(jù)。
