如何用Java从Protobuf的.desc文件访问自定义字段选项

核心思路 #

自定义选项is_key是对FieldOptions的扩展，存储在字段的options的extension集合中。我们可以通过Protobuf的DescriptorProtos读取.desc文件，定位到目标消息和字段后，通过扩展编号（50002）获取对应的值。

实现代码 #

import com.google.protobuf.DescriptorProtos;
import java.io.FileInputStream;
import java.io.IOException;

public class CustomOptionReader {
    public static void main(String[] args) throws IOException {
        // 替换为你的.desc文件路径
        String descPath = "your/file/path/foo.desc";
        
        try (FileInputStream input = new FileInputStream(descPath)) {
            // 解析整个文件描述符集合
            DescriptorProtos.FileDescriptorSet fileSet = DescriptorProtos.FileDescriptorSet.parseFrom(input);
            
            // 定位到Foo消息的描述符
            DescriptorProtos.DescriptorProto fooMsg = null;
            for (DescriptorProtos.FileDescriptorProto fileProto : fileSet.getFileList()) {
                for (DescriptorProtos.DescriptorProto msgProto : fileProto.getMessageTypeList()) {
                    if ("Foo".equals(msgProto.getName())) {
                        fooMsg = msgProto;
                        break;
                    }
                }
                if (fooMsg != null) break;
            }
            
            if (fooMsg == null) {
                System.err.println("未找到Foo消息定义");
                return;
            }
            
            // 遍历Foo的字段，读取is_key选项
            for (DescriptorProtos.FieldDescriptorProto field : fooMsg.getFieldList()) {
                if (field.getOptions().hasExtension(50002)) {
                    boolean isKey = field.getOptions().getExtension(50002);
                    System.out.printf("字段[%s]的is_key值: %b%n", field.getName(), isKey);
                }
            }
        }
    }
}

补充说明 #

• 如果通过protoc生成了包含自定义选项的Java类，也可以用类的静态引用替代硬编码的编号，更安全：

  // 假设生成的类为FooProto，其中包含is_key的扩展定义
  boolean isKey = field.getOptions().getExtension(FooProto.is_key);
  

• 确保项目引入Protobuf Java依赖，例如Maven配置：

  <dependency>
      <groupId>com.google.protobuf</groupId>
      <artifactId>protobuf-java</artifactId>
      <version>3.25.3</version> <!-- 使用最新稳定版本 -->
  </dependency>
  

内容的提问来源于stack exchange，提问作者vignesh suresh