docs: 更新文档内容并优化语言风格
重构所有文档内容，使用更简洁直接的语言风格 更新架构、插件开发、部署等核心文档 优化代码示例和图表说明 统一术语和格式规范
This commit is contained in:
@@ -1,99 +1,90 @@
|
||||
# 插件开发：指令处理
|
||||
# 指令处理与参数解析
|
||||
|
||||
`@matcher.command()` 是插件开发中使用最频繁的装饰器。本节将深入介绍它的高级用法，帮助您构建功能更强大的指令。
|
||||
光会 `event.reply()` 只能写玩具。正经的插件，都得和用户传进来的参数打交道。
|
||||
|
||||
## 1. 获取指令参数
|
||||
## 1. 获取原始参数
|
||||
|
||||
在很多场景下，指令都需要接收用户提供的参数，例如 `/weather 北京`。框架会自动解析这些参数，并通过函数签名注入到您的处理器中。
|
||||
|
||||
您只需要在处理函数的参数列表中添加一个名为 `args` 的参数，并指定其类型为 `list[str]`。
|
||||
最简单粗暴的方式，就是直接在处理器函数里声明 `args: 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: 用户发送的参数列表 (已按空格分割)
|
||||
"""
|
||||
@matcher.command("echo")
|
||||
async def handle_echo(event: MessageEvent, args: str):
|
||||
# 如果用户发送 /echo hello world
|
||||
# args 的值就是 "hello world"
|
||||
if not args:
|
||||
await event.reply("请输入城市名，例如：/weather 北京")
|
||||
return
|
||||
|
||||
# args[0] 就是 "北京"
|
||||
city = args[0]
|
||||
|
||||
# ...后续逻辑...
|
||||
await event.reply(f"正在查询 {city} 的天气...")
|
||||
await event.reply("你啥也没说啊。")
|
||||
else:
|
||||
await event.reply(f"你说了：{args}")
|
||||
```
|
||||
|
||||
* 如果用户发送 `/weather 北京`，`args` 将是 `['北京']`。
|
||||
* 如果用户发送 `/weather 上海 浦东`，`args` 将是 `['上海', '浦东']`。
|
||||
* 如果用户只发送 `/weather`，`args` 将是一个空列表 `[]`。
|
||||
`args` 就是去掉命令本身后，后面跟着的**一整坨字符串**。
|
||||
|
||||
## 2. 设置指令别名
|
||||
## 2. 自动解析参数 (推荐)
|
||||
|
||||
同一个功能，用户可能习惯使用不同的指令名称来触发，例如 `天气` 和 `weather`。`@matcher.command()` 允许您为一个处理器设置多个别名。
|
||||
一整坨字符串用起来太费劲了，还得自己 `split()`。框架提供了更高级的玩法：**参数自动解析**。
|
||||
|
||||
只需在装饰器中传入多个名称即可：
|
||||
你只需要在函数签名里，用类型提示声明你想要的参数，框架会像 FastAPI 一样，自动帮你解析和注入。
|
||||
|
||||
### a. 基础用法
|
||||
|
||||
```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("正在重载所有插件...")
|
||||
# ... 执行重载逻辑 ...
|
||||
@matcher.command("add")
|
||||
async def handle_add(event: MessageEvent, a: int, b: int):
|
||||
# 如果用户发送 /add 10 20
|
||||
# 框架会自动把 "10" 转成整数 10，注入给 a
|
||||
# 把 "20" 转成整数 20，注入给 b
|
||||
result = a + b
|
||||
await event.reply(f"计算结果是：{result}")
|
||||
```
|
||||
|
||||
* **工作原理**: 在调用您的处理函数之前，`CommandManager` 会自动调用 `PermissionManager` 来检查用户的权限。
|
||||
* **失败响应**: 如果用户权限不足，框架会自动回复一条权限不足的消息（该消息内容可在 `config.toml` 中配置），并且**不会**执行您的处理函数。
|
||||
**它是怎么工作的？**
|
||||
|
||||
可用的权限等级：
|
||||
框架会按顺序把 `args` 字符串用空格分割，然后尝试把分割后的每一块，转换成你声明的参数类型。
|
||||
|
||||
* `ADMIN`: 机器人超级管理员。
|
||||
* `OP`: 管理员（Operator），权限低于 `ADMIN`。
|
||||
* `USER`: 普通用户，默认权限。
|
||||
* `/add 10 20` -> `args` 是 `"10 20"` -> 分割成 `["10", "20"]`
|
||||
* 第一块 `"10"` -> 尝试转成 `int` -> 成功，`a = 10`
|
||||
* 第二块 `"20"` -> 尝试转成 `int` -> 成功，`b = 20`
|
||||
|
||||
权限关系是 `ADMIN > OP > USER`。设置 `permission=OP` 意味着 `OP` 和 `ADMIN` 都可以使用该指令。
|
||||
### b. 处理可选参数和默认值
|
||||
|
||||
通过组合使用参数处理、别名和权限控制，您可以构建出既灵活又安全的指令来满足各种复杂的需求。
|
||||
你可以像普通 Python 函数一样，给参数提供默认值。
|
||||
|
||||
```python
|
||||
from typing import Optional
|
||||
|
||||
@matcher.command("greet")
|
||||
async def handle_greet(event: MessageEvent, name: str, title: Optional[str] = "先生"):
|
||||
# 例 1: /greet 张三
|
||||
# name = "张三", title = "先生" (默认值)
|
||||
|
||||
# 例 2: /greet 李四 女士
|
||||
# name = "李四", title = "女士"
|
||||
|
||||
await event.reply(f"你好，{name} {title}！")
|
||||
```
|
||||
|
||||
### c. 贪婪的最后一个参数
|
||||
|
||||
有时候，最后一个参数可能包含空格，比如 `/say hello world`。默认情况下，`hello` 会被解析给第一个参数，`world` 会被解析给第二个。
|
||||
|
||||
如果你想让最后一个参数“吃掉”所有剩下的内容，可以用 `...` 作为默认值（这是一个特殊的标记）。
|
||||
|
||||
```python
|
||||
@matcher.command("say")
|
||||
async def handle_say(event: MessageEvent, target_user: str, content: str = ...):
|
||||
# 例: /say 张三 早上好，吃了没？
|
||||
# target_user = "张三"
|
||||
# content = "早上好，吃了没？"
|
||||
|
||||
await event.reply(f"正在对 {target_user} 说：{content}")
|
||||
```
|
||||
|
||||
## 3. 更复杂的解析：依赖注入
|
||||
|
||||
如果你的参数不是简单的 `int` 或 `str`，或者你需要更复杂的解析逻辑（比如 `@某人`），请参考 `FastAPI` 的依赖注入系统，我们用了同一套逻辑。
|
||||
|
||||
@@ -1,51 +1,10 @@
|
||||
# 插件开发：基础指南
|
||||
# 插件开发入门
|
||||
|
||||
在 NEO Bot Framework 中，几乎所有的功能都是通过**插件**来实现的。框架提供了一个强大而简单的插件系统，让您可以专注于功能逻辑的实现。
|
||||
写插件是给 NEO Bot 添加功能的唯一方式。这玩意儿很简单，一个 Python 文件就是一个插件。
|
||||
|
||||
## 插件是什么？
|
||||
## 1. 创建你的第一个插件
|
||||
|
||||
一个插件本质上就是一个位于 `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` 和事件类型。
|
||||
在 `plugins/` 目录下，新建一个 `hello.py` 文件。
|
||||
|
||||
```python
|
||||
# plugins/hello.py
|
||||
@@ -53,36 +12,65 @@ __plugin_meta__ = {
|
||||
from core.managers.command_manager import matcher
|
||||
from models.events.message import MessageEvent
|
||||
|
||||
# __plugin_meta__ 是插件元信息，会在 /help 指令里显示
|
||||
__plugin_meta__ = {
|
||||
"name": "你好世界",
|
||||
"description": "一个简单的插件，用于回复 'Hello, World!'。",
|
||||
"usage": "/hello - 发送问候。",
|
||||
"description": "一个简单的示例插件",
|
||||
"usage": "/hello - 发送你好"
|
||||
}
|
||||
|
||||
# 使用 @matcher.command 装饰器来注册一个指令
|
||||
@matcher.command("hello")
|
||||
async def handle_hello_command(event: MessageEvent):
|
||||
# @matcher.command() 装饰器注册一个命令
|
||||
# "hello" 是命令名，aliases 是别名
|
||||
@matcher.command("hello", aliases=["hi", "你好"])
|
||||
async def handle_hello(event: MessageEvent):
|
||||
"""
|
||||
当用户发送 /hello 时，此函数将被调用。
|
||||
处理 /hello 命令
|
||||
"""
|
||||
# 使用 event.reply() 方法可以快速回复消息到来源地
|
||||
await event.reply("Hello, World!")
|
||||
# event.reply() 是一个快捷方法，可以直接回复消息
|
||||
await event.reply(f"你好，{event.sender.nickname}！")
|
||||
|
||||
```
|
||||
|
||||
### 4. 测试插件
|
||||
## 2. 加载插件
|
||||
|
||||
1. 确保 `python main.py` 正在运行。
|
||||
2. 保存 `plugins/hello.py` 文件。您应该会在控制台看到插件重载的日志。
|
||||
3. 在任何一个机器人所在的群聊或私聊中，发送 `/hello`。
|
||||
4. 机器人应该会回复 `Hello, World!`。
|
||||
不用你动手，NEO Bot 启动时会自动加载 `plugins/` 目录下的所有 `.py` 文件。
|
||||
|
||||
恭喜！您已经成功创建并运行了您的第一个插件。
|
||||
如果你是在 Bot 运行时新增或修改了插件，只需要在控制台输入 `reload` 命令，或者让管理员在群里发 `/reload`，就能热重载所有插件。
|
||||
|
||||
## 插件的最佳实践
|
||||
## 3. 测试插件
|
||||
|
||||
* **保持独立**: 尽量让每个插件文件只负责一项相关的功能。
|
||||
* **清晰命名**: 为您的插件文件和处理函数选择清晰、描述性的名称。
|
||||
* **善用模型**: 充分利用 `models` 中定义的事件和消息段类型，以获得完整的类型提示和代码补全支持。
|
||||
* **异步优先**: 框架是基于 `asyncio` 构建的。对于任何 I/O 密集型操作（如网络请求、文件读写），请务必使用 `async/await` 语法，以避免阻塞事件循环。
|
||||
现在，去群里或者私聊给 Bot 发送：
|
||||
|
||||
现在您已经掌握了插件的基础，可以继续学习更高级的主题，例如[如何处理带参数的指令](./command-handling.md)。
|
||||
* `/hello`
|
||||
* `/hi`
|
||||
* `/你好`
|
||||
|
||||
Bot 应该会回复你：“你好，[你的昵称]！”
|
||||
|
||||
## 插件剖析
|
||||
|
||||
### `__plugin_meta__`
|
||||
|
||||
这个字典不是必须的，但强烈建议写上。它定义了插件的元信息，主要给 `/help` 命令用。
|
||||
|
||||
* `name`: 插件叫啥。
|
||||
* `description`: 这插件是干嘛的。
|
||||
* `usage`: 怎么用，写上具体的指令和说明。
|
||||
|
||||
### `@matcher.command()`
|
||||
|
||||
这是最核心的装饰器，用来注册一个命令处理器。
|
||||
|
||||
* **第一个参数**: `name` (str)，命令的主名。
|
||||
* `aliases`: `List[str]`，命令的别名列表。
|
||||
* `permission`: `int`，执行该命令所需的权限等级，默认为 `USER` (所有人可用)。可以是 `ADMIN`, `OP`。
|
||||
|
||||
### 处理器函数
|
||||
|
||||
被 `@matcher.command()` 装饰的函数就是处理器。它必须是一个 `async` 异步函数。
|
||||
|
||||
* **参数**: 框架会自动往里注入参数，你只需要用类型提示声明你需要什么。
|
||||
* `event: MessageEvent`: 这是最常用的，包含了消息的所有信息，比如发送者、群号、消息内容等。
|
||||
* `args: str`: 如果命令有参数（比如 `/echo hello world`），`args` 就是 `hello world` 这部分字符串。
|
||||
|
||||
就这么简单，一个最基础的插件就写完了。
|
||||
|
||||
Reference in New Issue
Block a user