Google's Protobuf之PHP示例用法说明

搜了一遍，好像对PHP使用Protobuf的博文好少好少，因为公司有项目用到，所以这边也进行了解了一下。

google官方没有php版的使用说明，示例以allegro的php-protobuf进行说明，参考地址见本文最后面。

1. 安装php的protobuf扩展(linux)

从 https://github.com/allegro/php-protobuf 下载源代码

1) 进入源代码

2) /{php的bin目录}/phpize

3) ./configure

4) make && make install

5) 在php.ini里加入 extension=protobuf.so

6) 重启php

7) 用php -m 或 phpinfo() 查看扩展有没有安装成功

 

2. php的protobuf扩展说明

1) 继承ProtobufMessage类

2) 值的类型说明

const PB_TYPE_DOUBLE     = 1;
const PB_TYPE_FIXED_32   = 2;
const PB_TYPE_FIXED_64   = 3;
const PB_TYPE_FLOAT      = 4;
const PB_TYPE_INT        = 5;
const PB_TYPE_SIGNED_INT = 6;
const PB_TYPE_STRING     = 7;
const PB_TYPE_BOOL       = 8;

3) 属性字段的类型说明

required: 必须
optional: 可选
repeated: 多值

4) required/optional实现的方法

get{FIELD}()        // return field value
set{FIELD}($value)  // set field value to $value

5) repeated实现的方法

append{FIELD}($value)       // append $value value to field
clear{FIELD}()              // empty field
get{FIELD}()                // return array of field values
getAt{FIELD}($index)        // return field value at $index index
getCount{FIELD}()           // return number of field values
getIterator{FIELD}($index)  // return ArrayIterator for field values

 

3. php如何使用protobuf

首先声明一个ProtobufMessage的子类，示例：

<?php
/**
 * 人
 * 声明一个ProtobufMessage的子类
 * 要实现ProtobufMessage里的抽象方法reset
 *
 */
class Person extends ProtobufMessage{
    /**
     * 属性字段索引定义
     */
    const NAME = 1;     //姓名
    const AGE = 2;      //年龄
    const CARS = 3;     //拥有的汽车

    /**
     * type的定义值如下:
     *
     * 1:double; 2:fixed_32; 3:fixed_64; 4:float; 5:int; 6:signed int; 7:string; 8:bool;
     *
     */
    protected static $fields = array(
        self::NAME => array(
            'name' => 'name',
            'required' => true, //required:必填,optional:可选
            'type' => 7
        ),
        self::AGE => array(
            'name' => 'age',
            'required' => true,
            'type' => 5
        ),
        self::CARS => array(
            'name' => 'cars',
            'repeated' => true, //repeated:多值,数组或对象
            'type' => 7
        )
    );

    public function __construct() {
        $this->reset();
    }

    public function reset() {
        $this->values[self::NAME] = null;
        $this->values[self::AGE] = null;
        $this->values[self::CARS] = array();
    }

    public function fields() {
        return self::$fields;
    }

    /**
     * required/optional类型的字段
     * 要实现两个方法:  set{FIELD}($value)
     *                  get{FIELD}()
     *
     * 以上方法非必须
     */

    /**
     * 获得名字
     * @return string
     */
    public function getName() {
        return $this->get(self::NAME);
    }

    /**
     * 设置名字
     * @param string $name
     * @return bool
     */
    public function setName($name) {
        return $this->set(self::NAME, $name);
    }

    /**
     * 获得年龄
     * @return int
     */
    public function getAge() {
        return $this->get(self::AGE);
    }

    /**
     * 设置年龄
     * @param int $age
     * @return bool
     */
    public function setAge($age) {
        return $this->set(self::AGE, $age);
    }

    /**
     * repeated类型的字段
     * 要实现多值型的方法:  append{FIELD}($value)
     *                      clear{FIELD}()
     *                      get{FIELD}()
     *                      get{FIELD}At($index)
     *                      get{FIELD}Count()
     *                      get{FIELD}Iterator()
     *
     * 以上这些方法非必须,命名方式也非必须,但最好有个统一的命名规则
     */

    /**
     * 追加值
     *
     * @param string $car
     * @return bool
     */
    public function appendCars($car) {
        return $this->append(self::CARS, $car);
    }

    /**
     * 清除值
     * @return bool
     */
    public function clearCars() {
        return $this->clear(self::CARS);
    }

    /**
     * 获得值
     * @return array
     */
    public function getCars() {
        return $this->get(self::CARS);
    }

    /**
     * 获得某个索引的值
     * @param int $index 数组索引值
     * @return string
    public function getCarsAt($index) {
        return $this->get(self::CARS, $index);
    }

    /**
     * 获得数组的数量
     * @return int
     */
    public function getCarsCount() {
        return $this->count(self::CARS);
    }

    /**
     * 获得数组的迭代类
     * @return ArrayIterator
     */
    public function getCarsIterator() {
        return new ArrayIterator($this->get(self::CARS));
    }

}

使用姿势：

<?php
$person = new Person();
$person->setName('Arno');
$person->setAge(18);
$person->appendCars('宝马');
$person->appendCars('奔驰');

$packed = $person->serializeToString(); //序列化成proto格式
$cc = $person->getCarsCount();
var_dump($cc);
#file_put_contents('person.proto', $packed); //保存成文件或mysql的二进制字段里

//以下为读过程

$person->reset();
try {
    $person->parseFromString($packed);
} catch ( Exception $e ) {
    die('Upss.. there is a bug in this example');
}

$person->dump(); //输出

 

4. 参考：

Google开发者官网: https://developers.google.com/protocol-buffers/

Google的Github官网: https://github.com/google/protobuf

PHP的Protobuf扩展官网: https://github.com/allegro/php-protobuf