如何在 Golang 中使用 `omitempty` 和 protobuf Timestamp

Question

我的结构中有一个名为 ExpireTime 的可选字段。它有一个 time.Time 类型和一个 json:"expire_time,omitempty" 标签，当它为空时不发送它。这部分工作得很好。

当我想通过 GRPC 使用相同的字段时，我运行在将其转换为 protobuf timestamp format 时遇到了问题。

type Timestamp struct {

    // Represents seconds of UTC time since Unix epoch
    // 1970-01-01T00:00:00Z. Must be from 0001-01-01T00:00:00Z to
    // 9999-12-31T23:59:59Z inclusive.
    Seconds int64 `protobuf:"varint,1,opt,name=seconds,proto3" json:"seconds,omitempty"`
    // Non-negative fractions of a second at nanosecond resolution. Negative
    // second values with fractions must still have non-negative nanos values
    // that count forward in time. Must be from 0 to 999,999,999
    // inclusive.
    Nanos int32 `protobuf:"varint,2,opt,name=nanos,proto3" json:"nanos,omitempty"`
    // contains filtered or unexported fields
}

ExpireTime *timestamppb.Timestamp `protobuf:"bytes,1,opt,name=expire_time,json=expireTime,proto3" json:"expire_time,omitempty"`

问题是空 time.Time{} 对象将被转换为对应于 0001-01-01T00:00:00Z 的负 seconds 值。在这种情况下将不会应用 omitEmpty 标志，因为该值未被清零。当它实际上是空的时，我该怎么做才能省略这个字段？谢谢！

Answer 1

Protobuf 总是包含网络上的字段；没有（不再）可选字段设置。

您的代码需要使用默认值作为 non-value 的信号。

Answer 2

如你所说 time.Time{} 转换为 0001-01-01T00:00:00Z；这个 is working as intended. Note that you also need to be careful converting in the opposite direction（零 TimeStamp 将变成 1970-01-01T00:00:00Z）。

但是通常 Timestamp 将是消息的一部分，例如：

message MyMessage{
   google.protobuf.Timestamp  comm_time = 1;
}

运行这到 protoc 将导致如下结果：

type MyMessage struct {
    state         protoimpl.MessageState
    sizeCache     protoimpl.SizeCache
    unknownFields protoimpl.UnknownFields

    CommTime *timestamppb.Timestamp `protobuf:"bytes, 1,opt,name=comm_time,json=commTime,proto3" json:"comm_time,omitempty"`
}

这意味着您应该能够通过 CommTime=nil 获得您想要的结果；例如

sourceTime := time.Time{}  // Whatever time you want to encode
var commTime *timestamp.Timestamp
if !sourceTime.IsZero() {
        commTime = timestamppb.New(sourceTime)
}

msg := MyMessage{
   CommTime: commTime,
}

如何在 Golang 中使用 `omitempty` 和 protobuf Timestamp

How to use `omitempty` with protobuf Timestamp in Golang

go

protocol-buffers

marshalling

proto