问题: verify:e2e 的班级账号段会临时把班级码改成 E2E####,结束时只还原了密码,
导致演示实例(以及随后跑的打包产物冒烟)拿着文档默认码 G101 登录被 401。
修复:
- e2e 开始前记录该班原本的班级码,结束时连码带密码一起还原
- 新增断言'清理:班级码恢复为验证前的原值(不污染演示数据)',并断言用原码仍可登录
- README 权限矩阵段落补充需求 6/7 的成绩导入取舍说明与放开范围(6 处改动清单)
验收: verify:e2e 126/126(结束后实例仍为 G101/123456)
打包产物(portable.exe) 47/47, packaged=true, login=高一(1)班 classSession=true
班级小助手(Class Helper)
班级信息管理系统,采用 pnpm monorepo,包含后端服务、Web 管理端(教师/管理员)与 桌面客户端(学生)三端。核心链路:
教师在 Web 端发布内容
│ REST API(JWT 鉴权)
▼
后端服务(Express + Prisma)
│ 写入数据库 + 按班级房间广播
▼
Socket.IO ──► class:{classId} 房间 ──► 学生桌面客户端实时更新 UI
当前交付范围
| 阶段 | 内容 | 状态 |
|---|---|---|
| 1 | pnpm monorepo 脚手架、TypeScript / ESLint / Prettier / 环境变量 | ✅ 已完成 |
| 2 | 后端:Prisma schema + 迁移 + 种子数据 + JWT 认证 + RBAC + 模块化 REST API + Socket.IO | ✅ 已完成 |
| 3 | Web 管理端:登录、主布局、仪表盘、班级/学生/课表/作业/通知/成绩页面、Axios 封装、实时提示 | ✅ 已完成 |
| 4 | EXE 客户端:Electron 主进程/preload/渲染进程、登录、课表/作业/通知/成绩/设置、实时推送、IndexedDB 离线缓存 | ✅ 已完成(冒烟验证 47/47) |
| 5 | 三端联调脚本、打包命令、完整 README | ✅ 已完成(三套安装包 + 两套 UI 回归测试) |
| 6 | 测试账号与种子数据说明 | ✅ 已完成(见下文) |
| 7 | 生产化:服务端安装程序(内置 Node)、Web 端 PWA 可安装、Docker + Nginx 部署、生产加固与运维文档 | ✅ 已完成(见 docs/production.md) |
| 8 | 客户端灵动岛(通知浮窗,上课隐藏 / 下课弹出 / 紧急立即展开)与上课时段紧急通知二次确认 | ✅ 已完成(见"上课时段策略") |
与原始提示词的两处偏差(已与你确认)
- 桌面客户端采用 Electron + Vue 3(而非 Avalonia/FluentAvalonia):正文 90% 的要求 (Socket.IO Client、Pinia、IndexedDB 离线缓存、electron-builder)都基于 Electron, 且本机没有 .NET SDK。
- 数据库 先用 SQLite(libSQL 内嵌)跑通 MVP,并预留 MySQL 切换:本机没有可用 MySQL 实例;
docs/mysql.md给出云数据库切换的完整步骤,deploy/提供 MySQL 版 Compose。
三套交付产物
| 产物 | 文件 | 用途 |
|---|---|---|
| 服务端 + Web 管理端安装程序 | release-server/班级小助手服务端-0.1.0-x64-setup.exe(34 MB) |
装到教师电脑/校服务器即完整系统,内置 Node 运行时,双击安装、开机自启、自动建库建号 |
| 学生客户端安装程序 | packages/desktop-client/release/班级小助手-0.1.0-x64-setup.exe(107 MB) |
学生机安装(NSIS 安装包) |
| 学生客户端单文件版 | packages/desktop-client/release/班级小助手-0.1.0-x64-portable.exe(106.9 MB) |
免安装直接运行(U 盘分发) |
| Web 管理端(PWA) | 由服务端在 / 直接托管 |
浏览器打开即用,可在 Edge/Chrome 中「安装为应用」;已适配手机小屏(1Panel 风格抽屉导航) |
生产部署(Windows 安装包 / Docker + MySQL / 手动部署)请看 docs/production.md。
目录结构
class-helper/
├── package.json # 根脚本(dev / build / db:* / verify:* / dist:* / icons)
├── pnpm-workspace.yaml # workspace 定义 + allowBuilds(pnpm 11 依赖构建白名单)
├── tsconfig.base.json # 共享 TS 基础配置
├── eslint.config.mjs # ESLint 扁平配置(TS + Vue)
├── .dockerignore # 容器构建上下文排除项
├── build/icon.{ico,png} # 应用图标(由 pnpm icons 生成)
├── scripts/
│ ├── use-database.mjs # SQLite ⇄ MySQL provider 切换助手
│ ├── generate-icons.mjs # 用 Electron 渲染 SVG 生成 PNG/ICO 图标
│ ├── dist-server.mjs # 服务端 + Web 管理端 打包(免安装目录 + NSIS 安装程序)
│ ├── lib/electron-env.mjs # 启动 Electron 的公共处理(清理 RUN_AS_NODE + 定位可执行文件)
│ ├── nsis/server-installer.nsi# 安装程序脚本模板
│ └── ui-smoke/ # Web 管理端 UI 真实点击回归测试(Electron 驱动 + 上课时段探针)
├── deploy/ # 生产部署:Dockerfile / docker-compose.yml / nginx.conf
├── docs/
│ ├── production.md # 生产部署指南(三种形态 + 运维 + 安全清单)
│ └── mysql.md # MySQL 切换指南
└── packages/
├── shared/ # 三端共享:类型契约、常量、工具函数
│ └── src/{types,constants,utils,index}.ts
├── server/ # 后端服务
│ ├── prisma/schema.prisma # 数据模型
│ ├── prisma/migrations/ # 迁移历史(已生成并应用)
│ ├── prisma/seed.ts # 种子数据
│ ├── prisma.config.ts # Prisma 7 配置(迁移/种子/连接串)
│ ├── scripts/verify-e2e.mjs # 后端端到端验收脚本(126 项)
│ └── src/
│ ├── app.ts # Express 装配(静态托管 + 探针 + 限流 + 模块挂载)
│ ├── index.ts # 启动入口(自检/初始化 + HTTP + Socket.IO + 优雅退出)
│ ├── config/env.ts # 环境变量校验(zod)+ 生产配置自检
│ ├── lib/ # db / db-bootstrap / web-static / http / jwt / access(RBAC) / mappers
│ ├── middleware/ # auth / error / validate / security(helmet+限流+耗时日志)
│ ├── realtime/ # socket.ts + bus.ts(事件总线)
│ └── modules/ # 功能模块 + registry.ts
├── web-admin/ # Web 管理端(Vue 3 + Vite + Element Plus + PWA)
│ ├── public/ # manifest / sw.js / 图标(由 pnpm icons 生成)
│ └── src/{api,stores,router,layouts,views,styles}
└── desktop-client/ # EXE 客户端(Electron + Vue 3)
├── electron-builder.yml # 打包配置(nsis 安装包 + portable 单文件)
├── build/icon.ico # 应用图标(electron-builder 自动使用)
├── vite.config.mts # 渲染进程构建(base: './',hash 路由)
├── scripts/{build-main,dev,smoke,dist-win}.mjs
└── src/
├── main/ # 主进程:窗口/单实例/配置持久化(IPC)/冒烟验证/灵动岛
├── preload/ # contextBridge 安全桥(不暴露 ipcRenderer 本体)
├── island/ # 灵动岛渲染进程(独立透明置顶窗口)
├── types/desktop.d.ts # 主进程 <-> 渲染进程契约
└── renderer/ # 渲染进程:api / stores / cache / router / layouts / views
技术栈
| 层 | 选型 | 版本 |
|---|---|---|
| 包管理 | pnpm workspace | 11.8.0 |
| 语言 | TypeScript | 5.9.3(typescript-eslint 要求 < 6.1,因此未用 7.x) |
| 后端 | Node.js + Express | 24.18 / 5.2 |
| ORM | Prisma + driver adapter | 7.10(+ @prisma/adapter-libsql) |
| 实时 | Socket.IO | 4.8 |
| 认证 | jsonwebtoken + bcryptjs | 9.0 / 3.0 |
| 校验 | zod | 4.6 |
| Web 端 | Vue 3 + Vite + Element Plus + Pinia + Vue Router + Axios + ECharts | 3.5 / 8.3 / 2.14 / 4.0 / 5.3 / 1.20 / 6.1 |
| EXE 客户端 | Electron + Vue 3 + Element Plus + Pinia + Socket.IO Client + IndexedDB | 44.3 / 3.5 / 2.14 / 4.0 / 4.8 |
| 打包 | electron-builder(nsis / portable) | 26.15 |
运行环境要求:Node.js ≥ 20.19(Prisma 7 硬性要求,推荐 22/24)。
快速开始
# 1. 安装依赖(Node >= 20.19,pnpm >= 10)
pnpm install
# 2. 准备环境变量(后端)
cp packages/server/.env.example packages/server/.env
# → 至少修改 JWT_SECRET;本地开发可直接使用仓库内已有的 .env
# 3. 生成 Prisma Client 并建库、写入种子数据
pnpm db:generate
pnpm db:migrate
pnpm db:seed
# 4. 启动(后端 4000 + Web 端 5173 一起启动)
pnpm dev
启动后访问:
| 服务 | 地址 |
|---|---|
| Web 管理端(开发) | http://127.0.0.1:5173 |
| 后端服务首页(浏览器可读,列出已挂载模块) | http://127.0.0.1:4000 |
| 后端 API | http://127.0.0.1:4000/api |
| 健康检查 | http://127.0.0.1:4000/api/health |
后端只提供 REST API 与 WebSocket,没有业务网页界面。直接访问
http://127.0.0.1:4000/会返回服务首页(带Accept: application/json时返回结构化信息); 其它未匹配路径统一返回{ "success": false, "code": "NOT_FOUND" }。 Web 管理端地址是 5173 端口,请勿访问 80 端口(会连接被拒绝)。
也可以分开启动:pnpm dev:server(仅后端)、pnpm dev:web(仅 Web 端)。
启动 EXE 客户端(学生端)
# 开发模式:自动构建主进程 + 启动 Vite 渲染进程(5174) + 打开 Electron 窗口(支持热更新)
pnpm dev:desktop
# 已构建产物的冒烟验证(不弹窗,跑完自动退出)
pnpm build:desktop
pnpm verify:desktop
客户端首次启动会带上默认服务器地址 http://127.0.0.1:4000,输入班级码 + 班级密码(种子数据:G101 / 123456)即可进入班级。
若要验证"断网可查看缓存",登录并浏览过程序后关闭后端(Ctrl+C 停掉 pnpm dev:server),
客户端会在顶部提示「当前处于离线状态」,页面继续显示本地缓存数据;重新启动后端后会自动同步。
端到端验收脚本
# 另开一个终端先启动后端:pnpm dev:server
pnpm verify:e2e # 后端 + REST + Socket.IO + RBAC + 上课时段拦截 + 叫人 + 导入 + 班级账号:126 项
pnpm verify:web # Web 管理端真实点击(含权限入口隐藏、手机适配、叫人入口、紧急通知 + 导入弹窗):18 项
pnpm verify:desktop # Electron 客户端(含灵动岛动画/收回/已读/作业/叫人、真实链路、课表时间轴、个性化 10 项参数与托盘/退出无残留):47 项
后端脚本验证实时推送时延、作业完成、成绩下发、权限隔离、上课时段紧急通知拦截、导入与失败回滚、班级账号代全班操作等 126 项, 实测通知 37ms、作业 26ms、成绩 25ms 到达(要求 < 5 秒),紧急通知 409 拦截与二次确认后发布均通过; 客户端脚本验证 preload 桥接、渲染进程、IndexedDB 读写、断网回退、灵动岛四种状态切换与联网集成 (班级账号登录 + 四类数据 + Socket.IO),实测 47/47 通过;退出后再启动一次校验单实例锁与文件锁已释放。
默认账号与种子数据
pnpm db:seed 会清空业务表并写入一套完整演示数据(1 管理员 / 2 教师 / 3 班级 / 15 学生 /
15 课程 / 90 条课表 / 15 份作业 / 12 条通知 / 90 条成绩)。
| 角色 | 用户名 | 密码 | 说明 |
|---|---|---|---|
| 管理员 | admin |
admin123 |
可访问全部班级 |
| 教师 | teacher1 |
teacher123 |
张老师:高一(1)班、高二(3)班班主任 |
| 教师 | teacher2 |
teacher123 |
李老师:高一(2)班班主任,高二(3)班协作教师 |
| 学生 | student01 |
student123 |
高一(1)班 |
| 学生 | student02 … student05 |
student123 |
高一(1)班 |
| 学生 | student06 … student10 |
student123 |
高一(2)班 |
| 学生 | student11 … student15 |
student123 |
高二(3)班 |
| 班级 | 班级码 G101 |
123456 |
高一(1)班(学生端班级登录,非个人账号) |
| 班级 | 班级码 G102 |
123456 |
高一(2)班 |
| 班级 | 班级码 G203 |
123456 |
高二(3)班 |
- 学生初始密码可用
DEFAULT_STUDENT_PASSWORD配置(默认123456), 教师也可在「学生管理」里一键重置为默认密码。 - 班级账号(学生端主入口)用班级码 + 班级密码登录,默认密码由
DEFAULT_CLASS_PASSWORD配置(默认123456); 管理员可在「班级管理 → 班级账号」里改班级码或重置密码,详见 学生端班级账号。 - 教学周由
TERM_START_DATE(第 1 教学周的周一)换算,当前周次用于课表默认视图。
常用命令
| 命令 | 说明 |
|---|---|
pnpm dev |
并行启动 shared(tsc watch) + 后端 + Web 端 |
pnpm dev:server / pnpm dev:web |
只启动后端 / 只启动 Web 端 |
pnpm dev:desktop |
启动 EXE 客户端开发模式(Vite 5174 + Electron,热更新) |
pnpm build |
构建 shared + 后端 + Web 端 + EXE 客户端 |
pnpm build:desktop |
仅构建 EXE 客户端(esbuild 主进程/preload + Vite 渲染进程) |
pnpm icons |
生成应用图标(PNG/ICO,用 Electron 渲染 SVG) |
pnpm dist:server |
打包服务端 + Web 管理端(免安装目录 + NSIS 安装程序,内置 Node) |
pnpm dist:dir |
打包客户端免安装目录 release/win-unpacked(含可执行文件,最快) |
pnpm dist:win |
打包客户端 nsis 安装包 + portable 单文件 EXE |
pnpm dist:all |
服务端安装程序 + 客户端安装程序一起打 |
pnpm verify:e2e |
后端端到端验收(126 项,含角色权限矩阵、导入与班级账号,需服务端已启动) |
pnpm verify:web |
Web 管理端 UI 真实点击测试(Electron 驱动,18 项,含权限入口隐藏与导入弹窗) |
pnpm verify:desktop |
EXE 客户端冒烟验证(47 项,含灵动岛动画/收回/已读/作业/叫人、课表时间轴、个性化全参数) |
pnpm typecheck |
全仓库类型检查(含 vue-tsc) |
pnpm lint / pnpm lint:fix |
ESLint 检查 / 自动修复 |
pnpm format / pnpm format:check |
Prettier 格式化 / 检查 |
pnpm db:generate |
生成 Prisma Client(输出到 packages/server/src/generated/prisma) |
pnpm db:migrate |
创建并应用迁移 |
pnpm db:seed |
写入种子数据 |
pnpm db:reset |
重置数据库并重新执行 seed |
pnpm db:studio |
打开 Prisma Studio |
pnpm db:switch:mysql / db:switch:sqlite |
切换数据库 provider |
Web 管理端(含手机小屏适配)
布局沿用 1Panel 风格:固定深色侧边栏(#1f2d3d + 蓝色圆角选中态)+ 白色顶栏(当前页标题/连接状态/用户菜单)+
浅灰底 + 白色圆角卡片内容区。手机小屏下侧边栏收进抽屉,由顶栏汉堡按钮唤出。
| 断点 | 布局行为 |
|---|---|
> 992px 桌面 |
常驻 210px 深色侧边栏 + 顶栏显示连接状态与"已接收 N 条实时事件" |
769–992px 平板 |
保留侧边栏,内容区内边距压缩(14px) |
<= 768px 手机 |
侧边栏不渲染,顶栏汉堡按钮 → 240px 深色抽屉菜单;顶栏显示当前页标题;用户菜单收成头像图标 |
手机端细节(1Panel 同款思路:控件纵向铺满、表格卡片内滚动、弹窗自适应):
| 位置 | 小屏行为 |
|---|---|
| 抽屉菜单 | 点汉堡滑出、点菜单项自动收起;aria-expanded 标记状态;桌面端侧边栏视觉不变 |
| 顶栏 | 只保留汉堡 + 当前页标题 + 连接状态圆点 + 头像;身份信息移入用户下拉菜单第一行 |
| 页面工具栏 | 选择器/搜索框/按钮全部铺满整行(width: 100%),方便拇指点击 |
| 表格 | 卡片内横向滚动(.table-card + overflow-x: auto),页面本身不横向滚动 |
| 弹窗/消息框 | 宽度 calc(100vw - 24px)、贴近整屏;表单标签与输入框自适应 |
| 详情抽屉 | 宽 86vw;el-descriptions 由 2~3 列自动降为单列,避免文字被压成竖排 |
| 统计卡片 | .stat-grid 两列;登录页卡片自适应宽度并保留安全内边距 |
实拍(pnpm verify:web 自动留档到 docs/screenshots/web-mobile/):
| 场景 | 截图 |
|---|---|
| 手机抽屉菜单 | ![]() |
| 手机通知页(工具栏铺满 + 表格卡片内滚动) | ![]() |
| 手机弹窗自适应 | ![]() |
实现位置:src/composables/useResponsive.ts(断点 + resize 监听)、src/layouts/AdminLayout.vue(抽屉/顶栏)、
src/styles/index.css(全局响应式规则)、各视图表格卡片加 .table-card。
pnpm verify:web 的 18 项里,最后 10 项专门验证权限入口隐藏、手机端、叫人入口与 ClassIsland 时间配置导入弹窗(Electron 真实点击):
| 校验项 | 实测结果 |
|---|---|
| 侧边栏收起、顶栏汉堡按钮出现 | ✅ innerWidth=377 汉堡=true 桌面侧边栏未渲染 |
| 点汉堡滑出抽屉菜单(菜单项完整) | ✅ 7 项、left=0、transform=none、遮罩进入动画已结束 |
| 抽屉里真实点击"通知发布"并自动收起抽屉 | ✅ path=/notifications、抽屉 right=0(已滑出屏幕) |
| 页面无横向溢出 | ✅ scrollWidth=377 = innerWidth,越界元素=无(表格自身滚动不计入) |
| 表格在卡片内横向滚动 | ✅ 卡片可视 336px / 内容 576px / 表格 560px |
| 工具栏控件铺满整行 | ✅ 控件宽 338px(视口 377px) |
| 弹窗宽度自适应 | ✅ 弹窗宽 353px、left=12(不超出视口且接近整屏) |
踩坑记录:这套检查必须让窗口真正可见(
win.showInactive())。 Chromium 会冻结隐藏页面的 CSS transition,Vue 的<Transition>收不到transitionend, Element Plus 抽屉会一直停在enter-from(表现为"点了没反应")——冒烟里已按"等抽屉滑到位"断言,避免误判。
手机访问:与电脑同一局域网时用
http://<主机IP>:4000打开管理端; 支持「添加到主屏幕」(PWA manifest + Service Worker)。
EXE 客户端(学生端)
进程结构与安全设置
| 进程 | 文件 | 职责 |
|---|---|---|
| 主进程 | src/main/* → dist/main/index.js |
窗口/单实例锁、配置持久化(safeStorage 加密 token)、IPC、冒烟验证 |
| 预加载 | src/preload/index.ts → dist/preload/index.js |
通过 contextBridge 暴露最小 API(getConfig/saveConfig/getAppInfo/openExternal),不暴露 ipcRenderer 本体 |
| 渲染进程 | src/renderer/** → dist/renderer/* |
Vue 3 界面、Axios 请求、Socket.IO 实时、IndexedDB 离线缓存 |
安全基线:contextIsolation: true、nodeIntegration: false、sandbox: true、webSecurity: true,
外部链接一律交给系统浏览器打开,禁止应用内导航到非本地地址。
功能页面
| 页面 | 功能 |
|---|---|
| 登录 | 服务器地址 + 班级码 + 班级密码,附带「测试连接」;已登录但服务器不可达时可「离线进入」 |
| 课表 | 按周展示 7 列课表,支持上一周/下一周/下拉选择周次,高亮"今天",显示周次范围与地点 |
| 作业 | 列表(全部/未完成/已完成过滤)、详情抽屉、全班标记完成/取消、附件链接、逾期高亮 |
| 通知 | 未读红点(侧边栏徽标)、优先级标签、点击自动标为已读、全部已读、未读过滤、详情抽屉 |
| 成绩 | 班级账号看到全班成绩总览:表格(分数/得分率/等级)+ ECharts 柱状图 + 等级分布 + 最近更新 |
| 设置 | 服务器地址(保存并测试)、账号信息、离线缓存条目统计与清空、客户端版本信息、退出登录 |
通知到达时还会由灵动岛在桌面中上方浮出提醒(见上一节),上课时段自动隐藏、紧急通知立即展开。
灵动岛(桌面通知浮窗)
客户端有一个独立于主窗口的灵动岛:一个无边框、透明、置顶、不占任务栏的窄条窗口,
常驻桌面中上方(屏幕工作区顶部居中,y = workArea.y + 8)。它是"消息到达"的第一现场:
| 场景 | 灵动岛行为 |
|---|---|
| 收到通知(非上课时段) | 直接出现胶囊(无"上岛"入场动画):新消息 · 共 N 条 + 发送人 + 点击查看,15 秒后自动收起 |
| 点击胶囊 | 展开为详情卡(弹簧形变 + 内容弹入):标题、内容、时间、打开应用 / 标为已读 / 知道了,20 秒后收起 |
| 点击卡片空白处 | 回缩为胶囊(不直接消失,仍可再次点开) |
| 点击屏幕任意位置 | 同样回缩为胶囊:展开时窗口临时可聚焦,点到别处即失焦收起(WinUI 同款"点击外部关闭") |
| 点"标为已读" | 通知中心同步标记已读、未读红点立即减少(此前只从灵动岛队列移除、列表仍显示未读) |
| 新作业发布 | 也上岛:胶囊显示"新作业"(青蓝描边 + 书本图标),展开可见"截止时间:…" |
| 叫人(老师点名) | 上课时段也立即展开:琥珀金卡片、"叫人"徽标、"请 XXX 同学找 XXX 老师"、按钮为"收到" |
| 卡片形变 | 卡片是固定尺寸、顶部居中锚定的,窗口只负责露出/裁切透明区域 —— 收回时不会出现被拉伸的"方框",图标也不会上下跳 |
| 点击右上角收起按钮 | 同上:回缩为胶囊 |
| 上课时间段收到普通通知 | 完全不显示(窗口直接隐藏,不打扰课堂)并进入待发队列;下课后自动弹出详情(14 秒)→ 收起为胶囊(25 秒) |
| 上课时间段收到紧急通知 | 无论是否上课立刻展开显示详情(带内部红色呼吸光晕与"紧急"角标,无需点击),45 秒后收起 |
| 上课时间段内的任何点击 | 一律不显示(不会展开、也不会回缩出胶囊),只有紧急通知能出现在屏幕上 |
| 多条约谈 | 队列按时间排序,紧急通知优先插播;卡片底部提示"还有 N 条通知" |
| 退出/断开 | 主窗口退出时灵动岛一并关闭;上课状态来自 GET /api/schedules/current(10 秒心跳 + 下课时长定时器) |
- 动画:窗口尺寸用逐帧缓动实现"形变"(胶囊 → 详情/紧急为 340ms
easeOutBack弹簧回弹, 收起为 260mseaseOutCubic),胶囊出现不做动画直接显示; 卡片内部用cubic-bezier(0.34, 1.56, 0.64, 1)弹簧缩放入场,未读点用dot-pulse。 尺寸与淡入使用独立令牌,互不打断(早前"淡入取消形变导致窗口卡在胶囊尺寸"的问题已修复)。 - 光晕:紧急形态的红色呼吸光晕只用 inset 阴影画在卡片内部。 窗口只比卡片大 2~4px,任何向外的 box-shadow/光晕都会被窗口边界裁切, 在屏幕上表现为"卡片周围一圈奇怪的光晕硬边"——冒烟测试里有一条像素断言守着这一点 (截图最外圈偏红像素必须为 0)。
- 事件流:
notification:new→renderer/stores/realtime.ts→pushNotificationToIsland()→ 主进程IslandController(决定隐藏/胶囊/详情)→ 灵动岛渲染进程src/island/IslandApp.vue。 - 相关文件:
src/main/island.ts(控制器 + IPC)、src/preload/island.ts、src/island/IslandApp.vue、src/renderer/island/bridge.ts(上课状态轮询与通知转发)。
各形态实拍(由 pnpm verify:desktop 自动截取并归档到 docs/screenshots/island/,并做像素级校验):
截图路径可用
ISLAND_SHOTS_DIR覆盖(默认.cache/island-shots/); 归档目录里的图就是打包后 EXE 跑自动化验证时产出的同一份文件。
界面风格(ClassIsland 同款 Fluent)
客户端整体视觉对齐 ClassIsland 的 Fluent / WinUI 观感:
- 浅色 Mica 底(
#f3f3f3)+ 半透明亚克力卡片(rgba(255,255,255,.7)+backdrop-filter: blur(20px)) - 强调色
#0F6CBD(悬停#115EA3);选中导航项 = 强调色淡底 + 左侧 3px 强调条 - 圆角统一:卡片 8px / 控件 4px;描边用半透明黑(
rgba(0,0,0,.06))代替灰线;阴影极轻 - 字体
Segoe UI Variable / 微软雅黑 UI;表格表头无底色、行分隔为 1px 细线;滚动条改为细圆角 - Element Plus 变量(
--el-color-primary、--el-border-radius-base等)整体对齐上述规范
课表「今天」时间轴(ClassIsland 标志性观感),今天 / 本周 双标签:
| 元素 | 说明 |
|---|---|
| 大时钟 | 时:分 大字 + 秒小字(每秒刷新)+ 日期 / 星期 / 第 N 教学周 |
| 当前状态卡 | 「正在上 XXX」+ 时段地点 + 距下课 X 分钟;无课时显示「今天的课都上完了 / 今天没有课程安排」 |
| 时间轴 | 左侧时间栏(开始/结束)+ 竖向轨道与节点 + 右侧课卡:已结束(置灰)、正在上课(强调色实底 + 进度条 + 距下课倒计时)、下一节(橙色标记 + 还有多久开始) |
| 周视图 | 保留原"节次 × 星期"表格(本周 标签) |
实拍(docs/screenshots/client/,时间轴图为造了"已结束/正在上/下一节"三节课后的抓图):
| 页面 | 截图 |
|---|---|
| 课表 · 今天(时间轴) | ![]() |
| 作业 | ![]() |
| 通知 | ![]() |
| 设置 | ![]() |
后续可继续深化:迷你悬浮课表窗口(ClassIsland 的桌面课表条)、上课/下课提醒动画与铃声。
个性化设置与系统托盘
设置 → 灵动岛 · 个性化(改动即实时生效,保存后写入本地配置,重启仍生效):
| 设置项 | 区间/取值 | 说明 |
|---|---|---|
| 灵动岛高度 | 36–72px | 胶囊高度;展开卡按同差值联动(+264/+292/+308px),内容用 flex + 溢出滚动承载 |
| 灵动岛宽度 | 220–420px | 同上,展开卡按差值联动 |
| 圆角 | 8–32px | 卡片圆角 |
| 不透明度 | 40%–100% | 窗口整体不透明度 |
| 字号 | 11–18px | 卡片基础字号 |
| 动画速度 | 0.5×–2× | 形变/淡入时长倍率 |
| 主题色 | 取色器 | 用于高亮、按钮、进度条(CSS 变量下发到灵动岛渲染进程) |
| 显示位置 | 顶部居中 / 左上 / 右上 / 底部居中 | 按住 workArea 计算,多屏跟随主屏 |
| 动画开关 | 开/关 | 关闭后展开/收起瞬时生效(不再逐帧插值) |
| 始终置顶 | 开/关 | 对应 setAlwaysOnTop |
- 越界值在主进程统一夹紧(
normalizeIslandAppearance),用户填坏配置也不会让布局错乱。 - 「预览效果」按钮会本地推一条通知,立刻看到当前尺寸/配色/动画。
- 落盘位置:客户端
config.json的island字段(旧配置没有该字段时自动补默认值,向后兼容)。
形变动画(需求 4 抖动修复):窗口尺寸改为单条帧循环驱动(优先 requestAnimationFrame,
主进程没有该全局时退化为 ~60fps 定时器),新动画会取消上一条并作废令牌,结束时对齐最终尺寸;
卡片始终是固定尺寸 + 顶部居中锚定,只让窗口露出/裁切,形变过程中卡片上边缘不动;
展开动画结束后才取焦点。冒烟实测:收回过程窗口宽度序列 362→330→305→288→274→270→268…
单调收缩、卡片上边缘波动 0px、卡片宽度只取 396/260 两个固定值,连续 5 次快速开合后状态与尺寸稳定。
系统托盘(需求 5):关闭主窗口不退出程序,而是隐藏到托盘后台继续接收通知;
托盘图标(左键单击/双击)恢复主窗口,右键菜单提供「显示主窗口 / 隐藏到托盘 / 退出班级小助手」。
退出时统一清理:销毁托盘 → 销毁灵动岛(含帧循环与定时器)→ 销毁全部窗口
(渲染进程随之结束,其中的 Socket.IO 连接、IndexedDB 句柄一并释放),并用 app.exit(0) 兜底,
任务管理器中不留残留进程。冒烟实测:关闭后 visible=false / destroyed=false / 进程存活=true,
清理后 托盘=false / 灵动岛=false。
"退出无残留"是被实测出来的,不是只写在文档里:冒烟脚本在 Electron 进程真正退出之后再做两件事 ——
① 删除该次运行独占的 userData 目录(含 Chromium SingletonLock 与 IndexedDB 文件句柄),
删得掉就说明没有进程还占着句柄;② 用同一个配置目录再启动一次,若还有残留进程占着单实例锁,
第二次启动会静默退出且不产出结果文件——实测第二次启动正常跑完并再次全绿
([smoke] [PASS] 退出后无残留:配置文件锁已释放,二次启动成功(41/41))。
离线缓存与自动同步
┌────────────── 在线 ──────────────┐
请求 → fetchWithCache(store, key, loader, fallback)
└── 失败 → 读取 IndexedDB 缓存 → 返回旧数据(UI 标记"离线缓存")
实时推送(notification:new / grade:updated ...) → 更新内存状态 + 写回 IndexedDB
服务器不可达 → 可达(health 轮询 20s 或任意请求成功)→ 触发 onServerRecovered → 各页自动重新拉取
- 缓存按业务域分为 6 个 object store:
profile/classes/schedules/homeworks/notifications/grades。 - 缓存写入前统一做 JSON 纯化(Vue 响应式对象是 Proxy,直接写入 IndexedDB 会抛
could not be cloned)。 - 登录令牌由主进程用 Electron
safeStorage(Windows 下为 DPAPI)加密后落盘,因此重启客户端可离线进入。 - 令牌缺失/失效时保持缓存资料可见,恢复网络后自动刷新个人资料。
打包 Windows EXE
pnpm dist:dir # 免安装目录:packages/desktop-client/release/win-unpacked/班级小助手.exe
pnpm dist:win # nsis 安装包 + portable 单文件(需联网下载 NSIS 工具,可用镜像)
打包脚本 packages/desktop-client/scripts/dist-win.mjs 做了三件事,规避常见网络问题:
- 复用本地已解压的 Electron:检测到
node_modules/electron/dist/electron.exe时通过--config.electronDist直接使用,不再重复下载 150MB+ 发行包; - 默认走国内镜像(可用环境变量覆盖):
ELECTRON_MIRROR=https://cdn.npmmirror.com/binaries/electron/、ELECTRON_BUILDER_BINARIES_MIRROR=https://npmmirror.com/mirrors/electron-builder-binaries/; - 构建缓存固定到仓库内
.cache/,不污染全局目录。
产物说明:release/win-unpacked/班级小助手.exe(约 235MB,Electron 运行时)+ resources/app.asar
(约 2.7MB,仅含 dist/ 与 package.json,运行时不需要 node_modules)。
默认使用 Electron 内置图标(未提供 build/icon.ico)。
客户端冒烟验证(无需人工点击)
pnpm verify:desktop 以 ELECTRON_SMOKE_TEST=1 启动应用(不弹窗),主进程依次校验后自动退出:
| 校验项 | 实测结果 |
|---|---|
| 渲染进程挂载 + 窗口标题 | ✅ children=1 / title=班级小助手 |
| 登录页渲染(三个输入框) | ✅ 服务器地址 / 班级码 / 班级密码 |
| preload contextBridge 注入 | ✅ 9 个方法(含灵动岛 3 个) |
| IPC 往返(getAppInfo/saveConfig) | ✅ Electron 44.3.0 |
| 配置文件写入用户目录 | ✅ %APPDATA%\@classhelper\desktop-client\config.json |
| IndexedDB 缓存读写 | ✅ 读写/统计/删除 + 6 个 store |
| 断网时回退本地缓存 | ✅ fromCache=true(请求不可达端口) |
| 灵动岛窗口创建(置顶/透明/不占任务栏) | ✅ ready=true |
| 上课期间普通通知自动隐藏 | ✅ mode=hidden queued=1 visible=false(窗口真的隐藏,不是只改状态) |
| 上课期间点击不展开(严格不显示) | ✅ mode=hidden visible=false |
| 下课后自动弹出暂存通知详情 | ✅ mode=expanded reason=after-class |
| 上课期间紧急通知立即展开(无需点击) | ✅ mode=expanded reason=urgent |
| 紧急通知带展开动画 | ✅ 16ms 采样 34 帧,出现 7 个中间尺寸,最终 424x344(窗口从胶囊尺寸弹簧展开) |
| 上课期间收起不回缩成胶囊 | ✅ mode=hidden visible=false |
| 普通通知直接显示胶囊(无入场动画) | ✅ 推送前已隐藏,60ms 内窗口即为 268x44、mode=pill(无"上岛"动画) |
| 胶囊 → 点击 → 展开详情 | ✅ 新消息 · 共 2 条 → expanded(含真实 DOM 断言与截图) |
| 点击卡片空白处回缩为胶囊 | ✅ 真实点击 .body 空白区域 → mode=pill |
| 点击右上角收起按钮回缩为胶囊 | ✅ 真实点击 .icon-btn → mode=pill |
| 灵动岛截图留档 + 像素级校验 | ✅ 4 张(808×632 / 848×688 / 536×88 / 808×632);宽高比与状态机配置偏差 0.000;形态尺寸递增 pill < expanded < urgent;紧急态偏红 20584 px(卡片内部光晕) |
| 紧急红晕不外溢(窗口边缘无红光) | ✅ 截图最外圈(2px)偏红像素 = 0(守住"卡片周围不出现光晕硬边") |
联网集成(ELECTRON_SMOKE_ONLINE=1) |
✅ login=高一(1)班 classSession=true / 1 班级 / 30 节课 / Socket.IO 已连接 |
| 个性化:尺寸联动不破坏布局 | ✅ 高 56 / 宽 300 / 圆角 26 / 字号 14 → 窗口 300x56,CSS 变量同步,展开态内容溢出 0px |
| 个性化:透明度 / 主题色 | ✅ setOpacity 实际 0.62(设置 0.62);--island-accent = #ff7043 |
| 个性化:停靠位置(4 个锚点) | ✅ 左上 8,8 / 右上 1164,8 / 底部居中 586,800 / 顶部居中 586,8 |
| 个性化:置顶开关 | ✅ 关闭后 isAlwaysOnTop=false,开启后 true |
| 个性化:动画开关 / 速度 | ✅ 关闭动画后 60ms 内即为 404x316(无过渡);speed=0.5 收回 435ms vs speed=2 收回 128ms |
| 个性化:持久化 | ✅ 写入客户端配置后重新读取完全一致(尺寸/圆角/透明度/主题色/字号/动画/速度/位置/置顶) |
| 退出清理:托盘 / 灵动岛 / 窗口 | ✅ isTrayReady()=false、island.isReady()=false、窗口全部销毁 |
| 退出后无残留(文件锁 + 二次启动) | ✅ 配置目录可删除(句柄已释放)→ 用同一配置目录二次启动成功并再次全绿 |
该验证对开发产物与打包后的 EXE 都适用(打包后用 ELECTRON_SMOKE_RESULT=<file> 写出 JSON 结果,
已实测 packaged: true、47/47 通过、退出码 0)。灵动岛各状态的窗口截图会写到
ISLAND_SHOTS_DIR(默认 .cache/island-shots/,仓库内留档目录 docs/screenshots/island/),
并对尺寸、宽高比、绘制内容(不透明像素/颜色种类)、紧急态红色像素与外溢红光做断言。
冒烟进程使用独立 userData(ELECTRON_SMOKE_PROFILE),因此用户开着客户端也能跑验证。
叫人(老师点名让学生过来)
老师在 Web 管理端 → 学生管理 → 叫人 选中学生,配合快捷短语或自定义消息发送; 学生端桌面立即浮出灵动岛卡片,显示「请 XXX 同学找 XXX 老师」+ 具体事由,按钮为「收到」。
| 位置 | 行为 |
|---|---|
| 服务端 | POST /api/calls(教师/管理员)→ 落库一条 HIGH 级通知(进学生通知中心、可用已读状态) + 广播 notification:new(班级房间)与 call:new(定向到被叫学生 user:{id}) |
| 快捷短语 | CALL_QUICK_PHRASES(共享常量):请到办公室/讲台/实验室/门卫处找我、请带上作业本/试卷找我、请到教室门口等我、请马上来一趟;点击选中,再点取消 |
| 自定义消息 | 输入框内容优先于快捷短语(最长 200 字),例如"带上昨天的数学作业到办公室" |
| 客户端 | call:new → 灵动岛 kind=call,无视上课时段立即展开(老师正在等这名学生),90 秒后自动收起 |
| 权限 | 学生调用被拒 403;教师只能叫自己班级的学生(跨班/不在本班返回 400/403) |
verify:e2e 覆盖 6 项(201 + 标题模板、自定义消息优先、上课时段允许、学生 403、学生通知中心可见且未读、清理);
verify:web 覆盖弹窗与短语可选中;verify:desktop 覆盖"上课中也立即展开 + 徽标/按钮文案"。
上课时段策略(紧急通知二次确认)
"上课时段"由课表实时判定:GET /api/schedules/current?classId= 返回
{ inClass, current, next, week, serverTime }(at 参数可覆盖判定时刻,便于联调与测试)。
服务端强制拦截(不是只靠前端提醒):
POST /api/notifications { classId, title, content, priority: "URGENT" } → 409 URGENT_DURING_CLASS
POST /api/notifications { …, priority: "URGENT", confirmDuringClass: true } → 201
POST /api/notifications { …, priority: "NORMAL" }(上课时段) → 201(不受限)
409 响应体携带 details: { classId, current, next, week, serverTime },前端据此渲染"正在上的课"。
这样即使有人绕过界面直接调接口,也一定会被拦下来。
Web 管理端:教师在通知发布弹窗选择"紧急"并提交时,先查询班级上课状态,命中则弹出全屏二次确认
(packages/web-admin/src/components/UrgentClassWarning.vue):
- 全屏遮罩 + 强警示配色,文案"现在为上课时间段……" + 正在上的课时段 + 待发布标题;
- 确认按钮带 3 秒倒计时(圆环进度 + 每秒钟数提示),倒计时结束前不可点击,防止误触;
- 取消则不发;确认后带
confirmDuringClass: true重新提交并成功发布; - 兜底:并发场景(提交瞬间刚好打铃)仍会收到 409,此时同样弹出该警告。
EXE 客户端:上课时段非紧急通知自动隐藏、下课后自动弹出;紧急通知无论是否上课都立即展开(见"灵动岛"一节)。
回归测试:verify:e2e 覆盖 409 拦截 / 二次确认后 201 / 普通通知不受限(用 at 固定时刻,结果可复现);
verify:web 用真实点击构造"正在上课"场景并断言全屏警告文案、按钮禁用与倒计时时长(实测 ~2.96s)。
学生端班级账号(学生端主体 = 班级)
需求:学生端不再以"个人学生"为登录主体,改为**班级账号(班级设备)**登录,数据按班级隔离。
账号模型
| 项目 | 说明 |
|---|---|
| 登录凭据 | 班级码(Class.code,唯一、4~16 位字母数字、大小写不敏感)+ 班级密码(bcrypt 哈希) |
| 会话形态 | JWT { sub: <classId>, classId: <classId>, role: 'STUDENT', classSession: true } |
| 未设密码 | passwordHash = null → 班级登录被拒(403 CLASS_PASSWORD_NOT_SET),提示管理员设置 |
| 管理入口 | Web 管理端「班级管理」→ 行内「班级账号」按钮(改班级码 / 重置密码),仅管理员 |
| 向后兼容 | 个人学生账号(student01…)与 /auth/login 完全保留,接口层不受影响 |
数据按班级隔离
GET /classes:班级会话只返回自己所在班级(跨班请求一律 403);- 作业 / 通知 / 课表 / 成绩:全部按班级收敛,班级会话无法访问其他班级;
- 发布类接口(通知、作业、成绩、课表、叫人):班级会话是
STUDENT,一律 403; - 成绩:
GET /grades/my对班级会话返回全班成绩总览(客户端标题自动变为「本班成绩」)。
班级设备代全班操作(个人数据语义)
班级设备代表整个班级,因此"个人记账"类操作由服务端一次性写入全班学生:
| 操作 | 行为 | 教师端看到的结果 |
|---|---|---|
| 通知「标为已读」/「全部已读」 | 为全班学生写入 NotificationRead(已存在的跳过) |
已读人数 = 班级学生数 |
| 作业「全班标记完成」 | 为全班学生 upsert HomeworkStatus.completed |
完成人数 = 班级学生数 |
| 叫人「收到」 | 复用通知已读机制(同上) | 该生已读 |
读状态判定统一使用 userId in 全班学生(packages/server/src/lib/session.ts 的 resolvePersonalIds()),
因此普通学生账号仍然只影响自己,行为与改造前完全一致。
实现位置
packages/server/src/lib/class-account.ts:班级码校验/生成、密码设置与重置、登录校验、自助改密码;packages/server/src/lib/session.ts:isClassSession/resolvePersonalIds/personalIdWhere;packages/server/src/middleware/auth.ts:班级会话回查Class表(而不是User表);packages/server/src/realtime/socket.ts:班级会话以班级 id 加入user:{classId}房间,叫人消息直达班级设备;packages/web-admin/src/views/ClassesView.vue:班级账号列 + 设置/重置弹窗;packages/desktop-client/src/renderer/views/LoginView.vue:班级码 + 班级密码登录页(不再展示个人账号入口)。
导入(成绩 / 名单表格 + ClassIsland 时间配置)
三条导入链路都在服务端完成解析、校验与去重,前端只负责收集文件与展示结果, 因此 Web 端、客户端与后续接口调用者拿到的是同一套规则与同一份结果统计。
1. 成绩表格导入(管理员)
界面:Web 管理端 →「成绩录入」→「导入表格」(组件 packages/web-admin/src/components/TableImportDialog.vue)。
- 下载模板:
GET /imports/template?kind=grades&format=xlsx|csv模板列:学生用户名 / 学生姓名 / 考试名称 / 分数 / 总分 / 课程(CSV 带 BOM,Excel 直接双击不乱码)。 - 上传预览:
POST /imports/table/preview→ 列名、前 20 行、totalRows、建议字段映射与校验问题。- 支持
.xlsx / .xls / .csv / .tsv(SheetJS,自动识别分隔符),上限 8MB; - 列名按同义词自动映射(如「学号→学生用户名」「得分→分数」「满分→总分」),也可手动改;
- 缺必填列(考试名称、分数)不会静默通过,直接给出"缺少必填列「…」"提示。
- 支持
- 确认导入:
POST /imports/table/commit,参数mapping(规范字段 → 列名)+mode:upsert(默认)已存在则更新;append已存在则跳过;- 成绩重复判定:同班级 + 同学生 + 同考试 + 同课程;学生按「用户名」优先、「姓名」兜底匹配;
- 返回
{ total, inserted, updated, skipped, failed, errors[], warnings[] },errors[].row是 Excel 视角的行号(含表头),便于老师改完再导。
2. 学生名单导入(管理员)
界面:Web 管理端 →「学生管理」→「导入名单」(复用同一组件,kind=students)。
- 模板列:
用户名 / 姓名 / 初始密码;用户名必须匹配^[A-Za-z0-9_.-]{3,32}$; - 重复判定:同一用户名(
append跳过 /upsert更新姓名与班级); - 密码留空使用
DEFAULT_STUDENT_PASSWORD,服务端 bcrypt 加密后入库; - 用户名被教师/管理员账号占用时该行进错误行,不会覆盖他人账号。
3. ClassIsland 课表时间配置导入(管理员 / 本班班主任)
界面:Web 管理端 →「课表管理」→「导入时间配置」
(组件 packages/web-admin/src/components/TimeLayoutImportDialog.vue)。
- 输入:粘贴 JSON 文本或选择 ClassIsland 导出的
.json文件; - 容错解析(
packages/server/src/modules/imports/time-layout.service.ts): 顶层数组、{ TimeLayouts: [...] }、{ TimeLayoutItems | Items | items | Layouts | TimeLayout: [...] }都能识别; 时间支持"8:0:0"/"08:00"/ ISO 字符串 /StartSecond: 28800秒数;字段名兼容StartTime|startTime|start、EndTime|end、Name|Title|Subject、TimeType|Type、IsSkipped|skip; - 校验:时间无法解析、结束不晚于开始、空配置都会给出逐条原因(含条序号与名称);
时间重叠、分割线无时间、原配置标记跳过等只作为
warnings; - 写入模式:
replace:整体替换该班同名(缺省「默认时间表」)配置;merge:以开始时间为槽位标识合并——同槽位被导入项覆盖,其它旧节次全部保留(不静默丢数据);
- 失败回滚:解析存在
errors时返回 400IMPORT_INVALID/IMPORT_EMPTY, 数据库完全不写入,界面会提示"原有配置不会被修改",不会出现导入到一半的脏状态。
REST API 一览
统一响应体:{ "success": true, "data": {}, "message": "" }(错误为 success:false + code)。
所有接口前缀 /api,除登录外均需 Authorization: Bearer <token>。
| 方法 | 路径 | 权限 | 说明 |
|---|---|---|---|
| POST | /auth/login |
公开 | 登录(教师 / 管理员 / 个人学生),返回 token + 用户信息 |
| POST | /auth/class-login |
公开 | 班级账号登录:班级码 + 班级密码 → classSession 会话 |
| GET | /auth/me |
登录 | 当前用户(学生附带班级/年级) |
| PATCH | /auth/password |
登录 | 修改自己的密码 |
| POST | /auth/logout |
登录 | 退出(无状态,客户端丢弃 token) |
| GET | /classes |
登录 | 班级列表(按权限收敛) |
| GET | /classes/:id |
班级可见 | 班级详情(学生/课程/协作教师) |
| POST / PATCH / DELETE | /classes /classes/:id |
管理员 | 班级增删改(创建时自动生成班级码 = 班级账号) |
| PATCH | /classes/:id/class-account |
管理员 | 设置 / 重置班级账号(班级码 + 班级密码) |
| GET / POST | /classes/:id/students |
班级可见 / 可写 | 学生名单 / 添加学生(已存在账号直接转入) |
| DELETE | /classes/:id/students/:userId |
教师/管理员 | 移出学生 |
| POST / DELETE | /classes/:id/teachers[/:teacherId] |
教师/管理员 | 分配 / 取消协作教师 |
| GET / POST / PATCH / DELETE | /courses |
登录 / 教师 | 课程管理 |
| GET | /schedules?classId=&week=&dayOfWeek= |
登录 | 课表列表(week 过滤周次范围) |
| GET | /schedules/grid?classId=&week= |
登录 | 周视图(7 列结构,供客户端直接渲染) |
| GET | /schedules/current?classId=&at= |
登录 | 当前上课状态(inClass / current / next;at 为诊断用时间覆盖) |
| POST / PATCH / DELETE | /schedules |
教师/管理员 | 课表增删改(广播 schedule:updated) |
| GET | /homeworks?classId=&courseId=&pendingOnly=&keyword= |
登录 | 作业列表(学生带完成状态,教师带完成人数) |
| GET | /homeworks/:id |
班级可见 | 作业详情 |
| POST / PATCH / DELETE | /homeworks |
教师/管理员 | 发布/修改/删除(广播 homework:new / homework:updated) |
| PATCH | /homeworks/:id/status |
登录 | 标记完成/取消(广播 homework:status) |
| GET | /notifications?classId=&priority=&unreadOnly=&keyword= |
登录 | 通知列表(带已读状态) |
| GET | /notifications/unread-count |
登录 | 未读数(红点) |
| POST | /notifications |
教师/管理员 | 发布通知(广播 notification:new);上课时段发布紧急通知需 confirmDuringClass |
| POST | /notifications/:id/read、/notifications/read-all |
登录 | 标记已读 |
| DELETE | /notifications/:id |
教师/管理员 | 删除通知 |
| GET | /grades/my |
登录 | 个人成绩 |
| GET | /grades?classId=&courseId=&userId=&examName= |
教师/管理员 | 班级成绩 |
| GET | /grades/stats?classId=&courseId=&examName= |
教师/管理员 | 等级分布 + 各课程平均得分率 |
| POST | /grades、/grades/bulk |
教师/管理员 | 单条 / 批量录入(广播 grade:updated) |
| PATCH / DELETE | /grades/:id |
教师/管理员 | 修改 / 删除成绩 |
| GET | /students?classId=&keyword= |
教师/管理员 | 学生名单 |
| POST / PATCH / DELETE | /students |
教师/管理员 | 学生账号增删改 |
| POST | /students/:id/reset-password |
教师/管理员 | 重置密码 |
| GET | /teachers?keyword= |
教师/管理员 | 教师列表(分配协作教师用) |
| POST | /teachers |
管理员 | 新建教师账号 |
| GET | /dashboard/summary / /dashboard/term |
登录 | 仪表盘汇总 / 学期周次 |
| GET | /imports/template?kind=&format= |
管理员 | 导入模板下载(csv 走 JSON,xlsx 走二进制) |
| POST | /imports/table/preview |
管理员 | 上传表格(base64)解析预览:列名 + 前 20 行 + 校验问题 + 建议映射 |
| POST | /imports/table/commit |
管理员 | 按字段映射与写入模式导入(成绩 / 学生名单),返回新增/更新/跳过/失败与错误行号 |
| POST | /imports/time-layout/preview |
管理员/本班班主任 | 解析 ClassIsland 时间配置 JSON(只解析不落库) |
| GET / POST / DELETE | /imports/time-layout |
管理员/本班班主任 | 时间配置列表 / 导入(replace 覆盖、merge 合并)/ 删除 |
| GET | /health |
公开 | 健康检查(含已挂载模块列表) |
WebSocket 事件
连接方式:io(url, { auth: { token } }),握手阶段用 JWT 鉴权。
| 事件 | 方向 | 载荷 |
|---|---|---|
connected |
服务端 → 客户端 | { userId, role, rooms } |
notification:new |
服务端 → 客户端 | NotificationDto |
homework:new |
服务端 → 客户端 | HomeworkDto |
homework:updated |
服务端 → 客户端 | HomeworkDto & { deleted?: boolean } |
homework:status |
服务端 → 客户端 | HomeworkStatusDto & { classId } |
grade:updated |
服务端 → 客户端 | GradeDto |
schedule:updated |
服务端 → 客户端 | { classId, action, schedule? } |
class:updated |
服务端 → 客户端 | { classId, action } |
class:join / class:leave / ping |
客户端 → 服务端 | 手动订阅班级(服务端二次校验权限) |
房间规则(@classhelper/shared 的 SOCKET_ROOMS):
class:{classId}、user:{userId}、role:{role}、students、teachers。
客户端断线由 Socket.IO 自动重连(Web 端 store 与后续 EXE 端共用同一套事件名)。
角色与权限模型(RBAC)
班级内的角色由"账号角色 + 与该班级的关系"共同决定,前后端共用同一份矩阵
(packages/shared/src/permissions.ts,后端 lib/access.ts 复用,前端用它隐藏入口):
| 角色 | 判定方式 | 可见范围 |
|---|---|---|
ADMIN 管理员 |
User.role = ADMIN |
全部班级 |
班主任 HEAD |
Class.teacherId === 当前用户 |
本班 |
科任老师 SUBJECT |
ClassTeacher 中存在当前用户 |
被分配的班级 |
学生 STUDENT |
User.classId / 班级账号 |
自己的班级(只读业务数据) |
权限矩阵(PERMISSION_MATRIX,验收脚本按此逐条断言):
| 操作 | 管理员 | 班主任 | 科任老师 |
|---|---|---|---|
| 班级创建 / 修改 / 删除 | ✅ | ❌ | ❌ |
| 分配班主任与科任老师 | ✅ | ❌ | ❌ |
| 学生名单管理(增删 / 重置密码 / 导入) | ✅ | ❌ | ❌ |
| 课表管理(增删改 / 时间配置导入) | ✅ | ✅(仅本班) | ❌ |
| 布置作业 | ✅ | ✅ | ✅ |
| 叫人 | ✅ | ✅ | ✅ |
| 发布通知 | ✅ | ✅ | ✅ |
| 成绩录入 / 修改 / 导入 | ✅ | ❌ | ❌ |
实现要点:
src/middleware/auth.ts:JWT 校验后回查数据库,班级/角色变更立即生效。src/lib/access.ts:resolveUserClassRole()解析班级内角色,assertCanManageClasses/assertCanAssignTeachers/assertCanManageRoster/assertCanManageSchedule/assertCanPublishContent/assertCanManageGrades在服务层断言(路由只做角色过滤)。resolveClassScope()收敛列表数据(classId in [...]),单条接口直接断言;越权一律403。- 前端按同一矩阵隐藏入口:教师端侧边栏不再显示「班级管理 / 学生管理 / 成绩录入」, 课表页的增删改按钮仅对"管理员或本班班主任"显示,成绩页的录入/删除按钮仅对管理员显示。
叫人入口位置调整:班主任与科任老师都需要叫人,而「学生管理」页是管理员专属, 因此教师的叫人入口放在「通知发布 → 叫人」(选班级 → 选学生 → 快捷短语/自定义消息), 管理员在学生管理里仍保留逐行「叫人」。
行为变更提示:按需求"科任老师只有布置作业、叫人、通知权限""班主任另有本班课表管理权限", 成绩录入与班级/名单管理已收紧为管理员专属;如需把成绩下放给班主任或科任老师, 只需调整
packages/shared/src/permissions.ts里的canManageGrades()并同步断言。需求 6 写的是"老师端与学生端班级账号均可用且不越权",而本仓库按需求 7 的权限清单把 成绩导入/录入实现为管理员专属(
verify:e2e有两项断言"班主任/科任老师录入成绩 403")。 这是有意保留的取舍,等你确认后再按下面范围放开(约 6 处、一行核心判定):
packages/shared/src/permissions.ts:canManageGrades()改为按班级角色判定(ADMIN | HEAD);packages/server/src/lib/access.ts:assertCanManageGrades(user, classId)改为异步并用resolveUserClassRole;packages/server/src/modules/grades/*、modules/imports/imports.module.ts:路由从requireRole('ADMIN')放宽为ADMIN | TEACHER,服务层按班级断言(科任仍 403);packages/web-admin/src/views/{GradesView,StudentsView}.vue:isAdmin改为"管理员或本班班主任";packages/server/scripts/verify-e2e.mjs:班主任成绩断言由 403 改为 201(科任仍 403),本文件的权限矩阵同步更新。
模块化设计(可随时增删模块)
后端每个功能是一个独立目录,统一契约 ApiModule = { name, basePath, router, enabled? }:
// packages/server/src/modules/registry.ts
export const apiModules: ApiModule[] = [
authModule,
classesModule,
coursesModule,
schedulesModule,
homeworksModule,
notificationsModule,
gradesModule,
studentsModule,
teachersModule, // ← 新增模块只需在这里加一行
dashboardModule,
].filter((module) => module.enabled !== false);
- 新增模块:新建
modules/<name>/(*.schemas.ts校验、*.service.ts业务、*.module.ts路由), 在 registry 里加一行即可,app.ts无需改动。 - 移除/下线模块:删掉对应行,或把
enabled置为false,其接口立即从路由表消失。 - 实时推送解耦:业务模块只调用
realtime/bus.ts的emitToClass/emitToUser, 不直接依赖 Socket.IO 实例,因此「移除实时通道」不影响业务代码。 - 共享契约:所有 DTO 与类型集中在
@classhelper/shared,三端共用,避免契约漂移。
数据库
- 默认:SQLite(Prisma 7 的 libSQL driver adapter,数据文件
packages/server/prisma/dev.db)。 - 模型设计为跨库通用(无 enum、无
@db.*原生类型),切换到 MySQL 只需改 provider + 连接串。 - 完整步骤见
docs/mysql.md:
pnpm db:switch:mysql
pnpm --filter @classhelper/server add @prisma/adapter-mariadb
# 修改 packages/server/.env 的 DATABASE_PROVIDER / DATABASE_URL
pnpm db:migrate && pnpm db:seed
数据库表:User / Class / ClassTeacher / Enrollment / Course / Schedule /
Homework / HomeworkStatus / Notification / NotificationRead / Grade /
TimeLayout(共 12 张);Class.code / Class.passwordHash 是班级账号字段。
启动时迁移(安装版自动升级)
packages/server/src/lib/db-bootstrap.ts 用一张账本表 _ch_migrations 记录已执行的迁移目录名:
- 全新安装:库中无业务表 → 依次执行
prisma/migrations/下全部迁移,并创建初始管理员; - 覆盖安装升级:只补跑账本里没有记录的迁移(已存在的表/索引自动跳过),
因此新增表(如
TimeLayout)无需用户手动执行prisma migrate deploy; - 已是最新:直接跳过,不做任何写操作。
日志会明确写出 全新安装 / 升级安装、应用了几个迁移、跳过了几个已存在对象,便于排障。
验收标准对照
| 验收项 | 结果 | 证据 |
|---|---|---|
| 教师 Web 端发布通知,学生端 5 秒内收到 | ✅ | verify:e2e:notification:new 37–44ms |
| 教师发布作业,学生能查看并标记完成 | ✅ | homework:new 26–40ms,PATCH /homeworks/:id/status 200 且列表回显 completed=true |
| 教师录入成绩,学生能查看个人成绩 | ✅ | grade:updated 21–25ms,/grades/my 返回记录;批量录入与统计接口通过 |
| 学生能查看课表,支持按周切换 | ✅ | /schedules/grid?week=1 返回 30 节,week 过滤 weekStart ≤ week ≤ weekEnd |
| 断网后客户端可查看缓存数据 | ✅ | 客户端冒烟:断网时回退到本地缓存 → fromCache=true items=1;离线横幅 + 缓存统计页可用 |
| 权限隔离:学生不能访问其他班级数据 | ✅ | 10 项越权断言全部 403/401(学生跨班/跨班作业/跨班课表、教师跨班发布、未登录访问…) |
| 上课时段发布紧急通知必须二次确认 | ✅ | 服务端 409 URGENT_DURING_CLASS(confirmDuringClass 后 201);Web 端全屏警告 + 3 秒倒计时 |
| 客户端灵动岛:上课隐藏 / 下课弹出 / 紧急立即展开 | ✅ | verify:desktop 状态断言 + 像素级截图(docs/screenshots/island/) |
| 灵动岛:收回无"方框"闪烁 / 点击屏幕任意处收回 | ✅ | 采样卡片尺寸恒为固定值(396×308、260×38)+ 失焦自动收回 |
| 灵动岛"标为已读"同步通知中心 | ✅ | 真实链路:点击后 read=false → true、未读数 1 → 0 |
| 作业发布也上岛("新作业"胶囊 + 截止时间) | ✅ | kind=homework + 展开显示"截止时间:…" |
| 叫人(老师点名 → 学生灵动岛立即跳出) | ✅ | verify:e2e 6 项 + verify:desktop 上课中也立即展开(徽标"叫人"、按钮"收到") |
| 成绩 / 名单表格导入(xlsx·xls·csv) | ✅ | 模板下载 + 预览映射 + 重复处理 + 行号级错误:verify:e2e 导入 22 项、verify:web 弹窗实测 |
| ClassIsland 时间配置导入(覆盖 / 合并 / 回滚) | ✅ | 合法 200、非法 400 IMPORT_INVALID 且原配置仍为 3 节、merge 覆盖 1 新增 1 共 4 节 |
| 安装版覆盖升级自动补迁移 | ✅ | 真实旧库升级日志:升级安装:已应用 2 个迁移文件,跳过 34 个已存在对象,TimeLayout 自动建表 |
| 学生端主体 = 班级(班级码 + 班级密码登录) | ✅ | verify:e2e 班级账号 19 项:登录 / 错误密码 401 / 跨班 403 / 发布 403 / 班级码重复 400 / 密码重置 / 班级码用后还原 |
| 班级设备代全班操作(已读 · 完成 · 成绩总览) | ✅ | 标记已读写入 6 条(全班 6 人)、教师端 readCount=6、completedCount=6、/grades/my 全班成绩 |
| 客户端只保留班级登录入口 | ✅ | verify:desktop:login=高一(1)班 classSession=true,导航「成绩」标题变为「本班成绩」 |
| 能成功打包 Windows EXE | ✅ | 班级小助手-0.1.0-x64-setup.exe / -portable.exe / win-unpacked/*.exe(见下表) |
| 提供完整 README(启动、构建、打包、默认账号) | ✅ | 本文档含快速开始、命令表、API、WebSocket、RBAC、模块化、MySQL 切换、打包与常见问题 |
打包产物验证(对最终 EXE 实测,非仅开发产物):
| 产物 | 大小 | 冒烟结果 |
|---|---|---|
| 服务端安装程序(内置 Node + Web 端) | 34MB | ✅ 静默安装(升级保留 .env 与数据库)→ 自动建库建号 → 服务就绪 → 对安装实例跑 62/62 e2e + 15/15 UI |
release/win-unpacked/班级小助手.exe |
234.7MB | ✅ 28/28,packaged: true,退出码 0(含灵动岛动画/作业/叫人/时间轴) |
release/…-x64-portable.exe(单文件) |
106.9MB | ✅ 打包后冒烟 28/28,packaged: true,退出码 0(自解压单文件同样通过) |
release/…-x64-setup.exe(客户端) |
107.2MB | ✅ 构建成功,已嵌入自定义图标;含灵动岛与本次行为修正 |
当前实测:
| 验证 | 结果 |
|---|---|
pnpm verify:e2e(开发环境与安装后的生产实例各跑一次) |
126/126 ✅ |
pnpm verify:web(Web 管理端真实点击 + 权限入口隐藏 + 手机适配 + 叫人 + 导入弹窗 + PWA) |
18/18 ✅ |
pnpm verify:desktop(客户端冒烟 + 灵动岛动画/收回 + 个性化全参数 + 托盘与退出无残留) |
47/47 ✅ |
pnpm typecheck / pnpm lint / pnpm format:check |
全部通过 ✅ |
| 安装程序完整生命周期(静默安装 → 启停脚本 → 卸载) | 通过 ✅ |
| Docker / Nginx 部署样例 | 文件已提供,本机无 Docker 未实测 ⚠️ |
常见问题(本机环境已知坑)
- 在 DSH 桌面端(Electron 宿主)里执行 pnpm 时,依赖的
.bin不会被注入 PATH 现象:pnpm run <script>报'prisma' 不是内部或外部命令。 原因:本机 pnpm 由 Electron 进程承载,bin 目录位于node_modules/.pnpm/node_modules/.bin,未注入子进程 PATH。 规避:直接用 Node 调用 CLI 入口,例如node packages/server/node_modules/prisma/build/index.js generate、node packages/web-admin/node_modules/vite/bin/vite.js build。 在普通终端(非 Electron 宿主)中pnpm <script>一切正常。
1.5 脚本里启动 Electron 时必须清掉 ELECTRON_RUN_AS_NODE,并且不要 import 'electron' 取路径
现象(两种,都只在本机这种"宿主终端本身是 Electron"的环境里出现):
① node scripts/smoke.mjs 正常,但 pnpm verify:desktop 报
Cannot find module 'electron'(Electron 退化成纯 Node 运行);
② pnpm dist:win 报 Unknown argument: .../electron-builder/out/cli/cli.js。
原因:本机 pnpm 运行在 Electron 内置 Node 上,会给子进程带上 ELECTRON_RUN_AS_NODE=1;
同时 process.versions.electron 存在时,require('electron') 返回的是 API 对象而非可执行文件路径,
spawn(process.execPath, [cli.js, …]) 会被 Electron 当成"启动应用"而多出一个位置参数。
规避(已内置到代码里):
scripts/lib/electron-env.mjs:resolveElectronEnv()清理变量、resolveElectronExecutable()从node_modules/electron/path.txt定位 electron.exe;scripts/lib/node-runtime.mjs:resolveNodeRuntime()明确找一个真正的 node.exe, 供 electron-builder CLI 与"内置 Node 运行时"打包使用。
-
不要用 PowerShell 管道调用
start.cmd现象:& "$install\start.cmd" | Select-Object -First 20会一直不返回。 原因:脚本内启动的 node 进程在该上下文里继承了管道句柄。 规避:双击运行,或用Start-Process cmd.exe "/c start.cmd"(脚本自身 4 秒内退出)。 -
原生模块会按 Electron ABI 构建 同一原因会让
node-gyp/prebuild-install以runtime=electron为目标, 装出的.node在 Node 进程里无法加载。本项目因此改用 libSQL 适配器 (@libsql/win32-x64-msvc为 npm 预编译包,无需本地编译),彻底规避该问题。 -
本机 TLS 中间人证书导致依赖二进制下载失败 现象:
prebuild-install warn install unable to verify the first certificate。 规避:安装时设置NODE_OPTIONS=--use-system-ca(Node ≥ 22.15 支持), 并确保npm_config_cache指向可写目录(如仓库内.cache/npm-cache)。 -
受限沙箱下 Vite 构建报
spawn EPERMVite 在 Windows 上通过execFile解析真实路径,需要放开子进程管道限制后再构建。 -
Prisma 7 与旧版本差异
prisma的 npmlatest标签当前指向8.0.0-rc,本项目显式锁定 7.10.0; 生成器为prisma-client(输出到src/generated/prisma,已 gitignore), 连接串在prisma.config.ts中配置,且必须通过 driver adapter 接入数据库。 -
Electron 二进制下载慢或失败
electron的 postinstall 会从 GitHub 拉取约 151MB 发行包,本机实测 10 分钟仍未完成。 规避:安装前设置镜像与缓存目录(本项目已把 electron 缓存指向.cache/electron):ELECTRON_MIRROR=https://cdn.npmmirror.com/binaries/electron/。 打包阶段scripts/dist-win.mjs已内置该镜像,并优先复用本地已解压的 Electron。 -
electron-builder 的构建工具(NSIS / winCodeSign)下载慢 通过
ELECTRON_BUILDER_BINARIES_MIRROR=https://npmmirror.com/mirrors/electron-builder-binaries/解决(已内置到dist-win.mjs),实测 nsis-3.0.4.1 与 nsis-resources 正常下载。scripts/dist-server.mjs会直接复用 electron-builder 缓存里的makensis。 -
应用图标
pnpm icons会用 Electron 渲染 SVG 生成packages/desktop-client/build/icon.ico(多尺寸)、 PWA 所需的 PNG 与favicon.svg。electron-builder 与 NSIS 安装程序都会自动使用该图标。 -
服务端安装包内的
.cmd脚本为什么是英文提示? cmd.exe 按 OEM 代码页(GBK)解析脚本文件,UTF-8 中文会产生乱码甚至语法错误, 因此脚本提示统一用 ASCII,中文说明放在安装向导与README.txt中。
交付清单(阶段 7 · 生产化)
| 路径 | 说明 |
|---|---|
scripts/dist-server.mjs |
服务端 + Web 端打包(内置 Node、依赖、迁移、启停脚本、安装程序) |
scripts/nsis/server-installer.nsi |
NSIS 安装程序模板(安装/快捷方式/开机自启/卸载保留数据) |
scripts/generate-icons.mjs + scripts/icons/ |
图标生成(Electron 渲染 SVG → PNG/ICO) |
scripts/ui-smoke/ |
Web 管理端 UI 真实点击回归测试 |
packages/server/src/middleware/security.ts |
helmet + 限流(通用/登录)+ 请求耗时日志 |
packages/server/src/lib/web-static.ts |
Web 管理端静态托管 + SPA 回退 + 缓存策略 |
packages/server/src/lib/db-bootstrap.ts |
首启动自动迁移 + 自动创建管理员 |
packages/web-admin/public/{manifest,sw.js} |
PWA:可安装为应用 + 离线外壳 |
deploy/{Dockerfile,docker-compose.yml,nginx.conf} |
云部署与 HTTPS 反代样例 |
docs/production.md |
生产部署指南(三种形态 + 运维 + 安全清单 + 故障排查) |
阶段 8(灵动岛 + 上课时段策略)新增文件:
| 路径 | 说明 |
|---|---|
packages/desktop-client/src/main/island.ts |
灵动岛控制器(窗口/状态机/动画/超时/IPC) |
packages/desktop-client/src/preload/island.ts |
灵动岛 preload 桥(islandGetState/islandPush/islandSetClassState) |
packages/desktop-client/src/island/IslandApp.vue |
灵动岛界面(胶囊 / 详情 / 紧急三种形态 + 动画) |
packages/desktop-client/src/renderer/island/bridge.ts |
上课状态轮询(10s)与通知转发 |
packages/server/src/modules/schedules/schedules.service.ts |
computeClassStatus / getClassStatus(上课时段判定) |
packages/web-admin/src/components/UrgentClassWarning.vue |
上课时段发布紧急通知的全屏二次确认(3 秒倒计时) |
scripts/ui-smoke/live-probe.mjs |
UI 回归测试的"真实上课时段"探针(自建课表 + 用后清理) |
scripts/lib/{electron-env,node-runtime}.mjs |
Electron/Node 运行时定位与宿主环境兼容处理 |
docs/screenshots/island/*.png |
灵动岛四种形态的自动化留档截图(由冒烟验证生成,含像素级断言) |
阶段 9(导入能力:成绩 / 名单表格 + ClassIsland 时间配置)新增文件:
| 路径 | 说明 |
|---|---|
packages/server/src/modules/imports/imports.module.ts |
导入路由(模板下载 / 表格预览与提交 / 时间配置预览·导入·列表·删除) |
packages/server/src/modules/imports/imports.schemas.ts |
Zod 校验(base64 文件、字段映射、写入模式、时间配置 payload) |
packages/server/src/modules/imports/table-import.service.ts |
SheetJS 解析 + 模板生成 + 同义词映射 + 成绩/名单写入与结果统计 |
packages/server/src/modules/imports/time-layout.service.ts |
ClassIsland 时间配置容错解析(多形态/多字段名/秒与 HH:mm)+ 覆盖/合并 |
packages/server/prisma/migrations/20260912120000_add_time_layout/ |
TimeLayout 表迁移 |
packages/web-admin/src/components/TableImportDialog.vue |
成绩 / 名单导入弹窗(模板、预览、字段映射、模式、结果与错误行) |
packages/web-admin/src/components/TimeLayoutImportDialog.vue |
ClassIsland 时间配置导入弹窗(粘贴/选文件、解析预览、覆盖/合并、已存列表) |
packages/shared/src/types.ts 的导入 DTO |
TableImportPreview / TableImportResult / TimeLayoutDto 等前后端共用 |
阶段 10(学生端班级账号)新增文件:
| 路径 | 说明 |
|---|---|
packages/server/src/lib/class-account.ts |
班级码校验/生成、班级密码设置与重置、登录校验、班级账号自助改密码 |
packages/server/src/lib/session.ts |
isClassSession / resolvePersonalIds / personalIdWhere(全班范围) |
packages/server/prisma/migrations/20260912130000_add_class_account/ |
Class.code / Class.passwordHash 迁移(老数据回填 C00001 形式) |
packages/desktop-client/src/renderer/views/LoginView.vue |
班级码 + 班级密码登录页(不再展示个人学生账号入口) |
packages/web-admin/src/views/ClassesView.vue(班级账号列与弹窗) |
管理员设置班级码 / 重置班级密码 |
packages/desktop-client/scripts/smoke.mjs(班级账号准备) |
冒烟前通过管理端接口准备可用班级凭据,兼容全新安装与升级安装 |
后续可选增强
- 代码签名证书(消除 SmartScreen 提示)。
- 客户端"提交类操作离线队列"(当前离线为只读,联网后自动同步读取的数据)。
- Socket.IO 多实例广播(引入
@socket.io/redis-adapter)与 CI 流水线。 - 灵动岛位置/尺寸可配置(多显示器时跟随当前活动屏幕,而非固定主屏)。










