Protobuf Field Mask是否可以应用于仅grpc的情况?

时间:2018-12-27 16:54:29

标签: rest go grpc grpc-gateway

让我们以来自官方doc的示例为例:

// Updates a book.
rpc UpdateBook(UpdateBookRequest) returns (Book) {
  // Update maps to HTTP PATCH. Resource name is mapped to a URL path.
  // Resource is contained in the HTTP request body.
  option (google.api.http) = {
    // Note the URL template variable which captures the resource name of the
    // book to update.
    patch: "/v1/{book.name=shelves/*/books/*}"
    body: "book"
  };
}

message UpdateBookRequest {
  // The book resource which replaces the resource on the server.
  Book book = 1;

  // The update mask applies to the resource. For the `FieldMask` definition,
  // see https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#fieldmask
  FieldMask update_mask = 2;
}

如果我没有grpc网关,而仅使用grpc,我可以通过这种方式使用mask:

// Updates a book.
rpc UpdateBook(UpdateBookRequest) returns (Book);

message UpdateBookRequest {
  // The book resource which replaces the resource on the server.
  Book book = 1;

  // The update mask applies to the resource. For the `FieldMask` definition,
  // see https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#fieldmask
  FieldMask update_mask = 2;
}

如果是,该掩码应如何工作-过滤器请求?或在数据库保存期间应用,以及如何知道数据库... 所以我对使用它有些困惑。在我自己的grpc示例中,我看到该掩码未过滤该请求。

1 个答案:

答案 0 :(得分:0)

根据protobuf docs

  

更新操作中的字段掩码
更新操作中的字段掩码指定要更新目标资源的哪些字段。该API仅需更改掩码中指定的字段的值,而其他字段保持不变。如果传入资源来描述更新的值,则API将忽略掩码未涵盖的所有字段的值。

应用字段掩码时,它指定gRPC请求中要更新的特定字段。请记住,如果您在HTTP请求中使用它(根据我的了解,您正在执行的操作),那么它必须是PATCH请求而不是PUT请求。

例如,假设您有一个名为Books的声明,具有以下属性:title作为字符串,year_published作为int32,author作为作者。声明Author的字段first_name作为字符串,last_name作为字符串。如果要使用author.first_name的域掩码,则只能更新first_nameauthor的{​​{1}}域。

请注意,这是基于protobufs文档的,我可能会完全误解,所以请带一点盐。