在proto3中,可以直接使用protoc
命令生成PHP代码。生成的PHP代码不能直接使用,还需要 Protobuf 的PHP库 支持。
下面通过一个例子演示下PHP怎么使用protobuf。首先定义proto文件:
syntax = "proto3";
package lm;
message helloworld
{
int32 id = 1; // ID
string str = 2; // str
int32 opt = 3; // optional field
}
注意这里采用的是proto3的语法,和proto2不太一样,required
和optional
的限定已经没有了,所有的字段都是可选的。proto3相比proto2有什么区别,可以参照 这篇文章。
接着用protoc
生成PHP文件:
protoc --php_out=./ hello.proto
会看到生成了一个hello.pb.php
文件:
生成PHP代码
namespace Lm;
use Google\Protobuf\Internal\DescriptorPool;
use Google\Protobuf\Internal\GPBType;
use Google\Protobuf\Internal\RepeatedField;
use Google\Protobuf\Internal\GPBUtil;
class helloworld extends \Google\Protobuf\Internal\Message
{
....
}
阅读下里面的代码,发现它use了Google\Protobuf
下的类,这是一个PHP库,可以去下载:
https://github.com/google/protobuf/tree/master/php/src/Google/Protobuf
也可以用composer
引入到项目中,推荐用composer引入,因为composer会帮你自动生成Autoloader:
composer require google/protobuf
采用composer方式引入google/protobuf
之后,项目中会出现一个vendor
目录。在自己的代码中includevendor
下的autoload.php
,以及刚才生成的helloworld.pb.php
文件,就可以进行二进制的读写了。
简单读写示例
有了google/protobuf
库的帮助,PHP读写protobuf格式的二进制还是很方便的。
利用protobuf写入数据到二进制文件:
<?php
include 'vendor/autoload.php';
include 'hello.pb.php';
$from = new \Lm\helloworld();
$from->setId(1);
$from->setStr('foo bar, this is a message');
$from->setOpt(29);
$data = $from->serializeToString();
file_put_contents('data.bin', $data);
读取同样的二进制文件:
<?php
include 'vendor/autoload.php';
include 'hello.pb.php';
$data = file_get_contents('data.bin');
$to = new \Lm\helloworld();
$to->mergeFromString($data);
echo $to->getId() . PHP_EOL;
echo $to->getStr() . PHP_EOL;
echo $to->getOpt() . PHP_EOL;
希望对您的工作有帮助。:-)