ClassHelper/docs/management/upgrade.md

---
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](https://github.com/LoveChengke/classhelper/releases)
页面取，可用 `SHA256SUMS-<版本>.txt` 核对。

## 升级步骤

### Windows 安装包

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

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

### Linux

```bash
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

```bash
docker compose pull
docker compose up -d
```

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

### 手动 / 源码

拉新代码（或覆盖安装新的服务端程序）→ 重启服务端。启动时 `db-bootstrap` 会用账本表 `_ch_migrations`
对比已执行的迁移，只补跑缺的那些：

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

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

### 客户端（ClassHelper 班级端）

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

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

## 升级前的准备清单

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

## 给维护者

打版本、出安装包、发 Release 的完整流程见[版本迭代与发布](../dev/release.md)。

### 客户端远控与更新修复

先升级服务端，再推送修复后的客户端安装包。服务端兼容旧客户端读取顶层心跳字段，旧设备也可领取更新；第一次升级前仍遵循旧客户端的空闲安装条件。新客户端支持立即、放学后和空闲安装三种策略。放学后取指定的最早时间与当天最后一节课结束时间中的较晚者；设备离线时在再次上线后处理。