Files
ClassHelper/docs/management/upgrade.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

6.7 KiB
Raw Blame History

title, description
title description
更新与升级 检查更新与各形态的升级步骤、Linux 的升级回滚链路,以及升级前必须做的准备。

更新与升级

先知道版本是怎么回事

三端共用一套版本口径:

  • 版本号的单一来源是仓库根 package.json。服务端在运行时读它(打包后读的是运行时清单), 不在代码里写死;
  • 比较逻辑放在 @classhelper/shared 的 compareVersions / isNewerVersion,三端共用 —— 避免出现"客户端说有新版、服务端说没有";
  • 数字相同、只有后缀不同时,带后缀的算更新(对应 v0.1.0-fix 这种"同版本号的修复发布")。

检查更新

端 入口 检查路径
服务端 / Web 管理端 顶栏用户菜单 →「检查更新」 浏览器 → 服务端 GET /api/update/check → GitHub
桌面客户端 启动后自动一次(延迟 5 秒)+「设置 → 关于」里的「检查更新」按钮 主进程 → GitHub(不经后端)

两端的路径不同是被约束逼出来的:

  • Web 端不能直连 GitHub。服务端下发的 CSP 里 connect-src 只放行 'self' 与 WebSocket, 浏览器发往 api.github.com 的请求会直接被拦掉。走服务端转发还有个好处:所有管理员共享同一份缓存 (GitHub 匿名限流是 60 次/小时/IP)。
  • 客户端在主进程做。渲染进程的 CSP 与导航防线是安全模型里最要紧的一层, 不让它去连外部域名、解析外部 JSON。

"查不到"是设计内的结果

机房服务器与教室机器常常只有内网,请求会超时或失败。这时接口返回 ok: false + 一句人话 (「无法连接 GitHub,本机可能没有外网」),界面按"暂时查不到更新"呈现并给重试入口, 而不是弹红字报错。

失败结果同样进缓存 —— 否则断网时每点一次按钮都要白等一个超时。

细节 说明
缓存 两端各缓存 30 分钟;?force=1 绕过服务端缓存,但仅管理员生效(否则任意登录用户都能刷爆匿名限流)
权限 任何已登录用户都能查(信息来自公开仓库);force 除外
只提示一次 客户端启动检查发现新版才推提示;点「忽略此版本」记进配置,同一版本不再提示

更新只提示,不自动下载、不自动安装。安装包仍由人从 Releases 页面取,可用 SHA256SUMS-<版本>.txt 核对。

升级步骤

Windows 安装包

  1. stop.cmd 停止服务;
  2. 备份 data 目录;
  3. 运行新版本安装程序 —— 覆盖安装会保留原有 .env,JWT 密钥与端口设置不变, 用户不需要重新登录;
  4. start.cmd 启动。数据库结构如有变更,会在首次启动时自动补跑迁移。

如果升级后需要重新登录,说明 .env 被覆盖了(JWT 密钥变了),检查安装目录权限。

Linux

sudo classhelper upgrade --check            # 只检查有没有新版本
sudo classhelper upgrade                    # 升到最新版
sudo classhelper upgrade --version 1.2.0    # 升到指定版本
sudo classhelper upgrade --url ./classhelper-server-linux-x64-1.0.1.tar.gz --sha256 <哈希>   # 内网离线
sudo classhelper upgrade --url <包> --force # 强制重装同一版本

sudo classhelper rollback --list            # 看有哪些程序快照
sudo classhelper rollback                   # 回滚到最近一份(会问一次确认)

upgrade 的完整链路(任一步失败都不改动程序文件):

解析目标版本 → 下载 → 校验 sha256 → 备份数据与配置 → 快照当前程序文件 →
停服 → 替换程序文件(改名 + 就位,data/ 与配置原地不动)→ 起服 → 轮询 /healthz
   ↘ 失败:自动用刚才的快照回滚并重新起服,再告诉你失败原因

两点必须知道:

  1. 升级不会回滚数据库结构。如果新版执行过迁移,回滚程序前要确认旧版还能读新库, 必要时用 classhelper backup restore 连数据一起回退。
  2. 替换程序文件用的是"改名 + 就位"而不是删除重写:升级时正在运行的就是 bin/classhelper 自己, 必须先改名再放新文件,运行中的进程继续读旧 inode,否则 bash 会读到半个脚本。

Docker

docker compose pull
docker compose up -d

数据库迁移在启动时自动补跑。

手动 / 源码

拉新代码或替换免安装目录 → 重启服务端。启动时 db-bootstrap 会用账本表 _ch_migrations 对比已执行的迁移,只补跑缺的那些:

  • 全新安装:依次执行全部迁移并创建初始管理员;
  • 覆盖安装:只补跑账本里没有的迁移(已存在的表 / 索引自动跳过);
  • 已是最新:不做任何写操作。

日志里会明确写出「全新安装 / 升级安装」、应用了几个迁移、跳过了几个已存在对象。

客户端(ClassHelper 班级端)

从 Releases 取新的 setup.exe 覆盖安装即可,配置在 %APPDATA%,不受影响。

如果你是在自己维护的机器上只替换了 releases/ 里的产物、而没有同步到安装目录, 用户打开的还是旧的 resources/app.asar —— 表现为"改了但界面不生效"。 覆盖升级时用 robocopy ... /E 推一遍,再对那个副本跑一次打包版冒烟确认。

ClassIsland 插件

必须先完全退出 ClassIsland(它会锁住 DLL),再覆盖插件,然后重启。 插件配置 Config\Plugins\<插件 id>\Settings.json 里存着服务器地址与设备令牌,别覆盖它。

升级前的准备清单

  • 备份数据(classhelper backup / 复制 data 目录 / mysqldump);
  • 记下当前版本号,必要时能回滚到它;
  • 挑一个没课的时间 —— 升级期间实时推送会中断;
  • 升级后确认 /readyz 是 200,并且客户端顶栏的实时通道显示"已连接"。

给维护者

打版本、出安装包、发 Release 的完整流程见版本迭代与发布。