refactor(core): 重构核心模块结构并添加开发文档

将核心模块按功能重新组织为更清晰的结构,包括 managers、handlers 和 utils 目录
添加完整的开发文档,涵盖快速开始、项目结构、核心概念和插件开发指南
更新所有相关模块的导入路径以匹配新的结构
将单例模式实现提取到单独的 singleton.py 文件
This commit is contained in:
2026-01-07 22:51:27 +08:00
parent c708761726
commit 56b1014419
45 changed files with 772 additions and 104 deletions

View File

@@ -0,0 +1,88 @@
# 插件开发:基础指南
在 NEO Bot Framework 中,几乎所有的功能都是通过**插件**来实现的。框架提供了一个强大而简单的插件系统,让您可以专注于功能逻辑的实现。
## 插件是什么?
一个插件本质上就是一个位于 `plugins/` 目录下的独立 Python 文件 (`.py`)。
框架会在启动时自动扫描并加载这个目录下的所有文件作为插件。
## 🔥 热重载工作流
在开始编写插件之前,了解框架的**热重载**机制至关重要,它能极大地提升您的开发效率。
1. **启动机器人**: 首先,在您的终端中运行 `python main.py` 并保持其运行状态。
2. **创建或修改插件**: 在 `plugins/` 目录下创建新的 `.py` 文件,或者修改一个已有的插件文件。
3. **保存文件**: 当您保存文件时,框架会自动检测到文件变更。
4. **自动重载**: 控制台会显示 `插件重载完成` 的日志,这意味着您的新代码已经生效,无需重启整个程序。
## 创建您的第一个插件
让我们来创建一个经典的 "Hello World" 插件。
### 1. 创建文件
`plugins/` 目录下创建一个新文件,命名为 `hello.py`
### 2. 定义插件元数据 (`__plugin_meta__`)
为了让框架能够识别您的插件信息(例如在 `/help` 命令中显示),您需要在文件顶部定义一个名为 `__plugin_meta__` 的特殊字典。
```python
# plugins/hello.py
__plugin_meta__ = {
"name": "你好世界",
"description": "一个简单的插件,用于回复 'Hello, World!'",
"usage": "/hello - 发送问候。",
}
```
* `name`: 插件的名称。
* `description`: 插件功能的简短描述。
* `usage`: 插件的使用方法说明。
### 3. 编写处理器
现在,让我们来编写一个响应 `/hello` 指令的函数。我们需要从框架中导入 `matcher` 和事件类型。
```python
# plugins/hello.py
from core.managers.command_manager import matcher
from models.events.message import MessageEvent
__plugin_meta__ = {
"name": "你好世界",
"description": "一个简单的插件,用于回复 'Hello, World!'",
"usage": "/hello - 发送问候。",
}
# 使用 @matcher.command 装饰器来注册一个指令
@matcher.command("hello")
async def handle_hello_command(event: MessageEvent):
"""
当用户发送 /hello 时,此函数将被调用。
"""
# 使用 event.reply() 方法可以快速回复消息到来源地
await event.reply("Hello, World!")
```
### 4. 测试插件
1. 确保 `python main.py` 正在运行。
2. 保存 `plugins/hello.py` 文件。您应该会在控制台看到插件重载的日志。
3. 在任何一个机器人所在的群聊或私聊中,发送 `/hello`
4. 机器人应该会回复 `Hello, World!`
恭喜!您已经成功创建并运行了您的第一个插件。
## 插件的最佳实践
* **保持独立**: 尽量让每个插件文件只负责一项相关的功能。
* **清晰命名**: 为您的插件文件和处理函数选择清晰、描述性的名称。
* **善用模型**: 充分利用 `models` 中定义的事件和消息段类型,以获得完整的类型提示和代码补全支持。
* **异步优先**: 框架是基于 `asyncio` 构建的。对于任何 I/O 密集型操作(如网络请求、文件读写),请务必使用 `async/await` 语法,以避免阻塞事件循环。
现在您已经掌握了插件的基础,可以继续学习更高级的主题,例如[如何处理带参数的指令](./command-handling.md)。