Go weak 指针如何实现不阻止回收的对象索引

Go 1.24 新增的 weak 包，让索引可以保存 weak.Pointer[T]，而不必用 *T 把对象一直留在可达集合里。最小做法是写入时调用 weak.Make(obj)，读取时调用 Value()；对象仍存活就得到临时强指针，已经被回收就得到 nil。官方说明见 https://pkg.go.dev/weak。

变化一句话：索引可以引用对象但不拥有对象

weak.Pointer[T] 是指向 T 的弱指针。只被弱指针引用的对象不算可达，因此索引不会为了“以后可能查到”而延长对象生命周期。weak.Make 接收 *T，Value 返回创建弱指针时使用的原指针；若目标已经被垃圾回收，则返回 nil。

Go 1.24 的发布说明把弱指针定位为低层原语，典型用途包括弱映射、规范化映射和缓存。它不是自动缓存框架，也不承诺对象不可达后 Value() 一定在某个期限内变成 nil。对于极小且不含指针的对象，运行时还可能合并分配槽，弱指针甚至可能长期不变为 nil。

为什么改：普通对象索引本身就是强所有者

旧实现常把对象指针直接放进 map。即使会话、任务或连接等真正所有者已经释放对象，只要索引还保留 *Object，GC 就仍能从 map 追踪到对象，结果是“索引忘记删除一次，对象就常驻”。

type Object struct {
	ID      string
	Payload []byte
}

// 普通 map 保存 *Object，会让索引成为额外的强所有者。
var strongIndex = map[string]*Object{}

func putStrong(obj *Object) {
	// 只要该键未删除，obj 及其 Payload 都会保持可达。
	strongIndex[obj.ID] = obj
}

weak 版本改变的是所有权，不是查询接口的外形：业务层仍用 ID 查找，但索引不再保证对象一定存在。真正的强所有者应是请求、会话、连接池槽位或其他明确生命周期组件。

对旧代码的影响：命中现在是一项可失效的能力

此外，weak.Pointer 的零值等价于对 nil 调用 weak.Make，其 Value() 始终返回 nil。同一原始指针创建的弱指针可以比较相等，即使对象后来被回收，该相等关系仍保持；但对象复活、字段偏移等细节不适合作为一般业务标识。

迁移建议：封装 weak.Make、Value 和惰性删除

下面的索引用一个互斥锁保护 map。Get 在锁内读取弱指针并调用 Value，避免查询失效时误删刚被并发写入的新值。返回的 *Object 是临时强引用，调用方持有它期间对象保持可达。

package objectindex

import (
	"sync"
	"weak"
)

type Object struct {
	ID      string
	Payload []byte
}

type Index struct {
	mu   sync.Mutex
	refs map[string]weak.Pointer[Object]
}

func NewIndex() *Index {
	// map 只保存弱指针，不承担对象所有权。
	return &Index{refs: make(map[string]weak.Pointer[Object])}
}

func (i *Index) Put(obj *Object) {
	// nil 不进入索引，避免制造永远失效的条目。
	if obj == nil {
		return
	}
	i.mu.Lock()
	defer i.mu.Unlock()
	// weak.Make 建立查询关系，但不会让 obj 因索引而保持可达。
	i.refs[obj.ID] = weak.Make(obj)
}

func (i *Index) Get(id string) (*Object, bool) {
	i.mu.Lock()
	defer i.mu.Unlock()

	ref, ok := i.refs[id]
	if !ok {
		return nil, false
	}
	obj := ref.Value()
	if obj == nil {
		// 目标已回收时惰性删除键，避免失效条目无限积累。
		delete(i.refs, id)
		return nil, false
	}
	// 返回值从此处起是调用方持有的强引用。
	return obj, true
}

func (i *Index) Sweep() int {
	i.mu.Lock()
	defer i.mu.Unlock()

	removed := 0
	for id, ref := range i.refs {
		// Sweep 只整理已失效条目，不推断对象应在何时被回收。
		if ref.Value() == nil {
			delete(i.refs, id)
			removed++
		}
	}
	return removed
}

如果读流量很高，可以在确认语义后再换成分片锁或“读锁读取、写锁二次确认删除”的结构。第一版先保证并发正确性，通常比为了减少锁范围而引入覆盖新值的竞态更重要。

最小验证：只验证强所有者存在时稳定命中

可靠的单元测试应验证确定语义：只要强所有者仍可达，Get 就能返回同一个对象。为了防止编译器在最后一次源码使用后提前判定对象不可达，可在必须保持存活的区间末尾调用 runtime.KeepAlive。

func TestIndexReturnsLiveObject(t *testing.T) {
	idx := NewIndex()
	obj := &Object{ID: "order-42", Payload: []byte("ready")}
	idx.Put(obj)

	got, ok := idx.Get("order-42")
	// 强所有者 obj 仍然存活，因此查询必须命中同一对象。
	if !ok || got != obj {
		t.Fatalf("want live object, got ok=%v value=%p", ok, got)
	}

	// 明确要求 obj 至少存活到本测试检查完成。
	runtime.KeepAlive(obj)
}

不要再写一个“把 obj=nil、调用一次 runtime.GC()、然后断言 Value()==nil”的硬性测试。官方文档明确说明 Value 不保证最终一定返回 nil；GC 调度、分配方式和微小对象合并都可能让这种测试偶发失败。若业务必须在确定时刻删除索引项，应由显式 Delete、租约、TTL 或所有者关闭流程完成，而不是监听 GC。

上线前检查

• 构建环境至少为 Go 1.24，并在 go.mod 中声明匹配版本。
• 确认业务层仍有明确强所有者，不能只把对象放入 weak 索引后就期望它稳定存在。
• 所有 Value() 调用都处理 nil，并将其解释为可重建或可忽略的索引未命中。
• 为失效键设计惰性删除、周期 Sweep 或显式删除，避免 map 的字符串键本身不断累积。
• 不要把对象回收、cleanup 或 finalizer 的执行时刻当作可靠业务信号。

常见问题

weak.Pointer 能替代所有缓存吗？

不能。它只改变引用对 GC 可达性的影响，没有容量上限、命中率策略、TTL、加载合并或持久化能力。需要稳定命中和资源预算时，仍应使用普通缓存策略。

为什么 Get 返回指针后对象不会立刻消失？

Value() 返回的 *Object 是正常强指针。只要调用方仍持有并使用它，对象就在该使用区间内保持可达；弱的是索引中的引用，不是取出后的返回值。

可以用 runtime.AddCleanup 自动删键吗？

可以把它作为辅助整理机制，但 cleanup 不保证在程序退出前运行，也可能延迟很久。回调和参数还不能反向强引用目标对象，否则对象永远不可达不到。多数索引先采用 Get 惰性删除和低频 Sweep 更容易推断。