如何将Protobuf类实例格式化为不含未知字段的JSON字符串？

我之前也碰到过这个糟心的问题——用protobuf-java-format把Protobuf实例转成JSON时，那些没在定义里的未知字段总会偷偷混进来，生成像"4": [3]这种完全不符合预期的内容。好在这个库本身就有现成的解决办法，还有备用方案可以兜底。

方法一：配置JsonFormat忽略未知字段（推荐） #

protobuf-java-format的JsonFormat类支持通过配置跳过未知字段的序列化，只需要在创建格式化器的时候开启ignoreUnknownFields选项就行，这是最直接高效的方式。

代码示例： #

// 方式1：直接设置属性
JsonFormat jsonFormat = new JsonFormat();
jsonFormat.setIgnoreUnknownFields(true);
String cleanJson = jsonFormat.printToString(docInfo);

// 方式2：Builder模式（更优雅）
String cleanJson = JsonFormat.newBuilder()
    .ignoreUnknownFields(true)
    .build()
    .printToString(docInfo);

开启这个配置后，序列化过程会自动跳过所有未在Protobuf定义中声明的字段，最终生成的JSON只会包含你预先定义好的字段，完全符合预期。

方法二：先清理Protobuf实例再序列化（兜底方案） #

如果因为版本兼容或者特殊场景导致第一种方法不生效，你可以先创建一个清除了未知字段的新Protobuf实例，再进行序列化。

核心原理是利用Protobuf的Builder只保留已定义字段的特性，通过合并原实例到新Builder中，自动丢弃未知字段：

代码示例： #

// 创建清除了未知字段的新实例
DocInfo cleanedDocInfo = DocInfo.newBuilder()
    .mergeFrom(docInfo)
    .build();

// 序列化清理后的实例
String cleanJson = JsonFormat.printToString(cleanedDocInfo);

mergeFrom方法只会复制Protobuf定义中存在的字段，那些未知字段会被直接忽略，所以新实例里就不会有多余的内容了。

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