Files
ClassHelper/docs/dev/index.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

3.7 KiB
Raw Blame History

title, description
title description
开发文档 ClassHelper的架构、接口、数据模型、权限、动效层,以及验收与发版流程。

开发文档

ClassHelper是一个 pnpm monorepo,一份代码产出四个交付物:

交付物 位置 形态
后端服务 packages/server Express 5 + Prisma 7 + Socket.IO,接口前缀 /api
Web 管理端 packages/web-admin Vue 3 + Vite + Element Plus(教师 / 管理员用,PWA 可安装)
桌面客户端 packages/desktop-client Electron + Vue 3(ClassHelper 班级端 / 教室机器,含灵动岛浮窗)
共享契约 packages/shared 三端共用的类型 / 常量 / 权限 / 工具函数
ClassIsland 联动插件 packages/classisland-plugin .NET 8 / C#(独立于 pnpm workspace,不参与 pnpm install)

核心链路:

教师在 Web 端发布内容
        │  REST API(JWT 鉴权)
        ▼
   后端服务(Express + Prisma)
        │  写库 + 按班级房间广播
        ▼
 Socket.IO ──► class:{classId} 房间 ──► 学生桌面客户端实时更新 UI(含灵动岛)

ClassIsland(教室机器)──► 联动插件 ──► /api/integrations/classisland/*(设备令牌鉴权)
                                  ▲                          │
                                  └──── 老师下发的提醒 ◄──────┘

这一章有什么

页面 内容
架构总览 目录结构、技术栈、模块化设计、几条贯穿全局的约定
REST API 全部接口一览(方法 / 路径 / 权限)
实时事件(Socket.IO) 事件清单、房间规则、新增事件要改哪三处
数据模型 16 张表、迁移历史、跨库约定
角色与权限 权限矩阵与实现位置
动效层与主题 beUI 令牌、CSS linear() 弹簧、深色主题
ClassIsland 插件 插件契约、镜像为什么要带 startTime、部署与调试
灵动岛设计令牌 岛逐项的几何 / 配色 / 排版 token
验收与测试 五套验收脚本怎么跑、哪些用例是脆弱的
版本迭代与发布 改版本号、出安装包、发 Release 的完整流程

仓库里另外两份文档

  • 完整参考 —— 产品说明书 + 验收对照表(原 README 全文), 功能行为的权威来源;仓库首页那份 README 是精简后的门面页,细节都在这里。
  • AGENTS.md —— 写给 AI 编码代理的工程约定与本机踩坑记录,改代码前必读。 里面每一条硬约定都对应一次真实的翻车,比代码注释更值得先看一遍。