Windows 安装 NoneBot2

Posted 2021-09-01 ʚVVcatɞ

使用环境：Python 3.7.10
NoneBot2 官方参考文档：https://v2.nonebot.dev/

NoneBot 仅支持 Python 3.7+
推荐安装一个 Python 3.7+的版本，否则会安装第三方库时会报错。

通过脚手架安装

pip install nb-cli

创建一个完整的项目

可以使用 nb-cli 或者自行创建完整的项目目录：

nb create

• Project Name: 项目名称
• Where to store the Plugin：可选择src目录下
• which adapter(s) would you like to use? ：选择 cqhttp （空格可以确认选择，选择完按回车，键盘方向键控制上下）

• src/plugins: 用于存放编写的 bot 插件
• env, .env.dev, .env.prod: 各环境配置文件
• bot.py: bot 入口文件
• pyproject.toml: 项目依赖管理文件，默认使用 poetry

启动 Bot

python bot.py

安装 NoneBot CQHTTP 适配器

pip install nonebot-adapter-cqhttp

配置 CQHTTP 协议端

下载 go-cqhttp 对应平台的 release 文件：https://github.com/Mrs4s/go-cqhttp/releases
选择 go-cqhttp_windows_amd64.zip下载进行解压
运行 exe 文件

# 第一次运行
未找到配置文件，正在为您生成配置文件中！
请选择你需要的通信方式:
> 1: HTTP通信
> 2: 正向 Websocket 通信
> 3: 反向 Websocket 通信
> 4: pprof 性能分析服务器
请输入你需要的编号，可输入多个，同一编号也可输入多个(如: 233)
您的选择是:13
默认配置文件已生成，请修改 config.yml 后重新启动!

生成默认配置文件并修改默认配置

修改 config.yml 配置文件

# go-cqhttp 默认配置文件

account: # 账号相关
  uin: 12345 # QQ账号
  password: 'xxxx' # 密码为空时使用扫码登录
  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

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
  # 是否启用 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

# 连接服务列表
servers:
  # 添加方式，同一连接方式可添加多个，具体配置说明请查看文档
  #- http: # http 通信
  #- ws:   # 正向 Websocket
  #- ws-reverse: # 反向 Websocket
  #- pprof: #性能分析服务器
  # HTTP 通信设置
  - http:
      # 服务端监听地址
      host: 127.0.0.1
      # 服务端监听端口
      port: 5700
      # 反向HTTP超时时间, 单位秒
      # 最小值为5，小于5将会忽略本项设置
      timeout: 5
      # 长轮询拓展
      long-polling:
        # 是否开启
        enabled: false
        # 消息队列大小，0 表示不限制队列大小，谨慎使用
        max-queue-size: 2000
      middlewares:
        <<: *default # 引用默认中间件
      # 反向HTTP POST地址列表
      post:
      #- url: '' # 地址
      #  secret: ''           # 密钥
      #- url: 127.0.0.1:5701 # 地址
      #  secret: ''          # 密钥
  # 反向WS设置
  - ws-reverse:
      # 反向WS Universal 地址
      # 注意 设置了此项地址后下面两项将会被忽略
      universal: ws://127.0.0.1:8765/cqhttp/ws
      # 反向WS API 地址
      api: ws://127.0.0.1:8765/cqhttp/api
      # 反向WS Event 地址
      event: ws://127.0.0.1:8765/cqhttp/event
      # 重连间隔 单位毫秒
      reconnect-interval: 3000
      middlewares:
        <<: *default # 引用默认中间件

• uid: 改成QQ号
• password: 改成密码
• ws://your_websocket_universal.server: 改成 ws://127.0.0.1:8765/cqhttp/ws
• ws://your_websocket_api.server 改成 ws://127.0.0.1:8765/cqhttp/api
• ws://your_websocket_event.server 改成 ws://127.0.0.1:8765/cqhttp/event

启动 go-cqhttp

运行 go-cqhttp.exe 文件

[2021-05-27 23:51:53] [INFO]: 当前版本:v1.0.0-beta4
[2021-05-27 23:51:53] [INFO]: 用户交流群: 721829413
[2021-05-27 23:51:53] [WARNING]: 虚拟设备信息不存在, 将自动生成随机设备.
[2021-05-27 23:51:53] [INFO]: 已生成设备信息并保存到 device.json 文件.
[2021-05-27 23:51:53] [INFO]: 开始尝试登录并同步消息...
[2021-05-27 23:51:53] [INFO]: 使用协议: iPad
[2021-05-27 23:51:54] [INFO]: Protocol -> connect to server: 113.96.13.95:8080
[2021-05-27 23:51:58] [INFO]: 收到服务器地址更新通知, 将在下一次重连时应用.
[2021-05-27 23:51:58] [INFO]: 登录成功 欢迎使用: 雨
[2021-05-27 23:51:58] [INFO]: 开始加载好友列表...
[2021-05-27 23:51:58] [INFO]: 共加载 1 个好友.
[2021-05-27 23:51:58] [INFO]: 开始加载群列表...
[2021-05-27 23:52:00] [INFO]: 共加载 20 个群.
[2021-05-27 23:52:00] [INFO]: 信息数据库初始化完成.
[2021-05-27 23:52:00] [INFO]: 正在加载事件过滤器.
[2021-05-27 23:52:00] [INFO]: 资源初始化完成, 开始处理信息.
[2021-05-27 23:52:00] [INFO]: アトリは、高性能ですから!
[2021-05-27 23:52:00] [INFO]: CQ HTTP 服务器已启动: 127.0.0.1:5700
[2021-05-27 23:52:00] [INFO]: 正在检查更新.
[2021-05-27 23:52:00] [INFO]: 开始尝试连接到反向WebSocket Universal服务器: ws://127.0.0.1:8765/cqhttp/ws
[2021-05-27 23:52:00] [WARNING]: 连接到反向WebSocket Universal服务器 ws://127.0.0.1:8765/cqhttp/ws 时出现错误: dial tcp 127.0.0.1:8765: connect: connection refused

机器人项目生成好了, 下面是目录结构

lin
├── Dockerfile
├── .env.dev
├── .env.prod
├── README.md
├── bot.py
├── docker-compose.yml
├── pyproject.toml
└── src
    └── plugins

env.dev 文件中的 PORT参数需要修改为8765，要与 go-cqhttp配置文件中给出的反向代理地址的端口一致，也可以根据自己的需求，改成自己需要的端口，在修改端口的同时也要连同 go-cqhttp目录下config.yml 文件中的反向代理端口一起修改。

到此就可以正式运行了

python bot.py

05-28 00:33:43 [INFO] nonebot | NoneBot is initializing...
05-28 00:33:43 [INFO] nonebot | Current Env: dev
05-28 00:33:43 [DEBUG] nonebot | Loaded Config: {'driver': 'nonebot.drivers.fastapi', 'host': IPv4Address('127.0.0.1'), 'port': 8765, 'debug': True, 'api_root': {}, 'api_timeout': 30.0, 'access_token': None, 'secret': None, 'superusers': set(), 'nickname': set(), 'command_start': {'/'}, 'command_sep': {'.'}, 'session_expire_timeout': datetime.timedelta(seconds=120), 'environment': 'dev'}
05-28 00:33:43 [DEBUG] nonebot | Succeeded to load adapter "cqhttp"
05-28 00:33:43 [WARNING] __main__ | Always use `nb run` to start the bot instead of manually running!
05-28 00:33:43 [INFO] nonebot | Running NoneBot...
05-28 00:33:43 [DEBUG] nonebot | Loaded adapters: cqhttp
05-28 00:33:43 [INFO] uvicorn | Uvicorn running on http://127.0.0.1:8765 (Press CTRL+C to quit)
05-28 00:33:43 [INFO] uvicorn | Started reloader process [1165] using watchgod
05-28 00:33:43 [INFO] nonebot | NoneBot is initializing...
05-28 00:33:43 [INFO] nonebot | Current Env: dev
05-28 00:33:43 [DEBUG] nonebot | Loaded Config: {'driver': 'nonebot.drivers.fastapi', 'host': IPv4Address('127.0.0.1'), 'port': 8765, 'debug': True, 'api_root': {}, 'api_timeout': 30.0, 'access_token': None, 'secret': None, 'superusers': set(), 'nickname': set(), 'command_start': {'/'}, 'command_sep': {'.'}, 'session_expire_timeout': datetime.timedelta(seconds=120), 'environment': 'dev'}
05-28 00:33:43 [DEBUG] nonebot | Succeeded to load adapter "cqhttp"
05-28 00:33:44 [INFO] uvicorn | Started server process [1168]
05-28 00:33:44 [INFO] uvicorn | Waiting for application startup.
05-28 00:33:44 [INFO] uvicorn | Application startup complete.
05-28 00:33:44 [INFO] uvicorn | ('127.0.0.1', 14601) - "WebSocket /cqhttp/ws" [accepted]
05-28 00:33:44 [INFO] nonebot | WebSocket Connection from CQHTTP Bot ****** Accepted!

一旦新的配置文件正确生效之后，NoneBot 所在的控制台（如果正在运行的话）应该会输出类似下面的内容（两条访问日志）：

05-28 00:33:44 [INFO] uvicorn | ('127.0.0.1', 14601) - "WebSocket /cqhttp/ws" [accepted]
05-28 00:33:44 [INFO] nonebot | WebSocket Connection from CQHTTP Bot ****** Accepted!

这表示 CQHTTP 协议端已经成功地使用 CQHTTP 协议连接上了 NoneBot。
现在，尝试向你的机器人账号发送如下内容：

/echo Hello Wolrd

NoneBot2启动完成，剩下的可以自己来开发了。