PHP 生成代码指南

描述协议缓冲区编译器为任何给定协议定义生成的 PHP 代码。

在阅读本文档之前，您应该阅读proto3 语言指南或Editions 语言指南。请注意，协议缓冲区编译器目前仅支持 proto3 和 Editions 为 PHP 生成代码。

编译器调用

当使用 --php_out= 命令行标志调用时，协议缓冲区编译器会生成 PHP 输出。--php_out= 选项的参数是您希望编译器写入 PHP 输出的目录。为了符合 PSR-4，编译器会创建一个与 proto 文件中定义的包相对应的子目录。此外，对于 proto 文件输入中的每个消息，编译器会在包的子目录中创建一个单独的文件。消息的输出文件名称由三部分组成

基本目录：proto 路径（通过 --proto_path= 或 -I 命令行标志指定）被输出路径（通过 --php_out= 标志指定）替换。
子目录：包名中的 . 被操作系统目录分隔符替换。每个包名组件都首字母大写。
文件：消息名后附加 .php。

因此，举例来说，假设您像下面这样调用编译器：

protoc --proto_path=src --php_out=build/gen src/example.proto

而 src/example.proto 定义如下

edition = "2023";
package foo.bar;
message MyMessage {}

编译器将读取文件 src/foo.proto 并生成输出文件：build/gen/Foo/Bar/MyMessage.php。编译器将根据需要自动创建目录 build/gen/Foo/Bar，但它不会创建 build 或 build/gen；它们必须已经存在。

包（Packages）

.proto 文件中定义的包名默认用于为生成的 PHP 类生成模块结构。给定一个文件，例如

package foo.bar;

message MyMessage {}

协议编译器会生成一个名为 Foo\Bar\MyMessage 的输出类。

命名空间选项

编译器支持附加选项来定义 PHP 和元数据命名空间。如果定义了这些选项，它们将用于生成模块结构和命名空间。给定选项，例如

package foo.bar;
option php_namespace = "baz\\qux";
option php_metadata_namespace = "Foo";
message MyMessage {}

协议编译器会生成一个名为 baz\qux\MyMessage 的输出类。该类将具有命名空间 namespace baz\qux。

协议编译器生成一个名为 Foo\Metadata 的元数据类。该类将具有命名空间 namespace Foo。

生成的选项区分大小写。默认情况下，包名会转换为 Pascal 命名法。

消息

给定一个简单的消息声明：

message Foo {
  int32 int32_value = 1;
  string string_value = 2;
  repeated int32 repeated_int32_value = 3;
  map<int32, int32> map_int32_int32_value = 4;
}

协议缓冲区编译器生成一个名为 Foo 的 PHP 类。该类继承自一个公共基类 Google\Protobuf\Internal\Message，它提供了用于编码和解码消息类型的方法，如以下示例所示

$from = new Foo();
$from->setInt32Value(1);
$from->setStringValue('a');
$from->getRepeatedInt32Value()[] = 1;
$from->getMapInt32Int32Value()[1] = 1;
$data = $from->serializeToString();
$to = new Foo();
try {
  $to->mergeFromString($data);
} catch (Exception $e) {
  // Handle parsing error from invalid data.
  ...
}

您不应该创建自己的 Foo 子类。生成的类并非设计用于子类化，并可能导致“脆弱的基类”问题。

嵌套消息会导致生成一个同名的 PHP 类，并以其包含消息作为前缀，用下划线分隔，因为 PHP 不支持嵌套类。因此，例如，如果您的 .proto 文件中有以下内容

message TestMessage {
  message NestedMessage {
    int32 a = 1;
  }
}

编译器将生成以下类

// PHP doesn’t support nested classes.
class TestMessage_NestedMessage {
  public function __construct($data = NULL) {...}
  public function getA() {...}
  public function setA($var) {...}
}

如果消息类名是保留字（例如，Empty），则在类名前添加前缀 PB。

class PBEmpty {...}

我们还提供了文件级别的选项 php_class_prefix。如果指定了此选项，它将作为前缀添加到所有生成的消息类中。

字段

对于消息类型中的每个字段，协议缓冲区编译器都会生成一组访问器方法来设置和获取该字段。访问器方法使用从 snake_case 字段名转换为 PascalCase 的名称。因此，给定字段 field_name，访问器方法将是 getFieldName 和 setFieldName。

// optional MyEnum optional_enum
$m->getOptionalEnum();
$m->setOptionalEnum(MyEnum->FOO);
$m->hasOptionalEnum();
$m->clearOptionalEnum();

// MyEnum implicit_enum
$m->getImplicitEnum();
$m->setImplicitEnum(MyEnum->FOO);

每当您设置一个字段时，值都会根据该字段的声明类型进行类型检查。如果值类型错误（或超出范围），将引发异常。默认情况下，允许在整数、浮点数和数字字符串之间进行类型转换（例如，将值分配给字段或向重复字段添加元素）。不允许的转换包括所有到/从数组或对象的转换。浮点数到整数的溢出转换是未定义的。

您可以在标量值类型表中查看每个标量协议缓冲区类型对应的 PHP 类型。

`has...` 和 `clear...`

对于具有显式存在的字段，编译器会生成一个 has...() 方法。如果字段已设置，此方法返回 true。

编译器还会生成一个 clear...() 方法。此方法取消设置字段。调用此方法后，has...() 将返回 false。

对于具有隐式存在的字段，编译器不会生成 has...() 或 clear...() 方法。对于这些字段，您可以通过将字段值与默认值进行比较来检查其是否存在。

奇异消息字段

对于具有消息类型的字段，编译器会生成与标量类型相同的访问器方法。

具有消息类型的字段默认为 null，并且在访问时不会自动创建。因此，您需要显式创建子消息，如下所示

$m = new MyMessage();
$m->setZ(new SubMessage());
$m->getZ()->setFoo(42);

$m2 = new MyMessage();
$m2->getZ()->setFoo(42);  // FAILS with an exception

您可以将任何实例分配给消息字段，即使该实例也在其他地方（例如，作为另一个消息的字段值）持有。

重复字段

协议缓冲区编译器为每个重复字段生成一个特殊的 RepeatedField。因此，例如，给定以下字段

repeated int32 foo = 1;

生成的代码允许您这样做

$m->getFoo()[] =1;
$m->setFoo($array);

映射字段

协议缓冲区编译器为每个映射字段生成一个 MapField。因此，给定此字段

map<int32, int32> weight = 1;

您可以使用生成的代码执行以下操作

$m->getWeight()[1] = 1;

枚举

PHP 没有原生枚举，因此协议缓冲区编译器会为您的 .proto 文件中的每个枚举类型生成一个 PHP 类，就像消息一样，并为每个值定义常量。因此，给定此枚举

enum TestEnum {
  Default = 0;
  A = 1;
}

编译器生成以下类

class TestEnum {
  const DEFAULT = 0;
  const A = 1;
}

与消息一样，嵌套枚举会生成一个同名的 PHP 类，并以其包含消息作为前缀，用下划线分隔，因为 PHP 不支持嵌套类。

class TestMessage_NestedEnum {...}

如果枚举类名或值名是保留字（例如 Empty），则在类名或值名前添加前缀 PB。

class PBEmpty {
  const PBECHO = 0;
}

我们还提供了文件级别的选项 php_class_prefix。如果指定了此选项，它将作为前缀添加到所有生成的枚举类中。

Oneof

对于 oneof，协议缓冲区编译器会为 oneof 中的每个字段生成一个 has 和 clear 方法，以及一个特殊的访问器方法，让您找出哪个 oneof 字段（如果有）已设置。因此，给定此消息

message TestMessage {
  oneof test_oneof {
    int32 oneof_int32 = 1;
    int64 oneof_int64 = 2;
  }
}

编译器生成以下字段和特殊方法

class TestMessage {
  private oneof_int32;
  private oneof_int64;
  public function getOneofInt32();
  public function setOneofInt32($var);
  public function getOneofInt64();
  public function setOneofInt64($var);
  public function getTestOneof();  // Return field name
}

访问器方法的名称基于 oneof 的名称，并返回一个字符串，表示 oneof 中当前已设置的字段。如果 oneof 未设置，该方法返回一个空字符串。

当您设置 oneof 中的一个字段时，它会自动清除 oneof 中的所有其他字段。如果您想在 oneof 中设置多个字段，则必须在单独的语句中进行。

$m = new TestMessage();
$m->setOneofInt32(42); // $m->hasOneofInt32() is true
$m->setOneofInt64(123); // $m->hasOneofInt32() is now false