正在阅读的评论。使用协议缓冲区描述符对象的proto文件

Question

我目前正在重新访问一个使用Google协议缓冲区的项目。

在项目中，我想利用协议缓冲区的特性描述符和反射。

官方文件指出，的注释。可以读取proto文件：

1. 使用对消息或描述符调用的函数DebugStringWithOptions（）
2. 使用对描述符调用的函数GetSourceLocation（）

我无法检索注释，所以我认为我做了一些完全错误的事情，或者该功能尚未在协议缓冲区中完全实现。

以下是一些代码片段：

google::protobuf::DebugStringOptions options;
options.include_comments = true;
std::cout << "google::protobuf::Descriptor::DebugStringWithOptions(): "
          << message.descriptor()->DebugStringWithOptions(options) << std::endl
          << std::endl;

const google::protobuf::FieldDescriptor* field_descriptor{
    message.descriptor()->field(1)};

// TODO(wolters): Why doesn't this work?
google::protobuf::SourceLocation* source_location{
    new google::protobuf::SourceLocation};
field_descriptor->GetSourceLocation(source_location);

// if (field_descriptor->GetSourceLocation(source_location)) {
std::cout << "start_line: " << source_location->leading_comments
          << std::endl;
std::cout << "end_line: " << source_location->leading_comments << std::endl;
std::cout << "start_column: " << source_location->start_column << std::endl;
std::cout << "end_column: " << source_location->end_column << std::endl;
std::cout << "leading_comments: " << source_location->leading_comments
          << std::endl;
std::cout << "trailing_comments: " << source_location->trailing_comments
          << std::endl;
// }

我已经尝试在<代码>中对注释使用以下两种语法。proto文件，但它们似乎都不起作用：

MessageHeader header = 1;  // The header of this `Message`.

/**
 * The header of this `Message`.
 */
MessageHeader header = 1;

我使用的是GCC 4.7.1（启用了C 11支持）和最新的协议缓冲区版本3.0.0-alpha-4.1。

是否有人可以引导我进入正确的方向和/或为我提供一个工作示例？

编辑2015-09-24：

在官方文档中重新设置了自我描述消息部分并测试了大量内容之后，我似乎对protobuf描述符有了更好的理解。

如果以下一个或多个陈述不正确，请更正：

1. 只有在另一端不知道的情况下，selfdescripingmessage协议才有用。原型定义

在我看来，实现这一目标的唯一途径是：

>

--include_imports --include_source_info and --descriptor_set_out=message.desc

将message.desc文件与应用程序/库一起发布，以便能够在运行时读取它（见下文）。

这对我来说似乎很复杂，所以我还有两个问题：

1. 难道没有一种不使用FileDescriptorSet就可以包含源信息的方法吗

编辑2015-09-25：所谓上帝类，我的意思是消息类和/或描述符类提供了或多或少无用的公共功能，因为它们在客户端使用时不提供任何信息。以“普通”消息为例：因此生成的代码不包含源注释信息，因此所有描述符类（例如，描述符和字段描述符）中的GetSourceLocation方法完全无用。从逻辑角度来看，如果处理消息和描述符，则应提供单独的实例，如果处理来自文件描述符集（其源通常是从.proto文件生成的.desc文件）的信息，则应提供单独的实例。A<代码>[…]Lite类将成为“普通”类的父类。关于protoc可能永远不会包含源代码注释的论点强调了我的观点。

“连接”是指使用来自的描述符信息更新消息中的描述符信息的API函数。desc文件（如果我理解正确，它总是消息提供的描述符的超集）。

Answer 1

听起来你基本上已经明白了。

您将深入了解协议编译器内部的API，这些API并不是真正为公众使用而设计的。它变得复杂了，因为没有人编写帮助层来简化事情，因为没有多少人使用这些功能。

我不知道你所说的“上帝阶层”是什么意思<代码>消息仅仅是protobuf实例的抽象接口。描述符描述protobuf实例的类型<代码>消息：：getDescriptor（）返回消息的类型，但除此之外，这些API之间没有太多直接连接。。。

是否有一种方法可以在不使用FileDescriptorSet的情况下包含源信息？

注释故意从嵌入到生成代码中的描述符中剥离出来，因此需要单独运行解析器，生成描述符集，并动态使用它。

是否可以使用具体的消息类/实例“连接”/设置FileDescriptorSet，因为这将大大简化事情？

您的意思是希望Message：：getDescriptor（）返回包含源文件中注释数据的描述符吗？这将要求将注释数据嵌入生成的代码中，这对于protoc实现来说是微不足道的（它目前有意将它们去掉，所以它只能不这样做），但可能会膨胀和危险（可能会泄露使用protobufs构建的封闭源代码二进制文件的用户的秘密）。