在JSON和Protobuf之间转换

1. 概述

在本教程中，我们将演示如何从JSON转换为Protobuf以及如何从Protobuf转换为JSON。

Protobuf是一种免费开源的跨平台数据格式，用于序列化结构化数据。

2. Maven依赖

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

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

3. 将JSON转换为Protobuf

我们可以使用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\""));
}

4. 将Protobuf转换为JSON

我们可以使用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\""));
}

5. 总结

在本文中，我们演示了如何将JSON转换为protobuf，反之亦然。

与往常一样，本教程的完整源代码可在GitHub上获得。

Show Disqus Comments