Python weakref.WeakKeyDictionary在缓存键对象回收时的行为

1. WeakKeyDictionary基本概念

创建 weakref.WeakKeyDictionary 是Python标准库中提供的一种特殊字典，它使用弱引用来存储键。与普通字典不同，当键对象没有被其他引用指向时，它可以被垃圾回收机制自动移除，从而避免内存泄漏。

导入 要使用 WeakKeyDictionary，执行 import weakref 来导入weakref模块。

2. 弱引用字典与普通字典的区别

普通字典保持对键的强引用，即使键在其他地方已经没有引用，字典中的引用也会阻止对象被垃圾回收。而 WeakKeyDictionary 使用弱引用来存储键，当键对象在其他地方没有强引用时，它可以被垃圾回收。

对比 两种字典的行为差异：

3. 键对象被回收时的行为

理解 当 WeakKeyDictionary 中的键对象被垃圾回收后，字典会自动移除对应的键值对。这个过程对使用者是透明的，不需要手动干预。

查看 当尝试访问已被回收的键时，会触发 KeyError 异常，与普通字典的行为一致。

检查 使用 key in weak_dict 可以检查键是否仍然存在于字典中。

4. 应用场景

设计 缓存系统时使用 WeakKeyDictionary 可以自动回收不再使用的缓存项，避免内存无限增长。

实现 观察者模式时，观察者列表可以使用 WeakKeyDictionary 存储，当观察者对象不再需要时自动从列表中移除。

5. 实际代码示例

import weakref
import gc

class DataObject:
    def __init__(self, name):
        self.name = name

    def __repr__(self):
        return f"DataObject({self.name})"

# 创建普通字典和弱引用字典
normal_dict = {}
weak_dict = weakref.WeakKeyDictionary()

# 创建对象并添加到两个字典中
obj1 = DataObject("Object1")
obj2 = DataObject("Object2")

normal_dict[obj1] = "Value1"
normal_dict[obj2] = "Value2"

weak_dict[obj1] = "WeakValue1"
weak_dict[obj2] = "WeakValue2"

# 删除对象的强引用
del obj1
del obj2

# 强制垃圾回收
gc.collect()

# 检查字典内容
print("普通字典大小:", len(normal_dict))  # 输出: 2
print("弱引用字典大小:", len(weak_dict))  # 输出: 0

运行 上述代码会显示普通字典仍保留两个键值对，而弱引用字典已清空所有键值对。

6. 高级用法与注意事项

监控 使用 weakref.finalize 可以为键对象注册一个回调函数，在对象被回收时执行额外操作。

def callback(ref):
    print(f"对象 {ref.key} 被回收了")

obj = DataObject("Temporary")
ref = weakref.finalize(obj, callback, weakref.ref(obj))

注意 WeakKeyDictionary 的键必须是可哈希的对象，并且支持弱引用。基本类型如 int、str、tuple 等默认不支持弱引用，需要包装在自定义类中。

限制 弱引用字典不能直接使用不可哈希对象作为键，也不能使用不支持弱引用的对象。

处理 当需要使用不可哈希对象作为键时，可以创建一个包装类并实现 __hash__ 和 __eq__ 方法：

class HashableWrapper:
    def __init__(self, obj):
        self.obj = obj

    def __hash__(self):
        return hash(id(self.obj))

    def __eq__(self, other):
        return isinstance(other, HashableWrapper) and id(self.obj) == id(other.obj)

# 使用示例
original_list = [1, 2, 3]
wrapped = HashableWrapper(original_list)
weak_dict = weakref.WeakKeyDictionary()
weak_dict[wrapped] "值"

优化 在缓存系统中，可以结合 WeakKeyDictionary 和 WeakValueDictionary 创建双向弱引用缓存，既能基于键查找，也能基于值查找，同时两者都不会阻止对象被回收。