Protocol Buffers 知名类型

索引

• Any（消息）
• Api（消息）
• BoolValue（消息）
• BytesValue（消息）
• DoubleValue（消息）
• Duration（消息）
• Empty（消息）
• Enum（消息）
• EnumValue（消息）
• Field（消息）
• Field.Cardinality（枚举）
• Field.Kind（枚举）
• FieldMask（消息）
• FloatValue（消息）
• Int32Value（消息）
• Int64Value（消息）
• ListValue（消息）
• Method（消息）
• Mixin（消息）
• NullValue（枚举）
• Option（消息）
• SourceContext（消息）
• StringValue（消息）
• Struct（消息）
• Syntax（枚举）
• Timestamp（消息）
• Type（消息）
• UInt32Value（消息）
• UInt64Value（消息）
• Value（消息）

以“Value”结尾的知名类型是其他类型的包装消息，例如 BoolValue 和 EnumValue。这些现在已废弃。如今使用包装器的唯一原因是

• 与已使用它们的旧消息进行有线兼容。
• 如果你想将标量值放入 Any 消息中。

在大多数情况下，有更好的选择

• 对于新消息，最好使用常规的显式存在字段（proto2/proto3 中的 optional，2023 年及更高版本中的常规字段）。
• 扩展通常比 Any 字段是更好的选择。

Any

Any 包含一个任意序列化消息以及描述序列化消息类型的 URL。

JSON

Any 值的 JSON 表示使用反序列化嵌入消息的常规表示，带有一个额外的字段 @type，其中包含类型 URL。示例

package google.profile;
message Person {
  string first_name = 1;
  string last_name = 2;
}

{
  "@type": "type.googleapis.com/google.profile.Person",
  "firstName": <string>,
  "lastName": <string>
}

如果嵌入消息类型是知名类型并且具有自定义 JSON 表示，该表示将被嵌入，并添加一个 value 字段，该字段除了 @type 字段外，还包含自定义 JSON。示例（对于消息 google.protobuf.Duration）

{
  "@type": "type.googleapis.com/google.protobuf.Duration",
  "value": "1.212s"
}

Api

Api 是一个用于 Protocol Buffer 服务的轻量级描述符。

BoolValue

bool 的包装消息。

BoolValue 的 JSON 表示是 JSON true 和 false。

BytesValue

bytes 的包装消息。

BytesValue 的 JSON 表示是 JSON 字符串。

DoubleValue

double 的包装消息。

DoubleValue 的 JSON 表示是 JSON 数字。

Duration

Duration 表示一个带符号的固定长度时间跨度，以秒和纳秒分辨率的秒分数表示。它独立于任何日历以及“天”或“月”等概念。它与 Timestamp 相关，因为两个 Timestamp 值之间的差是 Duration，并且可以从 Timestamp 中添加或减去。范围大约为 ±10,000 年。

示例 1：在伪代码中从两个 Timestamp 计算 Duration。

Timestamp start = ...;
Timestamp end = ...;
Duration duration = ...;

duration.seconds = end.seconds - start.seconds;
duration.nanos = end.nanos - start.nanos;

if (duration.seconds < 0 && duration.nanos > 0) {
  duration.seconds += 1;
  duration.nanos -= 1000000000;
} else if (duration.seconds > 0 && duration.nanos < 0) {
  duration.seconds -= 1;
  duration.nanos += 1000000000;
}

示例 2：在伪代码中从 Timestamp + Duration 计算 Timestamp。

Timestamp start = ...;
Duration duration = ...;
Timestamp end = ...;

end.seconds = start.seconds + duration.seconds;
end.nanos = start.nanos + duration.nanos;

if (end.nanos < 0) {
  end.seconds -= 1;
  end.nanos += 1000000000;
} else if (end.nanos >= 1000000000) {
  end.seconds += 1;
  end.nanos -= 1000000000;
}

Duration 的 JSON 表示是一个以 s 结尾的 String，表示秒数，前面是秒数，纳秒表示为小数秒。

Empty

一个通用的空消息，你可以重用它来避免在 API 中定义重复的空消息。一个典型的例子是将其用作 API 方法的请求或响应类型。例如

service Foo {
  rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty);
}

Empty 的 JSON 表示是空的 JSON 对象 {}。

Enum

枚举类型定义

EnumValue

枚举值定义。

Field

消息类型的一个字段。

Cardinality

字段是可选、必需还是重复。

Kind

基本字段类型。

FieldMask

FieldMask 表示一组符号字段路径，例如

paths: "f.a"
paths: "f.b.d"

这里 f 表示某个根消息中的字段，a 和 b 表示在 f 中找到的消息中的字段，d 表示在 f.b 中找到的消息中的字段。

字段掩码用于指定应由获取操作返回（一个 _投影_）或由更新操作修改的字段子集。字段掩码也有自定义的 JSON 编码（见下文）。

投影中的字段掩码

当 FieldMask 指定一个 _投影_ 时，API 将过滤响应消息（或子消息）以仅包含掩码中指定的那些字段。例如，考虑这个“预掩码”响应消息

f {
  a : 22
  b {
    d : 1
    x : 2
  }
  y : 13
}
z: 8

应用上一个示例中的掩码后，API 响应将不包含字段 x、y 或 z 的特定值（它们的值将设置为默认值，并在 proto 文本输出中省略）

f {
  a : 22
  b {
    d : 1
  }
}

除字段掩码的最后一个位置外，不允许重复字段。

如果在获取操作中不存在 FieldMask 对象，则该操作适用于所有字段（如同已指定所有字段的 FieldMask）。

请注意，字段掩码不一定适用于顶级响应消息。在 REST 获取操作的情况下，字段掩码直接应用于响应，但在 REST 列表操作的情况下，掩码应用于返回资源列表中的每个单独消息。在 REST 自定义方法的情况下，可以使用其他定义。掩码的适用位置将与其在 API 中的声明一起明确记录。无论如何，对返回资源/资源的影响是 API 的必需行为。

更新操作中的字段掩码

更新操作中的字段掩码指定目标资源的哪些字段将被更新。API 必须只更改掩码中指定的字段值，而保持其他字段不变。如果传入资源以描述更新值，API 将忽略掩码未覆盖的所有字段的值。

要将字段的值重置为默认值，该字段必须在掩码中，并在提供的资源中设置为默认值。因此，要重置资源的所有字段，请提供资源的默认实例并在掩码中设置所有字段，或者不提供掩码，如下所述。

如果在更新时不存在字段掩码，则操作适用于所有字段（如同已指定所有字段的字段掩码）。请注意，在模式演进的情况下，这可能意味着客户端不知道且因此未填入请求中的字段将被重置为默认值。如果这是不希望的行为，特定服务可能会要求客户端始终指定字段掩码，否则会产生错误。

与获取操作一样，请求消息中描述更新值的资源的位置取决于操作类型。无论如何，API 必须遵守字段掩码的效果。

HTTP REST 的注意事项

使用字段掩码的更新操作的 HTTP 类型必须设置为 PATCH 而不是 PUT，以满足 HTTP 语义（PUT 只能用于完全更新）。

字段掩码的 JSON 编码

在 JSON 中，字段掩码被编码为单个字符串，其中路径以逗号分隔。每个路径中的字段名称都转换为小驼峰命名约定。

例如，考虑以下消息声明

message Profile {
  User user = 1;
  Photo photo = 2;
}
message User {
  string display_name = 1;
  string address = 2;
}

在 proto 中，Profile 的字段掩码可能如下所示

mask {
  paths: "user.display_name"
  paths: "photo"
}

在 JSON 中，相同的掩码表示如下

{
  mask: "user.displayName,photo"
}

FloatValue

float 的包装消息。

FloatValue 的 JSON 表示是 JSON 数字。

Int32Value

int32 的包装消息。

Int32Value 的 JSON 表示是 JSON 数字。

Int64Value

int64 的包装消息。

Int64Value 的 JSON 表示是 JSON 字符串。

ListValue

ListValue 是一个包含重复值字段的包装器。

ListValue 的 JSON 表示是 JSON 数组。

Method

Method 表示一个 API 的方法。

Mixin

声明一个要包含在此 API 中的 API。包含 API 必须重新声明来自包含 API 的所有方法，但文档和选项继承如下

• 如果在去除注释和空白后，重新声明方法的文档字符串为空，它将从原始方法继承。

• 属于服务配置（http、可见性）的每个未在重新声明方法中设置的注解都将继承。

• 如果继承了 http 注解，则路径模式将按如下方式修改。任何版本前缀将替换为包含 API 的版本加上（如果指定）root 路径。

简单 Mixin 示例

package google.acl.v1;
service AccessControl {
  // Get the underlying ACL object.
  rpc GetAcl(GetAclRequest) returns (Acl) {
    option (google.api.http).get = "/v1/{resource=**}:getAcl";
  }
}

package google.storage.v2;
service Storage {
  //       rpc GetAcl(GetAclRequest) returns (Acl);

  // Get a data record.
  rpc GetData(GetDataRequest) returns (Data) {
    option (google.api.http).get = "/v2/{resource=**}";
  }
}

Mixin 配置示例

apis:
- name: google.storage.v2.Storage
  mixins:
  - name: google.acl.v1.AccessControl

mixin 构造意味着 AccessControl 中的所有方法也以相同的名称和请求/响应类型在 Storage 中声明。文档生成器或注解处理器将在继承文档和注解后看到有效的 Storage.GetAcl 方法，如下所示

service Storage {
  // Get the underlying ACL object.
  rpc GetAcl(GetAclRequest) returns (Acl) {
    option (google.api.http).get = "/v2/{resource=**}:getAcl";
  }
  ...
}

注意路径模式中的版本如何从 v1 更改为 v2。

如果 mixin 中的 root 字段已指定且非空，它应为继承的 HTTP 路径的根相对路径。示例

apis:
- name: google.storage.v2.Storage
  mixins:
  - name: google.acl.v1.AccessControl
    root: acls

这暗示了以下继承的 HTTP 注解

service Storage {
  // Get the underlying ACL object.
  rpc GetAcl(GetAclRequest) returns (Acl) {
    option (google.api.http).get = "/v2/acls/{resource=**}:getAcl";
  }
  ...
}

NullValue

NullValue 是一个单例枚举，表示 Value 类型联合的空值。

NullValue 的 JSON 表示是 JSON null。

选项

一个 Protocol Buffer 选项，可以附加到消息、字段、枚举等。

SourceContext

SourceContext 表示关于 Protocol Buffer 元素源的信息，例如它定义在哪个文件中。

StringValue

string 的包装消息。

StringValue 的 JSON 表示是 JSON 字符串。

Struct

Struct 表示一个结构化数据值，由映射到动态类型值的字段组成。在某些语言中，Struct 可能由原生表示支持。例如，在 JS 等脚本语言中，结构体表示为对象。该表示的详细信息与该语言的 proto 支持一起描述。

Struct 的 JSON 表示是 JSON 对象。

语法

定义 Protocol Buffer 元素的语法。

Timestamp

Timestamp 表示一个独立于任何时区或日历的时间点，以 UTC 纪元时间中的秒和纳秒分辨率的秒分数表示。它使用扩展了公历到元年之前的日历（Proleptic Gregorian Calendar）编码。它假设所有分钟都为 60 秒长，即闰秒是“涂抹”的，因此不需要闰秒表进行解释。范围从 0001-01-01T00:00:00Z 到 9999-12-31T23:59:59.999999999Z。通过限制在此范围，我们确保可以与 RFC 3339 日期字符串进行相互转换。请参阅 https://www.ietf.org/rfc/rfc3339.txt。

Timestamp 类型以 RFC 3339 格式编码为字符串：“{year}-{month}-{day}T{hour}:{min}:{sec}[.{frac_sec}]Z”，其中 {year} 始终以四位数表示，而 {month}、{day}、{hour}、{min} 和 {sec} 都用零填充到两位数。小数秒（最多可达 9 位，即纳秒分辨率）是可选的。“Z”后缀表示时区（“UTC”）；时区是必需的。proto3 JSON 序列化器在打印 Timestamp 类型时应始终使用 UTC（如“Z”所示），而 proto3 JSON 解析器应能够接受 UTC 和其他时区（如偏移量所示）。

示例 1：从 POSIX time() 计算 Timestamp。

Timestamp timestamp;
timestamp.set_seconds(time(NULL));
timestamp.set_nanos(0);

示例 2：从 POSIX gettimeofday() 计算 Timestamp。

struct timeval tv;
gettimeofday(&tv, NULL);

Timestamp timestamp;
timestamp.set_seconds(tv.tv_sec);
timestamp.set_nanos(tv.tv_usec * 1000);

示例 3：从 Win32 GetSystemTimeAsFileTime() 计算 Timestamp。

FILETIME ft;
GetSystemTimeAsFileTime(&ft);
UINT64 ticks = (((UINT64)ft.dwHighDateTime) << 32) | ft.dwLowDateTime;

// A Windows tick is 100 nanoseconds. Windows epoch 1601-01-01T00:00:00Z
// is 11644473600 seconds before Unix epoch 1970-01-01T00:00:00Z.
Timestamp timestamp;
timestamp.set_seconds((INT64) ((ticks / 10000000) - 11644473600LL));
timestamp.set_nanos((INT32) ((ticks % 10000000) * 100));

示例 4：从 Java System.currentTimeMillis() 计算 Timestamp。

long millis = System.currentTimeMillis();

Timestamp timestamp = Timestamp.newBuilder().setSeconds(millis / 1000)
    .setNanos((int) ((millis % 1000) * 1000000)).build();

示例 5：在 Python 中从当前时间计算 Timestamp。

now = time.time()
seconds = int(now)
nanos = int((now - seconds) * 10**9)
timestamp = Timestamp(seconds=seconds, nanos=nanos)

Type

一个 Protocol Buffer 消息类型。

UInt32Value

uint32 的包装消息。

UInt32Value 的 JSON 表示是 JSON 数字。

UInt64Value

uint64 的包装消息。

UInt64Value 的 JSON 表示是 JSON 字符串。

Value

Value 表示一个动态类型的值，可以是 null、数字、字符串、布尔值、递归结构体值或值列表。值的生成者应设置其中一种变体，缺少任何变体表示错误。

Value 的 JSON 表示是 JSON 值。