refactor(core): 重构核心模块结构并添加开发文档

将核心模块按功能重新组织为更清晰的结构，包括 managers、handlers 和 utils 目录添加完整的开发文档，涵盖快速开始、项目结构、核心概念和插件开发指南更新所有相关模块的导入路径以匹配新的结构将单例模式实现提取到单独的 singleton.py 文件
2026-01-07 22:51:27 +08:00
parent c708761726
commit 56b1014419
45 changed files with 772 additions and 104 deletions
--- a/docs/core-concepts/singleton-managers.md
+++ b/docs/core-concepts/singleton-managers.md
@@ -0,0 +1,89 @@
+# 核心概念：单例管理器
+
+在 `core/managers/` 目录下，存放着一系列全局唯一的**管理器（Managers）**。它们是 NEO Bot Framework 功能的核心实现，负责处理事件、管理权限、加载插件等关键任务。
+
+理解这些管理器的职责，有助于您更好地利用框架提供的能力，并进行更高级的开发。
+
+## 设计模式：单例 (Singleton)
+
+框架中所有的管理器都采用了**单例设计模式**。这意味着在整个应用程序的生命周期中，每个管理器类只会存在一个实例。
+
+**为什么使用单例？**
+
+*   **全局访问点**: 任何模块（尤其是插件）都可以方便地导入并使用同一个管理器实例，无需手动传递。
+*   **状态共享**: 管理器内部维护的状态（如已注册的命令、用户权限列表）是全局共享和一致的。
+*   **资源统一管理**: 对于像 Redis 连接这样的资源，单例模式确保了全局只有一个连接池，避免了资源的浪费和冲突。
+
+框架在 `core/utils/singleton.py` 中提供了一个 `Singleton` 基类，所有管理器都继承自它，以轻松实现单例模式。
+
+## 核心管理器介绍
+
+### 1. `CommandManager` (全局实例: `matcher`)
+
+*   **文件**: `core/managers/command_manager.py`
+*   **全局实例**: `from core.managers.command_manager import matcher`
+*   **核心职责**:
+    *   **事件处理中枢**: 它是事件流转的核心，负责接收所有类型的事件，并将其分发给相应的底层处理器。
+    *   **装饰器提供者**: 为插件提供了 `@matcher.command()`, `@matcher.on_notice()` 等一系列装饰器，用于注册事件处理器。
+    *   **指令匹配**: 内部维护了一个指令注册表，能够根据消息内容匹配到对应的处理函数。
+
+`matcher` 是插件开发者最常打交道的管理器。
+
+### 2. `PermissionManager` (全局实例: `permission_manager`)
+
+*   **文件**: `core/managers/permission_manager.py`
+*   **全局实例**: `from core.managers.permission_manager import permission_manager`
+*   **核心职责**:
+    *   **权限定义与检查**: 定义了 `ADMIN`, `OP`, `USER` 等权限等级，并提供了 `check_permission` 方法来验证用户权限。
+    *   **数据持久化**: 负责从 `core/data/permissions.json` 文件中加载和保存用户权限设置。
+    *   **与 `AdminManager` 联动**: 在检查权限时，会自动将机器人管理员（来自 `AdminManager`）识别为最高权限 `ADMIN`。
+
+### 3. `AdminManager` (全局实例: `admin_manager`)
+
+*   **文件**: `core/managers/admin_manager.py`
+*   **全局实例**: `from core.managers.admin_manager import admin_manager`
+*   **核心职责**:
+    *   **管理员管理**: 提供 `add_admin`, `remove_admin`, `is_admin` 等接口，用于管理机器人的超级管理员列表。
+    *   **数据同步**: 实现了内存、`core/data/admin.json` 文件以及 Redis 缓存之间的数据同步，确保管理员列表的一致性和高效查询。
+
+### 4. `PluginManager`
+
+*   **文件**: `core/managers/plugin_manager.py`
+*   **核心职责**:
+    *   **插件加载**: 负责扫描 `plugins/` 目录，导入所有合法的插件模块。
+    *   **元数据提取**: 读取插件文件中定义的 `__plugin_meta__` 字典，用于 `/help` 指令等功能。
+    *   **热重载支持**: `load_all_plugins` 函数被 `main.py` 中的文件监控服务调用，以实现插件的热重载。
+
+此管理器通常在后台工作，开发者较少直接与其交互。
+
+### 5. `RedisManager` (全局实例: `redis_manager`)
+
+*   **文件**: `core/managers/redis_manager.py`
+*   **全局实例**: `from core.managers.redis_manager import redis_manager`
+*   **核心职责**:
+    *   **连接管理**: 负责初始化和管理与 Redis 服务器的异步连接。
+    *   **提供实例**: 通过 `redis_manager.redis` 属性，为其他模块提供一个可用的 `redis` 客户端实例。
+
+## 如何在插件中使用管理器
+
+在您的插件中，只需通过 `import` 语句导入相应管理器的全局实例即可使用。
+
+**示例**: 在插件中检查用户是否为管理员。
+
+```python
+# plugins/my_plugin.py
+
+from core.managers.command_manager import matcher
+from core.managers.permission_manager import permission_manager, ADMIN
+from models.events.message import MessageEvent
+
+@matcher.command("secret")
+async def secret_command(event: MessageEvent):
+    # 使用 permission_manager 检查用户权限
+    is_admin = await permission_manager.check_permission(event.user_id, ADMIN)
+    
+    if is_admin:
+        await event.reply("这是一个只有管理员能看到的秘密。")
+    else:
+        await event.reply("抱歉，您没有权限执行此命令。")
+```