把 XH巡课 的当前可运行版本放进仓库,方便后续继续改并同步。

This commit is contained in:
itxiaohui committed 2026-11-21 12:31:01 +08:00
commit 6e5107f1b6
134 files changed
+11284

No files matched your search

+14
View File
@@ -0,0 +1,14 @@
# 架构
教师浏览器分别采集摄像头和麦克风,经 WebRTC 推到 LiveKit 房间。房间名是 `xh-{学校}-{班级}-{会话}`。后端在确认音视频发布后把会话标为 LIVE,家长只拿订阅令牌。录像由 LiveKit Egress 直接写入 MinIO,后端只保存元数据和短时播放地址。
## 运行单元
- `frontend`:Vue 3、Vite、Element Plus、LiveKit Client。
- `backend`:Spring Boot 3.5.16。Controller 只接收请求,规则在 Service。
- PostgreSQL:用户、学校、授权、课程、直播和录像元数据。
- Redis:验证码、刷新令牌、限流、设置版本和观看心跳。
- LiveKit / Egress:实时分发和合成录像。
- MinIO:私有录像文件。
Java 工具链是 Docker 镜像 `maven:3.9.11-eclipse-temurin-21` 和 `eclipse-temurin:21-jre`,不进入宿主机 PATH。
+22
View File
@@ -0,0 +1,22 @@
# 部署
复制 `.env.example` 为 `.env`,替换管理员密码、`JWT_SECRET`、`APP_ENCRYPTION_KEY`、LiveKit 和 MinIO 密钥。确认无误后再把 `APP_PROD_GUARD=true`。
```powershell
docker compose --env-file .env up --build
```
- 网站:`http://localhost:8088`
- 后端:`http://localhost:8080`
- MinIO 控制台:`http://localhost:9001`
- LiveKit:`ws://localhost:7880`,UDP `50000-50100`
校内部署时,把 `deploy/livekit.yaml` 的 `rtc.node_ip` 设成教师和学生浏览器都能访问的地址。跨 NAT 需要单独的 TURN,不能假设 HTTPS 足够。
数据库备份:
```powershell
docker compose exec postgres pg_dump -U xuenke xuenke > backup.sql
```
录像保留天数来自学校设置,过期任务每天 02:30 清理。
+9
View File
@@ -0,0 +1,9 @@
# 实施顺序
1. 虚拟 Java 环境、规则和数据库。当前已完成。
2. 账号、学校、绑定和权限测试。规则测试已通过,接口还要用真实数据库再跑一遍。
3. 独立设备选择、LiveKit 推流和家长订阅。代码已接上,缺真实媒体验证。
4. Egress 到 MinIO 的录像与回放。代码已接上,缺真实文件验证。
5. 管理端其余页面、短信和邮件的真实凭据联调。
6. 用同一口径测量延迟、失败率和资源占用,再决定是否提高并发。
7. Compose 部署和学校网络的 ICE/TURN 配置。
+26
View File
@@ -0,0 +1,26 @@
# 实现状态
更新时间:2026-11-21
Java 不安装在宿主机。编译和测试使用 `scripts/mvn.ps1`,镜像是 `maven:3.9.11-eclipse-temurin-21`。
## 已完成并通过测试
- Spring Boot 3.5.16 / Java 21 后端可在 Docker 中编译。
- 单元测试 `PolicyTest` 6 项通过:密码策略、公开注册只能成为待审核家长、直播房间隔离、家长不能推流、直播/回放授权分开、录像探针必须同时有音视频、密钥可加密往返。
- 前端设备拆分测试 1 项通过:摄像头与麦克风分属两个列表。
- 数据库 Flyway 脚本、RBAC、注册开关、家长绑定审核、课程与课表、直播状态机、LiveKit 令牌、Egress/MinIO 录像、SMTP/短信适配、Docker Compose 草稿已写入代码。
## 已写代码但尚未在本机完整跑通
- Docker Compose 全栈尚未启动,因此还没有真实的开播、观看、录像文件和 HTTPS 验收。
- 浏览器摄像头和麦克风尚未用真实设备验证。希沃硬件不在当前环境。
- 阿里云、腾讯云短信和 SMTP 只完成了协议实现,没有使用真实密钥发送。
- 300 人观看压力测试没有执行,不能宣称支持该并发。
## 下一步
1. 启动 Compose 中的 PostgreSQL、Redis、MinIO、LiveKit 和后端。
2. 用管理员账号走通建校、建班、审核、开播、观看、停播。
3. 有摄像头时在浏览器里验证独立设备切换。
4. 记录资源占用后再做小规模并发,不把未测结果写成能力。
+16
View File
@@ -0,0 +1,16 @@
# 需求核对
产品名默认「XH巡课」,后台可改,页面从 `/api/public/site` 读取。
必须保留的规则:
- 公开注册只创建家长,且默认待审核。注册不授予任何班级直播权。
- 家长要核对学号和学生姓名,再由管理员分别批准直播和回放。
- 摄像头列表和麦克风列表分开,进入教室页不自动打开设备。
- 推流成功并调用 ack 之后才是 LIVE。停播时断开房间并停止录像。
- 不同班级使用不同房间和令牌。
- 录像要同时有视频轨和音频轨,播放地址短时有效。
- 巡课多画面默认静音。
- 密钥不进日志。生产环境拒绝示例口令和模拟短信。
技术约束:Vue 3、Java 21、Spring Boot 3.5、PostgreSQL、Redis、LiveKit、MinIO、Docker Compose。宿主机不安装 JDK。
+25
View File
@@ -0,0 +1,25 @@
# 测试报告
日期:2026-11-21
## 环境
- 宿主机没有安装 Java。
- 后端测试容器:`maven:3.9.11-eclipse-temurin-21`。
- 前端:Node 24.18.0,Vitest 5.1.1。
## 结果
| 套件 | 命令 | 结果 |
|---|---|---|
| 后端策略测试 | `scripts/mvn.ps1 test` | 6 通过,0 失败 |
| 前端设备列表 | `npm test` | 1 通过,0 失败 |
## 未执行
- 对 PostgreSQL 的接口集成测试。
- 真实摄像头、麦克风、LiveKit 房间和 Egress 文件。
- 1 / 5 / 10 个班级,以及 50 / 100 / 300 个观看者的压力测试。
- 服务器重启后的直播恢复。
没有上述证据时,不把并发观看能力写成已支持。