ad8f7e761f
* 滚木 * 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中的项目描述和技术栈说明 - 更新快速上手文档，简化安装步骤 - 调整事件流转文档的描述方式 - 简化架构文档内容 - 更新指令处理文档，添加参数注入示例 - 优化单例管理器文档的表述 * refactor(core): 优化权限管理和事件模型 - 重构 AdminManager 和 PermissionManager 以 Redis 为主要数据源 - 为所有事件模型添加 slots=True 提升性能 - 更新文档说明 Mypyc 编译注意事项 - 清理测试和调试文件 - 移动静态资源到 web_static 目录 * feat: 添加模块编译脚本和导出依赖功能 refactor(events): 移除数据类的slots参数以提升兼容性 build: 更新requirements.txt依赖列表 * docs: 更新性能优化文档并修复命令管理器帮助输出 更新性能优化相关文档，详细说明 Python 3.14 JIT 编译器的使用方法和原理，补充与 Mypyc 的互补策略。同时修复命令管理器中帮助信息的输出方式，移除图片发送仅保留文本输出。 调整部署文档结构，明确两种性能优化方案（AOT 和 JIT）的配置方法和适用场景。完善架构文档中关于 JIT 的原理和启用方式说明。 * feat(help): 重构帮助菜单界面并优化样式 refactor(bili_parser): 修复 API 响应 content-type 问题 fix(command_manager): 添加帮助图片获取的错误处理 docs(deployment): 简化部署文档并移除 JIT 相关内容 * feat: 新增自动同意请求插件和API文档 docs: 更新文档结构和内容 * refactor(scripts): 重构并优化脚本文件结构 feat(scripts): 添加Python环境检查脚本 feat(scripts): 增强依赖导出脚本功能 perf(plugins/bili_parser): 优化B站解析器性能和代码结构 style(plugins/bili_parser): 统一代码风格和常量命名 --------- Co-authored-by: baby20162016 <2185823427@qq.com>
123 lines
5.4 KiB
Markdown
123 lines
5.4 KiB
Markdown
# 性能优化详解
|
||
|
||
NEO Bot 实际上是python，有人说用Java可能更好。。。嗯但是镀铬酸钾不会Java，镀铬酸钾只会python，所以只能用python了
|
||
|
||
## 1. Playwright 页面池 (Page Pool)
|
||
|
||
### 痛点
|
||
之前 Bot 发图流程：
|
||
1. 用户发指令。
|
||
2. Bot 启动浏览器。
|
||
3. 创建新页面。。
|
||
4. 渲染，截图。
|
||
5. 关闭浏览器。
|
||
|
||
这种模式下，发一张图至少要等 1 秒以上。。。
|
||
|
||
### 解决方案
|
||
`BrowserManager` 维护了一个**页面池**。
|
||
* **启动时**: 自动预热 3 个页面（可配置），挂在后台待命。
|
||
* **运行时**: 需要截图时，直接从池里 `get_page()`
|
||
* **结束后**: 截图完成，页面执行 `about:blank` 洗白，然后 `release_page()` 放回池里。
|
||
|
||
### 收益
|
||
我不知道快了多少，也没人测试，嗯
|
||
|
||
## 2. Jinja2 模板缓存
|
||
|
||
### 痛点
|
||
每次渲染 HTML，都要从硬盘读文件，然后解析模板语法。硬盘 IO 是慢的，解析也是慢的。
|
||
|
||
### 解决方案
|
||
`ImageManager` 引入了内存缓存 `_template_cache`。
|
||
* 第一次读取模板后，编译好的 `Template` 对象直接存入字典。
|
||
* 后续请求直接从内存拿对象渲染。
|
||
|
||
### 收益
|
||
省了硬盘IO
|
||
|
||
## 3. 全局 HTTP 连接复用
|
||
|
||
### 痛点
|
||
插件（如 B站解析）每次请求 API 都创建一个新的 `aiohttp.ClientSession`。
|
||
这意味着每次都要进行：DNS 解析 -> TCP 握手 -> SSL 握手。这在 HTTPS 下非常慢。
|
||
|
||
### 解决方案
|
||
我们在插件层面实现了 `get_session()`。
|
||
* 全局共享一个 `ClientSession`。
|
||
* 复用底层的 TCP 连接 (Keep-Alive)。
|
||
|
||
### 收益
|
||
实际上我也不知道，bot没高并发的实验。。。
|
||
|
||
## 4. orjson 极速序列化
|
||
|
||
### 痛点
|
||
Python 自带的 `json` 库性能好像不太好，特别是在处理 OneBot 这种大量 JSON 通信的场景下。
|
||
|
||
### 解决方案
|
||
全面替换为 `orjson`。
|
||
* Rust 编写
|
||
* 支持直接返回 `bytes`，减少内存复制。
|
||
|
||
## 5. Python 3.14 JIT (Just-In-Time Compilation)
|
||
|
||
### 痛点
|
||
Python 解释器一边解析一边执行，遇到循环和函数调用就得反复解释。像消息处理这种高频循环，解释开销就特别明显。
|
||
|
||
### 解决方案
|
||
Python 3.14 自带了一个实验性的 JIT 编译器。启动时加上 `-X jit` 参数，它就会在运行时把热点代码编译成机器码。
|
||
|
||
**JIT 怎么工作的？**
|
||
1. **监控**: 解释器运行时会统计哪些函数、哪些循环被调最得频繁。
|
||
2. **编译**: 把这些“热点”代码编译成机器码。
|
||
3. **替换**: 下次再执行到这段代码，直接跑机器码，跳过解释步骤。
|
||
|
||
**哪些代码受益最大？**
|
||
- `plugins/` 里的业务逻辑（比如 B站解析、代码沙箱）。
|
||
- 循环密集的操作（比如遍历消息段、处理大量群消息）。
|
||
- 频繁调用的工具函数。
|
||
|
||
### 如何启用？
|
||
启动机器人时加上 `-X jit` 参数：
|
||
|
||
```bash
|
||
python -X jit main.py
|
||
```
|
||
|
||
### 收益
|
||
* **热点代码加速**: 经常跑的代码能快 2-10 倍（看具体场景）。
|
||
* **零配置**: 不用改代码，加个启动参数就行。
|
||
* **与 Mypyc 互补**: JIT 负责动态、灵活的插件代码；Mypyc 负责静态、类型明确的核心模块。两者结合，全面覆盖。
|
||
|
||
## 6. Mypyc 编译 (AOT Compilation)
|
||
|
||
### 痛点
|
||
Python 作为一种解释型语言，在处理 CPU 密集型任务时性能较差。对于机器人框架的核心部分，如 WebSocket 消息解析、事件分发和插件管理，这些代码被高频调用，其性能直接影响机器人的响应速度和吞吐量。
|
||
|
||
### 解决方案
|
||
我们引入了 `Mypyc`，一个将类型注解的 Python 代码编译为高性能 C 扩展的工具。通过项目根目录下的 `setup_mypyc.py` 脚本，我们可以选择性地将核心模块编译为二进制文件（在 Windows 上是 `.pyd`，在 Linux 上是 `.so`）。
|
||
|
||
**哪些模块被编译了？**
|
||
- `core/ws.py`: WebSocket 消息处理循环，这是整个机器人框架的 I/O 中枢。
|
||
- `core/managers/*.py`: 所有的核心管理器，如指令管理器、插件管理器等，负责事件分发和业务逻辑。
|
||
- `core/utils/*.py`: 高频使用的工具函数。
|
||
- `models/*.py`: 数据模型类，如消息段、发送者等。
|
||
|
||
这些高频调用的代码路径被编译为接近原生机器码的速度，极大地提升了性能。
|
||
|
||
### 如何编译？
|
||
在项目根目录下运行以下指令：
|
||
```bash
|
||
python setup_mypyc.py
|
||
```
|
||
脚本会自动查找并编译预设的模块列表。
|
||
|
||
### 特别注意：关于事件模型的编译
|
||
`Mypyc` 对 Python 某些动态特性和高级用法支持尚不完善。在实践中，我们发现 `dataclass` 与 `Mypyc` 存在一些兼容性问题，尤其是在使用继承和某些高级特性（如 `slots=True`）时，可能会导致编译失败或运行时错误（例如 `AttributeError: attribute '__dict__' of 'type' objects is not writable`）。
|
||
|
||
- **当前状态**：为了确保稳定性，`setup_mypyc.py` 脚本**默认不编译** `models/events/` 目录下的事件模型文件。这些文件虽然也被频繁使用，但它们的结构相对复杂，与 `Mypyc` 的兼容性问题仍在探索中。
|
||
- **未来展望**：我们会持续关注 `Mypyc` 的更新，当其对 `dataclass` 的支持得到改善后，会重新尝试将事件模型加入编译列表，以实现极致的性能。
|
||
|
||
通过这种方式，我们在保证核心模块性能的同时，也维持了项目的稳定性和可维护性。
|