以OneBot适配器举例,在机器人后台消息接收时会经过如下流程:首先gocqhttp会从QQ服务器获取消息,然后通过反向WebSocket(如果用的是的话)将消息传输给正在运行的Onebot平台,平台将消息处理后发出响应再发还给gocqhttp端,最后gocqhttp根据响应向QQ服务器发出消息,这就是消息处理的整个流程。
简单来说gocqhttp就是沟通Nonebot和QQ服务器之间通信的桥梁,也就是眼睛耳朵鼻子或者说身体的各个部位,而Nonebot就是相当于"大脑",负责处理接收到的信息并且发送指令给手、脚这种身体部位让他们行动,这就是形象化的过程。
首先先看一段代码
from nonebot import on_keyword
from nonebot.adapters.onebot.v11 import Message
word=on_keyword({"你是谁"})
@word.handle()
async def _():
await word.finish(Message("我是bot!"))
这段代码实现的功能是:如果有人发送(无论是与机器人的私聊还是群聊里)任一包含"你是谁"这三个关键字的消息的时候,机器人会回复消息:“我是bot”。功能是很简单,但是里面的基础知识点不少,下面逐一分析一下
from nonebot import on_keyword
from nonebot.adapters.onebot.v11 import Message
这段经典的Import代码的功能是从nonebot库中引入on_keyword
方法,再从Onebot V11库中引入Message
方法。不过这两个方法具体用法我们之后再谈,接下来先聊聊这个import。
Nonebot2中的很多功能都需要通过import导入后才能使用,虽然你也可以通过无脑from nonebot import *
这种办法来一劳永逸,但不保证这样会不会出一些奇奇怪怪的问题,所以我的建议是需要什么方法就导入什么。**那么我怎么知道从哪些库里引入我想要的函数呢?**这里我列举了一些常见库里包含的常见函数,可以供大家参考
库 | 常用函数/方法 | 说明 |
---|---|---|
nonebot | on_message,on_notice,on_request,on_keyword,on_command,on_regex | 基础库 |
nonebot.config | Config | 配置文件库 |
nonebot.matcher | Match | 事件响应器 |
nonebot.params | Arg,State,CommandArg,RegexMatched | 参数库 |
nonebot.permission | SUPERUSER,Permission | 权限库 |
nonebot.log | logger,default_format | 日志库 |
nonebot.adapters.onebot.v11 | Bot,Message,MessageSegment,Event,PRIVATE,GROUP等 | Onebot库 |
(注:OneBot V11的库可以从nonebot.adapters.onebot.v11
直接导入,也可以用诸如nonebot.adapters.onebot.v11.message
的方式导入,详见官方文档)
word=on_keyword({"你是谁"})
这行代码的含义是“注册一个名为word,类型为on_keyword的事件响应器”,那么这句话是什么意思呢?
首先是“注册”,注册其实类似于C语言里面的函数声明,函数必须在声明后才可以使用,事件响应器(具体是什么不急着谈)也是如此。简单来说你想建个房子,但你建房子之前必须要指定一块地说我要在这里建房子才行,而不能直接就建房子,响应器注册就是指定一个变量(土地)来建房子(响应器)。并且这里面的“word”也是类似于“函数的名字”一样的存在,所以可以在符合Python变量命名法的前提下随便取名,这个变量在之后使用事件响应器时会用到。
之后是on_keyword
,前面说过on_keyword是NoneBot库中的一个方法,至于方法这个词具体是什么意思请去看《面向对象编程》。在这你可以简单理解成一个函数就行,这个函数会返回一个事件响应器,那它能输入什么参数呢?先来看看文档中的说明:
on_keyword(keywords, rule=..., *, permission=..., handlers=..., temp=..., priority=..., block=..., state=...)
注册一个消息事件响应器,并且当消息纯文本部分包含关键词时响应
第一个参数是keywords
,类型为集合(Set),传入的是用来触发该响应器工作的关键词集合(用{}包起来的)。
第二个参数是rule
,传入的是bool类型规则函数或者Rule参数。
第三个参数是permission
,传入的是bool类型的权限函数或者Permission参数。
第四个参数是handlers
,传入的参数是事件响应器列表。
第五个参数是temp
,传入的是bool类型参数,若为True则此响应器只使用一次。
第六个参数是priority
,传入的是int型参数,用于设定响应器的优先级。注意!此参数越大优先级越低。
第七个参数是block
,传入的是bool类型的参数,若为True则不会注册优先级小于此响应器的响应器,相当于消息被阻断在这里了。
最后一个参数是state
,传入的是字典类型参数。
目前需要了解的只有keywords
,permission
,priority
和block
这四个参数,其他参数我们之后才会讲到,所以可以先放着。
首先是keywords
参数,这个参数作用比较简单,就是传入一个元素是字符串的集合,然后如果接收到的消息包含这个集合内的任一关键字,则触发事件响应器。
第二个是permission
参数,这个参数负责传入能触发此事件响应器的消息发送者类型,也就是哪些人能触发这个响应器。一般来说重要的指令都会加上一些权限限制,诸如操作机器人后台的一些指令。常见的permission有SUPERUSER(写在.env文件中的超级用户),GROUP_ADMIN(群管理员)和GROUP_OWNER(群主),这些是框架本身提供的。除此以外我们也可以自定义权限组,当然这个内容之后再谈。
第三个参数是priority
,负责调控响应器触发的优先级,优先级越高,就越早被执行。举个例子,如有以下代码
word=on_keyword({"你是谁"},priority=60)
word_2=on_keyword({"你是谁"},priority=50)
两个响应器都以"你是谁"作为触发词,这时候如果接收到了包含"你是谁"的消息后,二者执行顺序就由priority
值来决定了。注意!priority
值越小,优先级越高!如上面那个例子中word_2就会比word要更早触发。
最后一个介绍的是block
参数,这个参数一般情况下是和前面那个priority
参数搭配起来用,用以阻断消息传递。还是以上面那段代码为例
word=on_keyword({"你是谁"},priority=60,block=True)
word_2=on_keyword({"你是谁"},priority=50,block=True)
用户输入"你是谁"后并不会触发两个响应器,而是只会触发优先级更高的那个也就是word_2,触发完之后因为block
值为True,所以消息传到这里就被阻断了,也就没办法触发优先级更低的响应器了。
@word.handle()
async def _():
await word.finish(Message("我是bot!"))
接下来最后这一段代码其实是响应器最核心的一部分,响应器触发后就会执行这段代码的内容,没有这部分事件响应器也只是单纯的一个空壳。
@word.handle()
,这个是函数的"装饰器",说白了就是给下面的函数标明:这个函数就是用来处理事件响应器的!,当然这个装饰器更具体的用法目前不用了解,只需要知道必须在处理响应器的函数前加上这个就行,格式为@响应器名.handle()
。
接下面的async def
意思是定义一个异步(协程)函数,Nonebot的事件响应器处理的主函数都一般情况下应当都是异步函数,而子函数(主函数中包含的函数)视情况而定。async def _()
即定义一个没有任何参数,也没有函数名字的异步函数。一般情况下事件响应器主函数都不需要用到名字,使用_
代替就行,不过如果为了辨识度高一点的话而命名那随意,之后也会有需要用到函数名字的地方。此外这还是个无参函数,异步函数(事件响应器)的参数传递我们之后再谈,这里的例子只是一个简单的消息触发与回复,所以并不需要传入任何参数。
await word.finish(Message("我是bot!"))
,这段代码用来结束事件响应器word,同时发送一个消息(Message)"我是bot"。在动作面前加上await
可以使异步进程进入"等待"状态,事件响应器中对响应器进行操作的方法一般都需要加上await
才能使用,比如此处的word.finish
。word.finish
用以执行事件响应器word
下的finish
方法,finish
方法用以结束该事件响应器,作用和循环语句中的break
很像。finish
方法可以传入一个空参数,如word.finish()
,也可以传入**字符串(Str)/消息(Message)/格式化消息模板(MessageTemplate)/消息段(MessageSegment)**这四种类型的参数,在上面的例子中我们传入的是一个消息(Message)类型,也完全可以用await word.finish("我是bot!")
替代。
标题可能看起来有点绕,意思其实就是我(bot)如何在一个QQ群里@在刚刚向我(bot)发送@消息的人。
首先来分析一下这个问题,要实现上述功能我们需要解决以下三个难题:如何知道TA发送的消息是在@我,如何知道是谁在给我发送消息@我以及如何@回去。
我们先一步一步来解决这个问题,首先是第一个难题:如何知道TA发送的消息是在@我。这里就需要讲到事件响应器的rule
参数了,上个例子中的on_keyword
就有这个参数,现在来详细讲一讲。rule
翻译过来即”规则“,用于规定触发事件响应器的条件,可以理解为在事件响应器外面套了一个if判断,条件满足时才会触发事件响应器,不满足的时候会直接跳过。说了这么多但rule
参数的本质其实就是一个bool类型的变量或者返回值类型为bool的函数,当rule
值为True
时即可以触发事件响应器,反之为False
时则不会触发,对,就是这么简单,接下来来讲讲如何使用rule以及如何解决我们上面的问题。
from nonebot import on_keyword
from nonebot.adapters.onebot.v11 import GroupMessageEvent
def _checker(event: GroupMessageEvent) -> bool :
return event.message_type=="group"
word=on_keyword({"你是谁"},rule=_checker)
上面这个例子就是个规则函数的简单应用。因为还没有讲到响应器的参数传递,所以先不细讲,大家只需要知道这个_checker
函数是用来判断接收到的消息类型是否为群聊消息就行。当消息类型为group
,即群聊消息时返回True
,反之返回False
,之后在消息传递到名为word
的事件响应器时,首先会根据rule
参数对应的规则函数_checker
进行处理然后返回判断出来的bool值,再决定要不要触发事件响应器。
嘛,现在回到我们刚刚那个例子,即如何知道TA是在@我?这里有两种方法,一种是自己写规则函数,另一种则是调用Nonebot中内置的to_me
方法。
法一
from nonebot import on_keyword
from nonebot.adapters.onebot.v11 import GroupMessageEvent
def _checker(event: GroupMessageEvent) -> bool :
return event.to_me
word=on_keyword({"你是谁"},rule=_checker)
法二
from nonebot import on_keyword
from nonebot.rule import to_me
word=on_keyword({"你是谁"},rule=to_me())
法二中的to_me
是Nonebot框架自带的一个方法,用于检测消息中是否有在@自己(bot),法一的事件方法我们马上就讲。
第二个问题:如何知道是谁在给我发送消息@我。这个就要涉及到事件响应器的参数传递了,下面我们详细讲讲。
事件响应器函数常用的传入参数一般有以下三种:bot(机器人),event(事件)以及args(参数),这里我们先只讲前两个,第三个args参数我们暂时还用不到。
首先是第一种参数:bot,bot类型的传入参数要用的就只有一个:Bot,下面是使用样例
from nonebot import on_keyword
from nonebot.adapters.onebot.v11 import Bot
word=on_keyword({"你是谁"})
@word.handle()
async def _(bot: Bot):
await word.finish(str(bot.self_id))
在上述代码中可以看到,Bot
作为一个参数传入事件响应器函数当中使用。Bot
其实可以看做Nonebot提供的一个类,当使用机器人的时候创建一个Bot
类,然后我们可以通过这个类来调用与机器人交互的各种属性与方法。比如上面例子当中的self_id
就是Bot
类的一个属性,返回的数据是当前bot的QQ号,类型为int(所以才要转换为str类型,不然会报参数类型不匹配的错误)。
Bot类型有如下的属性
属性名 | 返回值类型 | 说明 |
---|---|---|
self_id | int(整数型) | 机器人自己的QQ号 |
adapter | adapter(协议适配器) | 返回机器人所用的协议适配器 |
还有一些个人认为的Bot的常用方法,因为篇幅限制其他方法以及具体的参数传递就不讲了,可以自行翻阅文档。
方法名 | 作用 |
---|---|
send_msg | 发送(群聊/私聊)消息 |
delete_msg | 撤回消息 |
set_group_ban | 设置群组禁言 |
set_friend_add_request | 设置好友验证是否通过 |
set_group_add_request | 设置加群验证是否通过 |
get_login_info | 获取登录信息 |
get_group_member_info | 获取指定群成员信息 |
get_group_honor_info | 获取群荣誉(龙王等)信息 |
接下来是第二种参数:event事件参数,event类型其实包含很多类:如Event,GroupMessageEvent,PrivateMessageEvent等等。事件参数一些方法其实是和bot重复的,比如self_id等。不过由于事件参数传递的数据更多所以这些信息的获取一般常用事件参数来代替,下面列举了一些常见的事件参数类
类名 | 说明 |
---|---|
Event | 事件 |
GroupMessageEvent | 群消息事件 |
PrivateMessageEvent | 私聊消息事件 |
NoticeEvent | 通知事件 |
GroupUploadNoticeEvent | 群文件上传事件 |
GroupAdminNoticeEvent | 群管理员变动事件 |
GroupDecreaseNoticeEvent | 群人数减少事件 |
GroupIncreaseNoticeEvent | 群人数增加事件 |
GroupBanNoticeEvent | 群管理员禁言事件 |
FriendAddNoticeEvent | 好友增加事件 |
GroupRecallNoticeEvent | 群消息撤回事件 |
FriendRecallNoticeEvent | 私聊消息撤回事件 |
NotifyEvent | 提醒事件(这个文档没翻到) |
PokeNotifyEvent | 群戳一戳事件 |
HonorNotifyEvent | 群荣誉变更事件 |
LuckyKingNotifyEvent | 群红包运气王事件 |
RequestEvent | 请求事件 |
FriendRequestEvent | 好友申请事件 |
GroupRequestEvent | 入群申请事件 |
虽然没全部列举出来,但是这些类目前来说已经完全够用了,如何知道它们下面有哪些属性和方法呢?有两种方法:一是查阅官方文档,二是在编辑器中输入对应的类名后再加上.
就可以跳出对应的提示,然后可以根据语法提示选择需要的方法/属性就行了。
最后再附上一个具体例子
from nonebot import on_keyword
from nonebot.adapters.onebot.v11 import Message,GroupMessageEvent
word=on_keyword({"你是谁"})
@word.handle()
async def _(event:GroupMessageEvent):
if(event.user_id==123456 and event.group_id==654321):
await word.finish(Message("Done!"))
此段代码作用:当群聊654321中里有一个QQ号为123456的人发送包含“你是谁”这三个字的句子时,bot会发送“Done”。
回到我们最初的问题:如何知道是谁在给我发送消息@我?现在答案就明了了,参见以下代码
from nonebot import on_keyword
from nonebot.adapters.onebot.v11 import Message,GroupMessageEvent
from nonebot.rule import to_me
word=on_keyword({"你是谁"},rule=to_me())
@word.handle()
async def _(event:GroupMessageEvent):
uid=event.user_id
await word.finish(Message(str(uid)))
事件响应器主函数当中的变量uid即为我们获取到的“给我们发送消息的人”的QQ号,类型为int型。
最后我们要解决的问题是:如何@回去,在此之前我们需要了解一下Onebot的消息类型。上面我们曾提到word.finish()
方法可以传入四种参数:字符串(Str)/消息(Message)/格式化消息模板(MessageTemplate)/消息段(MessageSegment),其中格式化消息模板用法比较特殊,暂且避开不谈,只讲剩下三种。
字符串(Str)与消息(Message)大部分情况下可以等价,可以替代Message使用,但是有一种特殊情况:消息内包含CQ码的时候只能使用Message。
CQ码是go-cqhttp协议中的一种特殊的标识符,用以发送特殊消息(如图片、语音、@等等),常见的CQ码格式为[CQ:类型,参数=值,参数=值]
,如下面的例子就是CQ码的一种使用
//因为QQ接口的问题,此CQ码现在无法使用,会报错"消息可能被风控",可以尝试其他的CQ码。
@word.handle()
async def _():
await word.finish(Message("[CQ:share,url=https://www.baidu.com,title=百度]"))
上述代码发送了一个百度的链接(不是以文字链接的方式),而是一个可以点击的类似“小程序”的执行框,点击后可以直接跳转。(因为QQ接口的问题,此CQ码现在无法使用,会报错"消息可能被风控",可以尝试其他的CQ码。)
这里我列举了一些常见的CQ码,全部的CQ码请查阅go-cqhttp文档或者OneBot文档。
类型 | 参数 | 作用 |
---|---|---|
face | id=表情ID | 发送QQ内的表情 |
record | file=文件路径/URL | 发送语音(一般为mp3格式) |
at | qq=QQ号,(name=昵称) | @某人(不在群里时可以使用name参数) |
share | url=网站链接,name=网站名 | 发送网站分享 |
music | type=歌曲平台,id=歌曲ID | 发送音乐 |
image | 参数较多,参见文档 | 发送图片 |
reply | id=回复的消息ID,text=消息内容 | 发送回复消息 |
回到刚刚的代码,word.finish(Message("[CQ:share,url=https://www.baidu.com,title=百度]"))
是正确的用法,但如果使用的是word.finish("[CQ:share,url=https://www.baidu.com,title=百度]")
,虽然不会报错,但是go-cqhttp无法识别到CQ码,这样子输出的内容直接就是CQ码本身的文本内容,这点显然不是我们想要的。
不过CQ码不是唯一实现发送特殊消息的方式,除了CQ码之外还有一种叫消息段(MessageSegment)的东西,可以实现与CQ码相同的功能,并且还可以实现一些CQ码无法实现的功能,官方推荐使用消息段来替代CQ码,后续案例也都会使用CQ码。用法如下
@word.handle()
async def _():
await word.finish(MessageSegment.share(url="https://www.baidu.com",title="百度"))
这段代码与上面的[CQ:share,url=https://www.baidu.com,title=百度]
功能是一致的,但是使用MessageSegment方式发送特殊消息更加方便明了(还不用去查文档,打出来IDE就会给语法提示),减轻了编写与后期维护的压力。
现在相信大家已经能解决我们的最后一个问题:如何@回去。示例代码如下,分别使用了CQ码和消息段形式
CQ码
from nonebot import on_keyword
from nonebot.adapters.onebot.v11 import Message,GroupMessageEvent
from nonebot.rule import to_me
word=on_keyword({"你是谁"},rule=to_me())
@word.handle()
async def _(event: GroupMessageEvent):
await word.finish(Message(f"[CQ:at,qq={event.user_id}],你@我了!"))
消息段(推荐!!!)
from nonebot import on_keyword
from nonebot.adapters.onebot.v11 import Message,GroupMessageEvent,MessageSegment
from nonebot.rule import to_me
word=on_keyword({"你是谁"},rule=to_me())
@word.handle()
async def _(event: GroupMessageEvent):
await word.finish(MessageSegment.at(event.user_id))