nonebot2/docs/advanced/overloaded-handlers.md
2021-04-25 13:18:36 +08:00

2.7 KiB

事件处理函数重载

当我们在编写 nonebot2 应用时,常常会遇到这样一个问题:该怎么让同一类型的不同事件执行不同的响应逻辑?又或者如何让不同的 adapter 针对同一类型的事件作出不同响应?

针对这个问题, nonebot2 提供一个便捷而高效的解决方案:事件处理函数重载机制。简单地说,handler (事件处理函数) 会根据其参数的 type hints (PEP484 类型标注) 来对相对应的 adapterEvent 进行响应,并且会忽略不符合其参数类型标注的情况。

必须要注意的是,该机制利用了 inspect 标准库获取到了事件处理函数的 singnature (签名) ,进一步获取到参数名称和类型标注。故而,我们在编写 handler 时,参数的名称和类型标注必须要符合 T_Handler 规定,详情可以参看 指南 中的事件处理

::: tip 提示

如果想了解更多关于 inspect 标准库的信息,可以查看官方文档

:::

下面,我们会以 CQHTTP 中的 消息事件 中的 群聊消息事件私聊消息事件 为例,对该机制的应用进行简单的介绍。

一个例子

首先,我们需要导入需要的方法、类型。

from nonebot import on_command
from nonebot.adapters.cqhttp import Bot, GroupMessageEvent, PrivateMessageEvent

之后,我们可以注册一个 Matcher 来响应 消息事件

matcher = on_command("testoverload")

最后, 我们编写不同的 handler 并编写不同的类型标注来实现事件处理函数重载:

@matcher.handle()
async def _(bot: Bot, event: GroupMessageEvent):
    await matcher.send("群聊消息事件响应成功!")


@matcher.handle()
async def _(bot: Bot, event: PrivateMessageEvent):
    await matcher.send("私聊消息事件响应成功!")

此时,我们可以在群聊或私聊中对我们的机器人发送 testoverload ,它会在不同的场景做出不同的应答。

这样一个简单的事件处理函数重载就完成了。

进阶

事件处理函数重载机制同样支持被 matcher.got 等装饰器装饰的函数。 例如:

@matcher.got("key1", prompt="群事件提问")
async def _(bot: Bot, event: GroupMessageEvent):
    await matcher.send("群聊消息事件响应成功!")


@matcher.got("key2", prompt="私聊事件提问")
async def _(bot: Bot, event: PrivateMessageEvent):
    await matcher.send("私聊消息事件响应成功!")

只有触发事件符合的函数才会触发装饰器。