如何使用protobufjs将给定JSON对象转换为Protobuf Message

问题描述 #

给定如下JSON对象：

const json = {
    code: 3,
    message: 'Test error message',
    details: [
        {
            '@type': 'google.rpc.BadRequest',
            fieldViolations: [
                {
                    field: 'field',
                    description: 'must not be null',
                },
            ],
        },
    ],
};

如何使用protobufjs将其转换为Proto Message？

实现步骤 #

1. 准备依赖与核心Proto定义 #

先确保项目已安装protobufjs，同时需要引入Google官方的两个核心Proto文件：google/rpc/status.proto（定义基础错误状态结构）和google/rpc/error_details.proto（定义BadRequest这类详细错误类型）。

2. 加载Proto定义并生成Message类 #

通过protobufjs加载上述Proto文件，生成对应的Message构造类：

const protobuf = require("protobufjs");

// 异步加载Proto定义
async function loadProtos() {
    const root = await protobuf.load([
        "google/rpc/status.proto",
        "google/rpc/error_details.proto"
    ]);
    // 获取Status类型的Message类
    return root.lookupType("google.rpc.Status");
}

3. 完成JSON到Proto Message的转换 #

原JSON中的@type字段会被protobufjs自动识别，用于解析嵌套的BadRequest类型。直接调用fromObject方法即可完成转换：

async function convertJsonToProto(json) {
    const Status = await loadProtos();
    // 验证JSON格式并转换为Message实例
    const statusMessage = Status.fromObject(json);
    // 可选：将Message序列化为二进制Buffer
    const binaryBuffer = Status.encode(statusMessage).finish();
    return { statusMessage, binaryBuffer };
}

// 调用示例
convertJsonToProto(json).then(result => {
    console.log("转换后的Proto Message:", result.statusMessage);
});

4. 验证转换正确性 #

如果需要确认转换结果，可将Message实例转回普通对象对比：

const convertedBack = Status.toObject(result.statusMessage);
console.log("转回的对象:", convertedBack);

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