Files
eip4-web/README.md
zhengwr 7d4f26edd3 docs(readme): 修正过时联调指引(JDK17→21/8084→8093/账号/自举→build_devdb)
- 后端联调改走 scripts/run-dev.sh(dev :8093,JDK 21 守卫),删 JDK17 毒指引(项目必须 21,17 连编译都过不了)
- 账号分口径:dev 库 admin/111111(日常)/ local 自举 alice/123456(CI/对拍)
- .env 表 VITE_BACKEND_TARGET 默认对齐实际 8093
- 本地库指引:日常 eip4dev 用 build_devdb.sh,自举集仅 CI/对拍
- 页面 schema 契约行删「开发期静态 mock」过时表述;设计器行改「已闭环」

Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
2026-07-02 08:15:33 +08:00

111 lines
5.4 KiB
Markdown

# eip4-web
EIP4 前端渲染宿主——amis 6.13.0 本地化 SDK 渲染 + 登录/JWT + 待办聚合。
架构定位:前端独立 React 工程(amis 渲染宿主 + 设计器),Nginx 托管;
转换器产出页面在此渲染,登录/JWT 适配后端 platform-auth,待办聚合对接 platform-flow-gateway。
## 技术栈
| 层 | 选型 | 说明 |
|----|------|------|
| 框架 | React 18.3 + Vite 5 + TypeScript 5 | 主流稳妥,不引重型框架 |
| 路由 | react-router-dom 6 | 登录守卫 + 页面路由 |
| HTTP | axios 1.7 | 拦截器注入 Bearer + 401 跳登录 |
| 渲染 | amis 6.13.0 **本地 SDK** | `public/sdk-local/`(非 npm 包),`amisRequire('amis/embed')` 模式,**不依赖 CDN** |
amis 选型理由(选**本地 SDK** 而非 npm 包):本期约定 amis 锁 6.13.0 本地化部署,
SDK 产物来自 C5 构建预演(eip4-poc 的 `sdk-local/`),整套渲染器(图表/富文本/office 预览等)
已构建为离线产物。npm 包形态(`amis` + `amis-core` + 按需 thirds)虽利于 tree-shaking,
但需自行解决 6.13 本地化(locale)与可选渲染器装配,且与 PoC 已验证的 `amis-local.html`
范式不一致。本期复用 PoC 已验证产物,**与转换器/校验闸同源**,风险最低。详见 `docs/P4脚手架报告.md`。
## 启动
前置:Node v22+、后端 **JDK 21**(严禁 26,Groovy 红线,见 `../eip4-platform/README.md`)、
本地 PG(`localhost:5433`,日常开发库 `eip4dev`,构建见下)。
```bash
npm install
npm run dev # dev server :5173,/api 反代到后端(dev profile 默认 8093)
```
浏览器开 http://localhost:5173/login:
- **dev 库(eip4dev,日常开发)**:账号 `admin` / `111111`
- local 自举库(eip4m0,CI/对拍用):账号 `alice` / `123456`
### 后端联调(单独终端)
```bash
cd ../eip4-platform
mvn -pl platform-app,flowable-service -am package -DskipTests # 先出 jar
bash scripts/run-dev.sh platform # dev profile :8093(内置 JDK 21 守卫,自动关旧实例)
# 审批流联调用: bash scripts/run-dev.sh both (再起 flowable-service :8089)
# 日志 /tmp/eip4-platform.log;健康判定 curl :8093/v3/api-docs
# 前端反代端口冲突:复制 .env 为 .env.local 改 VITE_BACKEND_TARGET(已 gitignore)
```
日常开发库 `eip4dev` 构建:`bash tools/local-devdb/build_devdb.sh --drop-target`
(约 6 分钟,需内网可达客户库副本 192.168.20.68:5435)。
CI/对拍走 local profile + `eip4m0` 极简自举集(bootstrap SQL 见
`platform-parity/src/main/resources/bootstrap/`,含 alice 测试账号)。
## 构建
```bash
npm run build # tsc -b && vite build → dist/
npm run preview # 本地预览 dist
```
产物 `dist/` 可直接交 Nginx 托管:
- `dist/assets/` + `dist/index.html`:应用包(~204 KB,gzip ~71 KB)
- `dist/sdk-local/`:amis 6.13.0 本地 SDK(~61 MB,原样拷贝,不参与打包)
- `dist/schemas/`:开发期静态 schema(生产期改走后端接口,见下)
Nginx 关键配置:SPA 路由回退 `try_files $uri /index.html`;`/api` 反代到后端。
## 配置(.env)
| 变量 | 默认 | 说明 |
|------|------|------|
| `VITE_BACKEND_TARGET` | `http://localhost:8093` | dev server 的 `/api` 反代目标(dev profile 后端);冲突用 `.env.local` 覆盖 |
| `VITE_SCHEMA_SOURCE` | `mock` | `mock`=读 `public/schemas/`;`backend`=读后端 schema 接口 |
## 与后端契约清单
| 用途 | 方法 路径 | 契约来源 | 前端文件 |
|------|-----------|----------|----------|
| 登录签发 JWT | `POST /api/auth/login` | platform-auth/P2认证实测报告.md | `src/api/auth.ts` |
| 实体 amis CRUD 列表 | `GET /api/entity/{t}/list` | EntityController(amis 格式 `{status,msg,data:{items,total}}`) | `src/components/AmisRenderer.tsx`(fetcher) |
| 待办聚合 | `GET /api/todo` | platform-flow-gateway/P3网关实测报告.md(503 熔断降级) | `src/api/todo.ts` |
| 页面 schema | `GET /api/page/schema/{templateId}` | PageSchemaController(`sys_page_schema` 唯一真相,已落地) | `src/api/schema.ts` |
JWT 经 `src/api/http.ts` 拦截器注入 `Authorization: Bearer`;401(非登录端点)自动清会话 + 跳 `/login`。
## 安全权衡(JWT 存储)
折中:**内存权威副本 + localStorage 恢复源**(`src/auth/token.ts`)。
- 收益:刷新不掉登录态。
- 残留风险:XSS 脚本可读 localStorage 中的令牌。
- 缓解/演进:生产建议短有效期 + 后端令牌轮转 + CSP 限制脚本来源;
长期演进到 httpOnly Cookie + 刷新令牌(需后端下发 Set-Cookie + CSRF 防护)。
## 已定约定(开工前勿改 / 已遵守)
- amis 锁 6.13.0 本地化部署,不依赖 CDN(SDK 在 `public/sdk-local/`,来源见 C5 构建预演)✅
- 渲染宿主参照 PoC `amis-local.html`(本地 SDK 引用方式)✅
- 页面 schema 双闸:官方 schema.json 校验闸 + 运行时渲染冒烟闸(迁移手册 §8)✅
- 设计器:amis-editor 已接入并闭环(`src/editor/DesignerPage.tsx` + `editor.html`,设计中心独立 tab)✅
- 渲染层备选(amis fork 失败时):lowcode-engine / ProComponents(架构设计第七节)✅
## 目录
```
public/sdk-local/ amis 6.13.0 本地 SDK(从 eip4-poc 拷贝,不依赖 CDN)
public/schemas/ 开发期静态 schema(eip4-poc 转换器对客户库真实模板的转换产物)
src/api/ http(拦截器)/ auth / todo / schema
src/auth/ JWT 存储(内存+localStorage)
src/components/ AmisRenderer(本地 SDK 渲染 + fetcher 适配)/ AppLayout / RequireAuth
src/pages/ LoginPage / PageRenderPage / TodoPage
docs/ 联调验证截图 + P4脚手架报告.md
```