NoneBot2 规则系统详解：Rule 模块深度解析-优快云博客

本文链接：https://blog.youkuaiyun.com/gitblog_01097/article/details/148465649

NoneBot2 规则系统详解：Rule 模块深度解析

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

概述

在 NoneBot2 框架中，Rule（规则）是事件响应器（Matcher）的核心组成部分，用于决定是否应该对某个事件进行响应。本文将深入解析 Rule 模块的工作原理和使用方法，帮助开发者更好地掌握事件匹配机制。

Rule 基础概念

Rule 本质上是一个规则检查器的集合，它由多个 RuleChecker 组成。当事件传递到响应器时，Rule 会对事件进行检查，只有所有 RuleChecker 都返回 True 时，响应器才会继续执行后续逻辑。

Rule 类结构

class Rule(*checkers)

参数：接受任意数量的 RuleChecker，可以是同步或异步函数
特性：
- 支持通过 & 运算符组合多个规则
- 所有检查器必须全部通过才会返回 True
- 检查器会按照添加顺序依次执行

基本使用示例

from nonebot.rule import Rule

# 定义两个简单的检查器
async def check1(bot, event, state):
    return True

def check2(bot, event, state):
    return event.get_user_id() == "123456"

# 创建规则
rule = Rule(check1) & check2
# 等价于
rule = Rule(check1, check2)

内置规则类型

NoneBot2 提供了一系列常用的内置规则，开发者可以直接使用这些规则而无需自己实现。

1. 消息内容匹配规则

开头匹配 (startswith)

from nonebot.rule import startswith

# 匹配以"你好"或"hello"开头的消息
rule = startswith(("你好", "hello"))

结尾匹配 (endswith)

from nonebot.rule import endswith

# 匹配以"结束"或"bye"结尾的消息
rule = endswith(("结束", "bye"))

完全匹配 (fullmatch)

from nonebot.rule import fullmatch

# 精确匹配"菜单"或"menu"
rule = fullmatch(("菜单", "menu"))

关键词匹配 (keyword)

from nonebot.rule import keyword

# 匹配包含"帮助"或"help"的消息
rule = keyword("帮助", "help")

2. 命令系统规则

NoneBot2 提供了强大的命令系统支持，可以方便地处理各种命令格式。

基础命令 (command)

from nonebot.rule import command

# 匹配/test或/start命令
rule = command("test", "start")

# 匹配多级命令如/test.sub
rule = command(("test", "sub"))

Shell 风格命令 (shell_command)

from nonebot.rule import shell_command
from argparse import ArgumentParser

# 创建参数解析器
parser = ArgumentParser()
parser.add_argument("-v", "--verbose", action="store_true")

# 匹配/ls命令并解析参数
rule = shell_command("ls", parser=parser)

3. 正则表达式规则 (regex)

from nonebot.rule import regex

# 匹配包含数字的消息
rule = regex(r"\d+")

# 使用命名分组
rule = regex(r"(?P<name>\w+):(?P<age>\d+)")

4. 特殊事件规则

提及机器人 (to_me)

from nonebot.rule import to_me

# 只有当消息提及机器人时才响应
rule = to_me()

事件类型检查 (is_type)

from nonebot.adapters.onebot.v11 import MessageEvent

from nonebot.rule import is_type

# 只处理特定适配器的消息事件
rule = is_type(MessageEvent)

规则组合技巧

NoneBot2 的规则系统支持灵活的规则组合方式，可以满足各种复杂场景的需求。

逻辑与组合

使用 & 运算符或直接传入多个检查器：

from nonebot.rule import command, to_me

# 只有命令且提及机器人时才响应
rule = command("test") & to_me()

逻辑或实现

虽然 Rule 本身不支持逻辑或，但可以通过多个 Matcher 实现：

from nonebot import on_command
from nonebot.rule import to_me

# 两种触发方式
cmd1 = on_command("help", rule=to_me())
cmd2 = on_command("帮助", rule=to_me())

高级用法

自定义规则检查器

开发者可以创建自己的规则检查器：

async def check_admin(bot, event, state):
    return event.get_user_id() in ADMIN_LIST

# 使用时
rule = Rule(check_admin) & command("admin")

依赖注入

RuleChecker 支持依赖注入，可以方便地使用各种依赖：

from nonebot.params import Depends

async def depend_func():
    return True

async def checker(result: bool = Depends(depend_func)):
    return result

rule = Rule(checker)