pb2json 项目技术文档

pb2json 项目技术文档

pb2json Decode protobuf to json format 项目地址: https://gitcode.com/gh_mirrors/pb/pb2json

1. 安装指南

1.1 依赖安装

本项目依赖于 jansson 库，因此在安装 pb2json 之前，需要先安装 jansson。

1.1.1 安装 jansson

wget "http://www.digip.org/jansson/releases/jansson-2.1.tar.gz"
tar -zxvf jansson-2.1.tar.gz
cd jansson-2.1
./configure
make
sudo make install

1.2 安装 pb2json

在安装完 jansson 之后，可以继续安装 pb2json。

make
sudo make install

2. 项目使用说明

2.1 测试与示例

安装完成后，可以通过以下步骤进行测试：

cd $src/test
make
./runtest

2.2 使用方法

项目提供了两个 API 接口，用于将 protobuf 消息转换为 JSON 格式。

2.2.1 API 接口

• char *pb2json(Message *msg, const char *buf, int len);

  • 参数说明：
    • msg：由 protoc 生成的类的实例。
    • buf：protobuf 的二进制内容。
    • len：buf 的长度。
  • 返回值：成功时返回 JSON 字符串，失败时返回 NULL。返回的字符串需要由调用者释放。

• char *pb2json(Message &msg);

  • 参数说明：
    • msg：由 protoc 生成的类的实例。
  • 返回值：成功时返回 JSON 字符串，失败时返回 NULL。返回的字符串需要由调用者释放。

2.3 示例代码

以下是一个简单的使用示例：

#include "pb2json.h"
#include "person.pb.h"

int main() {
    Person person;
    person.set_name("John Doe");
    person.set_id(123);
    person.set_email("john.doe@example.com");

    char *json_str = pb2json(person);
    if (json_str) {
        printf("JSON: %s\n", json_str);
        free(json_str);
    } else {
        printf("Failed to convert protobuf to JSON.\n");
    }

    return 0;
}

3. 项目 API 使用文档

3.1 pb2json API

3.1.1 char *pb2json(Message *msg, const char *buf, int len);

• 功能：将 protobuf 消息转换为 JSON 字符串。
• 参数：
  • msg：protobuf 消息对象的指针。
  • buf：protobuf 消息的二进制数据。
  • len：二进制数据的长度。
• 返回值：成功时返回 JSON 字符串，失败时返回 NULL。

3.1.2 char *pb2json(Message &msg);

• 功能：将 protobuf 消息转换为 JSON 字符串。
• 参数：
  • msg：protobuf 消息对象的引用。
• 返回值：成功时返回 JSON 字符串，失败时返回 NULL。

4. 项目安装方式

4.1 安装依赖

首先需要安装 jansson 库：

wget "http://www.digip.org/jansson/releases/jansson-2.1.tar.gz"
tar -zxvf jansson-2.1.tar.gz
cd jansson-2.1
./configure
make
sudo make install

4.2 安装 pb2json

在安装完 jansson 之后，可以继续安装 pb2json：

make
sudo make install

通过以上步骤，您可以成功安装并使用 pb2json 项目。

pb2json Decode protobuf to json format 项目地址: https://gitcode.com/gh_mirrors/pb/pb2json