PBC 项目技术文档

本文档旨在帮助用户安装、使用及详细了解 PBC 项目，一个用于 C 语言的 Google Protocol Buffers 库，无需代码生成。

1. 安装指南

PBC 可以通过多种方式安装，以下为常用安装方法：

使用 vcpkg 安装

1. 克隆 vcpkg 仓库：

   git clone https://github.com/Microsoft/vcpkg.git
   

2. 进入 vcpkg 目录并初始化：

   cd vcpkg
   ./bootstrap-vcpkg.sh
   

3. 集成 vcpkg 到系统：

   ./vcpkg integrate install
   

4. 安装 PBC：

   ./vcpkg install pbc
   

手动编译安装

1. 下载 PBC 源码。
2. 编译源码，生成库文件。
3. 将库文件拷贝到指定目录。

2. 项目使用说明

PBC 提供了消息 API 和模式 API 供用户使用。

消息 API

使用 wmessage 进行编码，使用 rmessage 进行解码。以下为一个快速示例：

package tutorial;

message Person {
  required string name = 1;
  required int32 id = 2;        // 此人的唯一 ID 号码。
  optional string email = 3;
}

struct pbc_rmessage * m = pbc_rmessage_new(env, "tutorial.Person", slice);
printf("name = %s\n", pbc_rmessage_string(m , "name" , 0 , NULL));
printf("id = %d\n", pbc_rmessage_integer(m , "id" , 0 , NULL));
printf("email = %s\n", pbc_rmessage_string(m , "email" , 0 , NULL));

int phone_n = pbc_rmessage_size(m, "phone");
int i;

for (i=0;i<phone_n;i++) {
  struct pbc_rmessage * p = pbc_rmessage_message(m , "phone", i);
  printf("\tnumber[%d] = %s\n",i,pbc_rmessage_string(p , "number", i ,NULL));
  printf("\ttype[%d] = %s\n",i,pbc_rmessage_string(p, "type", i, NULL));
}

pbc_rmessage_delete(m);

模式 API

如果需要更好的性能，可以使用 pbc_pattern_xxx API。此 API 可以访问原生 C 结构中的数据，因此速度更快，内存使用更少。具体使用方法请参考 test/pattern.c。

3. 项目 API 使用文档

PBC 提供了消息 API 和模式 API。

消息 API

• pbc_rmessage_new：创建一个新的消息实例。
• pbc_rmessage_string：获取消息中的字符串字段。
• pbc_rmessage_integer：获取消息中的整数字段。
• pbc_rmessage_size：获取消息中某个字段的元素数量。
• pbc_rmessage_message：获取消息中的子消息。
• pbc_rmessage_delete：删除消息实例。

模式 API

• pbc_pattern_new：创建一个新的模式实例。
• pbc_pattern_xxx：访问模式中的数据。

4. 项目安装方式

PBC 支持以下安装方式：

• 使用 vcpkg 安装。
• 手动编译安装。