K2cr2O1
7f331970dd
- 简化插件开发指南中的描述，移除冗余内容 - 调整部署文档中的Python版本说明 - 优化最佳实践文档的措辞和格式 - 更新性能优化文档，删除不准确的数据 - 重构核心概念文档，使用更简洁的语言 - 修正README中的项目描述和技术栈说明 - 更新快速上手文档，简化安装步骤 - 调整事件流转文档的描述方式 - 简化架构文档内容 - 更新指令处理文档，添加参数注入示例 - 优化单例管理器文档的表述
101 lines
4.0 KiB
Markdown
101 lines
4.0 KiB
Markdown
# 核心概念：事件流转
|
||
|
||
NEO Bot 的核心就是**事件驱动**。搞懂一个事件从哪来、到哪去，你就懂了一大半。
|
||
|
||
下面就拿 `/echo hello` 举例
|
||
|
||
## 事件流转图
|
||
|
||
```mermaid
|
||
graph TD
|
||
%% 定义样式
|
||
classDef external fill:#e1f5fe,stroke:#01579b,stroke-width:2px;
|
||
classDef network fill:#fff9c4,stroke:#fbc02d,stroke-width:2px;
|
||
classDef core fill:#e8f5e9,stroke:#2e7d32,stroke-width:2px;
|
||
classDef plugin fill:#fce4ec,stroke:#c2185b,stroke-width:2px;
|
||
|
||
subgraph External [外部环境]
|
||
OneBot["OneBot v11 实现端<br/>(如 NapCatQQ)"]:::external
|
||
end
|
||
|
||
subgraph NeoBot [NEO Bot Framework]
|
||
direction TB
|
||
|
||
subgraph Network [网络接入层]
|
||
WS["WebSocket 连接<br/>core/ws.py"]:::network
|
||
end
|
||
|
||
subgraph Processing [核心处理层]
|
||
Factory["事件工厂<br/>models/events/factory.py"]:::core
|
||
Dispatcher["命令管理器<br/>core/managers/command_manager.py"]:::core
|
||
Handler["事件处理器<br/>core/handlers/event_handler.py"]:::core
|
||
BotAPI["Bot API 封装<br/>core/bot.py"]:::core
|
||
end
|
||
|
||
subgraph Plugins [业务插件层]
|
||
UserPlugin["用户插件<br/>plugins/*.py"]:::plugin
|
||
end
|
||
end
|
||
|
||
%% 事件上报流程 (实线)
|
||
OneBot -- "1. WebSocket 消息" --> WS
|
||
WS -- "2. 原始 JSON" --> Factory
|
||
Factory -- "3. Event 对象" --> WS
|
||
WS -- "4. 分发事件" --> Dispatcher
|
||
Dispatcher -- "5. 匹配指令/事件" --> Handler
|
||
Handler -- "6. 调用处理函数" --> UserPlugin
|
||
|
||
%% API 调用流程 (虚线)
|
||
UserPlugin -. "7. 调用 bot.send()" .-> BotAPI
|
||
BotAPI -. "8. 封装 API 请求" .-> WS
|
||
WS -. "9. 发送 JSON" .-> OneBot
|
||
|
||
%% 链接样式
|
||
linkStyle 0,1,2,3,4,5 stroke:#333,stroke-width:2px;
|
||
linkStyle 6,7,8 stroke:#666,stroke-width:2px,stroke-dasharray: 5 5;
|
||
```
|
||
|
||
## 详细步骤
|
||
|
||
### 1. 接收 WebSocket 消息 (`core/ws.py`)
|
||
|
||
* 你在群里发了条消息，OneBot (比如 NapCatQQ) 就会把它打包成一个 JSON，通过 WebSocket 扔给 Bot。
|
||
* `core/ws.py` 里的 `_listen_loop` 一直在那蹲着，收到这个 JSON 字符串。
|
||
|
||
### 2. 变成对象 (`models/events/factory.py`)
|
||
|
||
* `ws.py` 拿到 JSON 后，扔给 `EventFactory.create_event()`。
|
||
* 工厂类看一眼 `post_type` 是 `"message"`，`message_type` 是 `"group"`，会包装成 `GroupMessageEvent` 对象。
|
||
* 这时候是python对象了，有属性有方法，感觉很方便。。。
|
||
|
||
### 3. 塞点东西，准备分发 (`core/ws.py`)
|
||
|
||
* `ws.py` 拿到这个对象后，干两件事：
|
||
1. **塞 Bot 实例**：把 `self.bot` 塞进 `event.bot` 里。这样你在插件里拿到事件，就能直接 `event.reply()` 回复，不用到处找 Bot 实例。
|
||
2. **扔出去**：把事件扔给 `matcher.handle_event(bot, event)`，也就是命令管理器。
|
||
|
||
### 4. 找找谁来处理 (`core/managers/command_manager.py`)
|
||
|
||
* `CommandManager` (就是代码里的 `matcher`)
|
||
* 它看了一眼，然后转手交给 `MessageHandler`。
|
||
* `MessageHandler` 看消息内容是以 `/` 开头的吗？”
|
||
* 如果是 `/echo`，已经注册的指令列表，找到了 `plugins/echo.py` 里那个被 `@matcher.command("echo")` 标记的函数。
|
||
|
||
### 5. 干活 (`plugins/echo.py`)
|
||
|
||
* 直接调用它，把 `Event` 对象和参数 `args` 传进去。
|
||
* 这时候就是你写的代码在跑了。你想干啥都行。。。
|
||
|
||
### 6. 回复消息 (`core/bot.py` -> `core/ws.py`)
|
||
|
||
* 你在插件里写了 `await event.reply("hello")`。
|
||
* 这行代码背后，是 `core/bot.py` 把你的话封装成了一个标准的 OneBot API 请求（`send_group_msg`）。
|
||
* 然后 `core/ws.py` 把这个请求变成 JSON，通过 WebSocket 扔回给 OneBot。
|
||
|
||
### 7. 发送成功
|
||
|
||
* OneBot 收到请求，把 "hello" 发到了群里。
|
||
* 恩。。。
|
||
|
||
至此，一个完整的事件流转闭环就完成了。理解这个流程后，您就能明白框架是如何为开发者提供便捷接口的。
|