基于Nonebot2搭建QQ机器人（二）：插件使用

最新推荐文章于 2024-09-29 21:37:28 发布

SteveKenny

最新推荐文章于 2024-09-29 21:37:28 发布

阅读量5.3k

点赞数 4

分类专栏： # go-cqhttp实现聊天机器人文章标签：机器人 python 开发语言

本文链接：https://blog.csdn.net/qq_62789540/article/details/127111543

版权

本文详细介绍了如何使用Nonebot2创建和管理插件，包括模块和包插件的创建、加载插件的方式、事件响应器的使用以及事件处理流程。通过学习，读者可以掌握如何编写和配置插件，以及处理不同类型的事件响应。

摘要由CSDN通过智能技术生成

Nonebot2创建插件

1、插件简介

在编写插件之前，首先我们需要了解一下插件的概念。

在 NoneBot 中，插件可以是 Python 的一个模块 module，也可以是一个包 package 。NoneBot 会在导入时对这些模块或包做一些特殊的处理使得他们成为一个插件。插件间应尽量减少耦合，可以进行有限制的插件间调用，NoneBot 能够正确解析插件间的依赖关系。

下面详细介绍两种插件的结构：

1.1 模块插件（单文件形式）

在合适的路径创建一个 .py 文件即可。例如在创建项目中创建的项目中，我们可以在 awesome_bot/plugins/ 目录中创建一个文件 foo.py。

这个时候它已经可以被称为一个插件了，尽管它还什么都没做。

1.2 包插件（文件夹形式）

在合适的路径创建一个文件夹，并在文件夹内创建文件 __init__.py 即可。例如在创建项目中创建的项目中，我们可以在 awesome_bot/plugins/ 目录中创建一个文件夹 foo，并在这个文件夹内创建一个文件 __init__.py。

这个时候 foo 就是一个合法的 Python 包了，同时也是合法的 NoneBot 插件，插件内容可以在 __init__.py 中编写。

1.3 创建插件

除了通过手动创建的方式以外，还可以通过 nb-cli 来创建插件，nb-cli 会为你在合适的位置创建一个模板包插件。

nb plugin create

2、加载插件

2.1 直接加载

我们在编写我们的插件之前，我们需要学会如何去加载插件

注意：

请勿在插件被加载前 import 插件模块，这会导致 NoneBot2 无法将其转换为插件而损失部分功能。

load_plugin
- 通过点分割模块名称来加载插件，通常用于加载单个插件或者是第三方插件。例如：
nonebot.load_plugin(“path.to.your.plugin”)
load_plugins
- 加载传入插件目录中的所有插件，通常用于加载一系列本地编写的插件。例如：

nonebot.load_plugins(“src/plugins”, “path/to/your/plugins”)
```

> 请注意，插件所在目录应该为相对机器人入口文件可导入的，例如与入口文件在同一目录下。

load_from_json
- 通过 JSON 文件加载插件，是 load_all_plugins 的 JSON 变种。通过读取 JSON 文件中的 plugins 字段和 plugin_dirs 字段进行加载。例如：

// plugin_config.json
{ “plugins”: [“path.to.your.plugin”], “plugin_dirs”: [“path/to/your/plugins”]}
```

	
```python
	nonebot.load_from_json("plugin_config.json", encoding="utf-8")

>  如果 JSON 配置文件中的字段无法满足你的需求，可以使用 [`load_all_plugins`](https://nb2.baka.icu/docs/tutorial/plugin/load-plugin#load_all_plugins) 方法自行读取配置来加载插件。

load_from_toml
- 通过 TOML 文件加载插件，是 load_all_plugins 的 TOML 变种。通过读取 TOML 文件中的 [tool.nonebot] Table 中的 plugins 和 plugin_dirs Array 进行加载。例如：

	# plugin_config.toml
[tool.nonebot]
plugins = ["path.to.your.plugin"]
plugin_dirs = ["path/to/your/plugins"]

```python

nonebot.load_from_toml(“plugin_config.toml”, encoding=“utf-8”)
```

load_builtin_plugin
- 加载一个内置插件，是 load_plugin 的封装。例如：

nonebot.load_builtin_plugin(“echo”)
```

我们可以使用配置文件加载

2.2 跨域加载

倘若 plugin_a, plugin_b 均需被加载, 且 plugin_b 插件需要导入 plugin_a 才可运行, 可以在 plugin_b 利用 require 方法来确保插件加载, 同时可以直接 import 导入 plugin_a ,进行跨插件访问。

from nonebot import require

require('plugin_a')

import plugin_a

不用 require 方法也可以进行跨插件访问，但需要保证插件已加载

3、插件配置

通常，插件可以从配置文件中读取自己的配置项，但是由于额外的全局配置项没有预先定义的问题，导致开发时编辑器无法提示字段与类型，以及运行时没有对配置项直接进行检查。那么就需要一种方式来规范定义插件配置项。

3.1 创建模型

我们定义一个配置模型：

在 NoneBot2 中，我们使用强大高效的 Pydantic 来定义配置模型，这个模型可以被用于配置的读取和类型检查等。例如，我们可以定义一个配置模型包含一个 string 类型的配置项：

config.py

from pydantic import BaseModel, Extra


class Config(BaseModel, extra=Extra.ignore):
    token: str

3.2 导入配置

定义完成配置模型后，我们可以在插件加载时获取全局配置，导入插件自身的配置模型：

__init__.py

from nonebot import get_driver

from .config import Config

plugin_config = Config.parse_obj(get_driver().config)

4、事件响应

4.1 事件响应器

事件响应器（Matcher）是对接收到的事件进行响应的基本单元，所有的事件响应器都继承自 Matcher 基类。为了方便开发者编写插件，NoneBot2 在 nonebot.plugin 模块中为插件开发定义了一些辅助函数。首先，让我们来了解一下 Matcher 由哪些部分组成。

事件响应器类型（type）

事件响应器的类型即是该响应器所要响应的事件类型，只有在接收到的事件类型与该响应器的类型相同时，才会触发该响应器。如果类型留空，该响应器将会响应所有类型的事件。
NoneBot 内置了四种主要类型：meta_event、message、notice、request。通常情况下，协议适配器会将事件合理地分类至这四种类型中。如果有其他类型的事件需要响应，可以自行定义新的类型。
事件匹配规则（rule）

事件响应器的匹配规则是一个 Rule 对象，它是一系列 checker 的集合，当所有的 checker 都返回 True 时，才会触发该响应器。
事件触发权限（permission）

事件响应器的触发权限是一个 Permission 对象，它也是一系列 checker 的集合，当其中一个 checker 返回 True 时，就会触发该响应器。
优先级（priority）

事件响应器的优先级代表事件响应器的执行顺序
阻断（block）

当有任意事件响应器发出了阻止事件传递信号时，该事件将不再会传递给下一优先级，直接结束处理。
NoneBot 内置的事件响应器中，所有非 command 规则的 message 类型的事件响应器都会阻断事件传递，其他则不会。
在部分情况中，可以使用 matcher.stop_propagation() 方法动态阻止事件传播，该方法需要 handler 在参数中获取 matcher 实例后调用方法。
有效期（expire_time/temp）

事件响应器可以设置有效期，当事件响应器超过有效期时，将会被移除:
- temp 属性：配置事件响应器在下一次响应之后移除。
- expire_time 属性：配置事件响应器在指定时间之后移除。

4.2 创建响应器

创建事件响应器的辅助函数有以下几种：

on: 创建任何类型的事件响应器。
on_metaevent: 创建元事件响应器。
on_message: 创建消息事件响应器。
on_request: 创建请求事件响应器。
on_notice: 创建通知事件响应器。
on_startswith: 创建消息开头匹配事件响应器。
on_endswith: 创建消息结尾匹配事件响应器。
on_fullmatch: 创建消息完全匹配事件响应器。
on_keyword: 创建消息关键词匹配事件响应器。
on_command: 创建命令消息事件响应器。
on_shell_command: 创建 shell 命令消息事件响应器。
on_regex: 创建正则表达式匹配事件响应器。
CommandGroup: 创建具有共同命令名称前缀的命令组。
MatcherGroup: 创建具有共同参数的响应器组。

其中：

on_metaevent on_message on_request on_notice 函数都是在 on 的基础上添加了对应的事件类型 type
on_startswith on_endswith on_fullmatch on_keyword on_command on_shell_command on_regex 函数都是在 on_message 的基础上添加了对应的匹配规则 rule

4.3 事件处理

我们已经定义了事件响应器，然后，我们将会为事件响应器填充处理流程。

4.3.1 事件依赖

在事件响应器中，事件处理流程由一个或多个处理依赖组成，每个处理依赖都是一个 Dependent，下面介绍如何添加一个处理依赖，具体可以查看官网：https://nb2.baka.icu/docs/advanced/di/dependency-injection。

from nonebot import on_command
from nonebot.params import Depends # 1.引用 Depends
from nonebot.adapters.onebot.v11 import MessageEvent

test = on_command("123")

async def depend(event: MessageEvent): # 2.编写依赖函数
    return {
   "uid": event.get_user_id(), "nickname": event.