LoveChengke
19c2aa07b2
文档站（`docs/` 就是 docfx 项目，发布在 https://lovechengke.github.io/ClassHelper/）： - 四章 + 常见问题 + 完整参考，共 44 页：快速上手（8 页）/ 应用帮助（10 页）/ 管理运维（6 页）/ 开发文档（11 页）。信息架构照 ClassIsland 文档站来： 顶栏分章、左侧章节导航、右侧本页目录、上一页 / 下一页、站内搜索、深色主题跟随系统； - 自定义模板覆盖（`templates/classhelper/`）：把 docfx modern 模板那套英文 UI 文案 （In this article / Improve this doc / Next…）换成中文，补 GitHub 入口与版本徽标， 并加一层只调排版与配色的 `public/main.css`（不动 DOM 结构）； - 站点顶栏的版本徽标取自根 `package.json`（`docs/build.mjs` 用 `--metadata` 注入）， 不在文档里写第二份 —— 否则一定漂； - 404 页单独生成：GitHub Pages 的项目页挂在 `/<仓库名>/` 子路径下，而浏览器是按**被请求的路径** 解析页面里的相对链接的，所以 `<base>` 必须钉到站点根，由 `build.mjs`（本地 `./`）与 workflow（CI 传 `/<仓库名>/`）分别注入； - 构建前清空 `_site`：docfx 只覆盖不清理，删掉或改名的页面会以旧文件留在目录里， 而 Pages 上传的是整个目录。 版本迭代（**每一次 releases，不是每一次提交**）： - 新增 `scripts/version.mjs`。这个仓库里同一个版本号散在 **10 个文件**里（5 份 `package.json`、 `deploy/package.runtime.json`、两个 compose 的镜像 tag、插件 `manifest.yml`、以及插件 C# 里的 `PluginVersion` 常量），手工改必然漏一处，而漏掉的那处**不会报错**，只在某个不常走的分支上 表现为"版本号对不上"。现在收口成两条命令：`pnpm version:check`（逐处比对，不一致 exit 1） 与 `pnpm version:bump patch|minor|major`（一次改写全部 10 处，任何一处匹配不到或匹配到多处 就直接失败退出，不做尽力而为的部分改写）； - `AGENTS.md` 新增 §4.4「版本迭代（每一次 releases，不是每一次提交）」：写清版本号落在哪 10 处、 完整发布命令序列（体检 → 验收 → `dist:all` → 哈希清单 → 推 master → `gh release create` → Linux 包由 CI 合并哈希行），以及"已发布的版本号不要复用"的理由。 其它： - `.github/workflows/docs.yml`：推 master（`docs/**` / `package.json` / workflow 自身有变）即构建并 部署到 Pages；构建带 `--check`，把 docfx 的警告当错误 —— 最常见的警告是"某个 `.md` 没被任何 `toc.yml` 引用"，那种页面有内容但没有侧边栏，属于必须修掉的疏漏； - docs 目录重组后的引用同步：`production` / `mysql` / `linux-deploy` / `winisland-design-tokens` 移到新位置后，AGENTS.md、`deploy/`、`scripts/`、客户端源码注释里的路径引用一并更新； - 文档站只发布 `docs/` 这一棵树，页面里指向树外的相对链接（`../AGENTS.md` 等）改成 GitHub 绝对 URL， 否则上线全是 404； - 图标派生清单补上文档站模板里的 `logo.png` 与 `favicon.png`（`pnpm icons` 一并生成， 仍然只有一个图形源 `build/classhelper.{png,ico}`）； - `docs/_site` 进 `.gitignore` / `.prettierignore` 与 ESLint ignores； - 根脚本补 `version:check` / `version:bump` / `docs:build` / `docs:serve` / `docs:check`。
116 lines
6.5 KiB
Markdown
116 lines
6.5 KiB
Markdown
---
|
||
title: 表格与课表导入
|
||
description: 成绩、学生名单、教师名单的表格导入，以及从 ClassIsland 档案导入节次时间与课表。
|
||
---
|
||
|
||
# 表格与课表导入
|
||
|
||
五条导入链路**都在服务端完成解析、校验与去重**，前端只负责收集文件与展示结果。
|
||
所以 Web 端、客户端与直接调接口拿到的结果是同一套规则、同一份统计。
|
||
|
||
## 通用流程
|
||
|
||
表格类导入都是三段式（成绩 / 学生 / 教师都一样）：
|
||
|
||
1. **下载模板** —— `GET /imports/template?kind=grades&format=xlsx|csv`。
|
||
CSV 带 BOM，Excel 直接双击打开不乱码。
|
||
2. **上传预览** —— 服务端返回列名、前 20 行、总行数与**建议的字段映射**，以及校验问题。
|
||
列名按同义词自动映射（「学号→学生用户名」「得分→分数」「满分→总分」……），也可以手动改。
|
||
**缺必填列不会静默通过**，会直接给出「缺少必填列「…」」。
|
||
3. **确认导入** —— 按映射与写入模式提交：
|
||
|
||
| 模式 | 已存在的记录 |
|
||
| -------- | ------------ |
|
||
| `upsert` | 更新（默认） |
|
||
| `append` | 跳过 |
|
||
|
||
返回 `{ total, inserted, updated, skipped, failed, errors[], warnings[] }`。
|
||
`errors[].row` 是 **Excel 视角的行号（含表头）**，方便老师改完再导。
|
||
|
||
**体积限制**：文件上限 **8MB**，请求体上限 12MB（文件以 base64 放进 JSON，约 4/3 倍）。
|
||
超限返回 413 `IMPORT_TOO_LARGE` 与中文提示 —— 如果你看到一句英文的「request entity too large」，
|
||
那说明这个异常没被映射，属于 bug。
|
||
|
||
## 1. 成绩表格导入
|
||
|
||
- 入口：成绩录入 → 「导入表格」
|
||
- 模板列：`学生用户名 / 学生姓名 / 考试名称 / 分数 / 总分 / 课程`
|
||
- 支持 `.xlsx / .xls / .csv / .tsv`（自动识别分隔符）
|
||
- **重复判定**：同班级 + 同学生 + 同考试 + 同课程
|
||
- 学生按「用户名」优先、「姓名」兜底匹配
|
||
|
||
## 2. 学生名单导入
|
||
|
||
- 入口：学生管理 → 「导入名单」（仅管理员）
|
||
- 模板列：`用户名 / 姓名` —— 学生没有账号属性，**没有密码列**
|
||
- 用户名必须匹配 `^[A-Za-z0-9_.-]{3,32}$`
|
||
- 用户名已经被某个教师 / 管理员账号占用时，**这一行进错误列表**，不会覆盖他人账号
|
||
|
||
## 3. 教师名单导入
|
||
|
||
- 入口：教师管理 → 「导入名单」（仅管理员）
|
||
- 模板列：`用户名 / 姓名 / 初始密码 / 角色`
|
||
- 角色取 `ADMIN` / `TEACHER`，留空按 `TEACHER`
|
||
- 与新建教师同一套校验，导入完可以直接登录
|
||
|
||
## 4. 从 ClassIsland 导入课程表
|
||
|
||
**这是最省事的一条路**：如果教室里已经在用 ClassIsland，直接导入它的档案 JSON，
|
||
课表、节次时间、单双周会一起进来，不用排两遍。
|
||
|
||
- 入口：课表管理 → 「导入 ClassIsland 课程表」
|
||
- 输入：同一份档案 JSON（`ClassPlans` / `TimeLayouts` / `Subjects` 三个字典），
|
||
粘贴或选择 `.json` 文件
|
||
|
||
### 真实档案的形态
|
||
|
||
ClassIsland 2.x 的档案在 `Profiles/<档案名>.json`，字段是 PascalCase：
|
||
|
||
```jsonc
|
||
{
|
||
"TimeLayouts": {
|
||
"<guid>": { "Name": "…", "Layouts": [{ "StartTime": "08:00:00", "EndTime": "08:45:00", "TimeType": 0 }] },
|
||
},
|
||
"ClassPlans": { "<guid>": { "Name": "…", "Classes": [/* 与上课时间点逐位对齐 */] } },
|
||
"Subjects": { "<guid>": { "Name": "语文" } },
|
||
}
|
||
```
|
||
|
||
解析器同时兼容顶层数组、`{ TimeLayouts: [...] }`、`{ items | Items | Layouts | TimeLayout: [...] }`
|
||
与单个时间表对象。
|
||
|
||
| 细节 | 说明 |
|
||
| ------------ | ----------------------------------------------------------------------------------------------------------------------- |
|
||
| 时间字段 | `StartTime` / `EndTime`（`"08:00:00"`）；旧版 `StartSecond` / `EndSecond`（ISO 字符串或秒数）；`"8:0"` / `"08:00"` 都认 |
|
||
| `TimeType` | `0=上课`、`1=课间`、`2=分割线`、`3=行动`，与 ClassIsland 一致 |
|
||
| **节次对齐** | `ClassPlan.Classes[i]` 对应 `Layouts` 里**第 i 个 `TimeType === 0` 的时间点**（课间、分割线不占位） |
|
||
| 单双周 | `TimeRule.WeekCountDiv`（`0=每周`、`1=单周`、`2=双周`）+ `WeekCountDivTotal`（默认 2） |
|
||
| 星期换算 | ClassIsland 是 `0=周日 … 6=周六`，导入时换算成 `1=周一 … 7=周日` |
|
||
| 科目映射 | `Subjects[<guid>].Name`；该班还没有的科目**自动补建课程**（任课老师取该班班主任），预览里会提前列出 |
|
||
| 写入模式 | `replace` 清空该班课表后写入（事务内完成）/ `merge` 按「星期 + 开始时间 + 单双周」去重 |
|
||
|
||
**解析出 `errors` 时返回 400 且数据库完全不写入**（`IMPORT_INVALID` / `IMPORT_EMPTY`）——
|
||
先保证不写坏，再谈导入。
|
||
|
||
时间重叠、分割线没有时间这类问题只作 `warnings`，不阻断导入。
|
||
|
||
> **3 周及以上的轮换**没法用单双周表达，会给出 warning 并按"每周"处理。
|
||
|
||
## 5. 只导入节次时间（旧入口）
|
||
|
||
「导入时间配置」按钮**已经下线** —— 因为同一份档案 JSON 里的 `TimeLayouts` 已经跟着课表一起进来了。
|
||
组件与接口（`/imports/time-layout/*`）仍然保留给旧脚本调用。
|
||
|
||
它的写入模式也是 `replace`（整体替换该班同名配置）与 `merge`（以**开始时间**为槽位标识合并，
|
||
同槽位被导入项覆盖，其它旧节次保留，不静默丢数据）。
|
||
|
||
## 相关接口
|
||
|
||
| 路径 | 说明 |
|
||
| ------------------------------------------------------ | ------------------------------------------ |
|
||
| `/imports/template?kind=&format=` | 下载模板（`csv` 走 JSON，`xlsx` 走二进制） |
|
||
| `/imports/table/preview` | 上传解析预览（base64） |
|
||
| `/imports/table/commit` | 按映射与模式导入 |
|
||
| `/imports/class-plan/preview`、`/imports/class-plan` | ClassIsland 课程表预览 / 导入 |
|
||
| `/imports/time-layout/preview`、`/imports/time-layout` | 时间配置预览 / 导入（旧入口） |
|