React Flow 架构

何时使用 React Flow

适用场景

• 可视化编程界面
• 工作流构建器与自动化工具
• 图表编辑器（流程图、组织结构图）
• 数据管道可视化
• 思维导图工具
• 基于节点的音视频编辑器
• 决策树构建器
• 状态机设计工具

建议考虑替代方案的场景

• 简单的静态图表（直接使用 SVG 或 Canvas）
• 高负载实时协同（可能需要自定义同步层）
• 3D 可视化（使用 Three.js、react-three-fiber）
• 含 10,000+ 节点的图分析（使用基于 WebGL 的方案，如 Sigma.js）

决策工作流（判断门）

在锁定技术栈或启动冲刺开发前，请运行以下检查序列。仅针对一次性原型可跳过。

1. 明确交互行为 — 列出核心用户操作（例如：拖拽、连接、删除、分组）。通过条件：每个操作均对应一个具体可实现的 React Flow 回调函数（如 onNodesChange、onConnect 等）。

2. 评估规模等级 — 预估峰值节点数（可见画布内或整个文档总量）。通过条件：该数值落在“节点数量指南”表格某一行范围内，且你接受该行所推荐的策略（例如：当匹配该行时启用 onlyRenderVisibleElements）。

3. 确定状态存放位置 — 选择本地 Hook、外部 Store，或 Redux 等方案。通过条件：用一句话明确说明持久化、撤销/重做或跨界面同步的状态将存于何处；或明确声明“暂不需要”。

4. 再次审视替代方案 — 若当前用例落入“建议考虑替代方案”的范畴，通过条件：用一句话说明为何仍选用 React Flow，或明确指出你已选用列表中哪一替代方案。

架构模式

包结构（xyflow）

@xyflow/system (vanilla TypeScript)
├── 核心算法（边路径、边界计算、视口管理）
├── xypanzoom（基于 d3 的平移/缩放）
├── xydrag、xyhandle、xyminimap、xyresizer
└── 共享类型定义

@xyflow/react（依赖 @xyflow/system）
├── React 组件与 Hook
├── 基于 Zustand 的状态管理 Store
└── 框架专属集成

@xyflow/svelte（依赖 @xyflow/system）
└── Svelte 组件与 Store

含义：核心逻辑与框架无关。在贡献代码或调试问题时，请先确认问题是出现在 @xyflow/system 还是框架专属包中。

状态管理方式

1. 局部状态（适用于简单应用）

// 使用 useNodesState / useEdgesState 快速原型开发
const [nodes, setNodes, onNodesChange] = useNodesState(initialNodes);
const [edges, setEdges, onEdgesChange] = useEdgesState(initialEdges);

优势：简洁，样板代码最少 劣势：状态局限于组件树内部

2. 外部 Store（适用于生产环境）

// Zustand Store 示例
import { create } from 'zustand';

interface FlowStore {
  nodes: Node[];
  edges: Edge[];
  setNodes: (nodes: Node[]) => void;
  onNodesChange: OnNodesChange;
}

const useFlowStore = create((set, get) => ({
  nodes: initialNodes,
  edges: initialEdges,
  setNodes: (nodes) => set({ nodes }),
  onNodesChange: (changes) => {
    set({ nodes: applyNodeChanges(changes, get().nodes) });
  },
}));

// 在组件中使用
function Flow() {
  const { nodes, edges, onNodesChange } = useFlowStore();
  return ;
}

优势：状态全局可访问，更易于持久化与同步 劣势：配置成本更高，需谨慎优化 selector

3. Redux 或其他状态库

// 通过 selector 接入
const nodes = useSelector(selectNodes);
const dispatch = useDispatch();

const onNodesChange = useCallback((changes: NodeChange[]) => {
  dispatch(nodesChanged(changes));
}, [dispatch]);

数据流架构

用户输入 → 变更事件 → Reducer/处理器 → 状态更新 → 重新渲染
     ↓
[拖拽节点] → onNodesChange → applyNodeChanges → setNodes → ReactFlow
     ↓
[建立连接] → onConnect → addEdge → setEdges → ReactFlow
     ↓
[删除元素] → onNodesDelete → deleteElements → setNodes/setEdges → ReactFlow

子流程模式（嵌套节点）

// 包含子节点的父节点
const nodes = [
  {
    id: 'group-1',
    type: 'group',
    position: { x: 0, y: 0 },
    style: { width: 300, height: 200 },
  },
  {
    id: 'child-1',
    parentId: 'group-1',  // 关键：指向父节点的引用
    extent: 'parent',      // 关键：限制在父容器内
    position: { x: 10, y: 30 },  // 相对于父节点的坐标
    data: { label: 'Child' },
  },
];

注意事项：

• 使用 extent: 'parent' 限制拖拽范围
• 使用 expandParent: true 启用父节点自动展开
• 父节点的 z-index 影响子节点的渲染顺序

视口状态持久化

// 保存视口状态
const { toObject, setViewport } = useReactFlow();

const handleSave = () => {
  const flow = toObject();
  // flow.nodes, flow.edges, flow.viewport
  localStorage.setItem('flow', JSON.stringify(flow));
};

const handleRestore = () => {
  const flow = JSON.parse(localStorage.getItem('flow'));
  setNodes(flow.nodes);
  setEdges(flow.edges);
  setViewport(flow.viewport);
};

集成模式

与后端/API 集成

// 从 API 加载数据
useEffect(() => {
  fetch('/api/flow')
    .then(r => r.json())
    .then(({ nodes, edges }) => {
      setNodes(nodes);
      setEdges(edges);
    });
}, []);

// 防抖自动保存
const debouncedSave = useMemo(
  () => debounce((nodes, edges) => {
    fetch('/api/flow', {
      method: 'POST',
      body: JSON.stringify({ nodes, edges }),
    });
  }, 1000),
  []
);

useEffect(() => {
  debouncedSave(nodes, edges);
}, [nodes, edges]);

与布局算法集成

import dagre from 'dagre';

function getLayoutedElements(nodes: Node[], edges: Edge[]) {
  const g = new dagre.graphlib.Graph();
  g.setGraph({ rankdir: 'TB' });
  g.setDefaultEdgeLabel(() => ({}));

  nodes.forEach((node) => {
    g.setNode(node.id, { width: 150, height: 50 });
  });

  edges.forEach((edge) => {
    g.setEdge(edge.source, edge.target);
  });

  dagre.layout(g);

  return {
    nodes: nodes.map((node) => {
      const pos = g.node(node.id);
      return { ...node, position: { x: pos.x, y: pos.y } };
    }),
    edges,
  };
}

性能扩展

节点数量指南

优化技术

权衡取舍

受控模式 vs 非受控模式

连接模式

边渲染方式