NoneBot2 事件响应器(Matcher)详解与实战指南-优快云博客

本文链接：https://blog.youkuaiyun.com/gitblog_00379/article/details/148465601

NoneBot2 事件响应器(Matcher)详解与实战指南

nonebot2 跨平台 Python 异步聊天机器人框架 / Asynchronous multi-platform chatbot framework written in Python 项目地址: https://gitcode.com/gh_mirrors/no/nonebot2

什么是事件响应器

在 NoneBot2 框架中，事件响应器(Matcher)是构建机器人功能的核心组件，它负责对接收到的特定事件进行响应和处理。简单来说，事件响应器就像是一个智能过滤器+处理器组合，能够识别特定格式的消息并执行预设的操作。

事件响应器的工作原理

事件响应器的工作流程可以分为三个关键步骤：

事件筛选：通过预定义的规则判断是否应该处理当前事件
参数提取：从符合条件的事件中提取有用的信息
逻辑处理：执行预先定义好的处理逻辑

创建事件响应器的便捷方式

NoneBot2 提供了多种辅助函数来简化事件响应器的创建过程。这些辅助函数通常以 on_ 开头，例如：

on_command()：用于创建命令响应器
on_message()：用于创建消息响应器
on_notice()：用于创建通知响应器

基础命令响应器示例

from nonebot import on_command

# 创建一个响应/天气命令的事件响应器
weather = on_command("天气")

这个简单的例子创建了一个能够响应"/天气"命令的响应器。当用户发送"/天气"时，这个响应器就会被触发。

高级配置选项

NoneBot2 的事件响应器支持多种配置参数，让开发者能够精确控制响应器的行为：

常用配置参数

rule：设置触发规则
aliases：设置命令别名
priority：设置响应优先级
block：设置是否阻断事件传播

from nonebot import on_command
from nonebot.rule import to_me

weather = on_command(
    "天气",
    rule=to_me(),  # 要求@机器人或私聊
    aliases={"weather", "查天气"},  # 设置别名
    priority=10,  # 设置优先级
    block=True  # 阻断事件传播
)

实际应用场景

让我们通过一个天气预报插件的例子，看看事件响应器在实际开发中的应用：

from nonebot import on_command
from nonebot.adapters import Message
from nonebot.params import CommandArg

weather = on_command("天气", aliases={"weather", "查天气"})

@weather.handle()
async def handle_weather(city: Message = CommandArg()):
    if not city:
        await weather.finish("请告诉我你想查询哪个城市的天气哦~")
    
    # 这里可以添加获取天气数据的逻辑
    weather_data = await get_weather(city.extract_plain_text())
    await weather.finish(weather_data)

这个例子展示了如何：