docs: 更新文档内容,简化语言并修正格式
- 简化插件开发指南中的描述,移除冗余内容 - 调整部署文档中的Python版本说明 - 优化最佳实践文档的措辞和格式 - 更新性能优化文档,删除不准确的数据 - 重构核心概念文档,使用更简洁的语言 - 修正README中的项目描述和技术栈说明 - 更新快速上手文档,简化安装步骤 - 调整事件流转文档的描述方式 - 简化架构文档内容 - 更新指令处理文档,添加参数注入示例 - 优化单例管理器文档的表述
This commit is contained in:
@@ -1,8 +1,8 @@
|
||||
# 核心概念:事件流转
|
||||
|
||||
别管那些花里胡哨的,NEO Bot 的核心就是**事件驱动**。搞懂一个事件从哪来、到哪去,你就懂了一大半。
|
||||
NEO Bot 的核心就是**事件驱动**。搞懂一个事件从哪来、到哪去,你就懂了一大半。
|
||||
|
||||
下面就拿 `/echo hello` 这条傻瓜命令开刀,看看它在 Bot 内部是怎么裸奔的。
|
||||
下面就拿 `/echo hello` 举例
|
||||
|
||||
## 事件流转图
|
||||
|
||||
@@ -61,13 +61,12 @@ graph TD
|
||||
|
||||
* 你在群里发了条消息,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 还能给你补全。
|
||||
* 工厂类看一眼 `post_type` 是 `"message"`,`message_type` 是 `"group"`,会包装成 `GroupMessageEvent` 对象。
|
||||
* 这时候是python对象了,有属性有方法,感觉很方便。。。
|
||||
|
||||
### 3. 塞点东西,准备分发 (`core/ws.py`)
|
||||
|
||||
@@ -77,25 +76,25 @@ graph TD
|
||||
|
||||
### 4. 找找谁来处理 (`core/managers/command_manager.py`)
|
||||
|
||||
* `CommandManager` (就是代码里的 `matcher`) 是个大管家。
|
||||
* 它看了一眼:“哟,是条消息”,然后转手交给 `MessageHandler`。
|
||||
* `MessageHandler` 拿着放大镜看消息内容:“是以 `/` 开头的吗?”
|
||||
* 如果是 `/echo`,它就去翻小本本(注册的命令列表),找到了 `plugins/echo.py` 里那个被 `@matcher.command("echo")` 标记的函数。
|
||||
* `CommandManager` (就是代码里的 `matcher`)
|
||||
* 它看了一眼,然后转手交给 `MessageHandler`。
|
||||
* `MessageHandler` 看消息内容是以 `/` 开头的吗?”
|
||||
* 如果是 `/echo`,已经注册的指令列表,找到了 `plugins/echo.py` 里那个被 `@matcher.command("echo")` 标记的函数。
|
||||
|
||||
### 5. 干活 (`plugins/echo.py`)
|
||||
|
||||
* 找到了正主,直接调用它,把 `Event` 对象和参数 `args` 传进去。
|
||||
* 这时候就是你写的代码在跑了。你想干啥都行,查数据库、调 API、或者直接复读。
|
||||
* 直接调用它,把 `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。
|
||||
* 然后 `core/ws.py` 把这个请求变成 JSON,通过 WebSocket 扔回给 OneBot。
|
||||
|
||||
### 7. 发送成功
|
||||
|
||||
* OneBot 收到请求,把 "hello" 发到了群里。
|
||||
* 完事。
|
||||
* 恩。。。
|
||||
|
||||
至此,一个完整的事件流转闭环就完成了。理解这个流程后,您就能明白框架是如何将底层的网络通信与高层的插件逻辑解耦,并为开发者提供便捷接口的。
|
||||
至此,一个完整的事件流转闭环就完成了。理解这个流程后,您就能明白框架是如何为开发者提供便捷接口的。
|
||||
|
||||
Reference in New Issue
Block a user