基于go-cqhttp框架实现QQ机器人windows操作系统下go-cqhttp框架的安装与配置，并利用python编

本篇文章主要包含以下内容:

go-cqhttp框架的安装与配置
利用python编写监听和功能模块

笔者使用的相关环境信息如下:

环境	版本信息
操作系统	Window 10
go-cqhttp	v1.0.0-rc4
python	3.9.7

1.安装go-cqhttp框架

Github下载地址: Releases · Mrs4s/go-cqhttp (github.com)

点击上述地址进入Github,在页面中找到符合自己操作系统的安装包下载即可.

Windows系统：点击 Show all 25 assets 找到 go-cqhttp_windows_amd64.zip,点击即可进行下载.

或者直接复制下面地址到浏览器即可进行下载,但此方法具有一定的时效性
https://github.com/Mrs4s/go-cqhttp/releases/download/v1.0.0-rc4/go-cqhttp_windows_amd64.zip

下载完成后，解压得到三个文件: go-cqhttp.exe,LICENSE,README.md

双击exe文件即可进入初始化.如果出现下图提示,一直点击"确定"即可.

如果提示 "此应用无法在你电脑上运行",可能是因为上一步下载的文件出错,请检查文件名是否为amd64或更换为arm.

随后点击生成的go-cqhttp.bat文件,出现如下图界面,根据提示选择所需通信方式即可,这里笔者选择的是 $0$

2.修改配置文件

打开config.yml, 更改配置文件,具体参考官方文档: 配置 | go-cqhttp 帮助中心

初次配置建议修改的地方有:

account下的uin:用于配置机器人登录的qq账号;password可填可不填
address和url中的端口号,不与已占用端口冲突则不需要修改

笔者配置文件如下(部分信息已做隐私处理)：

account: # 账号相关
  uin: 123456789 # QQ账号
  password: '' # 密码为空时使用扫码登录
  encrypt: false  # 是否开启密码加密
  status: 0      # 在线状态 请参考 https://docs.go-cqhttp.org/guide/config.html#在线状态
  relogin: # 重连设置
    delay: 3   # 首次重连延迟, 单位秒
    interval: 3   # 重连间隔
    max-times: 0  # 最大重连次数, 0为无限制

  # 是否使用服务器下发的新地址进行重连
  # 注意, 此设置可能导致在海外服务器上连接情况更差
  use-sso-address: true
  # 是否允许发送临时会话消息
  allow-temp-session: false

heartbeat:
  # 心跳频率, 单位秒
  # -1 为关闭心跳
  interval: 5

message:
  # 上报数据类型
  # 可选: string,array
  post-format: string
  # 是否忽略无效的CQ码, 如果为假将原样发送
  ignore-invalid-cqcode: false
  # 是否强制分片发送消息
  # 分片发送将会带来更快的速度
  # 但是兼容性会有些问题
  force-fragment: false
  # 是否将url分片发送
  fix-url: false
  # 下载图片等请求网络代理
  proxy-rewrite: ''
  # 是否上报自身消息
  report-self-message: false
  # 移除服务端的Reply附带的At
  remove-reply-at: false
  # 为Reply附加更多信息
  extra-reply-data: false
  # 跳过 Mime 扫描, 忽略错误数据
  skip-mime-scan: false

output:
  # 日志等级 trace,debug,info,warn,error
  log-level: warn
  # 日志时效 单位天. 超过这个时间之前的日志将会被自动删除. 设置为 0 表示永久保留.
  log-aging: 15
  # 是否在每次启动时强制创建全新的文件储存日志. 为 false 的情况下将会在上次启动时创建的日志文件续写
  log-force-new: true
  # 是否启用日志颜色
  log-colorful: true
  # 是否启用 DEBUG
  debug: false # 开启调试模式

# 默认中间件锚点
default-middlewares: &default
  # 访问密钥, 强烈推荐在公网的服务器设置
  access-token: ''
  # 事件过滤器文件目录
  filter: ''
  # API限速设置
  # 该设置为全局生效
  # 原 cqhttp 虽然启用了 rate_limit 后缀, 但是基本没插件适配
  # 目前该限速设置为令牌桶算法, 请参考:
  # https://baike.baidu.com/item/%E4%BB%A4%E7%89%8C%E6%A1%B6%E7%AE%97%E6%B3%95/6597000?fr=aladdin
  rate-limit:
    enabled: false # 是否启用限速
    frequency: 1  # 令牌回复频率, 单位秒
    bucket: 1     # 令牌桶大小

database: # 数据库相关设置
  leveldb:
    # 是否启用内置leveldb数据库
    # 启用将会增加10-20MB的内存占用和一定的磁盘空间
    # 关闭将无法使用 撤回 回复 get_msg 等上下文相关功能
    enable: true
  sqlite3:
    # 是否启用内置sqlite3数据库
    # 启用将会增加一定的内存占用和一定的磁盘空间
    # 关闭将无法使用 撤回 回复 get_msg 等上下文相关功能
    enable: false
    cachettl: 3600000000000 # 1h

# 连接服务列表
servers:
  # 添加方式，同一连接方式可添加多个，具体配置说明请查看文档
  #- http: # http 通信
  #- ws:   # 正向 Websocket
  #- ws-reverse: # 反向 Websocket
  #- pprof: #性能分析服务器
  - http: # HTTP 通信设置
      address: 127.0.0.1:5700 # HTTP监听地址
      timeout: 5      # 反向 HTTP 超时时间, 单位秒，<5 时将被忽略
      long-polling:   # 长轮询拓展
        enabled: false       # 是否开启
        max-queue-size: 2000 # 消息队列大小，0 表示不限制队列大小，谨慎使用
      middlewares:
        <<: *default # 引用默认中间件
      post:           
      # 反向HTTP POST地址列表
      - url: http://127.0.0.1:5701/ # 地址
        secret: ''                  # 密钥
        max-retries: 0            # 最大重试，0 时禁用
        retries-interval: 1000      # 重试时间，单位毫秒，0 时立即

3.初次登录机器人

配置完成后,再次点击go-cqhttp.bat,按照提示进行操作即可.

笔者未配置密码,进行扫码登录如下所示:

登录成功后,会出现如下图所示信息:

此时向该机器人所在qq发送消息,会收到类似下图提示,'收到好友 xxx 的消息: xxx(-xxx)'

出现[WARNING]直接忽略即可,不影响机器人的正常运行.

若出现无法登录的情况,可以将device.json中的protocol修改为 2

4. 利用python监听端口

所需依赖: Flask,request,urllib.如何安装依赖在此不赘述.

新建main.py,写入以下内容:

from flask import Flask, request
# 导入自己编写的功能模块,将在后文提及
import api

app = Flask(__name__)
# '''监听端口，获取QQ信息'''
@app.route('/', methods=["POST"]) 
def post_data():
    requText = request.get_json()
    # 打印获取到的信息
    print(requText,end='\n#####\n')
    return 'OK'

if __name__ == '__main__':
    # 绑定端口,此处port需于cofig中的url一致
    app.run(debug=True, host='127.0.0.1', port=5701)

该程序的作用为获取机器人框架传来的信息,先启动bat文件后,再运行该python程序：

若终端显示上图内容，则说明该监听程序编写成功.

其中'post_type':'meta_event'代表心跳包,用于给qq服务器持续发送数据包模拟真实设备.

正常消息所返回的json对象格式如下代码所示:

{
    "post_type": "message",
    "message_type": "private",
    "time": 1677741248,
    "self_id": 此处为机器人qq号已做隐私处理,
    "sub_type": "friend",
    "message": "你好",
    "raw_message": "你好",
    "font": 0,
    "sender": {
        "age": 0,
        "nickname": "FsAnna",
        "sex": "unknown",
        "user_id": 此处为发送消息者qq号已做隐私处理
    },
    "message_id": -2061428659,
    "user_id": qq号,
    "target_id": qq号
}

更多类型以及json中字段详细信息请参考官方文档:事件 | go-cqhttp 帮助中心

5.编写功能模块

在上一步的基础上,我们已经能够获得机器人框架返回的json数据包,我们只需提取其中有用的数据，然后调用相关api即可实现各种各样的功能.

下面以发送信息为例,作为简单的例子引入.

首先翻阅官方api文档:API | go-cqhttp 帮助中心,找到'发送私聊消息'这一部分内容

由上图可知,发送消息需要用到的基本数据有: uesr_id表示消息发送给谁,message表示发送什么消息,至于其他参数我们暂且忽略.

此时我们编写这样一个功能: 若给机器人发送私聊消息,机器人将回复同样的消息.

获取 [是谁] 给机器人发送消息,即user_id:

更改main.py的代码内容如下:

from flask import Flask, request

# 导入自己编写的功能模块,将在后文提及
import api

app = Flask(__name__)

# '''监听端口，获取QQ信息'''
@app.route('/', methods=["POST"]) 
def post_data():
    requText = request.get_json()
    # 打印获取到的信息
    print(requText,end='\n#####\n')
    if requText.get('post_type') == 'message':
        meg_type = requText.get('message_type')
        # 获取发送者qq以及具体消息内容
        uid = requText.get('sender').get('user_id')
        msg = requText.get('raw_message')
        # 发送私聊消息
        if meg_type == 'private':
            # 调用api发送信息
            api.send_msg(msg,uid)
    return 'OK'


if __name__ == '__main__':
    # 绑定端口,此处port需于cofig中的url一致
    app.run(debug=True, host='127.0.0.1', port=5701)

编写功能模块代码,实现发送信息.

在同一目录下创建文件api.py,填入以下内容:

from urllib import parse
import requests
# 该url端口需与address一致
baseUrl = 'http://127.0.0.1:5700/'

def send_msg(message,uid):
    # 对消息进行url编码
    encodeMsg = parse.quote(message)	
    # 构造 调用api的payload
    payload = baseUrl + 'send_private_msg?user_id={0}&message={1}'.format(uid,encodeMsg)
    # 调用api
    requests.get(url=payload)
    return "Ok"

此时我们开启go-cqhttp.bat,并运行main.py,当我们给机器人所在qq发送私聊消息时,它就会回复相同信息.

6.编写更多功能

翻阅官方文档查看想要调用的api需要哪些数据
处理监听到的数据包获得所需部分数据
编写功能函数,调用相关api

参考资料

Python + Go-cqhttp + Pyqt5 - 搭建QQ机器人 - 夢想家劉雙濤的博客