GCP Cloud Endpoints REST与gRPC转换时部分字段丢失问题

问题核心 #

你的Go API返回的Protobuf结构体中，CyclePhase（值为PHASE_1，对应枚举0）和PhaseLocation（值为0.0）在JSON输出中被省略，但日志明确显示这两个字段有值，且当设置为非默认值时能正常显示。

原因 #

这是Protobuf JSON序列化的默认行为：

• 对于枚举类型，第一个定义的枚举值（值为0）是默认值，序列化时会被跳过
• 对于数值类型（如double、int32），0/0.0这类默认值也会被自动忽略

解决方案 #

方案1：全局修改序列化配置 #

使用jsonpb.Marshaler并启用EmitDefaults选项，强制输出所有字段（包括默认值）：

import "github.com/golang/protobuf/jsonpb"

// 在返回响应前进行序列化
marshaler := &jsonpb.Marshaler{
    EmitDefaults: true, // 关键：输出默认值字段
    OrigName:     true, // 可选：使用Protobuf定义的字段名而非驼峰转换
}

jsonResp, err := marshaler.MarshalToString(resp)
if err != nil {
    // 处理错误
}
// 将jsonResp作为响应返回

方案2：在Protobuf定义中单独配置字段 #

如果只需要特定字段输出默认值，可以在Protobuf字段上添加json_emit_default=true选项（需proto3支持）：

message Cycle {
  string id = 1;
  CyclePhase cyclePhase = 2 [json_emit_default=true];
  google.protobuf.Timestamp nextCycleStart = 3;
  int32 periodDuration = 4;
  double phaseLocation = 5 [json_emit_default=true];
}

重新生成Go代码后，这两个字段的默认值就会被包含在JSON输出中。

验证 #

你的测试结果正好印证了这个规则：

• 当phaseLocation为非0值、cyclePhase设为PHASE_2（非0枚举值）时，不属于默认值范畴，因此能正常出现在JSON中

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