nonebot2/website/docs/advanced/di/overload.md

77 lines
2.9 KiB
Markdown
Raw Normal View History

---
2022-01-06 17:51:32 +08:00
sidebar_position: 3
description: 重载事件处理函数
options:
menu:
2022-01-06 17:51:32 +08:00
weight: 62
2021-12-02 03:17:10 +08:00
category: advanced
---
2020-12-31 17:58:09 +08:00
# 事件处理函数重载
2021-04-25 02:08:52 +08:00
2022-02-05 19:46:33 +08:00
当我们在编写 NoneBot2 应用时,常常会遇到这样一个问题:该怎么让同一类型的不同事件执行不同的响应逻辑?又或者如何让不同的 `bot` 针对同一类型的事件作出不同响应?
2021-04-25 02:08:52 +08:00
2022-02-05 19:46:33 +08:00
针对这个问题, NoneBot2 提供一个便捷而高效的解决方案:事件处理函数重载机制。简单地说,`handler`(事件处理函数)会根据其参数的 `type hints`[PEP484 类型标注](https://www.python.org/dev/peps/pep-0484/))来对相对应的 `bot``event` 进行响应,并且会忽略不符合其参数类型标注的情况。
2021-04-25 02:08:52 +08:00
2022-02-05 19:46:33 +08:00
<!-- 必须要注意的是,该机制利用了 `inspect` 标准库获取到了事件处理函数的 `signature`(签名),进一步获取到参数名称和类型标注。故而,我们在编写 `handler` 时,参数的名称和类型标注必须要符合 `T_Handler` 规定,详情可以参看**指南**中的[事件处理](../../guide/creating-a-handler)。 -->
2021-04-25 02:08:52 +08:00
2021-12-03 23:30:15 +08:00
:::tip 提示
2021-04-25 02:08:52 +08:00
如果想了解更多关于 `inspect` 标准库的信息,可以查看[官方文档](https://docs.python.org/zh-cn/3.9/library/inspect.html)。
:::
2022-02-05 19:46:33 +08:00
下面,我们会以 OneBot 适配器中的群聊消息事件和私聊消息事件为例,对该机制的应用进行简单的介绍。
2021-04-25 02:08:52 +08:00
## 一个例子
首先,我们需要导入需要的方法、类型。
2021-04-25 02:08:52 +08:00
```python
2021-04-25 13:18:36 +08:00
from nonebot import on_command
2022-02-04 15:12:02 +08:00
from nonebot.adapters.onebot.v11 import Bot, GroupMessageEvent, PrivateMessageEvent
2021-04-25 02:08:52 +08:00
```
2022-02-05 19:46:33 +08:00
之后,我们可以注册一个 `Matcher` 来响应消息事件。
2021-04-25 02:08:52 +08:00
```python
2022-02-05 19:46:33 +08:00
matcher = on_command("test_overload")
2021-04-25 02:08:52 +08:00
```
2022-02-05 19:46:33 +08:00
最后,我们编写不同的 `handler` 并编写不同的类型标注来实现事件处理函数重载:
2021-04-25 02:08:52 +08:00
```python
@matcher.handle()
async def _(bot: Bot, event: GroupMessageEvent):
2021-04-25 13:18:36 +08:00
await matcher.send("群聊消息事件响应成功!")
2021-04-25 02:08:52 +08:00
@matcher.handle()
async def _(bot: Bot, event: PrivateMessageEvent):
2021-04-25 13:18:36 +08:00
await matcher.send("私聊消息事件响应成功!")
2021-04-25 02:08:52 +08:00
```
2022-02-05 19:46:33 +08:00
此时,我们可以在群聊或私聊中对我们的机器人发送 `test_overload`,它会在不同的场景做出不同的应答。
2021-04-25 02:08:52 +08:00
2021-04-25 13:18:36 +08:00
这样一个简单的事件处理函数重载就完成了。
## 进阶
事件处理函数重载机制同样支持被 `matcher.got` 等装饰器装饰的函数。例如:
2021-04-25 13:18:36 +08:00
```python
@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("私聊消息事件响应成功!")
```
2021-05-20 22:45:35 +08:00
只有触发事件符合的函数才会触发装饰器。
:::warning 注意
bot 和 event 参数具有最高的检查优先级,因此,如果参数类型不符合,所有的依赖项 `Depends` 等都不会被执行。
:::