Files
auto_control/doc
butubb f22263ab45 feat: 数据库连接层改造——库目标由 .env 装配 + 环境防呆(迁 MySQL 第一步)
为把数据库从单文件 SQLite 迁到 MySQL 5.7 铺路。本期不改后端:
DB_HOST 为空时仍走 SQLite,本地开发无感。

- config.py: 新增 DEPLOY_ENV(默认 dev)与 DB_HOST/PORT/USER/PASSWORD/NAME/
  CHARSET/COLLATION、DATABASE_URL、两个逃生阀(DB_ALLOW_ENV_MISMATCH /
  DB_ALLOW_SQLITE_FALLBACK)
- core/db_config.py(新增): URI 组装;按方言分叉的引擎参数(utf8mb4、
  pool_pre_ping、pool_recycle=1800、READ COMMITTED、STRICT_TRANS_TABLES);
  连接探活;app_meta 方言中立读写(MySQL 里 key 是保留字,需反引号)
- 防混库三层: ①库名与环境绑定(dev→auto_control_dev / prod→auto_control)
  ②库标签 app_meta.deployment_env 与 .env 声明比对 ③启动横幅打印当前库
  (生产用 WARNING 级)。不符直接拒绝启动并说明两边分别是什么
- web_server.py: 硬编码 sqlite URI → db_config;配置错在装配期就 exit 2;
  init_db 之后跑库标签校验 + 横幅
- core/models.py: PRAGMA 监听器加 sqlite 类型守卫——它挂在 Engine 基类上,
  MySQL 连接执行 PRAGMA 会直接导致建连失败
- requirements.txt 加 PyMySQL;scripts/start.sh 依赖守卫加 pymysql,
  并在 exec 前打印 DEPLOY_ENV/DB_NAME/DB_HOST
- .env.example 新增「数据库」段;DEVELOPMENT.md §4.1/4.2、DEPLOY.md §2.2 同步

验证: 用 DATABASE_URL 指向 users.db 的一致快照副本跑通主要只读接口
(health/devices/jobs/pool/groups/discovery/summary 全 200,app_meta 读写正常);
DEPLOY_ENV=prod 且无 DB_HOST 时退出码 2;开 DB_ALLOW_SQLITE_FALLBACK 后可回退。
2026-09-13 10:27:14 +08:00
..

auto_control 文档总索引

本目录是 auto_control(Android 多设备自动化任务平台)的唯一权威文档源。代码即事实,文档与代码不一致时以代码为准,并顺手把文档改对(见文末维护约定)。

项目名称统一为 auto_control(历史文档里出现过的 platform-tools 均为旧名,已全部改名)。


1. 文档地图

文档 内容 主要读者
ARCHITECTURE.md 架构详解:分层、启动装配顺序、线程与并发模型、设备生命周期、任务调度链路、状态机、关键设计决策与扩展点 所有开发者(先读这篇)
DATA_MODEL.md 数据模型:SQLite 表与字段、schema 迁移、非模型表、app_meta 配置键、数据目录、备份覆盖清单 后端开发、运维
API.md HTTP 接口全量:按蓝图分组的路由表、鉴权、请求/响应示例、非 JSON 响应、错误分支 前端开发、外部接入
TASK_DEV.md 任务与步骤开发:TaskType/TaskJob 概念、18 种步骤全表、选择器与定位、自定义动作、新增任务类型模板 写任务的开发
MCP.md MCP 手机控制手册:19 个 de_* 工具用法、写操作门控、坐标换算、接入示例 接入方、数字员工
MCP_DESIGN.md MCP 设计文档:边界划分、错误码、白名单/审计设计、演进方向 平台开发者
AI_CONSOLE.md AI 控制台:会话/SSE、经验库、动作库、巡检、Markdown 渲染、推理链、token 统计 使用者、平台开发者
AI_TASK_GEN.md AI 建任务:设计稿与里程碑(P0 未实现,属规划) 平台开发者
DEPLOY.md 部署与运维:环境准备、生产容器、数据备份导出/导入、故障排查 运维、部署者
DEVELOPMENT.md 开发手册:git 流程、技术红线、本地开发与调试、常见开发任务、文档同步约定 所有开发者
STF_REMOVAL.md 历史记录:摘除 OpenSTF 的迁移过程(阶段 0-3) 追溯背景时参考
staffdeck/KNOWLEDGE_BASE.md 给 StaffDeck 数字员工的知识库(MCP 接入/工具/约定/红线) 外部 AI 接入方
staffdeck/JOB_SPEC.md 数字员工岗位说明(岗位描述/看板摘要/执行约束) 外部 AI 接入方
backlog/TODO.md 已确认但暂缓的待办(含已知问题) 所有开发者

项目根目录的 README.md 是项目总览与快速上手(面向第一次接触项目的人),细节都在本目录。


2. 推荐的阅读路径

你的目的 按顺序读
第一次接触项目 根 README.md → ARCHITECTURE.md → DATA_MODEL.md
搭环境跑起来 根 README.md 的「快速上手」→ DEPLOY.md
写/改任务 TASK_DEV.md → ARCHITECTURE.md §任务调度
改后端/前端 DEVELOPMENT.md(流程+红线+本地开发)→ ARCHITECTURE.md → API.md
对外提供手机控制 MCP.md → staffdeck/KNOWLEDGE_BASE.md
排故障 DEPLOY.md §故障排查 → DEVELOPMENT.md §调试

3. 文档维护约定(红线)

与「doc 同步红线」一致:任何功能/配置/接口/表结构的增删改,必须在同一个 commit 里同步更新对应文档。

改动类型 必须同步的文档
HTTP 接口(新增/改参数/改返回/改鉴权) API.md
数据库表/字段/迁移 DATA_MODEL.md + ARCHITECTURE.md
新增持久化表 还要登记进 core/system_backup.py 的 SUMMARY_TABLES + DEPLOY.md §3.5(备份覆盖红线)
config.py / .env 键 DEVELOPMENT.md 配置速查 + DEPLOY.md + .env.example
页面 Tab / 子分栏 / 前端 JS 拆分 ARCHITECTURE.md §前端 + DEVELOPMENT.md
任务类型 / 步骤 schema TASK_DEV.md
常驻线程 / 进程装配 ARCHITECTURE.md §线程与并发
MCP 工具 MCP.md + MCP_DESIGN.md
对外接入约定 staffdeck/KNOWLEDGE_BASE.md
暂缓项 / 已知问题 backlog/TODO.md(完成时移出并同步相关文档)

新增文档时:在本文 §1 表格里登记一行,并在根 README 的「更多文档」里加链接——否则等于没写。

历史文档不追改:STF_REMOVAL.md 是迁移阶段的历史记录,只增不改,不随现状改写。