Dev (#36)
* 滚木 * feat: 重构核心架构，增强类型安全与插件管理 本次提交对核心模块进行了深度重构，引入 Pydantic 增强配置管理的类型安全性，并全面优化了插件管理系统。 主要变更详情： 1. 核心架构与配置 - 重构配置加载模块：引入 Pydantic 模型 (`core/config_models.py`)，提供严格的配置项类型检查、验证及默认值管理。 - 统一模块结构：规范化模块导入路径，移除冗余的 `__init__.py` 文件，提升项目结构的清晰度。 - 性能优化：集成 Redis 缓存支持 (`RedisManager`)，有效降低高频 API 调用开销，提升响应速度。 2. 插件系统升级 - 实现热重载机制：新增插件文件变更监听功能，支持开发过程中自动重载插件，提升开发效率。 - 优化生命周期管理：改进插件加载与卸载逻辑，支持精确卸载指定插件及其关联的命令、事件处理器和定时任务。 3. 功能特性增强 - 新增媒体 API：引入 `MediaAPI` 模块，封装图片、语音等富媒体资源的获取与处理接口。 - 完善权限体系：重构权限管理系统，实现管理员与操作员的分级控制，支持更细粒度的命令权限校验。 4. 代码质量与稳定性 - 全面类型修复：解决 `mypy` 静态类型检查发现的大量类型错误（包括 `CommandManager`、`EventFactory` 及 `Bot` API 签名不匹配问题）。 - 增强错误处理：优化消息处理管道的异常捕获机制，完善关键路径的日志记录，提升系统运行稳定性。 * feat: 添加测试用例并优化代码结构 refactor(permission_manager): 调整初始化顺序和逻辑 fix(admin_manager): 修复初始化逻辑和目录创建问题 feat(ws): 优化Bot实例初始化条件 feat(message): 增强MessageSegment功能并添加测试 feat(events): 支持字符串格式的消息解析 test: 添加核心功能测试用例 refactor(plugin_manager): 改进插件路径处理 style: 清理无用导入和代码 chore: 更新依赖项 * refactor(handler): 移除TYPE_CHECKING并直接导入Bot类 简化类型注解，直接导入Bot类而非使用TYPE_CHECKING条件导入，提高代码可读性和维护性 * fix(command_manager): 修复插件卸载时元信息移除不精确的问题 修复 CommandManager 中 unload_plugin 方法移除插件元信息时使用 startswith 导致可能误删其他插件的问题，改为精确匹配 同时调整相关测试用例验证精确匹配行为 * refactor: 清理未使用的导入和更新文档结构 docs: 添加config_models.py到项目结构文档 docs: 调整数据目录位置到core/data下 docs: 更新权限管理器文档描述 * 文档更新 * 更新thpic插件 支持一次返回多张图 * feat: 添加测试覆盖率并修复相关问题 refactor(redis_manager): 移除冗余的ConnectionError处理 refactor(event_handler): 优化Bot类型注解 refactor(factory): 移除未使用的GroupCardNoticeEvent test: 添加全面的单元测试覆盖 - 添加test_import.py测试模块导入 - 添加test_debug.py测试插件加载调试 - 添加test_plugin_error.py测试错误处理 - 添加test_config_loader.py测试配置加载 - 添加test_redis_manager.py测试Redis管理 - 添加test_bot.py测试Bot功能 - 扩展test_models.py测试消息模型 - 添加test_plugin_manager_coverage.py测试插件管理 - 添加test_executor.py测试代码执行器 - 添加test_ws.py测试WebSocket - 添加test_api.py测试API接口 - 添加test_core_managers.py测试核心管理模块 fix(plugin_manager): 修复插件加载日志变量问题 覆盖率已到达86%（忽略插件） * 更新/help指令，现在会发送图片 * feat(help): 重构帮助系统为图片渲染模式 添加浏览器管理器和图片管理器，用于通过 Playwright 渲染帮助菜单为图片 重构命令管理器以支持图片缓存和同步功能 添加 HTML 模板用于帮助菜单渲染 * build: 更新依赖文件 requirements.txt * build: 更新依赖文件 * feat: 添加性能优化和架构文档，更新依赖和核心模块 refactor(browser_manager): 实现页面池机制以提升性能 refactor(image_manager): 添加模板缓存并集成页面池 refactor(bili_parser): 迁移到异步HTTP请求并实现会话复用 docs: 新增性能优化、架构设计和最佳实践文档 chore: 更新requirements.txt添加新依赖 * docs: 更新文档内容并优化语言风格 重构所有文档内容，使用更简洁直接的语言风格 更新架构、插件开发、部署等核心文档 优化代码示例和图表说明 统一术语和格式规范 * docs: 更新文档内容，简化语言并修正格式 - 简化插件开发指南中的描述，移除冗余内容 - 调整部署文档中的Python版本说明 - 优化最佳实践文档的措辞和格式 - 更新性能优化文档，删除不准确的数据 - 重构核心概念文档，使用更简洁的语言 - 修正README中的项目描述和技术栈说明 - 更新快速上手文档，简化安装步骤 - 调整事件流转文档的描述方式 - 简化架构文档内容 - 更新指令处理文档，添加参数注入示例 - 优化单例管理器文档的表述 --------- Co-authored-by: baby20162016 <2185823427@qq.com>
This commit is contained in:
镀铬酸钾
67
docs/plugin-development/best-practices.md
Normal file
67
docs/plugin-development/best-practices.md
Normal file
@@ -0,0 +1,67 @@
|
||||
# 插件开发最佳实践
|
||||
|
||||
写插件很简单，但写出**高性能、不炸裂**的插件需要遵守规矩。
|
||||
|
||||
## 1. 绝对不要阻塞事件循环。。。
|
||||
|
||||
这是底线。NEO Bot 是单线程异步架构，如果你在主线程里 `time.sleep(5)`，整个机器人就会卡死 5 秒
|
||||
|
||||
* **错误**: `time.sleep(1)`, `requests.get(...)`, 大量 CPU 计算。
|
||||
* **正确**: `await asyncio.sleep(1)`, `await session.get(...)`。
|
||||
|
||||
如果你必须运行同步代码（比如图像处理、复杂计算）：
|
||||
```python
|
||||
from core.utils.executor import run_in_thread_pool
|
||||
|
||||
# 扔到线程池里去跑，别占着主线程
|
||||
result = await run_in_thread_pool(heavy_function, arg1, arg2)
|
||||
```
|
||||
|
||||
## 2. 复用资源
|
||||
|
||||
别每次都创建新的连接。
|
||||
|
||||
* **HTTP 请求**: 使用插件内提供的 `get_session()` 或全局 `aiohttp` session。
|
||||
* **浏览器**: 必须使用 `browser_manager.get_page()`，严禁自己 `playwright.chromium.launch()`。
|
||||
|
||||
## 3. 善用缓存
|
||||
|
||||
如果你的插件需要查外部 API（比如查天气、查 B 站），记得加缓存。
|
||||
Redis 就在那里，不用白不用。
|
||||
|
||||
```python
|
||||
from core.managers.redis_manager import redis_manager
|
||||
|
||||
# 存
|
||||
await redis_manager.set("weather:beijing", "sunny", ex=3600)
|
||||
# 取
|
||||
weather = await redis_manager.get("weather:beijing")
|
||||
```
|
||||
|
||||
## 4. 类型提示 (Type Hinting)
|
||||
|
||||
我开启了 Mypyc 编译，这意味着你的代码最好有规范的类型提示。
|
||||
这不仅是为了编译，也是为了让你自己少写 Bug
|
||||
|
||||
```python
|
||||
# 好的写法
|
||||
async def handle(event: MessageEvent, args: list[str]) -> None:
|
||||
...
|
||||
|
||||
# 不好写法
|
||||
async def handle(event, args):
|
||||
...
|
||||
```
|
||||
|
||||
## 5. 异常处理
|
||||
|
||||
别让你的插件因为一个报错就崩溃机器人
|
||||
虽然框架层有捕获机制，但你自己处理好异常是最好的。。。
|
||||
|
||||
```python
|
||||
try:
|
||||
await do_something()
|
||||
except Exception as e:
|
||||
logger.error(f"插件炸了: {e}")
|
||||
await event.reply("出错了，请稍后再试。")
|
||||
```
|
||||
@@ -1,99 +1,137 @@
|
||||
# 插件开发：指令处理
|
||||
# 指令处理与参数解析
|
||||
|
||||
`@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 北京")
|
||||
await event.reply("你啥也没说啊")
|
||||
else:
|
||||
await event.reply(f"你说了：{args}")
|
||||
```
|
||||
|
||||
`args` 就是去掉命令本身后，后面跟着的**一整坨字符串**。
|
||||
|
||||
## 2. 自动解析参数 (推荐)
|
||||
|
||||
一整坨字符串用起来太费劲了，还得自己 `split()`。框架提供了更高级的玩法：**参数自动解析**。
|
||||
|
||||
你只需要在函数签名里，用类型提示声明你想要的参数，框架会动帮你解析和注入。
|
||||
|
||||
### a. 基础用法
|
||||
|
||||
```python
|
||||
from core.managers.command_manager import matcher
|
||||
from models.events.message import MessageEvent
|
||||
|
||||
@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}")
|
||||
```
|
||||
|
||||
**它是怎么工作的？**
|
||||
|
||||
框架会按顺序把 `args` 字符串用空格分割，然后尝试把分割后的每一块，转换成你声明的参数类型。
|
||||
|
||||
* `/add 10 20` -> `args` 是 `"10 20"` -> 分割成 `["10", "20"]`
|
||||
* 第一块 `"10"` -> 尝试转成 `int` -> 成功，`a = 10`
|
||||
* 第二块 `"20"` -> 尝试转成 `int` -> 成功，`b = 20`
|
||||
|
||||
### 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. 智能的参数注入
|
||||
|
||||
除了 `args` 列表，命令处理器还可以自动接收一些非常有用的上下文对象。框架底层使用了 Python 的 `inspect` 模块来分析你函数的参数签名，并自动“注入”你需要的对象。
|
||||
|
||||
这是一种轻量级的**依赖注入**，让你的代码更简洁、更易于测试。
|
||||
|
||||
### 可用的参数
|
||||
|
||||
你可以在命令处理函数的参数中声明以下任意名称，框架会自动为你传入：
|
||||
|
||||
| 参数名 | 类型 | 描述 |
|
||||
| ------------------- | -------------------------------- | ---------------------------------------- |
|
||||
| `bot` | `Bot` | 当前的 Bot 实例，用于调用 API 发送消息等。 |
|
||||
| `event` | `MessageEvent` (或其子类) | 触发该命令的完整消息事件对象。 |
|
||||
| `args` | `List[str]` | 和之前一样，包含命令参数的字符串列表。 |
|
||||
| `permission_granted`| `bool` | 指示当前用户是否通过了权限检查。 |
|
||||
|
||||
### 示例
|
||||
|
||||
假设我们想写一个“回声”命令，但只在用户拥有管理员权限时才重复他们的消息。
|
||||
|
||||
```python
|
||||
# plugins/echo_plus.py
|
||||
from core.bot import Bot
|
||||
from core.permission import ADMIN
|
||||
from models.events.message import MessageEvent
|
||||
from core.managers.command_manager import matcher
|
||||
|
||||
@matcher.command("echo_plus", permission=ADMIN)
|
||||
async def echo_plus(bot: Bot, event: MessageEvent, args: list[str], permission_granted: bool):
|
||||
"""
|
||||
一个更强大的回声命令
|
||||
"""
|
||||
# 只有当 permission_granted 为 True 时，代码才会执行到这里
|
||||
# 因为框架会自动处理权限拒绝的情况
|
||||
|
||||
if not args:
|
||||
await bot.send(event, "你想要我复述什么呢？")
|
||||
return
|
||||
|
||||
# args[0] 就是 "北京"
|
||||
city = args[0]
|
||||
# 我们可以从 event 对象中获取更详细的信息
|
||||
user_id = event.user_id
|
||||
message_to_echo = " ".join(args)
|
||||
|
||||
# ...后续逻辑...
|
||||
await event.reply(f"正在查询 {city} 的天气...")
|
||||
response = f"管理员 {user_id} 说：{message_to_echo}"
|
||||
await bot.send(event, response)
|
||||
|
||||
```
|
||||
|
||||
* 如果用户发送 `/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` 都可以使用该指令。
|
||||
|
||||
通过组合使用参数处理、别名和权限控制，您可以构建出既灵活又安全的指令来满足各种复杂的需求。
|
||||
在这个例子中，我们没有手动检查权限。我们只是在 `@matcher.command` 中声明了 `permission=ADMIN`，然后在函数参数中请求了 `permission_granted: bool`。框架会自动完成权限检查，如果失败，甚至不会执行我们的函数，并会发送一条权限不足的消息。这就是依赖注入的强大之处。
|
||||
|
||||
@@ -1,51 +1,10 @@
|
||||
# 插件开发：基础指南
|
||||
# 插件开发入门
|
||||
|
||||
在 NEO Bot Framework 中，几乎所有的功能都是通过**插件**来实现的。框架提供了一个强大而简单的插件系统，让您可以专注于功能逻辑的实现。
|
||||
写插件是给 NEO Bot 添加功能的唯一方式，一个 Python 文件就是一个插件。（或者一个文件夹里边有__init__.py）
|
||||
|
||||
## 插件是什么？
|
||||
## 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,63 @@ __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` 文件。
|
||||
|
||||
恭喜！您已经成功创建并运行了您的第一个插件。
|
||||
## 3. 测试插件
|
||||
|
||||
## 插件的最佳实践
|
||||
现在，去群里或者私聊给 Bot 发送：
|
||||
|
||||
* **保持独立**: 尽量让每个插件文件只负责一项相关的功能。
|
||||
* **清晰命名**: 为您的插件文件和处理函数选择清晰、描述性的名称。
|
||||
* **善用模型**: 充分利用 `models` 中定义的事件和消息段类型，以获得完整的类型提示和代码补全支持。
|
||||
* **异步优先**: 框架是基于 `asyncio` 构建的。对于任何 I/O 密集型操作（如网络请求、文件读写），请务必使用 `async/await` 语法，以避免阻塞事件循环。
|
||||
* `/hello`
|
||||
* `/hi`
|
||||
* `/你好`
|
||||
|
||||
现在您已经掌握了插件的基础，可以继续学习更高级的主题，例如[如何处理带参数的指令](./command-handling.md)。
|
||||
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