如何在Java中将Protobuf序列化为带额外自定义字段的JSON

下面提供两种符合效率要求的落地实现，都无需重写JsonFormat、无需修改Protobuf定义，无序列化后二次解析再序列化的额外开销：

推荐方案：使用Jackson + jackson-datatype-protobuf 一次性序列化 #

该方案兼顾灵活性、安全性和性能，支持任意类型的额外字段，自动处理JSON转义，是生产环境最优选择。

• 第一步：引入依赖

<dependency>
    <groupId>com.fasterxml.jackson.datatype</groupId>
    <artifactId>jackson-datatype-protobuf</artifactId>
    <version>与项目Jackson版本保持一致即可</version>
</dependency>

• 第二步：初始化支持Protobuf序列化的ObjectMapper

import com.fasterxml.jackson.databind.ObjectMapper;
import com.fasterxml.jackson.datatype.protobuf.ProtobufModule;

// 全局初始化一次即可，无需重复创建
ObjectMapper protoMapper = new ObjectMapper()
    .registerModule(new ProtobufModule());

• 第三步：流式拼接字段输出
  全程流式写入，无中间字符串、Map转换操作，性能拉满：

import com.fasterxml.jackson.core.JsonGenerator;
import java.io.OutputStream;
import java.io.IOException;
import com.google.protobuf.InvalidProtocolBufferException;

public void serializeWithMetadata(ToBeSerialized protoObj, OutputStream outputStream) throws IOException {
    try (JsonGenerator gen = protoMapper.getFactory().createGenerator(outputStream)) {
        gen.writeStartObject();
        // 直接将Protobuf所有字段写入根JSON对象
        protoMapper.writeValue(gen, protoObj);
        // 追加任意自定义元字段，支持字符串、数字、布尔、嵌套对象等所有JSON类型
        gen.writeStringField("additional_field_1", "my_value");
        gen.writeStringField("additional_field_2", "my_other_value");
        gen.writeEndObject();
    }
}

如果需要得到字符串格式的JSON结果，将OutputStream替换为StringWriter即可。

轻量方案：基于原生JsonFormat改造，无额外依赖 #

如果不想引入第三方依赖，可以直接对原生JsonFormat的输出做轻量修改，全程只有字符串拼接操作，性能开销可忽略：

注意：需要自行处理额外字段值的JSON转义，避免特殊字符导致JSON格式错误。

import com.google.protobuf.util.JsonFormat;
import com.google.protobuf.InvalidProtocolBufferException;
import org.apache.commons.text.StringEscapeUtils; // 无commons依赖可自行实现JSON转义逻辑

public String serializeWithMetadata(ToBeSerialized protoObj) throws InvalidProtocolBufferException {
    String baseJson = JsonFormat.printer().print(protoObj);
    // 移除末尾的闭合大括号
    String jsonWithoutEnd = baseJson.substring(0, baseJson.length() - 1);
    // 拼接额外字段后补回闭合大括号
    return jsonWithoutEnd +
        ",\"additional_field_1\":\"" + StringEscapeUtils.escapeJson("my_value") + "\"," +
        "\"additional_field_2\":\"" + StringEscapeUtils.escapeJson("my_other_value") + "\"}";
}

内容的提问来源于stack exchange，提问作者preston.m.price