# 指令处理与参数解析 光会 `event.reply()` 只能写小插件。。。认识一下其他的方法吧 ## 1. 获取原始参数 最简单粗暴的方式,就是直接在处理器函数里声明 `args: str`。 ```python from core.managers.command_manager import matcher from models.events.message import MessageEvent @matcher.command("echo") async def handle_echo(event: MessageEvent, args: str): # 如果用户发送 /echo hello world # args 的值就是 "hello world" if not args: 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 # 我们可以从 event 对象中获取更详细的信息 user_id = event.user_id message_to_echo = " ".join(args) response = f"管理员 {user_id} 说:{message_to_echo}" await bot.send(event, response) ``` 在这个例子中,我们没有手动检查权限。我们只是在 `@matcher.command` 中声明了 `permission=ADMIN`,然后在函数参数中请求了 `permission_granted: bool`。框架会自动完成权限检查,如果失败,甚至不会执行我们的函数,并会发送一条权限不足的消息。这就是依赖注入的强大之处。