Files
ClassHelper/docs/get-started/client.md
T
LoveChengke 817af02357 feat(permissions,clients,ai,system,server,web,client,shared)!: 权限组 + 客户端设备远控与自动更新 + 大模型助手 + 系统诊断(1.3.0)
功能级准入改为「权限键」,`requireRole` 退成默认模板。

权限组
- 权限目录(39 键:键 / 中文名 / 分类 / 默认角色)收口到 shared,路由挂 requirePermission / requireAnyPermission
- 有效权限每请求实时算,改完分组立刻生效:ADMIN 全集且 permission:manage、system:manage 不可剥夺;
  CLASS_DEVICE 空集(不受分组影响);有分组 = 并集(因此也能用来**收回**权限);无分组 = 角色默认模板
- 新增「权限组」页:组增删改、成员分配、生效权限预览
- 班级维度的科目规则(assertCanManageSubjectContent)故意不可被权限组覆盖

客户端设备(ClassHelper 桌面端)
- 设备身份是 deviceKey(首次启动生成的 UUID,saveConfig 拒绝改写、退出登录也保留)
- 心跳走「DB 记状态 + 客户端定时拉」,不引入新的长连接:30 秒一次,在线窗口 90 秒
- 远控命令 shutdown / restart / logoff / lock:服务端有效期 10 分钟,客户端弹默认选中「取消」的对话框、
  60 秒未确认按取消处理,执行后必须回执(重复回执幂等),同一台机器同一条命令只弹一次
- 新增「客户端设备」页:版本一览、一键推送更新、下发远控

客户端安装包由服务端下载并缓存(教室机常常没有外网,浏览器也受 CSP 限制)
- POST /api/update/client/fetch 由服务端下载到 data/client-releases/<版本>/ 并登记 sha256 + size
- 自动安装三条护栏:没有 sha256 就拒收、必须等到非上课且主窗口隐藏满 5 分钟、冒烟模式永不安装

大模型助手:只解析、不落库
- POST /api/ai/interpret 返回**待确认**的结构化动作(建作业 / 发通知 / 叫人),
  真正落库仍调既有端点 —— 权限断言、上课时段紧急通知保护、ClassIsland 推送全部自动复用
- 模型给的 params 用与手动入口**同一份** zod 再校验(模型输出不可信)
- API Key 走 AES-256-GCM(密钥由 JWT_SECRET 经 scrypt 派生)加密存 AppSetting,只进不出
- provider=mock 是离线确定性解析,自动化验收一律用它;每次解析写一条 AiAudit(不含密钥)

系统与运维
- 开发者模式(服务端内存缓存开关,热路径不查库;开启后 500 才附 error.stack)、运行诊断(绝不回传密钥)
- 开机自启动运行期可改:Windows 改 HKCU\...\Run、Linux systemctl enable/disable,
  **非安装形态一律返回 supported:false**,不往开发机的注册表里写自启项
- 服务端侧栏折叠只用 CSS 收拢(不重建 DOM),关怀模式只放大字号与控件、不动任何几何令牌

客户端
- 崩溃自愈:渲染进程挂掉 / 超 10 秒无响应先静默重建主窗口(10 分钟最多 3 次),
  未捕获异常只在「没在上课、没人看着」时才重启进程;冒烟模式绝不重启(会杀掉验证实例)
- 上线补弹离线期间收到的消息只做一次:起点只在「可达 → 不可达」的边界写,恢复时取最近 5 条按时间升序推

发布内容批量
- POST /notifications/bulk、POST /homeworks/bulk:**单班失败不影响整批**,逐班返回结果
- 作业的科目名跨班**按名匹配**已有课程,找不到就整班记失败,绝不自动建课
  (自动建课会把创建者写成任课老师,等于越权改任教关系)
- 通知与作业同口径按「所属日期」归档,新增 /notifications/days 与 /notifications/creators

BREAKING CHANGE: 能不能做某件事不再看角色名,而是看权限键(GET /api/permissions/me)。
未分组的账号按角色默认模板生效,行为与 1.2.0 一致;分组之后生效集合只由组的并集决定。
服务端首次启动会自动应用 1 个数据库迁移(权限组 3 表 / AppSetting / 客户端设备·命令·安装包 /
AiAudit / Notification.assignDate / User.careMode,历史通知按本地日期回填),升级前请先备份。
2026-10-11 11:49:32 +08:00

4.9 KiB
Raw Blame History

title, description
title description
装 ClassHelper 班级端 在教室机器上安装 ClassHelper桌面客户端,用班级码登录,并第一次跑通实时通知。

装 ClassHelper 班级端

桌面客户端装在教室的那台机器上(教室大屏、讲台电脑)。它是学生看课表作业的地方, 也是「消息到达的第一现场」—— 灵动岛就长在这一端。

1. 下载与安装

从 Releases 取:

产物 用途
ClassHelper-<版本>-x64-setup.exe 安装包(约 98 MB),装到本机并建快捷方式
ClassHelper-<版本>-x64-portable.exe 单文件便携版,双击即用,适合不改动机房机器

要自己打:

pnpm dist:win     # 安装包 + 便携版(两个都是成品,没有中间的解包目录)

装不上 / 双击没反应 / 一闪就没(报 0x80000003)通常不是产物坏了,而是交付物被打了 Low 完整性标签。打包脚本收尾已自动修正;从 Release 下载的包不受影响。 另外:关窗是隐藏到托盘,进程还在,再双击会因单实例锁秒退 —— 先从托盘退出。

2. 登录

打开客户端 → 填三项:

字段 填什么
服务器地址 http://<服务器IP>:4000(局域网用内网 IP,别用 localhost)
班级码 管理员在「班级管理」里给这个班设的码,例如 G203
班级密码 建班级时设的密码

旁边的「测试连接」可以先确认网络通。已登录过但服务器暂时不可达时,登录页会给一个「离线进入」—— 进去后看到的是上次缓存的课表 / 作业 / 通知(顶部会标「离线缓存」),网络恢复后自动刷新。

客户端没有改密码入口,这是刻意的:教室机器上误改班级密码会把别的机器锁在门外。 班级密码由管理员在 Web 端「班级管理 → 修改班级账号」维护。

3. 首次启动的六步向导

第一次启动会在登录页上自动弹一个向导:欢迎 → 连接服务器 → 登录班级 → 登录之后(主界面与离线缓存)→ 灵动岛提醒 → 完成。走完或跳过都会记为已完成,之后不再自动弹。

想重看:登录页的**「查看使用引导」**,或进去之后 设置 → 通用 → 使用引导。

4. 认一认主界面

左侧是四个一级项(课表 / 作业 / 通知 / 成绩)加上一个可展开的设置分组, 顶部汉堡按钮把整栏收成 64px 的图标导轨(折叠状态会记住)。「通知」项上有未读红点。

页面 一句话
课表 周视图 + 「今天」时间轴(大时钟 / 正在上什么 / 下一节)
作业 看板模式(按科目卡片、可全屏)/ 列表模式;教室机器还能录入作业
通知 未读红点、优先级标签、点开自动标为已读
成绩 班级账号看到的是全班总览(表格 + 柱状图 + 等级分布)
设置 通用 / 外观 / 灵动岛 / 提醒 / 账号 / 关于,六个子页

细节见应用帮助。

5. 在教室机器上把它调成"能看"的样子

教室大屏的观看距离和角度跟办公桌不一样,装完建议顺手做三件事:

  1. 开全屏作业看板 —— 作业页「全屏看板」,按屏幕尺寸自动排版,整个屏幕刚好放得下、不用滚动。
  2. 调灵动岛 —— 设置 → 灵动岛:高度、宽度、字号、主题色、停靠位置、视觉风格。 讲台机器上通常把字号调大一点、位置放到顶部居中。 触摸屏(希沃白板等)走的是另一套命中逻辑,客户端会自动识别,不用手动开。
  3. 选提醒弹在哪端 —— 设置 → 提醒:ClassHelper 与 ClassIsland 都弹 / 只在客户端 / 只在 ClassIsland。 这个选择会同步到班级记录,服务端据此决定要不要推 ClassIsland。

6. 确认实时链路是通的

在 Web 管理端给这个班发一条普通通知,教室机器上应该几秒内出现灵动岛胶囊。如果没有:

  • 客户端顶栏的实时通道状态是不是"已连接"?
  • 现在是上课时段吗?上课时段的普通通知只进队列、下课才弹,这是设计行为,不是故障。
  • 服务器与教室机器之间能互相 ping 通吗?防火墙放行 4000 了吗?

排查清单见常见问题。

下一步(可选):接入 ClassIsland。