4.4 KiB
4.4 KiB
核心概念:事件流转
别管那些花里胡哨的,NEO Bot 的核心就是事件驱动。搞懂一个事件从哪来、到哪去,你就懂了一大半。
下面就拿 /echo hello 这条傻瓜命令开刀,看看它在 Bot 内部是怎么裸奔的。
事件流转图
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 字符串。- 注: 这里用了
orjson,反序列化速度飞快。
2. 变成对象 (models/events/factory.py)
ws.py拿到 JSON 后,扔给EventFactory.create_event()。- 工厂类眼疾手快,看一眼
post_type是"message",message_type是"group",直接把它变成一个GroupMessageEvent对象。 - 这时候它就不是一堆冷冰冰的 JSON 了,而是个活生生的 Python 对象,有属性有方法,写代码的时候 IDE 还能给你补全。
3. 塞点东西,准备分发 (core/ws.py)
ws.py拿到这个对象后,干两件事:- 塞 Bot 实例:把
self.bot塞进event.bot里。这样你在插件里拿到事件,就能直接event.reply()回复,不用到处找 Bot 实例。 - 扔出去:把事件扔给
matcher.handle_event(bot, event),也就是命令管理器。
- 塞 Bot 实例:把
4. 找找谁来处理 (core/managers/command_manager.py)
CommandManager(就是代码里的matcher) 是个大管家。- 它看了一眼:“哟,是条消息”,然后转手交给
MessageHandler。 MessageHandler拿着放大镜看消息内容:“是以/开头的吗?”- 如果是
/echo,它就去翻小本本(注册的命令列表),找到了plugins/echo.py里那个被@matcher.command("echo")标记的函数。
5. 干活 (plugins/echo.py)
- 找到了正主,直接调用它,把
Event对象和参数args传进去。 - 这时候就是你写的代码在跑了。你想干啥都行,查数据库、调 API、或者直接复读。
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" 发到了群里。
- 完事。
至此,一个完整的事件流转闭环就完成了。理解这个流程后,您就能明白框架是如何将底层的网络通信与高层的插件逻辑解耦,并为开发者提供便捷接口的。