mirror of
https://github.com/snowy-yang/qqbotsdk.git
synced 2026-10-21 09:56:17 +00:00
snowy-yang
bcd69099b6
GUIDE/API 拆为 docs/guide/ 五页与 docs/api/ 七页，侧边栏分组折叠， 旧链接 alias 映射；安装改为 pip install qqbotsdk-py，README 加徽章； 删除 docs 分支同步工作流，pages.yml 直部署（自定义域名 CNAME 随产物带上）。
75 lines
3.8 KiB
Markdown
75 lines
3.8 KiB
Markdown
# 配置与订阅
|
||
|
||
`.env` 环境变量、`intents.toml` 事件订阅与接入方式选择。完整字段参考只在本文。
|
||
|
||
## .env 配置
|
||
|
||
SDK 启动时自动加载项目根目录的 `.env`，`APPID`/`APPSECRET` 缺失启动即报错：
|
||
|
||
```ini
|
||
APPID=你的AppID
|
||
APPSECRET=你的AppSecret
|
||
CONNECTER=websocket # websocket 或 webhook，默认 websocket
|
||
|
||
BASE_URL=https://api.bot.qq.com # 可选，官方 API 地址
|
||
TIMEOUT=5000 # 可选，HTTP 请求超时（毫秒）
|
||
INTENTS_FILE=intents.toml # 可选，事件订阅配置文件路径
|
||
|
||
WEBHOOK_HOST=0.0.0.0 # 以下仅 webhook 接入时生效
|
||
WEBHOOK_PORT=8080
|
||
WEBHOOK_PATH=/qqbot/webhook
|
||
```
|
||
|
||
| 字段 | 环境变量 | 默认 | 说明 |
|
||
|---|---|---|---|
|
||
| `app_id` | `APPID` | 必填 | 缺失启动即 ValueError |
|
||
| `app_secret` | `APPSECRET` | 必填 | 同上 |
|
||
| `connecter` | `CONNECTER` | `websocket` | 仅允许 `websocket`/`webhook` |
|
||
| `base_url` | `BASE_URL` | `https://api.bot.qq.com` | 官方 API 根地址 |
|
||
| `timeout` | `TIMEOUT` | `5000`（毫秒） | 转为 aiohttp `ClientTimeout(total=…)` |
|
||
| `intents_file` | `INTENTS_FILE` | `intents.toml` | 事件订阅配置路径 |
|
||
| `webhook_host` | `WEBHOOK_HOST` | `0.0.0.0` | webhook 监听地址 |
|
||
| `webhook_port` | `WEBHOOK_PORT` | `8080` | webhook 监听端口 |
|
||
| `webhook_path` | `WEBHOOK_PATH` | `/qqbot/webhook` | webhook 回调路径 |
|
||
|
||
`Config` 是 frozen dataclass，`Bot()` 构造时一次性读齐；handler 可标注 `config: Config` 注入。
|
||
|
||
## 事件订阅（intents.toml）
|
||
|
||
SDK 启动时读取 `intents.toml` 计算订阅掩码。订阅粒度就是下面表格里的大类（Intents 分组），把某组设为 `true` 即订阅该组下的全部事件：
|
||
|
||
```toml
|
||
GROUP_AND_C2C_EVENT = true # 群/单聊消息与关注事件
|
||
INTERACTION = true # 互动事件（卡片按钮回调）
|
||
GUILDS = false # 频道/子频道增删改
|
||
```
|
||
|
||
QQ 网关只认分组位掩码，**组内单个事件无法单独开关**——能收到哪些事件由订阅了哪些分组决定（各组包含哪些事件见[事件 payload 对照](/docs/api/events.md)）。分组与特权要求：
|
||
|
||
| 分组 | 位掩码 | 说明 |
|
||
|---|---|---|
|
||
| `GUILDS` | 1 << 0 | 频道/子频道增删改 |
|
||
| `GUILD_MEMBERS` | 1 << 1 | 成员增删改 |
|
||
| `GUILD_MESSAGES` | 1 << 9 | 频道全量消息，**仅私域机器人** |
|
||
| `GUILD_MESSAGE_REACTIONS` | 1 << 10 | 频道表情表态 |
|
||
| `DIRECT_MESSAGE` | 1 << 12 | 频道私信 |
|
||
| `GROUP_AND_C2C_EVENT` | 1 << 25 | 群/单聊消息与关注事件（群机器人核心） |
|
||
| `INTERACTION` | 1 << 26 | 互动事件 |
|
||
| `MESSAGE_AUDIT` | 1 << 27 | 消息审核结果 |
|
||
| `FORUMS_EVENT` | 1 << 28 | 论坛事件，**仅私域机器人** |
|
||
| `AUDIO_ACTION` | 1 << 29 | 音频播放/上麦下麦 |
|
||
| `PUBLIC_GUILD_MESSAGES` | 1 << 30 | 频道公域消息（AT_MESSAGE_CREATE） |
|
||
|
||
分组名即 `Intent` 枚举成员名。配置只接受 `分组名 = true/false`；拼错的分组名、非布尔值，以及旧版"表内逐事件开关"的写法都会在启动时直接抛 `ValueError`（与其静默少订阅，不如启动即报错）。文件缺失则告警并按不订阅任何事件启动。
|
||
|
||
## 接入方式选择
|
||
|
||
| | WebSocket | Webhook |
|
||
|---|---|---|
|
||
| 网络要求 | 能访问外网即可，本地开发友好 | 需公网可达 + HTTPS，仅支持 80/443/8080/8443 端口 |
|
||
| 配置 | 无额外配置 | 平台回调地址填 `https://<域名>:<端口><WEBHOOK_PATH>` |
|
||
| 连接维护 | SDK 自动心跳、断线指数退避重连并 RESUME 续传；服务端约 1 小时会断开连接，SDK 会在临到期前（约 50 分钟）主动重连续传 | SDK 处理 Ed25519 验签、op=13 验证应答、60s TTL 事件去重 |
|
||
| 适用 | 长驻进程、需要会话与重连保障 | 无状态部署、回调型服务 |
|
||
|
||
两种方式下 handler 的写法完全一致，切换只需改 `CONNECTER`。
|