refactor(core): 重构核心模块结构并添加开发文档
将核心模块按功能重新组织为更清晰的结构,包括 managers、handlers 和 utils 目录 添加完整的开发文档,涵盖快速开始、项目结构、核心概念和插件开发指南 更新所有相关模块的导入路径以匹配新的结构 将单例模式实现提取到单独的 singleton.py 文件
This commit is contained in:
99
docs/plugin-development/command-handling.md
Normal file
99
docs/plugin-development/command-handling.md
Normal file
@@ -0,0 +1,99 @@
|
||||
# 插件开发:指令处理
|
||||
|
||||
`@matcher.command()` 是插件开发中使用最频繁的装饰器。本节将深入介绍它的高级用法,帮助您构建功能更强大的指令。
|
||||
|
||||
## 1. 获取指令参数
|
||||
|
||||
在很多场景下,指令都需要接收用户提供的参数,例如 `/weather 北京`。框架会自动解析这些参数,并通过函数签名注入到您的处理器中。
|
||||
|
||||
您只需要在处理函数的参数列表中添加一个名为 `args` 的参数,并指定其类型为 `list[str]`。
|
||||
|
||||
```python
|
||||
# plugins/weather.py
|
||||
from core.managers.command_manager import matcher
|
||||
from models.events.message import MessageEvent
|
||||
|
||||
@matcher.command("weather")
|
||||
async def handle_weather_command(event: MessageEvent, args: list[str]):
|
||||
"""
|
||||
处理 /weather 指令
|
||||
:param event: 消息事件对象
|
||||
:param args: 用户发送的参数列表 (已按空格分割)
|
||||
"""
|
||||
if not args:
|
||||
await event.reply("请输入城市名,例如:/weather 北京")
|
||||
return
|
||||
|
||||
# args[0] 就是 "北京"
|
||||
city = args[0]
|
||||
|
||||
# ...后续逻辑...
|
||||
await event.reply(f"正在查询 {city} 的天气...")
|
||||
```
|
||||
|
||||
* 如果用户发送 `/weather 北京`,`args` 将是 `['北京']`。
|
||||
* 如果用户发送 `/weather 上海 浦东`,`args` 将是 `['上海', '浦东']`。
|
||||
* 如果用户只发送 `/weather`,`args` 将是一个空列表 `[]`。
|
||||
|
||||
## 2. 设置指令别名
|
||||
|
||||
同一个功能,用户可能习惯使用不同的指令名称来触发,例如 `天气` 和 `weather`。`@matcher.command()` 允许您为一个处理器设置多个别名。
|
||||
|
||||
只需在装饰器中传入多个名称即可:
|
||||
|
||||
```python
|
||||
@matcher.command("weather", "天气")
|
||||
async def handle_weather_command(event: MessageEvent, args: list[str]):
|
||||
# ...
|
||||
```
|
||||
|
||||
现在,用户发送 `/weather 北京` 或 `/天气 北京` 都可以触发这个函数。
|
||||
|
||||
## 3. 权限控制
|
||||
|
||||
某些敏感指令只希望特定权限的用户才能执行,例如 `/reload` (重载插件) 或 `/ban` (禁言用户)。
|
||||
|
||||
`@matcher.command()` 装饰器提供了一个 `permission` 参数,可以轻松实现权限控制。
|
||||
|
||||
首先,从 `permission_manager` 导入预设的权限等级:
|
||||
|
||||
```python
|
||||
from core.managers.permission_manager import ADMIN, OP, USER
|
||||
```
|
||||
|
||||
然后,在装饰器中指定所需的权限:
|
||||
|
||||
```python
|
||||
# plugins/admin_tools.py
|
||||
from core.managers.command_manager import matcher
|
||||
from core.managers.permission_manager import ADMIN
|
||||
from models.events.message import MessageEvent
|
||||
|
||||
__plugin_meta__ = {
|
||||
"name": "管理工具",
|
||||
"description": "提供机器人管理功能",
|
||||
"usage": "/reload - 重载所有插件 (仅管理员)",
|
||||
}
|
||||
|
||||
@matcher.command("reload", permission=ADMIN)
|
||||
async def handle_reload_command(event: MessageEvent):
|
||||
"""
|
||||
重载所有插件,仅限管理员使用。
|
||||
"""
|
||||
# 这里的逻辑只有在权限检查通过后才会执行
|
||||
await event.reply("正在重载所有插件...")
|
||||
# ... 执行重载逻辑 ...
|
||||
```
|
||||
|
||||
* **工作原理**: 在调用您的处理函数之前,`CommandManager` 会自动调用 `PermissionManager` 来检查用户的权限。
|
||||
* **失败响应**: 如果用户权限不足,框架会自动回复一条权限不足的消息(该消息内容可在 `config.toml` 中配置),并且**不会**执行您的处理函数。
|
||||
|
||||
可用的权限等级:
|
||||
|
||||
* `ADMIN`: 机器人超级管理员。
|
||||
* `OP`: 管理员(Operator),权限低于 `ADMIN`。
|
||||
* `USER`: 普通用户,默认权限。
|
||||
|
||||
权限关系是 `ADMIN > OP > USER`。设置 `permission=OP` 意味着 `OP` 和 `ADMIN` 都可以使用该指令。
|
||||
|
||||
通过组合使用参数处理、别名和权限控制,您可以构建出既灵活又安全的指令来满足各种复杂的需求。
|
||||
88
docs/plugin-development/index.md
Normal file
88
docs/plugin-development/index.md
Normal 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)。
|
||||
Reference in New Issue
Block a user