|
| 1 | +# coding=utf-8 |
| 2 | +""" |
| 3 | +@project: MaxKB |
| 4 | +@file: message_bus.py |
| 5 | +@desc: 基于 Redis Pub/Sub 的跨进程、跨系统消息总线。提供 emit / on 两个接口。 |
| 6 | +""" |
| 7 | + |
| 8 | +import json |
| 9 | +import threading |
| 10 | +from typing import Callable, Dict, List |
| 11 | + |
| 12 | +from common.utils.logger import maxkb_logger |
| 13 | + |
| 14 | +CHANNEL = "maxkb:bus" |
| 15 | + |
| 16 | +_handlers: Dict[str, List[Callable]] = {} |
| 17 | +_handlers_lock = threading.Lock() |
| 18 | + |
| 19 | +_subscriber_started = False |
| 20 | +_subscriber_thread = None |
| 21 | +_subscriber_lock = threading.Lock() |
| 22 | + |
| 23 | + |
| 24 | +def _redis_client(): |
| 25 | + """取底层 redis-py 客户端(含 pubsub 能力),已由 Django settings 配置支持 sentinel/普通 Redis。""" |
| 26 | + from django_redis import get_redis_connection |
| 27 | + |
| 28 | + return get_redis_connection("default") |
| 29 | + |
| 30 | + |
| 31 | +def _start_subscriber() -> None: |
| 32 | + """懒启动:每个进程只起一条 daemon 订阅线程;线程因建连失败退出后,下次调用会重新拉起。""" |
| 33 | + global _subscriber_started, _subscriber_thread |
| 34 | + if _subscriber_started and _subscriber_thread is not None and _subscriber_thread.is_alive(): |
| 35 | + return |
| 36 | + with _subscriber_lock: |
| 37 | + if _subscriber_started and _subscriber_thread is not None and _subscriber_thread.is_alive(): |
| 38 | + return |
| 39 | + _subscriber_started = True |
| 40 | + _subscriber_thread = threading.Thread(target=_listen, name="maxkb-bus", daemon=True) |
| 41 | + _subscriber_thread.start() |
| 42 | + |
| 43 | + |
| 44 | +def _listen() -> None: |
| 45 | + # 建连失败(Redis 不可用)则记日志退出,不自动重连;由 emit 检测线程存活后重新拉起。 |
| 46 | + # 建连成功后的消息循环由 redis-py 内部维持,无需自行重连。 |
| 47 | + ps = None |
| 48 | + try: |
| 49 | + ps = _redis_client().pubsub(ignore_subscribe_messages=True) |
| 50 | + ps.subscribe(CHANNEL) |
| 51 | + for message in ps.listen(): |
| 52 | + _dispatch(message) |
| 53 | + except Exception as e: |
| 54 | + maxkb_logger.error(f"Message bus subscriber failed: {e}") |
| 55 | + finally: |
| 56 | + if ps is not None: |
| 57 | + try: |
| 58 | + ps.close() |
| 59 | + except Exception: |
| 60 | + pass |
| 61 | + |
| 62 | + |
| 63 | +def _dispatch(message) -> None: |
| 64 | + try: |
| 65 | + data = message.get("data") |
| 66 | + if isinstance(data, (bytes, bytearray)): |
| 67 | + data = data.decode("utf-8") |
| 68 | + body = json.loads(data) |
| 69 | + event = body.get("event") |
| 70 | + if not event: |
| 71 | + return |
| 72 | + args = body.get("args") |
| 73 | + for handler in list(_handlers.get(event, ())): |
| 74 | + try: |
| 75 | + handler(args) |
| 76 | + except Exception as e: |
| 77 | + maxkb_logger.error(f"Message bus handler error for event[{event}]: {e}") |
| 78 | + except Exception as e: |
| 79 | + maxkb_logger.error("Failed to dispatch message bus event: %s", e) |
| 80 | + |
| 81 | + |
| 82 | +def on(event: str, handler: Callable) -> None: |
| 83 | + """ |
| 84 | + 注册一个事件监听,本进程内生效;收到该事件时异步调用 handler(args)。 |
| 85 | + :param event: 事件名称 |
| 86 | + :param handler: 回调函数 def handler(args): |
| 87 | + pass |
| 88 | + """ |
| 89 | + with _handlers_lock: |
| 90 | + _handlers.setdefault(event, []).append(handler) |
| 91 | + _start_subscriber() |
| 92 | + |
| 93 | + |
| 94 | +def emit(event: str, args=None) -> bool: |
| 95 | + """ |
| 96 | + 向所有进程广播一个事件。Redis 不可用时返回 False。 |
| 97 | + :param event: 事件名称 |
| 98 | + :param args: 事件参数 |
| 99 | + """ |
| 100 | + _start_subscriber() |
| 101 | + try: |
| 102 | + _redis_client().publish( |
| 103 | + CHANNEL, |
| 104 | + json.dumps({"event": event, "args": args}, ensure_ascii=False), |
| 105 | + ) |
| 106 | + return True |
| 107 | + except Exception as e: |
| 108 | + maxkb_logger.warning(f"Message bus emit[{event}] failed: {e}") |
| 109 | + return False |
0 commit comments