docs: 更新架构文档和项目结构说明

添加反向WebSocket连接模式说明
补充核心管理器文档
更新项目结构文件
在文档首页添加特色功能说明
This commit is contained in:
2026-03-24 12:01:30 +08:00
parent c420168df2
commit ce650d2b1e
4 changed files with 124 additions and 48 deletions

View File

@@ -47,9 +47,12 @@ python setup_mypyc.py build_ext --inplace
## 2. 连接架构
### 正向 WebSocket 连接
### WebSocket 连接模式
NEO Bot 采用**正向 WebSocket 连接**模式Bot 主动连接 OneBot 实现(如 NapCatQQ
NEO Bot 支持两种 WebSocket 连接模式,可根据需求在 `config.toml` 中配置:
#### 1. 正向 WebSocket 连接 (默认)
Bot 主动连接 OneBot 实现(如 NapCatQQ
**流程**
@@ -63,6 +66,23 @@ Bot 启动 → 连接到 NapCatQQ (ws://127.0.0.1:3001)
调用 API 回复
```
#### 2. 反向 WebSocket 连接
OneBot 客户端主动连接 Bot 提供的 WebSocket 服务。
**流程**
```
Bot 启动反向 WS 服务 (监听 0.0.0.0:3002)
NapCatQQ 主动连接到 Bot
监听消息事件
分发到处理器
调用 API 回复
```
## 3. 资源管理架构
### 单例管理器

View File

@@ -65,6 +65,34 @@
* **记性好**: 模板用一次就记住,下次直接用缓存。
* **自动借还**: 它会自动找 `BrowserManager` 借页面,你只管 `render_template` 就行。
### 8. `BotManager` (`bot_manager`)
* **怎么找**: `from core.managers.bot_manager import bot_manager`
* **管啥**:
* **Bot 实例管理**: 统一管理 Bot 实例,方便在任何地方获取当前运行的 Bot。
* **生命周期**: 协助管理 Bot 的启动和关闭流程。
### 9. `MysqlManager` (`mysql_manager`)
* **怎么找**: `from core.managers.mysql_manager import mysql_manager`
* **管啥**:
* **数据库连接**: 管理与 MySQL 数据库的异步连接池。
* **数据持久化**: 提供执行 SQL 语句的接口,用于需要长期保存的数据。
### 10. `ReverseWsManager` (`reverse_ws_manager`)
* **怎么找**: `from core.managers.reverse_ws_manager import reverse_ws_manager`
* **管啥**:
* **反向 WS 服务**: 启动并管理反向 WebSocket 服务器,允许 OneBot 客户端主动连接 Bot。
* **连接管理**: 处理客户端的连接、断开和消息接收。
### 11. `ThreadManager` (`thread_manager`)
* **怎么找**: `from core.managers.thread_manager import thread_manager`
* **管啥**:
* **线程池管理**: 提供全局的线程池执行器,用于执行阻塞的同步任务。
* **异步桥接**: 方便地将同步函数转换为异步调用,避免阻塞事件循环。
## 咋用?
`import`