选择驱动器
驱动器 (Driver) 是机器人运行的基石,它是机器人初始化的第一步,主要负责数据收发。
驱动器的选择通常与机器人所使用的协议适配器相关,如果不知道该选择哪个驱动器,可以先阅读相关协议适配器文档说明。
如何安装驱动器请参考安装驱动器。
驱动器类型
驱动器类型大体上可以分为两种:
Forward
:即客户端型驱动器,多用于使用 HTTP 轮询,连接 WebSocket 服务器等情形。Reverse
:即服务端型驱动器,多用于使用 WebHook,接收 WebSocket 客户端连接等情形。
客户端型驱动器可以分为以下两种:
- 异步发送 HTTP 请求,自定义
HTTP Method
、URL
、Header
、Body
、Cookie
、Proxy
、Timeout
等。 - 异步建立 WebSocket 连接上下文,自定义
WebSocket URL
、Header
、Cookie
、Proxy
、Timeout
等。
服务端型驱动器目前有:
- ASGI 应用框架,具有以下功能:
- 协议适配器自定义 HTTP 上报地址以及对上报数据处理的回调函数。
- 协议适配器自定义 WebSocket 连接请求地址以及对 WebSocket 请求处理的回调函数。
- 用户可以向 ASGI 应用添加任何服务端相关功能,如:添加自定义路由。
配置驱动器
驱动器的配置方法已经在配置章节中简单进行了介绍,这里将详细介绍驱动器配置的格式。
NoneBot 中的客户端和服务端型驱动器可以相互配合使用,但服务端型驱动器仅能选择一个。所有驱动器模块都会包含一个 Driver
子类,即驱动器类,他可以作为驱动器单独运行。同时,客户端驱动器模块中还会提 供一个 Mixin
子类,用于在与其他驱动器配合使用时加载。因此,驱动器配置格式采用特殊语法:<module>[:<Driver>][+<module>[:<Mixin>]]*
。
其中,<module>
代表驱动器模块路径;<Driver>
代表驱动器类名,默认为 Driver
;<Mixin>
代表驱动器混入类名,默认为 Mixin
。即,我们需要选择一个主要驱动器,然后在其基础上配合使用其他驱动器的功能。主要驱动器可以为客户端或服务端类型,但混入类驱动器只能为客户端类型。
特别的,为了简化内置驱动器模块路径,我们可以使用 ~
符号作为内置驱动器模块路径的前缀,如 ~fastapi
代表使用内置驱动器 fastapi
。NoneBot 内置了多个驱动器适配,但需要安装额外依赖才能使用,具体请参考安装驱动器。常见的驱动器配置如下:
DRIVER=~fastapi
DRIVER=~aiohttp
DRIVER=~httpx+~websockets
DRIVER=~fastapi+~httpx+~websockets
获取驱动器
在 NoneBot 框架初始化完成后,我们就可以通过 get_driver()
方法获取全局驱动器实例:
from nonebot import get_driver
driver = get_driver()
内置驱动器
None
**类型:**服务端驱动器
NoneBot 内置的空驱动器,不提供任何收发数据功能,可以在不需要外部网络连接时使用。
DRIVER=~none