Java中JSON和Protobuf的互转

Kahen大约 2 分钟

Java中JSON和Protobuf的互转

在本教程中，我们将演示如何从JSON转换到Protobuf以及从Protobuf转换到JSON。 Protobuf是一个免费且开源的跨平台数据格式，用于序列化结构化数据。

要开始，让我们通过包含protobuf-java-util依赖项来创建一个Spring Boot项目：

`<dependency>`
    `<groupId>`com.google.protobuf`</groupId>`
    `<artifactId>`protobuf-java-util`</artifactId>`
    `<version>`3.25.3`</version>`
`</dependency>`

我们可以使用JsonFormat类将JSON转换为protobuf消息。JsonFormat是一个实用工具类，用于将protobuf消息转换为JSON格式。JsonFormat的parser()方法创建了一个Parser，它使用_merge()方法将JSON解析为protobuf消息。

让我们创建一个方法，它接受JSON并生成一个protobuf消息：

public static Message fromJson(String json) throws IOException {
    Builder structBuilder = Struct.newBuilder();
    JsonFormat.parser().ignoringUnknownFields().merge(json, structBuilder);
    return structBuilder.build();
}

让我们使用以下示例JSON：

{
    "boolean": true,
    "color": "gold",
    "object": {
      "a": "b",
      "c": "d"
    },
    "string": "Hello World"
}

现在，让我们编写一个简单的测试来验证从JSON到protobuf消息的转换：

@Test
public void givenJson_convertToProtobuf() throws IOException {
    Message protobuf = ProtobufUtil.fromJson(jsonStr);
    Assert.assertTrue(protobuf.toString().contains("key: \"boolean\""));
    Assert.assertTrue(protobuf.toString().contains("string_value: \"Hello World\""));
}

我们可以使用方法JsonFormat的printer()方法将protobuf消息转换为JSON，它接受protobuf作为MessageOrBuilder：

public static String toJson(MessageOrBuilder messageOrBuilder) throws IOException {
    return JsonFormat.printer().print(messageOrBuilder);
}

让我们编写一个简单的测试来验证从protobuf到JSON消息的转换：

@Test
public void givenProtobuf_convertToJson() throws IOException {
    Message protobuf = ProtobufUtil.fromJson(jsonStr);
    String json = ProtobufUtil.toJson(protobuf);
    Assert.assertTrue(json.contains("\"boolean\": true"));
    Assert.assertTrue(json.contains("\"string\": \"Hello World\""));
    Assert.assertTrue(json.contains("\"color\": \"gold\""));
}