如何让gRPC消息可JSON序列化 解决Python端字段丢失问题

你遇到的字段丢失问题是Protobuf官方JSON转换工具的默认行为导致的：默认会省略所有取值等于类型默认值的字段（bool默认false、数值默认0、字符串默认空、repeated字段默认空列表），未显式传值的字段就会被过滤掉。

gRPC请求的Protobuf消息转Python内置类型对象，最规范可靠的方案是直接使用Protobuf官方提供的转换工具，无需自行遍历属性：

方案1：转Python字典（全内置类型，可直接JSON序列化） #

使用MessageToDict方法可以直接把Protobuf消息对象转为全由Python基础类型组成的字典，repeated标量字段会自动转为列表，无需单独处理RepeatedScalarContainer类型：

from google.protobuf.json_format import MessageToDict

def handle_request(request):
    req_dict = MessageToDict(
        request,
        including_default_value_fields=True,  # 必加：保留值为默认值的字段，解决字段丢失问题
        preserving_proto_field_name=True,     # 可选：保留proto文件中定义的原始字段名，不会自动转为驼峰格式
        use_integers_for_enums=True           # 可选：如果存在枚举类型字段，转成整数取值而非枚举名字符串
    )
    # 此时req_dict可直接传入json.dumps序列化，无类型问题

方案2：直接转JSON字符串 #

如果你的使用场景只需要JSON字符串，不需要Python字典操作，可以给MessageToJson加上同样的参数解决字段丢失问题：

from google.protobuf.json_format import MessageToJson

serialized_json = MessageToJson(
    request,
    including_default_value_fields=True,
    preserving_proto_field_name=True
)

官方转换工具基于Protobuf的描述符实现，完全匹配proto定义，不会出现自行遍历属性可能拿到无关内置字段、版本兼容差的问题，稳定性和可靠性远高于自定义遍历方案。

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