Skip to content

系统架构

总览

TG-SignPulse 由四个核心层组成:

  1. Vue 3 前端面板
  2. FastAPI 后端 API
  3. 调度与任务服务
  4. tg_signer Telegram 执行引擎

前端

前端负责:

  • 登录与鉴权
  • 账号管理
  • 任务创建与编辑
  • AI 配置
  • 全局设置
  • 运行日志展示

开发模式默认运行在:

text
http://127.0.0.1:3000

后端 API

主要路由包括:

  • /api/auth — 认证与登录
  • /api/user — 用户管理
  • /api/accounts — 账号管理
  • /api/sign-tasks — 签到任务配置(主路径,文件存储)
  • /api/batch/sign-tasks — 签到任务批量操作(enable/disable/delete/run)
  • /api/ops — 运维:调度预览、备份状态/导出、内存统计
  • /api/logs — 执行日志
  • /api/config — 系统配置
  • /api/events — 事件流
  • /api/tasks已弃用 旧版 ORM 任务(兼容保留)
  • /api/batch/tasks已弃用 旧版 ORM 批量操作

后端负责:

  • JWT 鉴权
  • 数据库存储
  • 账号登录流程
  • 任务增删改查
  • 调度同步
  • 关键词监听生命周期管理

调度层

调度层基于 APScheduler。

主要职责:

  • 读取已启用任务
  • fixedrange 任务生成调度
  • 在任务变更后同步调度项
  • listen 模式则交给关键词监听服务,而不是普通 Cron

任务服务

SignTaskService 负责:

  • 任务创建、更新、删除
  • 共享任务的账号聚合
  • 手动执行任务
  • 历史记录和流程日志
  • 失败通知

关键词监听服务

KeywordMonitorService 负责:

  • 从任务配置中提取监听规则
  • 挂载 Telegram message handler
  • 匹配关键词、正则和话题
  • 触发通知、转发或继续动作
  • 在任务变化后重建监听器

执行引擎

tg_signer 负责真正和 Telegram 交互:

  • 发送文本
  • 发送骰子
  • 点击按钮
  • 等待消息变化
  • 调用 AI 识图 / OCR / 计算
  • 处理 FloodWait、重试和部分异常恢复

数据流

定时任务

text
Scheduler
  -> SignTaskService
  -> tg_signer core
  -> Telegram
  -> Log / History / Notification

监听任务

text
Telegram Update
  -> KeywordMonitorService
  -> Keyword Match
  -> Push / Forward / Continue Actions
  -> Log / History

存储层

主要存储分为三部分:

  • db.sqlite:面板数据库
  • sessions/:Telegram 会话
  • .signer/:任务配置与运行相关数据

AI、全局设置和 Telegram API 配置则单独保存在数据目录根部的 JSON 文件中。

设计特点

  • 前后端可一体容器化部署
  • 任务与账号关系支持从单账号扩展到多账号共享
  • 监听任务与定时任务共用动作模型
  • AI 提示词支持逐动作覆盖
  • 数据目录与运行目录分离,便于迁移与备份

扩展约束

当前部署模型以单写主实例为主:APScheduler、Telegram 客户端会话和关键词监听器默认在持有调度锁的进程内协调。

  • 数据库默认仍是 SQLite(WAL),并未取消或强制迁走。可通过 APP_DATABASE_URL / DATABASE_URL 可选切换到 PostgreSQL 等(SQLAlchemy URL,需对应驱动)。面板元数据可外置,但 Telegram session 仍不宜多进程共享同一账号文件
  • 调度锁:启动时尝试获取 data/.scheduler.lockAPP_SCHEDULER_LOCK=0 可关闭)。仅锁持有者注册 sign- / db- 业务 job,降低多副本重复签到风险。
  • 监听分片APP_MONITOR_SHARD=i/n + 可选 APP_MONITOR_ACCOUNT_ALLOWLIST,按账号拆分关键词监听;同一账号的 session 仍只能由一个进程持有
  • 旧任务 API/api/tasks 默认只读(APP_LEGACY_TASKS_READONLY=1),新功能统一 /api/sign-tasks
  • 任务队列:完整队列化(Celery/RQ 等)尚未内置;当前以进程内 APScheduler + 文件锁 + 监听分片为过渡方案。
  • 数据库锁定的排查步骤见 运维手册 - 场景 2:数据库锁定
  • 反向代理可以扩展入口流量,但不等同于后端多副本扩展。

基于 VitePress 构建 · 默认 SQLite,可选 PostgreSQL