开源图编辑库 NebulaGraph VEditor 的设计思路分享

本文首发于 NebulaGraph 公众号

开源图编辑库 NebulaGraph VEditor 的设计思路分享

NebulaGraph VEditor 是一个拥有高性能、高可定制的所见即所得图可视化编辑器前端库。

NebulaGraph VEditor 底层基于 SVG 绘图，它通过合理抽象代码结构以易于二次开发和自定义绘制，极适用于审批流，工作流，血缘关系，ETL 处理，图查询等图（Graph）和网络（Network）型拓扑信息的所见即所得编辑和预览场景。在 NebulaGraph 项目中，VEditor 轻松支持了图查询，图编辑，图建模，图结构，图路径展示等可视化场景。

在 NebulaGraph 中经过不断迭代、打磨之后，VEditor 已经相对完善，开源了相关代码。基于此，今天我就来为大家分享一下它的一些设计的思路与思考。

基本特性

• 高定制性的点，线形状，一切部件皆可定制
• 扁平，简单，直接的代码架构
• 小地图，磁吸线
• 各类快捷键支持
• 历史记录
• 轻量化，压缩前仅 160kb

设计理念

最早开始接触图编辑库时，本身需求其实并不高，能满足定制 + 动画即可，但看了业界非常多的流程图库后，作为一名前端工程师的自我修养让人很难对有些过度设计的架构，臃肿的接口，复杂的类关系有好感，这与我追寻简单，精简，低耦合的代码理念相悖。因此最终决定手写一个轻量的库，并能满足各种业务场景的定制需求。VEditor 的设计理念就是希望在可定制性和可理解性的基础上能让开发者用起来更轻便，减少学习各类 API，减少依赖各类库。

技术架构

开源图编辑库 NebulaGraph VEditor 的设计思路分享

整体架构主要通过事件来做实体间的依赖管理，也建议主要通过事件来获取整个流程图的状态变化。

其中渲染流程为半自动渲染，改变流程图数据后需要手动触发渲染，其他状态下对画布进行操作会触发用户定义的 shape 渲染函数，完成自定义节点渲染节点或线渲染。

渲染实现

VEditor 主体使用 SVG 进行渲染，得益于 SVG 的声明式使用方式，其内部结构都是外置可见的，对其进行样式定制化会非常的容易，用户可以在外界直接复写相关的 SVG 样式即可，同时还可以直接操作 SVGDOM 监听相关的鼠标事件，及对某些节点添加各类动画。

在形状渲染上，主要通过暴露出来的 Shape 接口注册用户的自定义渲染函数。从这个角度上来看，VEditor 可以基于任意使用渲染技术进行渲染，只要渲染接口返回 SVGDOM 即可，这个 DOM 可以是 SVGElement 或 ForeignObject 等。因此在使用 React 或 Vue 等虚拟 DOM 框架时，非常推荐用其管理 SVG 的渲染。甚至某些情况下可以包裹一个 Canvas 来渲染 WebGL 的节点，这非常大的拓展了业务中的定制性。

除了节点外，锚点及线也支持实现对应接口后注册为 Shape 的对象渲染，在我们的 Explorer 的实际业务中利用这个特点，实现了图计算流配置支持动态增删改算法参数锚点和TP查询输入输出锚点（图 1），以及图可视化查询中边的过滤，步数渲染（图 2)。也欢迎大家申请 Explorer 试用，体验下流程图相关功能，试用地址 https://nebula-graph.com.cn/products/explorer/

开源图编辑库 NebulaGraph VEditor 的设计思路分享

开源图编辑库 NebulaGraph VEditor 的设计思路分享

整体架构主要通过事件来做实体间的依赖管理，也建议主要通过事件来获取整个流程图的状态变化。

其中渲染流程为半自动渲染，改变流程图数据后需要手动触发渲染，其他状态下对画布进行操作会触发用户定义的 shape 渲染函数，完成自定义节点渲染节点或线渲染。

数据结构设计

VEditor 的数据结构和绝大部分的同类库类似，但不会破坏用户的对象引用，也就是在用户往节点或线的对象上挂载相关数据时，会对齐进行保留，这样会方便用户实现诸如节点配置，边配置等操作后将相关数据直接挂载到点数据上。因此历史记录的 Redo，Undo 等操作会将用户的数据当做快照一同存储下来。

{
	nodes:[{
		uuid:"uuid",
		type:"default",// shape类型 
	}],
	lines:[{
		from:"uuid",
		to:"uuid",
		fromPoint:0,
		toPoint:0
	}]
}

性能设计

众所周知，SVG 在小分辨率的渲染上，性能比 Canvas 差了许多，这也是易用性提升带来的一个缺点。尤其是在初始化时大量比较复杂或有动画的节点时，非常明显。针对这种情况，VEditor 的数据渲染部分采用的是异步流程，将锚点的渲染放到了下一个事件循环里，避免同步过程中大量获取 bbox 带来的浏览器强制重绘。在结束绘制后，缓存对应的节点数据避免重复获取。

开源图编辑库 NebulaGraph VEditor 的设计思路分享

而在添加节点或线等操作时，SVG 的 DOM 特性会让浏览器自动进行脏渲染，因此增量渲染的性能和 Canvas 差距并不，主要是进行交互和动画时导致 DOM 大量重绘会比较慢。目前设计的性能指标是 1000 个复杂形状的节点进行流畅渲染，在流程编辑类场景下是比较轻松的。

交互设计

VEdtior 默认提供了基于 Dagre 的有向图布局，但对其进行了优化，调用 Dagre 布局后，会自动对所有节点进行居中处理。同时提供了自适应大小功能，在自适应后，不同于其他库，这里会将当前节点的坐标重置为自适应的位置，在用户保存当前数据，可以直接还原自适应的位置。

VEditor 的小地图采用了 canvg 渲染，直接将 SVG 转换为 Canvas，可以保障小地图的准确性，同时减少性能损耗。在交互上则提供了全套的视图改变和拖拽功能。

未来计划

后面的规划中，VEditor 更倾向做一个不限领域的图数据编辑和渲染器，在完整缺失功能的同时，会扩大图编辑能发挥的场景并保持易用度。

• 添加框选器和多选操作
• 无向图，双箭头支持
• 性能进一步优化

👉 GitHub 开源地址：https://github.com/vesoft-inc/nebulagraph-veditor

欢迎来给我们提建议 and 贡献 PR 呦~