利用 WeakSet 解决 观察者 模式中的内存泄漏问题
大家好，今天我们来聊聊观察者模式，以及如何在 Python 中使用 WeakSet 来解决观察者模式中常见的内存泄漏问题。
观察者模式简介
观察者模式是一种行为型设计模式，它定义了一种一对多的依赖关系，让多个观察者对象同时监听某一个主题对象。当主题对象的状态发生改变时，所有依赖它的观察者对象都会收到通知并自动更新。
简单来说，就是有一个主题 (Subject) 维护着一个观察者 (Observer) 列表，主题的状态改变会通知所有观察者。
主要角色：
- 主题 (Subject): 维护观察者列表，提供添加、删除观察者的方法，并在状态改变时通知观察者。
- 观察者 (Observer): 定义一个更新接口，当接收到主题的通知时，执行更新操作。
- 具体主题 (ConcreteSubject): 主题的具体实现，维护自身状态，并在状态改变时通知观察者。
- 具体观察者 (ConcreteObserver): 观察者的具体实现，实现更新接口，响应主题的通知。
优点：
- 解耦: 主题和观察者之间是松耦合的，主题不需要知道观察者的具体实现。
- 扩展性: 可以方便地添加新的观察者，而无需修改主题的代码。
- 灵活性: 可以动态地添加和删除观察者。
缺点：
- 级联更新: 如果观察者过多，或者更新操作比较耗时，可能会导致性能问题。
- 意外更新: 观察者可能会在不期望的情况下被更新。
- 内存泄漏: 如果主题持有观察者的强引用，而观察者不再需要被通知时，可能会导致内存泄漏。
观察者模式的典型实现
下面是一个简单的观察者模式的 Python 实现：
class Subject:
def __init__(self):
self._observers = []
def attach(self, observer):
self._observers.append(observer)
def detach(self, observer):
self._observers.remove(observer)
def notify(self):
for observer in self._observers:
observer.update(self)
class Observer:
def update(self, subject):
pass
class ConcreteSubject(Subject):
def __init__(self):
super().__init__()
self._state = None
@property
def state(self):
return self._state
@state.setter
def state(self, value):
self._state = value
self.notify()
class ConcreteObserver(Observer):
def __init__(self, name):
self._name = name
def update(self, subject):
print(f"{self._name} 收到通知，状态更新为: {subject.state}")
# 示例
subject = ConcreteSubject()
observer1 = ConcreteObserver("观察者1")
observer2 = ConcreteObserver("观察者2")
subject.attach(observer1)
subject.attach(observer2)
subject.state = "新状态"
subject.detach(observer1)
subject.state = "另一个新状态"在这个例子中，Subject 类维护了一个 _observers 列表，用于存储观察者对象。attach 方法用于添加观察者，detach 方法用于删除观察者，notify 方法用于通知所有观察者。ConcreteSubject 是一个具体的主题，它维护着自身的状态，并在状态改变时调用 notify 方法。ConcreteObserver 是一个具体的观察者，它实现了 update 方法，用于响应主题的通知。
内存泄漏问题
上面的实现存在一个潜在的内存泄漏问题。如果观察者对象被销毁，但是主题仍然持有对它的引用，那么这个观察者对象就无法被垃圾回收，从而导致内存泄漏。
考虑以下情况：
import gc
class Subject:
def __init__(self):
self._observers = []
def attach(self, observer):
self._observers.append(observer)
def detach(self, observer):
self._observers.remove(observer)
def notify(self):
for observer in self._observers:
observer.update(self)
class Observer:
def update(self, subject):
pass
class ConcreteSubject(Subject):
def __init__(self):
super().__init__()
self._state = None
@property
def state(self):
return self._state
@state.setter
def state(self, value):
self._state = value
self.notify()
class ConcreteObserver(Observer):
def __init__(self, name):
self._name = name
def update(self, subject):
print(f"{self._name} 收到通知，状态更新为: {subject.state}")
# 示例
subject = ConcreteSubject()
def create_observer():
observer = ConcreteObserver("临时观察者")
subject.attach(observer)
print("临时观察者已创建并附加到主题")
return observer
observer1 = create_observer() #创建一个局部变量observer1指向临时观察者
subject.state = "状态改变"
del observer1 #删除局部变量observer1
gc.collect() # 手动触发垃圾回收
print("垃圾回收完成")
print(subject._observers)
subject.state = "再次改变状态" # 观察者仍然收到通知，说明对象没有被回收
在这个例子中，我们在 create_observer 函数中创建了一个 ConcreteObserver 对象，并将其附加到主题。 虽然 observer1 这个局部变量被删除掉了，但是由于主题仍然持有对该对象的引用，所以这个对象仍然存活，并没有被垃圾回收。这意味着如果 create_observer 函数被频繁调用，就会创建大量的临时观察者对象，导致内存泄漏。
使用 WeakSet 解决内存泄漏
WeakSet 是 Python 中 weakref 模块提供的一个类，它可以用来存储对象的弱引用。当一个对象只被 WeakSet 引用时，如果该对象不再被其他对象引用，那么它就可以被垃圾回收，并且 WeakSet 会自动移除对该对象的引用。
我们可以使用 WeakSet 来存储观察者对象，从而避免内存泄漏。修改后的代码如下：
import weakref
import gc
class Subject:
def __init__(self):
self._observers = weakref.WeakSet()
def attach(self, observer):
self._observers.add(observer)
def detach(self, observer):
self._observers.remove(observer)
def notify(self):
for observer in self._observers:
observer.update(self)
class Observer:
def update(self, subject):
pass
class ConcreteSubject(Subject):
def __init__(self):
super().__init__()
self._state = None
@property
def state(self):
return self._state
@state.setter
def state(self, value):
self._state = value
self.notify()
class ConcreteObserver(Observer):
def __init__(self, name):
self._name = name
def update(self, subject):
print(f"{self._name} 收到通知，状态更新为: {subject.state}")
# 示例
subject = ConcreteSubject()
def create_observer():
observer = ConcreteObserver("临时观察者")
subject.attach(observer)
print("临时观察者已创建并附加到主题")
return observer
observer1 = create_observer() #创建一个局部变量observer1指向临时观察者
subject.state = "状态改变"
del observer1 #删除局部变量observer1
gc.collect() # 手动触发垃圾回收
print("垃圾回收完成")
print(subject._observers)
subject.state = "再次改变状态" # 观察者已经被回收，不会收到通知
在这个修改后的例子中，我们将 Subject 类的 _observers 属性改为 weakref.WeakSet()。现在，当 observer1 变量被删除后，由于主题只持有对该对象的弱引用，所以该对象可以被垃圾回收，并且 WeakSet 会自动移除对该对象的引用。这样就避免了内存泄漏。
WeakSet 的工作原理
WeakSet 内部维护着一个弱引用集合。当向 WeakSet 中添加一个对象时，它实际上是创建了一个对该对象的弱引用，并将其添加到集合中。弱引用不会阻止垃圾回收器回收该对象。当垃圾回收器回收该对象时，与该对象关联的弱引用会被自动移除，WeakSet 也会自动更新。
弱引用 (Weak Reference)
弱引用是一种特殊的引用，它不会增加对象的引用计数。当一个对象只被弱引用引用时，它仍然可以被垃圾回收。Python 中的 weakref 模块提供了创建和使用弱引用的功能。
可以使用 weakref.ref(object) 创建一个对象的弱引用。可以通过调用弱引用对象来获取被引用的对象。如果被引用的对象已经被垃圾回收，那么调用弱引用对象会返回 None。
import weakref
class MyObject:
pass
obj = MyObject()
weak_ref = weakref.ref(obj)
print(weak_ref()) # 输出: <__main__.MyObject object at 0x...>
del obj
import gc
gc.collect()
print(weak_ref()) # 输出: NoneWeakSet 的适用场景
WeakSet 适用于以下场景：
- 缓存: 可以使用
WeakSet来缓存对象，当对象不再被其他对象引用时，可以自动从缓存中移除。 - 事件监听器: 可以使用
WeakSet来存储事件监听器，当监听器对象被销毁时，可以自动从监听器列表中移除。 - 对象关系管理: 可以使用
WeakSet来维护对象之间的关系，当对象被销毁时，可以自动更新关系。
总的来说，WeakSet 适用于需要维护对象集合，并且不希望阻止对象被垃圾回收的场景。
其他解决方案
除了使用 WeakSet，还有其他一些方法可以解决观察者模式中的内存泄漏问题：
- 手动管理: 在观察者对象被销毁时，手动从主题中移除观察者。这种方法需要小心地管理对象的生命周期，容易出错。
- 使用 ID: 主题不直接持有观察者对象的引用，而是持有观察者对象的 ID。当需要通知观察者时，通过 ID 查找观察者对象。这种方法需要维护一个 ID 到对象的映射，并且需要处理对象不存在的情况。
- 使用回调函数: 观察者不直接注册到主题，而是注册一个回调函数。当主题状态改变时，调用回调函数。这种方法可以避免主题持有观察者对象的引用，但是会增加代码的复杂性。
| 方案 | 优点 | 缺点 | 适用场景 |
| ——– | ——————————————————————— | ——————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————– stolen 的解决方案。
In []:
好的，这几种方法各有利弊。在简单的场景下，手动管理可能足够，但在复杂的系统中，WeakSet 通常是更好的选择，因为它能更优雅地处理对象的生命周期，减少人为错误的可能性。 使用 ID 的方法引入了额外的间接层，可能影响性能。 回调函数虽然避免了强引用，但当回调函数本身需要访问观察者对象的成员时，仍然需要某种方式来保持对象的存活，这又回到了内存管理的问题。
总结要点
- 观察者模式是一种强大的解耦工具，但也需要注意内存管理。
WeakSet提供了一种优雅的方式来解决观察者模式中的内存泄漏问题。- 了解
WeakSet的工作原理，可以更好地利用它来编写安全可靠的代码。