如何屏蔽 Protobuf 中的某些字段

Question

我找不到屏蔽 protobuf 结构中某些字段的方法。我确实阅读了 FieldMaskUtil 并尝试了几个示例，但它似乎做了相反的事情，即复制 FieldMask 中提到的字段，这与我想要的不同。这是示例结构和相应的测试代码。

原型：

syntax = "proto3";

package model;

option java_package = "test.demo.services.protobuf.customer.model";
option java_outer_classname = "CustomerProto";

message Accounts {
  repeated Account account = 1;
}

message Account {

  int32 id = 1;
  string number = 2;
  int32 customer_id = 3;

}

 message Customers {
   repeated Customer customers = 1;
}

message Customer {

  int32 id = 1;
  string pesel = 2;
  string name = 3;
  CustomerType type = 4;
  repeated Account accounts = 5;

  enum CustomerType {
    INDIVIDUAL = 0;
    COMPANY = 1;
  }

}

这是示例测试代码

package test.demo.services.protobuf.customer.model;

import org.junit.Test;
import test.demo.services.protobuf.customer.model.CustomerProto.Customer;
import com.google.protobuf.util.FieldMaskUtil;


public class TestMerge {


  @Test
  public void eraseFields() {

        Customer request = Customer.newBuilder().setId(10).setPesel("12345").setName("Harry Alto").build();
    // Erase name
      Customer.Builder modifieldRequest = Customer.newBuilder();
      FieldMaskUtil.merge(FieldMaskUtil.fromString("name"), request, modifieldRequest);
      System.out.println( modifieldRequest.build().toString());
}

}

这是输出：

name: "Harry Alto"

我所期望的是打印除名称以外的所有内容

id: 10
pesel: "12345"

有没有办法做我想做的事

Answer 1

FieldMaskUtil.merge(FieldMaskUtil.fromString("name"), request, modifieldRequest);

What i would have expected is to print everything other than name

不，根据 FieldMask 的 JavaDocs，行为与您描述的相反：

Field masks are used to specify a subset of fields that should be returned by a get operation or modified by an update operation.

掩码充当集合交集操作，仅选择指定的字段。在您的情况下，掩码仅指定 "name"，因此这就是它选择的内容。

您正在寻找的行为实际上是一个集合补码操作，选择所有未指定的字段。我不知道 Protobuf API 中的内置方法可以执行此操作。自己实施的选项是：

使用单独调用 FieldMask#fromString 为每个要保留的命名字段构建多个 FieldMask 实例。然后，使用 FieldMaskUtil#union 将它们全部组合起来。这将仅保留特别列出的字段。如果您稍后改进模式以添加更多字段，那么它不会选择这些新字段。您必须更改代码并将新的命名字段添加到该联合中。
调用MessageOrBuilder#getAllFields 获取消息中所有字段的描述符。如上所述使用 FieldMaskUtil#union 遍历所有这些字段，但跳过您想要忽略的特定字段，例如 "name"。如果您稍后改进架构以添加更多字段，那么这将选择这些新字段。您无需更改代码即可开始包含这些新字段。

请注意这些解决方案中模式演变的差异。选择哪个最合适取决于您的要求。

Answer 2

如果您真的想删除名称字段，您可以这样做：

Customer.Builder request Customer.newBuilder()
    .setId(10).setPesel("12345").setName("Harry Alto").build();
// Erase name
Customer.Builder modifiedRequest = request.toBuilder();
Customer modifyRequest = Customer.getDefaultInstance();
FieldMaskUtil.merge(FieldMaskUtil.fromString("name"), modifyRequest, modifiedRequest);
System.out.println(modifiedRequest.build().toString());

这应该会产生您想要的结果。

如何屏蔽 Protobuf 中的某些字段

How to Mask certain fields in Protobuf

java

protocol-buffers

protocol-buffers-3