m9rco / php-protobuf

Google的Protocol Buffers for PHP

维护者

详细信息

github.com/m9rco/php-protobuf

主页

源代码

问题

安装: 5

依赖项: 0

建议者: 0

安全: 0

星标: 0

关注者: 1

分支: 267

v0.12.5 2019-09-30 04:08 UTC

Requires

BSD-3-Clause c7f04ccab262d842b9c1dbfb6e328acbbe66a005

dataprotocol bufferspb

This package is auto-updated.

Last update: 2024-09-29 05:22:09 UTC

README

概述

Protocol Buffers 是一种高效且可扩展的编码结构化数据的方式。它可能用于文件格式和RPC协议。

PHP Protobuf 是Google的Protocol Buffers在PHP上的实现，旨在提供高性能，包括一个从.proto文件生成PHP类的protoc插件。解析（解析和序列化）的重劳由PHP扩展完成。

需求

  • PHP 7.0或更高版本（对于PHP 5支持请参考php5分支）
  • Pear的Console_CommandLine（用于protoc插件）
  • Google的protoc编译器版本2.6或更高

入门

安装

  1. 克隆源代码

    git clone https://github.com/allegro/php-protobuf

  2. 转到源代码目录

    cd php-protobuf

  3. 构建和安装PHP扩展（请参考php.net上的说明）

  4. 安装protoc插件依赖项

    composer install

用法

  1. 假设你有一个文件 foo.proto

    message Foo
{
    required int32 bar = 1;
    optional string baz = 2;
    repeated float spam = 3;
}

  2. 编译 foo.proto

    php protoc-gen-php.php foo.proto

  3. 创建 Foo 消息并用一些数据填充它

    require_once 'Foo.php';

$foo = new Foo();
$foo->setBar(1);
$foo->setBaz('two');
$foo->appendSpam(3.0);
$foo->appendSpam(4.0);

  4. 将消息序列化为字符串

    $packed = $foo->serializeToString();

  5. 从字符串解析消息

    $parsedFoo = new Foo();
try {
    $parsedFoo->parseFromString($packed);
} catch (Exception $ex) {
    die('Oops.. there is a bug in this example, ' . $ex->getMessage());
}

  6. 让我们看看我们解析了什么

    $parsedFoo->dump();

    应该产生类似以下输出的结果

    Foo {
  1: bar => 1
  2: baz => 'two'
  3: spam(2) =>
    [0] => 3
    [1] => 4
}

  7. 如果你想，你可以将对象重置为其初始状态

    $parsedFoo->reset();

指南

编译

PHP Protobuf 随带Google的protoc编译器插件。你可以直接运行

php protoc-gen-php.php -o output_dir foo.proto

或者传递给protoc

protoc --plugin=protoc-gen-allegrophp=protoc-gen-php.php --allegrophp_out=output_dir foo.proto

在Windows上使用protoc-gen-php.bat代替。

命令行选项

  • -o out, --out=out - 生成文件的输出目录（默认为当前目录）。
  • -I proto_path, --proto_path=proto_path - 搜索导入的目录。
  • --protoc=protoc - protoc编译器可执行文件路径。
  • -D define, --define=define - 定义生成器选项（例如 -Dnamespace='Foo\Bar\Baz'）。

生成器选项

  • namespace - 生成PHP类所使用的命名空间。

消息类

编译期间生成的类遵循PSR-0规范（每个类都放入它自己的文件）。如果未定义namespace生成器选项，则使用包名（如果存在）来创建命名空间。如果没有设置包名，则将类放入全局空间。

PHP Protobuf模块实现了ProtobufMessage类，它封装了协议逻辑。从proto文件编译的消息扩展了这个类，提供消息字段描述符。根据这些描述符，ProtobufMessage知道如何解析和序列化给定类型的消息。

为每个字段生成一组访问器。对于单值字段（required / optional）和多值字段（repeated），方法集是不同的。

  • required / optional

      get{FIELD}()        // return a field value
  has{FIELD}()        // check whether a field is set
  set{FIELD}($value)  // set a field value to $value

  • repeated

      append{FIELD}($value)       // append $value to a field
  clear{FIELD}()              // empty field
  get{FIELD}()                // return an array of field values
  getAt{FIELD}($index)        // return a field value at $index index
  getCount{FIELD}()           // return a number of field values
  has{FIELD}()                // check whether a field is set
  getIterator{FIELD}()        // return an ArrayIterator

{FIELD} 是驼峰式的字段名。

枚举

PHP原生不支持枚举类型。因此，枚举由PHP整型表示。为了方便，枚举被编译为具有对应其可能值的常量的类。

类型映射

可用的内置PHP类型的范围带来了一些限制。PHP不支持64位正整数类型。请注意，解析大整数值可能会导致得到意外的结果。

Protocol Buffers类型映射到PHP类型如下（x86_64）

| Protocol Buffers | PHP    |
| ---------------- | ------ |
| double           | float  |
| float            |        |
| ---------------- | ------ |
| int32            | int    |
| int64            |        |
| uint32           |        |
| uint64           |        |
| sint32           |        |
| sint64           |        |
| fixed32          |        |
| fixed64          |        |
| sfixed32         |        |
| sfixed64         |        |
| ---------------- | ------ |
| bool             | bool   |
| ---------------- | ------ |
| string           | string |
| bytes            |        |

Protocol Buffers类型映射到PHP类型如下（x86）

| Protocol Buffers | PHP                         |
| ---------------- | --------------------------- |
| double           | float                       |
| float            |                             |
| ---------------- | --------------------------- |
| int32            | int                         |
| uint32           |                             |
| sint32           |                             |
| fixed32          |                             |
| sfixed32         |                             |
| ---------------- | --------------------------- |
| int64            | if val <= PHP_INT_MAX       |
| uint64           | then value is stored as int |
| sint64           | otherwise as double         |
| fixed64          |                             |
| sfixed64         |                             |
| ---------------- | --------------------------- |
| bool             | bool                        |
| ---------------- | --------------------------- |
| string           | string                      |
| bytes            |                             |

未设置值表示为null类型。要取消设置值，只需将其值设置为null。

解析

要解析消息，创建一个消息类实例并调用其parseFromString方法，将序列化消息传递给它。遇到的错误通过抛出Exception来报告。异常信息提供了详细的解释。未设置的必需字段会被静默忽略。

$packed = /* serialized FooMessage */;
$foo = new FooMessage();

try {
    $foo->parseFromString($packed);
} catch (Exception $ex) {
    die('Parse error: ' . $e->getMessage());
}

$foo->dump(); // see what you got

序列化

要序列化消息，调用serializeToString方法。它返回一个包含protobuf编码消息的字符串。遇到的错误通过抛出Exception来报告。异常信息提供了详细的解释。未设置的必需字段将触发错误。

$foo = new FooMessage()
$foo->setBar(1);

try {
    $packed = $foo->serializeToString();
} catch (Exception $ex) {
    die 'Serialize error: ' . $e->getMessage();
}

/* do some cool stuff with protobuf-encoded $packed */

调试

可能会有这样的情况，你需要调查给定消息的实际内容。在消息实例上var_dump给出的结果有些晦涩难懂。

ProtobufMessage类提供了一个dump方法，可以将消息内容打印到标准输出。它接受一个可选参数，指定是否只想转储已设置的字段（默认情况下，它只转储已设置的字段）。传递false作为参数以转储所有字段。它产生的格式类似于var_dump。

或者，你可以使用printDebugString()方法，它以协议缓冲区文本格式生成输出。

IDE辅助器和自动完成支持

要集成此扩展与您的IDE（PhpStorm、Eclipse等）并获得自动完成支持，只需在项目根目录下的任何位置包含stubs\ProtobufMessage.php。

已知问题

参考文献

致谢