如何在BigQuery Storage Write API(C# .NET6)中强制序列化默认值

你使用C# .NET6的BigQuery Storage Write API时，遇到Protobuf默认不序列化/发送默认值（如int64类型的0），导致BigQuery对应字段显示null的问题，以下是两种直接有效的解决方法：

方案一：修改Proto文件，强制字段发送默认值 #

Protobuf 3从3.12版本开始支持proto3_optional选项，给目标字段添加该标记后，即使值为类型默认值也会被序列化发送。修改后的Proto代码如下：

syntax = "proto3";

message SomeModel  {
    int64 id = 1;
    optional int64 quantity = 2 [proto3_optional = true];
}

重新生成C#代码后，设置Quantity = 0时，该值会被正常序列化并发送至BigQuery，最终表中会存储0而非null。

方案二：在C#序列化阶段强制包含默认值 #

如果不想修改Proto定义，可以在调用序列化方法时传入WriteOptions，指定包含默认值：

var records = new List<SomeModel>();
records.Add(new SomeModel{Id = 1, Quantity = 0});

// 定义序列化选项：包含默认值
var writeOptions = new WriteOptions { IncludeDefaultValues = true };

var protoData = new AppendRowsRequest.Types.ProtoData
{
    WriterSchema = new ProtoSchema { ProtoDescriptor = SomeModel.Descriptor.ToProto() },
    Rows = new ProtoRows 
            { 
                SerializedRows = { records.Select(r => r.ToByteString(writeOptions)) } 
            }
};

这种方式无需修改Proto文件，仅在当前序列化流程中生效，适合需要灵活控制的场景。

注意事项 #

确保BigQuery表中quantity字段的类型与Proto字段匹配（如INT64），只要Protobuf发送了0值，BigQuery就会存储0，不会显示null。

内容的提问来源于stack exchange，提问作者satellite satellite