部署 v0.7.3 后,/health 的 scenes.error 给出决定性线索: No metadata for "Scene" was found. src/entities/index.ts 的 ENTITIES 一直漏了 Scene: export const ENTITIES = [Asset, Song, Motion, CharacterModel, ReviewRecord]; TypeORM 只按 ENTITIES 注册 metadata,漏注册的后果极其隐蔽: - 启动完全正常(DI 可解析、/health 正常、migrationsPending 0); - 迁移也正常(AddScenes 已执行,表其实是建好的); - 但第一次查 Scene 就抛 No metadata,于是 /api/scenes、/api/catalog/export、 /api/catalog/version、/api/reviews?status=pending 全部 500 → 客户端拉不到任何目录、管理端待审列表打不开。 即:此前"数据库缺 scenes 表"的判断也是错的(v0.7.3 的降级与诊断脚本因此仍然值得保留 —— 它们把"场景坏了"限制成"场景不可用",而不是整站不可用)。 修复:ENTITIES 加入 Scene 并导出。 新增静态防线 test/entities-registry.spec.ts(4 项):扫描 src/entities/*.entity.ts 里的 @Entity() 类并逐一与 ENTITIES 对账(漏一个即失败)、检查无重复/无多余、核对 AddScenes 迁移文件存在。已做反向验证:把 Scene 从 ENTITIES 移除后该测试立刻失败。 这类缺陷既过得了 tsc、也过得了启动冒烟(应用能启动),只能靠静态核对兜住。 文档:README.md/.txt 增加 v0.7.4 修订说明;tasks/015-scene-management.md 增 「缺陷修复记录四」;开发文档 §4.12 补「新增实体必须加入 ENTITIES」的硬性要求。 验证:npm run verify 通过(23 文件 / 285 项测试 + 契约/路由/版本一致 + 启动冒烟); 发布产物 opendance-web-v0.7.4.tar.gz sha256 e680c23fc382b6c39498608ea0154f8f80e9e6b5c13518f0f88095644ce88fe1。
OpenDance Studio 管理端(opendance-admin)
基于 React 18 + TypeScript + Vite 的管理后台,对接 web-server 的 NestJS API。
接口契约以 ../contracts/rest-api.yaml(rest-api 0.1.0)为准,
字段语义见 ../contracts/data-models.md。
界面语言为简体中文;无任何 UI 组件框架,全部样式集中在 src/styles.css。
快速开始
npm install # 或 pnpm install
npm run dev # 开发服务器 http://localhost:5173
npm run build # 生产构建(tsc -b && vite build)-> dist/
npm run preview # 本地预览 dist/
npm run typecheck # 只做类型检查(tsc --noEmit)
管理端请求的是同源的
/api/**与/health,不含任何硬编码域名。
开发代理(dev proxy)
vite.config.ts 已把 /api 与 /health 代理到 http://localhost:3000:
server: {
port: 5173,
proxy: {
'/api': { target: 'http://localhost:3000', changeOrigin: true },
'/health': { target: 'http://localhost:3000', changeOrigin: true },
},
}
因此本地只需先启动服务端,再 npm run dev 即可,无需配置 CORS。
VITE_API_BASE
src/api/client.ts 的基址取自:
const BASE_URL = import.meta.env.VITE_API_BASE?? '';
-
不设置(默认,空串):同源请求 -- 开发期走上面的 vite 代理,生产期走 nginx 反代。推荐。
-
设置:例如服务端在另一台机器上:
#.env.local(不要提交) VITE_API_BASE=http://192.0.2.10:3000此时浏览器会直接跨域请求该地址,需要服务端开启 CORS。 构建期注入:
VITE_API_BASE=https://api.example.com npm run build。
生产构建与部署
npm run build # 产物在 dist/
vite.config.ts 使用 base: './',产物使用相对路径引用,可挂在任意子路径下。
生产部署(业务服务自带管理端,不需要反代托管静态文件)
构建产物 dist/ 会被安装到 $APP_DIR/admin,并由 NestJS 服务自身托管
(含 SPA 深链接回退)。因此反向代理只需要把请求整体转发到后端端口即可,
不需要在代理层再配置静态站点或 try_files。
# 仓库根目录,一键部署后端(含管理端)
bash deploy/install.sh
- 后端通过
ADMIN_DIR定位管理端产物,默认../admin - 反代配置样例:
deploy/proxy/nginx.conf.example(nginx)、deploy/proxy/web.config.example(IIS) - 完整说明:
deploy/proxy/README.md
目录结构
src/
main.tsx 入口(BrowserRouter)
App.tsx 路由表
styles.css 全部样式
api/
client.ts fetch 封装(ApiError / 分页 / multipart)
types.ts 契约类型(与 rest-api.yaml 一一对应)
endpoints.ts 契约端点封装
components/
Layout.tsx 左侧导航骨架
ui.tsx 通用组件(表格/弹窗/分页/来源五元组展示与表单...)
VrmPreview.tsx three + @pixiv/three-vrm 的 3D 预览(懒加载分包)
lib/
labels.ts 枚举中文文案
format.ts 时间/字节/时长格式化
validation.ts 客户端校验(来源五元组等)
useAsync.ts 加载/错误/重试 hook
pages/
Dashboard.tsx 概览
Songs.tsx 歌曲管理 T-WEB-008
Models.tsx 模型管理 T-WEB-009
Motions.tsx 动作管理 T-WEB-004/006
Reviews.tsx 审核 T-WEB-007
页面与任务对照
| 路由 | 说明 | 任务 |
|---|---|---|
/ |
概览:三类资产按状态计数、契约版本与目录指纹、健康检查、API 不可达告警 | - |
/songs |
歌曲管理:分页/搜索/筛选、来源五元组必填、音频上传、软删除 | T-WEB-008 |
/models |
模型管理:VRM 优先、来源五元组完整展示、设为默认、3D 预览 | T-WEB-009 |
/motions |
动作管理:上传、预处理、关键点 NDJSON 下载 | T-WEB-004/006 |
/reviews |
审核:待审列表 + 审核流水,通过/驳回(驳回必填意见) | T-WEB-007 |
所有页面都显式处理加载中 / 空数据 / 请求失败三种状态,请求失败不会白屏。
3D 预览说明
src/components/VrmPreview.tsx: GLTFLoader + VRMLoaderPlugin(来自 @pixiv/three-vrm),
- 依据
vrm.meta.metaVersion区分 VRM 0.x / 1.0, 0.x 自动执行VRMUtils.rotateVRM0; - 自实现鼠标拖拽旋转与滚轮缩放(未引入 OrbitControls);
requestAnimationFrame循环内调用vrm.update(delta),并按包围盒自动取景;- 卸载时取消 RAF、断开 ResizeObserver、释放 renderer / geometry / material / texture;
- 无 WebGL 上下文时降级为错误提示,不会让页面崩溃。
three + @pixiv/three-vrm(约 750 kB)通过 React.lazy 单独分包,仅进入模型页时加载。