You need to enable JavaScript to run this app. 如何从Protobuf生成的FileDescriptorSet中提取自定义option?
优惠活动
大模型
产品
解决方案
定价
更多

如何从Protobuf生成的FileDescriptorSet中提取自定义option?

问题描述

假设我们有一个名为foo.proto的文件,用于定义消息和自定义选项:

syntax = "proto3";

package foo_package;

import "google/protobuf/descriptor.proto";

enum State {
    ALPHA = 0;
    BETA = 1;
}

extend google.protobuf.FieldOptions {
    State baz = 51234;
}

message Foo {
    string bar = 1 [ (baz) = ALPHA ];
}

我们在包含google/protobuf/descriptor.proto的目录下,通过以下命令为该消息生成FileDescriptorSet:

protoc -I=. --include_imports -oTMP ./foo.proto

核心问题:如何从上述FileDescriptorSet中的消息类里提取自定义选项baz?

官方文档与相关库实现给出的示例代码如下:

from google.protobuf.descriptor_pb2 import FileDescriptorSet
from google.protobuf.message_factory import GetMessages

with open("TMP", mode="rb") as f:
    fds = FileDescriptorSet.FromString(f.read())

    messages = GetMessages([file for file in fds.file])
    extensions = messages["foo_package.Foo"].DESCRIPTOR.fields_by_name["bar"].GetOptions().Extensions

但运行后得到的Extensions对象为空。相关issue提到使用DescriptorPool可以解决该问题,但直接使用该方案也无法生效,同样返回空对象。

解决方案

出现空Extensions的核心原因是:默认的DescriptorPool(或GetMessages内部使用的全局池)没有注册你自定义的baz扩展的类型信息,protobuf解析字段选项时无法识别这个自定义扩展字段,因此不会将其填充到Extensions映射中。

你需要手动初始化自定义的DescriptorPool,将FileDescriptorSet里的所有文件描述符添加进去,再通过池查询到自定义扩展的描述符,最后才能正确取到扩展值,示例代码如下:

from google.protobuf.descriptor_pb2 import FileDescriptorSet
from google.protobuf.descriptor_pool import DescriptorPool
from google.protobuf.message_factory import GetMessages

# 读取生成的FileDescriptorSet二进制文件
with open("TMP", mode="rb") as f:
    fds = FileDescriptorSet.FromString(f.read())

# 1. 初始化自定义DescriptorPool,导入所有依赖的文件描述符
pool = DescriptorPool()
for file_desc in fds.file:
    pool.Add(file_desc)

# 2. 从池中获取目标消息、字段的描述符
foo_message_desc = pool.FindMessageTypeByName("foo_package.Foo")
bar_field_desc = foo_message_desc.fields_by_name["bar"]

# 3. 查询自定义扩展的描述符(扩展全名为:包名.扩展字段名)
baz_extension_desc = pool.FindExtensionByName("foo_package.baz")

# 4. 从字段选项中提取自定义扩展值
field_options = bar_field_desc.GetOptions()
baz_value = field_options.Extensions[baz_extension_desc]

# 输出结果为State.ALPHA,对应枚举值0
print(baz_value)

注意事项

  • 必须保证protoc命令添加了--include_imports参数,否则生成的TMP文件只会包含当前foo.proto的描述,缺少依赖的descriptor.proto定义,会导致DescriptorPool添加文件时报错。
  • 自定义扩展的全名必须严格对应proto中的定义,格式为[package名].[扩展字段名],不要写错层级。

内容的提问来源于stack exchange,提问作者crcvd

相关产品推荐
方舟 Agent Plan

超全模态模型 × Harness 升级,最新支持 Deepseek-V4.1-Flash、GLM-5.3 系列、Doubao-Seedream-5.0-pro、Kimi-K3 (部分), 限时 9.9 元起

最近更新时间:2026.10.31 10:24:08