利用C++开发一个protobuf动态解析工具

目录

• 为什么需要这个工具
• 需求描述
• 开发
• 搜索现成方案
• AST在哪里
• 开始写代码
• 总结

为什么需要这个工具

数据库中存储的protobuf序列化的内容，有时候查问题想直接解析查看内容。很多编码在网上很容易找到编解码工具，但protobuf没有找到编解码工具，可能这样的需求比较少吧，那就自己用C++实现一个。

需求描述

我们知道，要解析protobuf，需要有proto定义，所以我们的输入参数需要包含序列化的数据以及proto定义，如果proto中包含多个message，还需要指定解析到哪个message。所以一共是三个输入参数。

此外，为了方便使用，我们的工具不要求给出完整的proto定义，如果有嵌套的message没有定义，不应影响其他字段解析。

开发

搜索现成方案

网上搜索了一圈，找到的类似方案大多需要导入完整的proto文件：

int DynamicParseFromPBFile(const std::string& file, const std::string& classname,
      const std::string& pb_str) {
  // ...
  // 导入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);

  // 动态创建message对象
  auto msg = message->New();
  msg->ParseFromString(pb_str);
  // msg即为解析到的结构
}

这样可以实现动态解析，但仍不满足我们的需求——即使proto不完整，也希望能解析。

举个例子：

message MyMsg {
  optional uint64 id = 1;
  optional OtherMsg other = 2;
}

MyMsg中包含OtherMsg类型，但并没有给出OtherMsg的定义，所以无法正常解析。

AST在哪里

事实上，在解析proto文件时，肯定需要先将其解析为抽象语法树(AST)，在AST中，我们可以很容易修改proto的定义，例如将other字段删掉，或者将其类型改为bytes，这样就可以正常解析了。

那么，proto文件解析成的AST结构在哪里呢？只能从源码中寻找答案了。

一番查找后，终于看到了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();
}

从这段代码中可以看到，FileDescriptorProto就是我们要找的AST结构。那么这到底是个什么结构呢？

其实，FileDescriptorProto本身也是一个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内嵌套定义的message也要包含在内
    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中找不到该类型名，则转为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对象，创建指定message类型对象。

// 解析proto并检查错误
SimpleDescriptorDatabase db;
db.Add(output);
DescriptorPool pool(&db);
auto descriptor = pool.FindMessageTypeByName(msg_type_name);
if (descriptor == nullptr) {
  // proto结构有错
  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步

将序列化的数据解析到msg中：

msg->ParseFromString(serilized_pb);
cout << "proto msg: " << msg->ShortDebugString().c_str() << endl;

这样，我们就成功实现了动态解析，也成功将不可读的二进制数据serilized_pb以可读的形式打印出来了。

总结

我们为了实现动态解析不完整的proto，我们首先从源码中找到了将proto定义转化为AST——也就是FileDescriptorProto——的方法。

接着，我们将AST对象进行修改，将不合法的proto改成合法的。

最后，我们再利用修改后的FileDescriptorProto构造出需要的message对象，解析序列化的数据。

到此这篇关于利用C++开发一个protobuf动态解析工具的文章就介绍到这了,更多相关C++ protobuf动态解析内容请搜索我们以前的文章或继续浏览下面的相关文章希望大家以后多多支持我们！