Bot配置文件
Bot配置文件通常情况下是配合Spring Boot starter的时候用的。
当使用Spring Boot starter时, 配置文件放在资源目录 resources 中的 /simbot-bots/ 目录下, 以 .bot.json 格式结尾,例如 myBot.bot.json。
属性说明
配置文件对应的反序列化类型是 OneBotBotSerializableConfiguration。
顶层结构
- component
固定值,必须为
simbot.onebot11。- authorization
鉴权与连接地址相关配置,必填。
- config
额外可选配置。绝大部分情况下都可以省略。
authorization
- botUniqueId
组件内部用于区分不同 Bot 的唯一 ID。 建议直接使用你的机器人 QQ 号或一个稳定且不会重复的标识。
- apiServerHost
HTTP API 服务地址。 如果不配置,运行时默认值来自
OneBotBotConfiguration.apiServerHost, 即http://localhost:3001。- eventServerHost
正向 WebSocket 事件地址。 如果为
null,则不会建立 ws 连接,也不会接收推送事件。- accessToken
共享鉴权 token。 如果配置了它,会同时写入 API 与事件连接两侧。
- apiAccessToken
只用于 HTTP API 请求的 token。 如果同时配置了
accessToken与apiAccessToken, 则以apiAccessToken为准。- eventAccessToken
只用于正向 WebSocket 连接的 token。 如果同时配置了
accessToken与eventAccessToken, 则以eventAccessToken为准。
config
- apiHttpRequestTimeoutMillis / apiHttpConnectTimeoutMillis / apiHttpSocketTimeoutMillis
分别对应 Ktor
HttpTimeout的请求、连接、读写超时配置。 如果三者都不提供,则不会额外配置超时插件。- wsConnectMaxRetryTimes
每次 ws 断开后重新连接的最大尝试次数。 运行时默认值为
2147483647。- wsConnectRetryDelayMillis
每次 ws 重连之间的等待时间,单位毫秒。 运行时默认值为
3500。- defaultImageAdditionalParams
为“非
OneBotImage类型但最终会被当作图片发送”的资源提供默认附加参数。 它不会影响你已经直接构建好的OneBotImage。可选子项:
localFileToBase64typecacheproxytimeout
使用建议
只做 API 调用时,可不配置
eventServerHost需要监听事件时,再配置
eventServerHost如果你的服务端 API 与 ws 分离部署,务必分别填写对应地址