Dev (#36)
* 滚木 * feat: 重构核心架构,增强类型安全与插件管理 本次提交对核心模块进行了深度重构,引入 Pydantic 增强配置管理的类型安全性,并全面优化了插件管理系统。 主要变更详情: 1. 核心架构与配置 - 重构配置加载模块:引入 Pydantic 模型 (`core/config_models.py`),提供严格的配置项类型检查、验证及默认值管理。 - 统一模块结构:规范化模块导入路径,移除冗余的 `__init__.py` 文件,提升项目结构的清晰度。 - 性能优化:集成 Redis 缓存支持 (`RedisManager`),有效降低高频 API 调用开销,提升响应速度。 2. 插件系统升级 - 实现热重载机制:新增插件文件变更监听功能,支持开发过程中自动重载插件,提升开发效率。 - 优化生命周期管理:改进插件加载与卸载逻辑,支持精确卸载指定插件及其关联的命令、事件处理器和定时任务。 3. 功能特性增强 - 新增媒体 API:引入 `MediaAPI` 模块,封装图片、语音等富媒体资源的获取与处理接口。 - 完善权限体系:重构权限管理系统,实现管理员与操作员的分级控制,支持更细粒度的命令权限校验。 4. 代码质量与稳定性 - 全面类型修复:解决 `mypy` 静态类型检查发现的大量类型错误(包括 `CommandManager`、`EventFactory` 及 `Bot` API 签名不匹配问题)。 - 增强错误处理:优化消息处理管道的异常捕获机制,完善关键路径的日志记录,提升系统运行稳定性。 * feat: 添加测试用例并优化代码结构 refactor(permission_manager): 调整初始化顺序和逻辑 fix(admin_manager): 修复初始化逻辑和目录创建问题 feat(ws): 优化Bot实例初始化条件 feat(message): 增强MessageSegment功能并添加测试 feat(events): 支持字符串格式的消息解析 test: 添加核心功能测试用例 refactor(plugin_manager): 改进插件路径处理 style: 清理无用导入和代码 chore: 更新依赖项 * refactor(handler): 移除TYPE_CHECKING并直接导入Bot类 简化类型注解,直接导入Bot类而非使用TYPE_CHECKING条件导入,提高代码可读性和维护性 * fix(command_manager): 修复插件卸载时元信息移除不精确的问题 修复 CommandManager 中 unload_plugin 方法移除插件元信息时使用 startswith 导致可能误删其他插件的问题,改为精确匹配 同时调整相关测试用例验证精确匹配行为 * refactor: 清理未使用的导入和更新文档结构 docs: 添加config_models.py到项目结构文档 docs: 调整数据目录位置到core/data下 docs: 更新权限管理器文档描述 * 文档更新 * 更新thpic插件 支持一次返回多张图 * feat: 添加测试覆盖率并修复相关问题 refactor(redis_manager): 移除冗余的ConnectionError处理 refactor(event_handler): 优化Bot类型注解 refactor(factory): 移除未使用的GroupCardNoticeEvent test: 添加全面的单元测试覆盖 - 添加test_import.py测试模块导入 - 添加test_debug.py测试插件加载调试 - 添加test_plugin_error.py测试错误处理 - 添加test_config_loader.py测试配置加载 - 添加test_redis_manager.py测试Redis管理 - 添加test_bot.py测试Bot功能 - 扩展test_models.py测试消息模型 - 添加test_plugin_manager_coverage.py测试插件管理 - 添加test_executor.py测试代码执行器 - 添加test_ws.py测试WebSocket - 添加test_api.py测试API接口 - 添加test_core_managers.py测试核心管理模块 fix(plugin_manager): 修复插件加载日志变量问题 覆盖率已到达86%(忽略插件) * 更新/help指令,现在会发送图片 * feat(help): 重构帮助系统为图片渲染模式 添加浏览器管理器和图片管理器,用于通过 Playwright 渲染帮助菜单为图片 重构命令管理器以支持图片缓存和同步功能 添加 HTML 模板用于帮助菜单渲染 * build: 更新依赖文件 requirements.txt * build: 更新依赖文件 * feat: 添加性能优化和架构文档,更新依赖和核心模块 refactor(browser_manager): 实现页面池机制以提升性能 refactor(image_manager): 添加模板缓存并集成页面池 refactor(bili_parser): 迁移到异步HTTP请求并实现会话复用 docs: 新增性能优化、架构设计和最佳实践文档 chore: 更新requirements.txt添加新依赖 * docs: 更新文档内容并优化语言风格 重构所有文档内容,使用更简洁直接的语言风格 更新架构、插件开发、部署等核心文档 优化代码示例和图表说明 统一术语和格式规范 * docs: 更新文档内容,简化语言并修正格式 - 简化插件开发指南中的描述,移除冗余内容 - 调整部署文档中的Python版本说明 - 优化最佳实践文档的措辞和格式 - 更新性能优化文档,删除不准确的数据 - 重构核心概念文档,使用更简洁的语言 - 修正README中的项目描述和技术栈说明 - 更新快速上手文档,简化安装步骤 - 调整事件流转文档的描述方式 - 简化架构文档内容 - 更新指令处理文档,添加参数注入示例 - 优化单例管理器文档的表述 --------- Co-authored-by: baby20162016 <2185823427@qq.com>
This commit is contained in:
@@ -1,74 +1,80 @@
|
||||
# 核心概念:单例管理器
|
||||
|
||||
在 `core/managers/` 目录下,存放着一系列全局唯一的**管理器(Managers)**。它们是 NEO Bot Framework 功能的核心实现,负责处理事件、管理权限、加载插件等关键任务。
|
||||
`core/managers/` 这地方,放的都是些**管事的**。它们是 NEO Bot 的核心。梨花飘落在你窗前。。。
|
||||
|
||||
理解这些管理器的职责,有助于您更好地利用框架提供的能力,并进行更高级的开发。
|
||||
## 为啥是单例?
|
||||
|
||||
## 设计模式:单例 (Singleton)
|
||||
就是**全局独一份**。
|
||||
|
||||
框架中所有的管理器都采用了**单例设计模式**。这意味着在整个应用程序的生命周期中,每个管理器类只会存在一个实例。
|
||||
* **到处都能用**: 在插件里 `import` 就行,不用传来传去。
|
||||
* **数据不打架**: 权限、命令这些东西,全局就一份,改了都认。
|
||||
* **省资源**: Redis 连接池、浏览器这种东西,开一个就够了,多了浪费。
|
||||
|
||||
**为什么使用单例?**
|
||||
我专门在 `core/utils/singleton.py` 搞了个基类,继承一下就行,你会的,加油。。。
|
||||
|
||||
* **全局访问点**: 任何模块(尤其是插件)都可以方便地导入并使用同一个管理器实例,无需手动传递。
|
||||
* **状态共享**: 管理器内部维护的状态(如已注册的命令、用户权限列表)是全局共享和一致的。
|
||||
* **资源统一管理**: 对于像 Redis 连接这样的资源,单例模式确保了全局只有一个连接池,避免了资源的浪费和冲突。
|
||||
## 认识一下
|
||||
|
||||
框架在 `core/utils/singleton.py` 中提供了一个 `Singleton` 基类,所有管理器都继承自它,以轻松实现单例模式。
|
||||
### 1. `CommandManager` (`matcher`)
|
||||
|
||||
## 核心管理器介绍
|
||||
* **怎么找**: `from core.managers.command_manager import matcher`
|
||||
* **管啥**:
|
||||
* **总调度**: 所有消息都得从它这过一遍
|
||||
* **发牌的**: 你用的 `@matcher.command()` 这种装饰器,就是它发的。
|
||||
* **对号入座**: 消息来了,它负责对一下,看是哪个插件的。
|
||||
|
||||
### 1. `CommandManager` (全局实例: `matcher`)
|
||||
写插件天天都得跟它打交道。
|
||||
|
||||
* **文件**: `core/managers/command_manager.py`
|
||||
* **全局实例**: `from core.managers.command_manager import matcher`
|
||||
* **核心职责**:
|
||||
* **事件处理中枢**: 它是事件流转的核心,负责接收所有类型的事件,并将其分发给相应的底层处理器。
|
||||
* **装饰器提供者**: 为插件提供了 `@matcher.command()`, `@matcher.on_notice()` 等一系列装饰器,用于注册事件处理器。
|
||||
* **指令匹配**: 内部维护了一个指令注册表,能够根据消息内容匹配到对应的处理函数。
|
||||
### 2. `PermissionManager` (`permission_manager`)
|
||||
|
||||
`matcher` 是插件开发者最常打交道的管理器。
|
||||
* **怎么找**: `from core.managers.permission_manager import permission_manager`
|
||||
* **管啥**:
|
||||
* **划分三六九等**: `ADMIN`, `OP`, `USER` 这些等级都是它定的。
|
||||
* **管理权限**: 谁有啥权限,都记在 `core/data/permissions.json` 里。
|
||||
* **会自动变通**: 查权限的时候,它会把 `AdminManager` 里的超管也当成 `ADMIN`。
|
||||
|
||||
### 2. `PermissionManager` (全局实例: `permission_manager`)
|
||||
### 3. `AdminManager` (`admin_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 缓存之间的数据同步,确保管理员列表的一致性和高效查询。
|
||||
* **怎么找**: `from core.managers.admin_manager import admin_manager`
|
||||
* **管啥**:
|
||||
* **钦差大臣**: 专门管机器人的超级管理员,增删改查都在这。
|
||||
* **三级缓存**: 内存 -> Redis -> 文件
|
||||
|
||||
### 4. `PluginManager`
|
||||
|
||||
* **文件**: `core/managers/plugin_manager.py`
|
||||
* **核心职责**:
|
||||
* **插件加载**: 负责扫描 `plugins/` 目录,导入所有合法的插件模块。
|
||||
* **元数据提取**: 读取插件文件中定义的 `__plugin_meta__` 字典,用于 `/help` 指令等功能。
|
||||
* **热重载支持**: `load_all_plugins` 函数被 `main.py` 中的文件监控服务调用,以实现插件的热重载。
|
||||
* **管啥**:
|
||||
* **拉人头**: 启动时把 `plugins/` 目录下的插件都拉进来。
|
||||
* **热更新**: 你改了插件代码,它负责重载,不用重启机器人。
|
||||
|
||||
此管理器通常在后台工作,开发者较少直接与其交互。
|
||||
这一般在幕后,你基本不用找它。
|
||||
|
||||
### 5. `RedisManager` (全局实例: `redis_manager`)
|
||||
### 5. `RedisManager` (`redis_manager`)
|
||||
|
||||
* **文件**: `core/managers/redis_manager.py`
|
||||
* **全局实例**: `from core.managers.redis_manager import redis_manager`
|
||||
* **核心职责**:
|
||||
* **连接管理**: 负责初始化和管理与 Redis 服务器的异步连接。
|
||||
* **提供实例**: 通过 `redis_manager.redis` 属性,为其他模块提供一个可用的 `redis` 客户端实例。
|
||||
* **怎么找**: `from core.managers.redis_manager import redis_manager`
|
||||
* **管啥**:
|
||||
* **接线员**: 管着和 Redis 的连接。
|
||||
* **提供工具**: 你要用 Redis,就找 `redis_manager.redis`。
|
||||
|
||||
## 如何在插件中使用管理器
|
||||
### 6. `BrowserManager` (`browser_manager`)
|
||||
|
||||
在您的插件中,只需通过 `import` 语句导入相应管理器的全局实例即可使用。
|
||||
* **怎么找**: `from core.managers.browser_manager import browser_manager`
|
||||
* **管啥**:
|
||||
* **浏览器**: 负责启动和关闭 Playwright。
|
||||
* **页面池**: 提前准备好几个空白页面(默认3个),你要用直接拿
|
||||
* **循环利用**: 用完记得还回来 (`release_page`)
|
||||
|
||||
**示例**: 在插件中检查用户是否为管理员。
|
||||
### 7. `ImageManager` (`image_manager`)
|
||||
|
||||
* **怎么找**: `from core.managers.image_manager import image_manager`
|
||||
* **管啥**:
|
||||
* **美工**: 把数据塞进网页模板
|
||||
* **记性好**: 模板用一次就记住,下次直接用缓存。
|
||||
* **自动借还**: 它会自动找 `BrowserManager` 借页面,你只管 `render_template` 就行。
|
||||
|
||||
## 咋用?
|
||||
|
||||
`import`
|
||||
|
||||
**例子**: 查查这人是不是op
|
||||
|
||||
```python
|
||||
# plugins/my_plugin.py
|
||||
@@ -79,11 +85,10 @@ 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("这是一个只有管理员能看到的秘密。")
|
||||
await event.reply("这是秘密!")
|
||||
else:
|
||||
await event.reply("抱歉,您没有权限执行此命令。")
|
||||
await event.reply("你没权限看这个。")
|
||||
```
|
||||
|
||||
Reference in New Issue
Block a user