# flow-designer-web **Repository Path**: BOBO_17/flow-designer-web ## Basic Information - **Project Name**: flow-designer-web - **Description**: 面向 flow-server-starter 的可视化流程设计器,用 React + antd + Redux Toolkit + React Flow 实现 - **Primary Language**: Unknown - **License**: Apache-2.0 - **Default Branch**: main - **Homepage**: None - **GVP Project**: No ## Statistics - **Stars**: 0 - **Forks**: 0 - **Created**: 2026-11-10 - **Last Updated**: 2026-11-12 ## Categories & Tags **Categories**: Uncategorized **Tags**: None ## README # flow-designer-web 面向 [flow-server-starter](https://gitee.com/BOBO_17/flow-server-starter) 的可视化流程设计器,用 React + antd + Redux Toolkit + React Flow 实现。 画布负责编排节点顺序,右侧表单由后端 `GET /nodes` 的节点元数据动态生成,因此后端新增节点无需改前端;保存时前端把画布转成 Flow JSON,直接调用 `POST /flow` 完成校验并部署。 ## 生态仓库 | 仓库 | 说明 | | --- | --- | | [flow-server-starter](https://gitee.com/BOBO_17/flow-server-starter) | 后端运行时:把 Flow JSON 编译成 Apache Camel 路由,提供管理接口与日志终端 | | [flow-host-sample](https://gitee.com/BOBO_17/flow-host-sample) | 只依赖 starter 的最小宿主工程,本设计器调试时默认连它 | 数据流向:本仓库产出 Flow JSON → `flow-server-starter` 编译成 Camel 路由 → 运行在 `flow-host-sample` 这类宿主里。 ## 功能 - **元数据驱动节点面板**:按 `/nodes` 返回的分类分组、搜索;入口节点做合法性约束(空链只能选入口,非空链禁用入口)。 - **React Flow 画布**:纵向链路布局,节点卡片显示序号、标题、类型、参数摘要与错误标记;禁止拖拽与连线,保证 Flow JSON 结构稳定。 - **动态属性表单**:按 `props.type` 渲染 `number / boolean / select / string-list / textarea / expression / json / object-list / nodes / text` 十种控件。 - **表达式编辑器**:`{lang, script}` 结构,支持 simple / constant / groovy / header / jsonpath / xpath,空脚本自动落为 `undefined`。 - **撤销重做**:Redux 快照栈(past / present / future),700ms 内连续编辑合并为一步,历史上限 50。 - **校验定位**:`POST /flow/validate` 返回的 `issues` 按 `nodeId` 与 `nodes[i]` 索引聚合,问题列表点击即可聚焦到对应节点。 - **流程管理**:流程树浏览、加载、新建空白流程、删除流程,Header 显示未保存状态。 - **节点调整**:属性面板提供上移、下移、删除,入口节点不可被移动到非首位。 - **日志终端**:WebSocket 连接宿主的 `/terminal`,2000 行环形缓冲,级别着色、自动滚动、断线 3 秒重连。 - **管理接口鉴权**:`X-Flow-Token` 统一注入,401 时自动弹出登录框,令牌存 `localStorage`。 ## 技术栈 | 项 | 取值 | | --- | --- | | 框架 | React 18.3 + TypeScript 5.6(strict) | | 构建 | Vite 5 | | UI | antd 5 + @ant-design/icons | | 状态 | Redux Toolkit 2(文档状态)+ RTK Query(服务端状态) | | 画布 | @xyflow/react 12(React Flow) | ## 快速开始 ### 1. 启动后端 任选其一。前端默认代理指向 host-sample 的 `8091`;使用 demo 时把 `VITE_PROXY_API_TARGET` 设为 `http://localhost:8086`。 ```bash # 后端自带 demo(含 H2 与一条示例流程,管理接口 8086、日志终端 8080) cd camel-flow-server-starter mvn -Pdemo spring-boot:run -Dspring-boot.run.profiles=demo # 或使用最小宿主(管理接口 8091,默认代理目标) cd flow-host-sample mvn spring-boot:run ``` ### 2. 启动前端 ```bash npm install npm run dev # http://localhost:5173 ``` `npm run build` 会先执行 `tsc --noEmit` 再做生产构建,类型错误会直接阻断构建。 ### 3. 环境变量与代理 默认代理指向 `flow-host-sample`(`8091`),连 starter demo 时改环境变量即可,无需改代码。复制 `.env.example` 为 `.env.local` 后覆盖: | 变量 | 默认值 | 说明 | | --- | --- | --- | | `VITE_API_BASE` | `/api` | 管理接口基地址;直连后端时填完整地址,如 `http://192.168.1.10:8091` | | `VITE_TERMINAL_URL` | 空 | 日志终端完整地址;留空则用当前页面 host + 后端返回的 `terminalPath` | | `VITE_PROXY_API_TARGET` | `http://localhost:8091` | 开发代理 `/api` 的目标 | | `VITE_PROXY_TERMINAL_TARGET` | `ws://localhost:8080` | 开发代理 `/terminal` 的目标 | 生产环境不经过 Vite 代理,直接同源部署,或用 `VITE_API_BASE` 指向后端地址(starter 已开启 CORS)。Header 会显示当前连接的 `server` 与节点数,便于确认连的是哪个环境。 ### 4. 配置鉴权 后端设置了 `flow.admin-token` 时,首次请求会收到 401 并弹出登录框;令牌保存在 `localStorage` 的 `flow.admin.token`。后端 token 留空则无需登录。 ## 使用说明 1. 左侧「节点」页签选一个入口节点(如 `rest`、`from`)作为链路起点。 2. 选中节点后点击其它节点,新节点会插入到选中项之后;右侧属性表单填写必填项。 3. Header 填写流程 `id / desc / group`,点「校验」查看问题,点「保存」走 `POST /flow` 部署并落库。 4. 已部署流程在左侧「流程」页签中以树形展示,点击叶子加载到画布继续编辑。 ## 目录结构 ```text flow-designer-web/ ├── index.html ├── vite.config.ts # 开发代理:/api → 8086,/terminal → 8080 ├── tsconfig.json ├── package.json └── src/ ├── main.tsx # 入口,挂载 Provider 与 antd ConfigProvider ├── App.tsx # 三栏布局、Header 操作、校验/部署/登录编排 ├── styles.css ├── api/ │ ├── client.ts # RTK Query:serverInfo/nodes/flows/flow/deploy/validate/delete │ ├── token.ts # localStorage 令牌读写 │ └── types.ts # 节点元数据、Flow JSON、校验结果等类型 ├── lib/flow.ts # FlowDoc 与 FlowDefinition 互转、节点摘要、issues 索引 ├── store/ │ ├── index.ts # configureStore 与类型化 hooks │ ├── flowSlice.ts # 文档、选中、脏标记、撤销重做、校验问题 │ └── logSlice.ts # 终端日志环形缓冲 └── components/ ├── NodePalette.tsx # 节点搜索与分类 ├── FlowCanvas.tsx # React Flow 画布 ├── FlowNodeCard.tsx # 自定义节点卡片 ├── PropertyPanel.tsx # 元数据驱动表单 ├── IssuesPanel.tsx # 校验结果 ├── FlowTree.tsx # 流程树 ├── TerminalPanel.tsx # 日志终端 └── LoginModal.tsx # 管理令牌登录 ``` ## 已知边界与路线图 当前版本(P0)只支持**线性链路**: - 分支与容器节点(`choice / filter / split / threads / loop / try`)依赖嵌套子链,画布暂不支持编辑,只能查看已有流程中的只读结构。 - 暂不支持导入/导出本地 Flow JSON、节点复制粘贴、画布缩放持久化与多主题。 P1 计划:容器节点的子画布编辑、JSON 导入导出、节点模板与片段复用、批量校验报告。