如何安全地回收 golang 中的 protobuf 对象

Question

我想回收protobuf的message对象，减少运行时的GC消耗，但是不知道是不是safe.The测试示例代码如下：

test.proto

message Hello{
  uint32  id   = 1;
}

test.pb.go

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

    ID  uint32 `protobuf:"varint,1,opt,name=id,proto3" json:"id,omitempty"`
}

func (x *Hello) Reset() {
    *x = Hello{}
    if protoimpl.UnsafeEnabled {
        mi := &file_proto_login_api_login_proto_msgTypes[0]
        ms := protoimpl.X.MessageStateOf(protoimpl.Pointer(x))
        ms.StoreMessageInfo(mi)
    }
}
// other codes

main.go

func main() {
    // Disable GC to test re-acquire the same data
    gc := debug.SetGCPercent(-1)

    // As a protobuf object pool
    cache := sync.Pool{New: func() interface{} { return &test.Hello{} }}
    
    // Take out an object and use it
    m1 := cache.Get().(*test.Hello)
    m1.ID = 999
    fmt.Println(&m1.ID) // print 999

    // Empty the data and put it back into the object pool
    m1.Reset()
    cache.Put(m1)

    // Take out an object again and use it
    m2 := cache.Get().(*test.Hello)
    fmt.Println(&m2.ID) // print 0

    debug.SetGCPercent(gc)
}

Answer 1

您显示的代码是安全的。当对对象的引用在对象被放入池中后被保留时，像这样的池化变得“不安全”。您冒着竞争条件或奇怪错误的风险。所以它也取决于使用你的对象的代码。

据我所知，protocol buffers 库和 gRPC 库不会保留对 protobuf 对象的引用。这样做会破坏很多代码，因为此类库无法知道何时可以安全地重用。

所以只要确保自己的代码在对象放入池中后不使用对象就可以了。

如何安全地回收 golang 中的 protobuf 对象

How to safely recycle protobuf objects in golang

go

protocol-buffers