Ruby 生成代码指南

描述 protocol buffer 编译器为任何给定的协议定义所生成的消息对象的 API。

在阅读本文档之前，您应先阅读 proto2、proto3 或 editions 的语言指南。

编译器调用

当使用 --ruby_out= 命令行标志调用 protocol buffer 编译器时，它会生成 Ruby 输出。--ruby_out= 选项的参数是您希望编译器写入 Ruby 输出的目录。编译器会为每个 .proto 输入文件创建一个 .rb 文件。输出文件的名称是通过对 .proto 文件名进行两处更改计算得出的：

  • 扩展名 (.proto) 被替换为 _pb.rb。
  • proto 路径（通过 --proto_path= 或 -I 命令行标志指定）被替换为输出路径（通过 --ruby_out= 标志指定）。

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

protoc --proto_path=src --ruby_out=build/gen src/foo.proto src/bar/baz.proto

编译器将读取文件 src/foo.proto 和 src/bar/baz.proto，并生成两个输出文件：build/gen/foo_pb.rb 和 build/gen/bar/baz_pb.rb。编译器会自动创建目录 build/gen/bar（如果需要），但它不会创建 build 或 build/gen；这些目录必须已存在。

包（Packages）

在 .proto 文件中定义的包名（package name）用于为生成的消息生成模块结构。给定一个如下文件：

package foo_bar.baz;

message MyMessage {}

protocol 编译器会生成一个名为 FooBar::Baz::MyMessage 的输出消息。

但是，如果 .proto 文件包含 ruby_package 选项，如下所示：

option ruby_package = "Foo::Bar";

那么生成的输出将优先使用 ruby_package 选项，并生成 Foo::Bar::MyMessage。

消息

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

message Foo {}

protocol buffer 编译器会生成一个名为 Foo 的类。该生成类派生自 Ruby 的 Object 类（proto 没有通用的基类）。与 C++ 和 Java 不同，Ruby 生成的代码不受 .proto 文件中 optimize_for 选项的影响；实际上，所有的 Ruby 代码都针对代码大小进行了优化。

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

Ruby 消息类为每个字段定义了访问器，并提供了以下标准方法：

  • Message#dup, Message#clone：对此消息执行浅拷贝，并返回新的副本。
  • Message#==：在两个消息之间执行深层相等性比较。
  • Message#hash：计算消息值的浅层哈希值。
  • Message#to_hash, Message#to_h：将对象转换为 Ruby 的 Hash 对象。只有顶层消息会被转换。
  • Message#inspect：返回表示此消息的人类可读字符串。
  • Message#[], Message#[]=：通过字符串名称获取或设置字段。将来，这可能还会用于获取/设置扩展。

消息类还将以下方法定义为静态方法。（通常我们更倾向于静态方法，因为常规方法可能会与您在 .proto 文件中定义的字段名冲突。）

  • Message.decode(str)：解码此消息的二进制 protobuf，并在一个新实例中返回它。
  • Message.encode(proto)：将此类的消息对象序列化为二进制字符串。
  • Message.decode_json(str)：解码此消息的 JSON 文本字符串，并在一个新实例中返回它。
  • Message.encode_json(proto)：将此类的消息对象序列化为 JSON 文本字符串。
  • Message.descriptor：返回此消息的 Google::Protobuf::Descriptor 对象。

当您创建消息时，可以在构造函数中方便地初始化字段。以下是构造和使用消息的示例：

message = MyMessage.new(int_field: 1,
                        string_field: "String",
                        repeated_int_field: [1, 2, 3, 4],
                        submessage_field: MyMessage::SubMessage.new(foo: 42))
serialized = MyMessage.encode(message)

message2 = MyMessage.decode(serialized)
raise unless message2.int_field == 1

嵌套类型

消息可以声明在另一个消息内部。例如：

message Foo {
  message Bar { }
}

在这种情况下，Bar 类在 Foo 内部被声明为一个类，因此您可以将其引用为 Foo::Bar。

字段

对于消息类型中的每个字段，都有用于设置和获取该字段的访问器方法。因此，给定一个字段 foo，您可以编写：

message.foo = get_value()
print message.foo

每当您设置一个字段时，都会根据该字段的声明类型对值进行类型检查。如果值的类型不正确（或超出范围），将会引发异常。

单一字段

对于单一原始类型字段（数字、字符串和布尔值），您赋给该字段的值应该是正确的类型，并且必须在适当的范围内：

  • 数字类型：值应为 Fixnum、Bignum 或 Float。您赋的值必须能在目标类型中精确表示。因此，将 1.0 赋给 int32 字段是可以的，但赋 1.2 则不行。
  • 布尔字段：值必须是 true 或 false。没有其他值会隐式转换为 true/false。
  • Bytes 字段：赋的值必须是 String 对象。protobuf 库将复制该字符串，将其转换为 ASCII-8BIT 编码，并将其冻结。
  • String 字段：赋的值必须是 String 对象。protobuf 库将复制该字符串，将其转换为 UTF-8 编码，并将其冻结。

不会发生自动的 #to_s、#to_i 等调用来执行自动转换。如有必要，您应首先自己转换值。

检查存在性

显式字段存在性由 field_presence 特性（在 editions 中）、optional 关键字（在 proto2/proto3 中）以及字段类型（消息和 oneof 字段始终具有显式存在性）确定。当一个字段具有存在性时，您可以通过调用生成的 has_...? 方法来检查该字段是否已在消息上设置。设置任何值——甚至是默认值——都会将该字段标记为存在。可以通过调用另一个生成的 clear_... 方法来清除字段。

例如，对于一个带有 int32 字段 foo 的消息 MyMessage：

message MyMessage {
  int32 foo = 1;
}

foo 的存在性可以按如下方式检查：

m = MyMessage.new
raise if m.has_foo?
m.foo = 0
raise unless m.has_foo?
m.clear_foo
raise if m.has_foo?

奇异消息字段

子消息字段始终具有存在性，无论它们是否被标记为 optional。未设置的子消息字段返回 nil，因此您始终可以判断该消息是否被显式设置。要清除子消息字段，请将其值显式设置为 nil。

if message.submessage_field.nil?
  puts "Submessage field is unset."
else
  message.submessage_field = nil
  puts "Cleared submessage field."
end

除了比较和赋值 nil 之外，生成的消息还有 has_... 和 clear_... 方法，其行为与基本类型相同：

if !message.has_submessage_field?
  puts "Submessage field is unset."
else
  message.clear_submessage_field
  raise if message.has_submessage_field?
  puts "Cleared submessage field."
end

当您分配子消息时，它必须是正确类型的生成消息对象。

在分配子消息时，可能会创建消息循环。例如：

// foo.proto
message RecursiveMessage {
  RecursiveMessage submessage = 1;
}

# test.rb
require 'foo'

message = RecursiveMessage.new
message.submessage = message

如果您尝试序列化这个对象，库将检测到循环并序列化失败。

重复字段

重复字段使用自定义类 Google::Protobuf::RepeatedField 来表示。这个类行为类似 Ruby 的 Array，并混入了 Enumerable。与常规的 Ruby 数组不同，RepeatedField 在构造时带有特定类型，并期望所有数组成员都具有正确的类型。类型和范围的检查方式与消息字段完全相同。

int_repeatedfield = Google::Protobuf::RepeatedField.new(:int32, [1, 2, 3])

raise unless !int_repeatedfield.empty?

# Raises TypeError.
int_repeatedfield[2] = "not an int32"

# Raises RangeError
int_repeatedfield[2] = 2**33

message.int32_repeated_field = int_repeatedfield

# This isn't allowed; the regular Ruby array doesn't enforce types like we need.
message.int32_repeated_field = [1, 2, 3, 4]

# This is fine, since the elements are copied into the type-safe array.
message.int32_repeated_field += [1, 2, 3, 4]

# The elements can be cleared without reassigning.
int_repeatedfield.clear
raise unless int_repeatedfield.empty?

对于包含消息的重复字段，Google::Protobuf::RepeatedField 的构造函数支持一个带有三个参数的变体：:message、子消息的类以及要设置的值：

first_message = MySubMessage.new(foo: 42)
second_message = MySubMessage.new(foo: 79)

repeated_field = Google::Protobuf::RepeatedField.new(
    :message,
    MySubMessage,
    [first_message, second_message]
)
message.sub_message_repeated_field = repeated_field

RepeatedField 类型支持与常规 Ruby Array 相同的所有方法。您可以使用 repeated_field.to_a 将其转换为常规的 Ruby Array。

与单一字段不同，从不为重复字段生成 has_...? 方法。

映射字段

Map 字段使用一个行为类似 Ruby Hash 的特殊类 (Google::Protobuf::Map) 来表示。与常规的 Ruby 哈希不同，Map 在构造时为键和值指定了特定类型，并期望 map 的所有键和值都具有正确的类型。类型和范围的检查方式与消息字段和 RepeatedField 元素完全相同。

int_string_map = Google::Protobuf::Map.new(:int32, :string)

# Returns nil; items is not in the map.
print int_string_map[5]

# Raises TypeError, value should be a string
int_string_map[11] = 200

# Ok.
int_string_map[123] = "abc"

message.int32_string_map_field = int_string_map

枚举

由于 Ruby 没有原生枚举，我们为每个枚举创建一个模块，并用常量来定义其值。给定 .proto 文件：

message Foo {
  enum SomeEnum {
    VALUE_A = 0;
    VALUE_B = 5;
    VALUE_C = 1234;
  }
  SomeEnum bar = 1;
}

您可以这样引用枚举值：

print Foo::SomeEnum::VALUE_A  # => 0
message.bar = Foo::SomeEnum::VALUE_A

您可以将数字或符号赋给枚举字段。当读回该值时，如果枚举值是已知的，它将是一个符号；如果未知，则是一个数字。

对于 OPEN 枚举（proto3 使用），任何整数值都可以赋给该枚举，即使该值未在枚举中定义。

message.bar = 0
puts message.bar.inspect  # => :VALUE_A
message.bar = :VALUE_B
puts message.bar.inspect  # => :VALUE_B
message.bar = 999
puts message.bar.inspect  # => 999

# Raises: RangeError: Unknown symbol value for enum field.
message.bar = :UNDEFINED_VALUE

# Switching on an enum value is convenient.
case message.bar
when :VALUE_A
  # ...
when :VALUE_B
  # ...
when :VALUE_C
  # ...
else
  # ...
end

枚举模块还定义了以下实用方法：

  • Foo::SomeEnum.lookup(number)：查找给定的数字并返回其名称，如果未找到则返回 nil。如果多个名称具有此数字，则返回第一个定义的名称。
  • Foo::SomeEnum.resolve(symbol)：返回此枚举名称对应的数字，如果未找到则返回 nil。
  • Foo::SomeEnum.descriptor：返回此枚举的描述符。

Oneof

给定一个带有 oneof 的消息：

message Foo {
  oneof test_oneof {
     string name = 1;
     int32 serial_number = 2;
  }
}

与 Foo 对应的 Ruby 类将有名为 name 和 serial_number 的成员，并具有与常规字段一样的访问器方法。然而，与常规字段不同，oneof 中的字段在任何时候最多只能设置一个，因此设置一个字段会清除其他字段。

message = Foo.new

# Fields have their defaults.
raise unless message.name == ""
raise unless message.serial_number == 0
raise unless message.test_oneof == nil

message.name = "Bender"
raise unless message.name == "Bender"
raise unless message.serial_number == 0
raise unless message.test_oneof == :name

# Setting serial_number clears name.
message.serial_number = 2716057
raise unless message.name == ""
raise unless message.test_oneof == :serial_number

# Setting serial_number to nil clears the oneof.
message.serial_number = nil
raise unless message.test_oneof == nil

对于 proto2 消息，oneof 成员也有单独的 has_...? 方法：

message = Foo.new

raise unless !message.has_test_oneof?
raise unless !message.has_name?
raise unless !message.has_serial_number?
raise unless !message.has_test_oneof?

message.name = "Bender"
raise unless message.has_test_oneof?
raise unless message.has_name?
raise unless !message.has_serial_number?
raise unless !message.has_test_oneof?