refactor(core): 优化权限管理和事件模型
- 重构 AdminManager 和 PermissionManager 以 Redis 为主要数据源 - 为所有事件模型添加 slots=True 提升性能 - 更新文档说明 Mypyc 编译注意事项 - 清理测试和调试文件 - 移动静态资源到 web_static 目录
This commit is contained in:
@@ -60,14 +60,33 @@ Python 自带的 `json` 库性能好像不太好,特别是在处理 OneBot 这
|
||||
* Rust 编写
|
||||
* 支持直接返回 `bytes`,减少内存复制。
|
||||
|
||||
## 5. Mypyc 编译
|
||||
## 5. Mypyc 编译 (AOT Compilation)
|
||||
|
||||
### 痛点
|
||||
Python太慢了。。。
|
||||
Python 作为一种解释型语言,在处理 CPU 密集型任务时性能较差。对于机器人框架的核心部分,如 WebSocket 消息解析、事件分发和插件管理,这些代码被高频调用,其性能直接影响机器人的响应速度和吞吐量。
|
||||
|
||||
### 解决方案
|
||||
利用 `setup_mypyc.py` 将核心模块编译为 C 扩展。
|
||||
* `core/ws.py`: WebSocket 消息处理循环。
|
||||
* `core/managers/*.py`: 事件分发逻辑。
|
||||
我们引入了 `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` 的支持得到改善后,会重新尝试将事件模型加入编译列表,以实现极致的性能。
|
||||
|
||||
通过这种方式,我们在保证核心模块性能的同时,也维持了项目的稳定性和可维护性。
|
||||
|
||||
@@ -22,14 +22,19 @@ source venv/bin/activate
|
||||
pip install -r requirements.txt
|
||||
```
|
||||
|
||||
### c. 编译核心模块 (可选,但强烈建议)
|
||||
### c. 编译核心模块 (可选,但为获得最佳性能强烈建议)
|
||||
|
||||
为了性能,把核心模块编译成 C 扩展。
|
||||
为了最大化性能,你可以将项目中的核心 Python 模块编译成 C 语言扩展。这将大幅提升机器人的响应速度和处理效率。
|
||||
|
||||
```bash
|
||||
python setup_mypyc.py build_ext --inplace
|
||||
# 确保你在虚拟环境中
|
||||
python setup_mypyc.py
|
||||
```
|
||||
|
||||
该脚本会自动编译 `core` 和 `models` 目录下的指定模块。编译后的文件(`.pyd` 或 `.so`)会直接生成在源码旁边。
|
||||
|
||||
> **注意**: 编译产物是平台相关的(例如,在 Windows 上编译的 `.pyd` 文件不能在 Linux 上使用)。因此,**请务必在你最终部署的服务器环境(例如 Linux)上执行此编译步骤**。更多关于 Mypyc 编译的细节,请参考 [性能优化详解](core-concepts/performance.md)。
|
||||
|
||||
## 2. 使用进程管理器
|
||||
|
||||
你想直接 `python main.py` 然后关掉 SSH?那机器人也跟着停了。必须用进程管理器来守护它。
|
||||
|
||||
@@ -22,7 +22,7 @@
|
||||
├── .gitignore # Git 忽略配置
|
||||
├── main.py # 主入口文件
|
||||
├── requirements.txt # Python 依赖列表
|
||||
└── setup_mypyc.py # Mypyc 编译脚本
|
||||
└── setup_mypyc.py # [可选] Mypyc 编译脚本,用于将核心模块编译为 C 扩展以提升性能
|
||||
```
|
||||
|
||||
## 重点目录说明
|
||||
|
||||
Reference in New Issue
Block a user