一、什么是 Signal?
在分布式系统或大型应用中,事件驱动 和解耦通信 非常重要。Celery 的 Signal
类正是实现这一目标的工具,它采用了经典的观察者模式,允许你在系统的关键节点(如任务执行前后、worker 启动关闭等)注册和触发自定义回调函数。
简单来说,Signal 就是一个"事件广播器",你可以注册多个监听器(回调),当事件发生时,Signal 会通知所有监听器。
二、Signal 的核心原理
1. 观察者模式
Signal 维护一个接收器列表(receivers),每个接收器都是一个可调用对象(函数或方法)。当事件发生时,Signal 会遍历这个列表,依次调用每个接收器,并传递相关参数。
2. 弱引用机制
为了避免内存泄漏,Signal 支持弱引用注册接收器。这样,如果接收器对象被销毁,Signal 不会阻止其被垃圾回收。
3. 线程安全
Signal 内部使用锁(threading.Lock
),保证在多线程环境下注册、注销和触发事件都是安全的。
4. 发送与接收
- connect:注册回调
- disconnect:注销回调
- send:广播事件,通知所有回调
- send_robust:与 send 等价,兼容 Django
三、Signal 类的主要方法详解
1. connect(receiver, sender=None, weak=True, dispatch_uid=None, retry=False)
- 注册一个接收器(回调函数)。
- 支持指定 sender(只监听某个事件源),支持弱引用和唯一标识(dispatch_uid)。
- 支持自动重试(如网络异常时)。
2. disconnect(receiver, sender=None, dispatch_uid=None)
- 注销接收器。
- 如果是弱引用,接收器被销毁时会自动移除,无需手动 disconnect。
3. send(sender, **named)
- 触发事件,通知所有接收器。
- sender 用于区分事件源,**named 是传递给回调的参数。
4. has_listeners(sender=None)
- 判断是否有监听器。
四、Signal 的高级特性
- 接收器缓存:可选开启,提升性能。
- 唯一标识(dispatch_uid):防止重复注册。
- 自动清理死接收器:弱引用对象被回收后自动清理。
- 异常处理:回调异常不会影响其他回调,异常会被捕获并记录。
五、实战 Demo
下面用一个简单的博客评论系统模拟 Signal 的用法:
python
from celery.utils.dispatch.signal import Signal
# 创建一个评论发布信号
comment_posted = Signal(providing_args=['user', 'content'])
# 定义接收器:发送通知
def notify_admin(signal, sender, user=None, content=None, **kwargs):
print(f"[通知] 管理员:用户 {user} 发布了评论:{content}")
# 定义接收器:自动审核
def auto_moderate(signal, sender, user=None, content=None, **kwargs):
if "spam" in content:
print(f"[审核] 评论被判定为垃圾:{content}")
else:
print(f"[审核] 评论通过:{content}")
# 注册接收器
comment_posted.connect(notify_admin)
comment_posted.connect(auto_moderate)
# 用户发布评论,触发信号
def post_comment(user, content):
print(f"用户 {user} 正在发布评论...")
comment_posted.send(sender='blog', user=user, content=content)
# 测试
post_comment("Alice", "这是一条正常评论")
post_comment("Bob", "spam spam spam")
输出:
css
用户 Alice 正在发布评论...
[通知] 管理员:用户 Alice 发布了评论:这是一条正常评论
[审核] 评论通过:这是一条正常评论
用户 Bob 正在发布评论...
[通知] 管理员:用户 Bob 发布了评论:spam spam spam
[审核] 评论被判定为垃圾:spam spam spam
六、Signal 在 Celery 和 Django 中的应用
- Celery:任务执行前后、worker 启动关闭、任务失败等都可以用 Signal 注册钩子,实现日志、监控、自动重试等功能。
- Django:模型保存、用户登录、请求处理等都可以用 Signal 实现自动化处理和解耦扩展。
七、总结与最佳实践
- Signal 是事件驱动和解耦通信的利器,适合复杂系统的扩展和维护。
- 推荐用弱引用注册接收器,避免内存泄漏。
- 回调函数要支持关键字参数,便于扩展。
- 可以用 dispatch_uid 保证唯一性,防止重复注册。
- 多个接收器互不影响,异常会被捕获和记录。