把 XH巡课 的当前可运行版本放进仓库,方便后续继续改并同步。
This commit is contained in:
commit
6e5107f1b6
134 files changed
+11284
No files matched your search
@@ -0,0 +1,14 @@
|
||||
---
|
||||
description: Spring Boot、数据库与 API 规范
|
||||
globs: backend/**/*.{java,yml,sql}
|
||||
alwaysApply: false
|
||||
---
|
||||
|
||||
# 后端
|
||||
|
||||
- Java 21,Spring Boot 3.5。公共响应使用 `ApiResponse`。业务错误抛 `BizException`。
|
||||
- DTO 使用 Jakarta Validation。列表接口必须分页,每页最多 100 条。
|
||||
- 写操作放在事务里。只读查询不要把大文件读进内存。
|
||||
- Flyway 是唯一建表方式。`ddl-auto` 保持 `validate`。新表要有外键、唯一约束和查询索引。
|
||||
- 学校数据默认按 `schoolId` 隔离。超级管理员除外。
|
||||
- 日志里不写密码、验证码、令牌、密钥和完整手机号。
|
||||
@@ -0,0 +1,15 @@
|
||||
---
|
||||
description: Vue 3、TypeScript 与界面规范
|
||||
globs: frontend/**/*.{vue,ts,css}
|
||||
alwaysApply: false
|
||||
---
|
||||
|
||||
# 前端
|
||||
|
||||
- 使用 `<script setup lang="ts">`。路由懒加载。站点名称、颜色、注册开关来自 `useSiteStore`。
|
||||
- 摄像头和麦克风是两个独立列表,禁止合并成一个设备框。
|
||||
- 进入教室页不得自动打开摄像头或麦克风,必须由教师点击授权。
|
||||
- 离开直播页时断开 Room、停止轨道并关闭 AudioContext。
|
||||
- 接口错误、空数据和加载中都要有可见状态。
|
||||
- 家长页优先手机宽度,教师页按钮适合触摸,后台页优先信息密度。
|
||||
- 主题色默认 `#1677ff`,并支持深色模式。
|
||||
@@ -0,0 +1,16 @@
|
||||
---
|
||||
description: XH巡课架构、代码规范与虚拟 Java 环境
|
||||
alwaysApply: true
|
||||
---
|
||||
|
||||
# XH巡课核心规则
|
||||
|
||||
- 项目是校园直播、巡课、回放的前后端分离网站。默认名称「XH巡课」,页面名称只读站点配置。
|
||||
- 技术栈:Vue 3 + TypeScript + Vite;Java 21 + Spring Boot 3.5;PostgreSQL、Redis、LiveKit、MinIO。
|
||||
- **禁止在宿主机安装 JDK 或修改系统 PATH。** Java 只存在于 Docker 镜像中。编译和测试用 `scripts/mvn.ps1`,运行用 `docker compose`。
|
||||
- 分层:Controller 只做入参和响应,业务在 Service,数据访问在 Repository。
|
||||
- 新功能必须接到现有权限模型。注册账号只能是家长,不能自动获得直播权限。
|
||||
- 关键业务数据进 PostgreSQL。Redis 只放验证码、刷新令牌、限流、短缓存和在线状态。
|
||||
- 不要提交密钥。本地口令只写在 `.env.example`,并标明必须更换。
|
||||
- 完成一个模块后更新 `docs/IMPLEMENTATION_STATUS.md`。未跑通的功能不能标成完成。
|
||||
- 改代码前先看真实文件。不要覆盖无关改动,不要删用户数据。
|
||||
@@ -0,0 +1,14 @@
|
||||
---
|
||||
description: 隐私、权限与数据安全规范
|
||||
globs: backend/**/security/**,backend/**/user/**,backend/**/binding/**,frontend/src/stores/auth.ts,frontend/src/api/**,docker-compose.yml,.env.example
|
||||
alwaysApply: false
|
||||
---
|
||||
|
||||
# 安全
|
||||
|
||||
- 家长必须通过学生信息核对和管理员审核,直播与回放分开授权,可撤销。
|
||||
- 播放令牌短时有效。撤销授权后立刻拒绝新令牌,并把该身份移出 LiveKit 房间。
|
||||
- 密码用 BCrypt。SMTP 和短信密钥用 AES-GCM 后入库,接口不回传明文。
|
||||
- 登录、验证码和注册要限流。关闭注册时,接口和页面一起生效。
|
||||
- 生产环境若仍使用示例口令或模拟短信,必须拒绝启动或拒绝发送。
|
||||
- 课堂涉及未成年人:不采集隐藏录像,不对学生做自动识别或纪律评分。
|
||||
@@ -0,0 +1,15 @@
|
||||
---
|
||||
description: 直播、录像与媒体性能规范
|
||||
globs: backend/**/live/**,backend/**/recording/**,frontend/src/composables/**,frontend/src/views/teacher/**,frontend/src/views/parent/**,frontend/src/views/inspect/**,deploy/**
|
||||
alwaysApply: false
|
||||
---
|
||||
|
||||
# 直播与录像
|
||||
|
||||
- 教师浏览器用 WebRTC 推到 LiveKit。家长只订阅,不与教师建点对点上传。
|
||||
- 房间名必须包含学校、班级和会话,不能复用到其他班级。
|
||||
- 发布成功并调用 ack 之后,会话才能变成 LIVE。
|
||||
- 切换设备用轨道替换,先停旧轨道再释放,不能叠两条音轨。
|
||||
- 录像走 LiveKit Egress 到 MinIO,后端不转发整段视频。回放用短时预签名地址。
|
||||
- 巡课墙默认静音,只在选中的一间教室开声音。
|
||||
- 没有实测数据时,不能宣称支持 300 路并发观看。
|
||||
@@ -0,0 +1,14 @@
|
||||
---
|
||||
description: 测试、验收与性能测量规范
|
||||
globs: backend/src/test/**,frontend/src/**/*.spec.ts,scripts/**,docs/TEST_REPORT.md
|
||||
alwaysApply: false
|
||||
---
|
||||
|
||||
# 测试
|
||||
|
||||
- 权限、注册关闭、班级隔离、直播状态机、录像探针解析必须有自动化测试。
|
||||
- 后端测试在 Docker 里的 Maven 中运行,不依赖宿主机 Java。
|
||||
- 集成测试使用 Compose 里的 PostgreSQL 和 Redis,不改用内存库冒充。
|
||||
- 失败的测试要修代码或修测试数据,不能删断言。
|
||||
- 模拟短信、无摄像头和未跑的压力场景必须在 `docs/TEST_REPORT.md` 标明。
|
||||
- 性能优化前后保留同口径的测量结果。
|
||||
Reference in new issue
Block a user