Files
ClassHelper/docs/management/database.md
T
LoveChengke 9d5ac7adf9 feat(shared,server,web,client,plugin)!: 角色与权限重构 + 学期周次 + 课表方向反转(1.2.0)
学生、任课关系、周次口径三处长期靠约定维持的事情,改为由数据模型保证。

学生不是账号
- 拆出独立 Student 表,没有 passwordHash / role / 任何登录字段
- 「学生不能登录」由表结构保证,不再靠「登录前判 role 再 403」的代码分支
- 三张个人数据表外键 userId → studentId;删掉 Enrollment 与 ClassTeacher
- 学生一律称「学号」、教师一律称「工号」,「学生账号」这个概念消失

任课关系唯一来源 = Course(班级 + 科目 + 教师)
- 班主任 = Class.teacherId,科任 = Course.teacherId,同一人两处指向同一账号、不重复建号
- 作业与成绩按科目再收一道:挂科目只由该科任课老师改,没挂科目归班主任 / 管理员
- 新增「任课教师分配」与「班级教师批量导入」(带「使用工号匹配」开关)

成绩与名单
- 成绩等级:百分制 / 等级制 A·B·C·D / 自定义,支持单个与批量改等级
- 按学号查成绩明细(教师端 + 班级端 + 设备令牌),受按班开关控制
- 调班 / 转出(单个与批量)+ 可查历史;学号不变、历史作业成绩留原归属
- 毕业归档页(按年度记录毕业班级 / 毕业生 / 转出学生 / 该届通知与作业)
- 学年升级(未毕业不归档、数据沿用);班级称呼改为「2026级1班」

ClassHelper 班级端在线状态
- Web 端显示 班级 / 设备名 / 设备号 / 在线离线 / 最后在线 / 最后心跳
- lastHeartbeatAt 驱动 60 秒在线窗口,与只表示「带状态上报」的 lastSeenAt 分开

学期周次
- 新增 TermWeek(classId 空串 = 全校默认),管理员可用日期范围选择器逐周配置
- 一键按开学日期生成整学期;联网拉取调休建议(只给建议、不改数据,无外网失败属正常)
- 改周次后随课表下发给教室的 ClassHelper 班级端

课表方向反转
- 主方向改为「服务端 → 教室」自动下发;教室不再自动回传
- 取教室课表改为手动动作(点击前弹警告),插件按待办标记在下一次心跳补报

改名
- 班级小助手 → ClassHelper:界面、窗口标题、托盘、灵动岛、EXE、安装包、
  安装目录、systemd 描述、插件清单与设置页、官网、文档站、README

BREAKING CHANGE: 产品名与 EXE 名变更(班级小助手.exe → ClassHelper.exe),
安装目录随之改变,不支持覆盖安装,需先卸载旧版。
服务端首次启动会自动应用 6 个数据库迁移(学生行按 id 原样搬迁,历史数据不丢),
升级前请先备份。
2026-10-06 19:41:18 +08:00

5.2 KiB
Raw Blame History

title, description
title description
数据库管理 备份与恢复、导出导入、定时备份,以及 Web 管理端里的「数据库管理」模块。

数据库管理

Web 管理端有一个「数据库管理」页(/database,仅管理员可见,后端同样 requireRole('ADMIN')), 把过去要手工做的数据库运维都收进了界面。

它能做什么

能力 说明
连接状态检测 当前类型(SQLite / MySQL)、连通性与延迟、引擎版本、数据体积、16 张表的行数、连接串(MySQL 密码脱敏)
连接测试 对任意目标库试连(切换前的第一步)
一键切换 SQLite ⇄ MySQL:自动「备份当前库 → 改写 schema provider → 生成客户端 / 建表 → 子进程迁移全部数据 → 改写 .env」,异步任务带步骤进度,失败自动回滚
备份 / 恢复 gzip JSON 快照存在 <数据目录>/backups/;手动备份 / 从备份恢复(整库覆盖)/ 删除
定时备份 enabled + 间隔小时数 + 保留份数,配置存在 data/database-settings.json;服务端每 10 分钟检查一次到点任务(进程不运行不补跑)
快捷导入导出 下载快照 JSON(跨库通用)/ 下载数据库文件(仅 SQLite)/ 导入快照(整库覆盖,base64 上传)

关键设计:只有一种快照格式

备份、导入导出、跨库迁移共用同一种「JSON 快照」:

  • 16 张表按拓扑序导出;
  • 恢复时临时关闭外键检查 —— 因为 User.classId → Class 与 Class.teacherId → User 是互相引用的,任何排序都会被其中一侧卡死;
  • 分批 createMany 写入。

因此任意一份备份都能恢复回任意一种受支持的数据库(SQLite 备份可以恢复进 MySQL,反之亦然)。

MySQL 的连接测试 / 建表 / 写入依赖随包内置的 @prisma/adapter-mariadb,不需要额外安装。

三条边界

  1. 主库只支持 SQLite 与 MySQL。Redis 这类内存键值库 Prisma 不支持建表 / 迁移, 接口层直接 422 拒绝;PostgreSQL 暂未纳入。
  2. 切换完成后必须重启服务端(安装版跑 restart.cmd,开发模式重跑 pnpm dev:server)才会连上新库。 切换失败会自动回滚 schema.prisma,.env 只在数据全部迁移成功后才改写。
  3. 目标库必须为空(有表就拒绝)。

安装包体积因此从约 34MB 涨到约 62MB:切换需要随包带上 prisma CLI 与 TypeScript 编译器 (Prisma 7 的生成器产出 .ts 源码,切换后要在目标机上编译进 dist)。

命令行 / SSH 场景的备份

Web 界面适合日常;服务器上更适合用命令。Linux 安装形态有一套现成的:

sudo classhelper backup                       # 备份配置 + 数据库
sudo classhelper backup --note "升级前" --keep 7
sudo classhelper backup list
sudo classhelper backup restore 20261005-033000     # 用某个备份覆盖当前配置与数据(会先停服务)
sudo classhelper backup schedule daily        # 每天 03:30 自动备份(systemd timer,保留 7 份)
sudo classhelper backup schedule off

备份落在 /var/backups/classhelper/<时间戳>[-说明]/:config.env + classhelper.db + meta.json, 目录权限 700、文件 600。

  • SQLite 用 VACUUM INTO 做一致性快照 —— 服务在跑也安全,比直接 cp 可靠得多;
  • MySQL 用 mysqldump --single-transaction,密码经环境变量传给子进程,不进 argv;
  • restore 前会先自动备份现状;恢复的对象是配置与数据,不是程序。

其它形态怎么备份

形态 备份 恢复
Windows 安装包 停服务后复制 data\ 目录(里面有 classhelper.db) 替换后启动
Linux classhelper backup(见上) classhelper backup restore
Docker 备份挂载出来的数据卷 还原数据卷
MySQL(任意形态) mysqldump -u classhelper -p classhelper > backup.sql mysql … < backup.sql

建议:每日自动备份 + 保留 7 份,并且定期真的恢复一次验证备份可用。

变更 JWT_SECRET 会让所有用户重新登录,无必要时不要换。 Linux 上换用 sudo classhelper key rotate。