.NET 6中GRPC服务布尔类型字段在Postman中显示异常问题

问题场景 #

在.NET 6的gRPC服务中定义布尔类型字段时，出现Postman显示异常的情况：

• 使用proto原生bool类型时，Postman完全不显示该属性
• 使用google.protobuf.BoolValue类型时，C#中对应值为false时，Postman显示"is_valid": {}；值为true时显示正常

相关代码示例 #

Proto文件片段

syntax = "proto3";

option csharp_namespace = "xxx.Organization.V1.Contracts";

import "google/protobuf/wrappers.proto";
import "protos/txp/common/api/query/range.proto";
import "protos/txp/common/filters/string_filter.proto";
import "protos/txp/organization/v1/timezone.proto";

package txp.organization.v1;

message AddressValidationResponse {
    Address address = 1;
    google.protobuf.BoolValue is_valid = 2;
    google.protobuf.BoolValue is_non_postal = 3;
    repeated google.protobuf.StringValue errors = 4;
    google.protobuf.StringValue success_message = 5;
    google.protobuf.StringValue address_precision = 6;
    Results results = 7;
}

自动生成的C#代码片段

/// <summary>Field number for the "is_valid" field.</summary>
public const int IsValidFieldNumber = 2;
private static readonly pb::FieldCodec<bool?> _single_isValid_codec = pb::FieldCodec.ForStructWrapper<bool>(18);
private bool? isValid_;
[global::System.Diagnostics.DebuggerNonUserCodeAttribute]
[global::System.CodeDom.Compiler.GeneratedCode("protoc", null)]
public bool? IsValid {
  get { return isValid_; }
  set {
    isValid_ = value;
  }
}

Postman响应截图

异常原因解析 #

1. 原生bool类型不显示的原因 #

Proto3的默认规则是不序列化字段的默认值，原生bool的默认值为false。当字段值等于默认值时，gRPC使用的Google.Protobuf.JsonFormatter序列化器不会将该字段纳入输出结果，因此Postman中完全看不到这个属性。

2. BoolValue类型显示{}的原因 #

google.protobuf.BoolValue是Proto提供的包装类型，对应C#中的bool?（可空布尔类型）。直接给C#的bool?赋值false时，并没有按照Proto包装类型的规范初始化完整的BoolValue实例结构——序列化器只会识别包装类型中显式设置的Value字段，若未通过BoolValue.FromBoolean()方法创建实例，序列化后就会输出空对象{}。

正确的使用方式是显式创建BoolValue实例：

response.IsValid = Google.Protobuf.WellKnownTypes.BoolValue.FromBoolean(false);

这样Postman就能正常显示"is_valid": false。

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