所用资源
本教程实践基于GitHub上开源的高效序列化工具:allegro/php-protobuf。该项目为PHP语言提供了完整的Protocol Buffers支持。

安装PHP的protobuf扩展
安装PHP的protobuf扩展步骤非常标准,与安装其他PHP扩展流程基本一致。首先进入解压后的扩展源码目录,然后按顺序执行以下命令:
phpize
./configure
make
make install
编译安装完成后,最关键的一步是在你的php.ini配置文件中添加一行扩展声明:
extension=protobuf.so
请务必记得重启你的PHP服务(例如PHP-FPM或Apache)。之后,通过创建一个phpinfo()页面进行验证,就能看到protobuf扩展已经成功加载并启用了。
如何使用?
第一步:定义与生成
首先,你需要创建一个.proto文件来定义你的数据结构格式。例如,我们创建一个名为foo.proto的文件,其内容如下:
message PhoneNumber {
required string number = 1;
required int32 type = 2;
}
message Person {
required string name = 1;
required int32 id = 2;
optional string email = 3;
repeated PhoneNumber phone = 4;
}
message AddressBook {
repeated Person person = 1;
}
数据结构定义完成后,使用allegro/php-protobuf项目提供的PHP脚本生成对应的PHP类文件:
php protoc-php.php foo.proto
执行成功后,你将得到一个名为pb_proto_foo.php的PHP文件。该文件包含了根据proto定义自动生成的PHP类,后续所有的序列化与反序列化操作都将依赖这些类。
第二步:应用实践
接下来我们通过具体场景来学习如何使用。假设我们需要与一个Java后端服务进行基于Protobuf的数据通信。
场景一:解析Java端传来的Buffer数据
当Java服务返回了一个经过序列化的protobuf二进制数据流时,在PHP端可以按以下方式解析:
require_once 'pb_proto_test.php'; // 引入之前生成的PHP类文件
$packed = curlGet('https://10.0.247.113:8080/testweb/proto'); // 此处模拟从Java端获取的二进制数据
$foo = new AddressBook();
try {
$foo->parseFromString($packed); // 核心解析方法,将二进制流反序列化为对象
} catch (Exception $ex) {
die('Parse error: ' . $e->getMessage()); // 解析出错时的异常处理
}
$pb = $foo->getPerson(); // 获取Person对象列表
// 可以打印整个数组查看结构:print_r($pb);
// 或者仅打印第一个元素:print_r($pb[0]);
// 在实际业务中,直接访问对象的Getter方法即可:
echo $pb[0]->getName() .' _ '.$pb[0]->getId() .' _ ';
print_r($pb[0]->getPhone());
场景二:PHP生成并修改Buffer数据
反之,PHP端也可以构造数据对象,将其序列化为二进制Buffer后发送给其他服务:
require_once 'pb_proto_test.php';
$foo = new Person();
$foo->setName('xiaojh');
$foo->setId(200);
$foo->setEmail('dofound@163.com');
// 如果需要添加重复字段(例如phone),可以使用append方法://$foo->appendPhone(2);
$packed = $foo->serializeToString(); // 核心序列化方法,得到二进制Buffer
$foo->clear(); // 清空对象状态,以便重复使用
try {
$xiao = $foo->parseFromString($packed); // 可将序列化后的数据再次解析回来,用于验证
// print_r($xiao);
} catch (Exception $ex) {
die('Upss.. there is a bug in this example');
}
echo $foo->getName();
echo $foo->getPhone()->number;
$foo->dump(); // 部分生成类会提供dump方法,便于调试时查看对象内容
PHP内部调用
------------------------------
生成buffer数据
