[Forward Content] WindrunnerMax：采用Canvas做的简历编辑器

Experiences and Insight 318 views · 0 replies ·

流浪的加菲

deepin

2024-04-15 17:40

Author

关于为什么要自己做一个简历编辑器：

固定模版不好用，各种模版用起来细节上并不是很满意，要么是模块的位置固定，要么是页面边距不满意，而通过 Canvas实现的简历编辑器都是图形，完全依靠画布绘制图形，在给定的基础图形上可以任意绘制，不会有排版问题。
数据安全不能保证，因为简历上通常会存在很多个人信息，例如电话、邮箱等等，这些简历网站通常都需要登录才能用，数据都存在服务端，虽然泄漏的可能性不大，但是保护隐私还是很重要的，此编辑器是纯前端项目，数据全部存储在本地，没有任何服务器上传行为，可以完全保证数据安全。
维持一页简历不易，之前使用某简历模版网站时，某一项写的字较多时导出就会出现多页的情况，而我们大家大概都听说过简历最好是一页，所以在实现此编辑器时是直接通过排版的方式生成 PDF ，所以在设置页面大小后，导出的 PDF总会是保持一页，看起来会更美观。

背景

我是有个基于 DOM实现的简历编辑器项目的，因为暂时找不到可以用 Canvas实现的比较有意思的场景，所以才选择了继续做简历编辑器，最开始做简历编辑器就是因为很多简历网站都是要开会员的，要不就是简历的自定义程度比较差，达不到我想要的效果，在学校的某一个晚上突发奇想于是自己做了一个出来。

因为是本着学习的态度以及对技术的好奇心来做的，所以除了一些工具类的包例如 ArcoDesign、ResizeObserve、Jest 等包之外，关于数据结构 packages/delta、插件化 packages/plugin、核心模块 packages/core 等都是手动实现的。实际上这也是本着自己学习的项目能自己写就自己写，公司/商业化项目能有已有包就用已有包的原则来的，在这里的目标是学习而不是做产品，自己学习肯定是希望能够更多地接触相对底层一些的能力，自己可以多踩一些坑会对相关能力有更深的理解，如果是公司的项目那肯定是成熟的产品优先，成熟的产品对于边界 case的处理以及积攒的 issue也不是轻易能够比拟的。

开源地址: https://github.com/WindrunnerMax/CanvasEditor 。
在线 DEMO: https://windrunnermax.github.io/CanvasEditor/ 。

笔记

因为我的主要目标是学习基本的 Canvas知识和能力，所以很多功能模块都是采用简单的方式实现的，主打一个能用就行。而实际上做好图形编程是一件非常困难的事，如果要做一些复杂的能力我会更倾向于用 konva等工具包来实现，而即使是简单地实现功能，在写代码的时候我也遇到了很多问题，也记录一些思考来解决问题。

数据结构

数据结构的设计，类似于 DeltaSet，最终呈现的数据结构形式是扁平化的，但是在 Core中需要设计 State来管理树形结构，因为要设计 Undo/Redo的功能，在不全量存储快照的情况下就意味着必须设计原子化的 Op，因为想实现的功能有组合这个能力，所以最终实现的形式实际上是树形的结构，而我希望的结构是扁平化的，因为树形结构查找起来比较费劲，需要实现的 Op类型也会变多，我希望能尽量减少 Op的类型并且能够做到 History，所以最终定下的数据结构是 DeltaSet作为存储，通过 State来管理整个编辑器状态。

History

原子化的 Op已经设计好了，所以在设计 History模块时就不需要全量保存快照了，但是如果每个操作都需要并入 History Stack的话可能并不是很好，通常都是有 N个 Op的一并 Undo/Redo，所以这个模块应该有一个定时器，如果在 N毫秒秒内没有新的 Op加入的话就将 Op并入 History Stack，但是当时我在思考一个问题，如果这 N毫秒内用户进行了 Undo操作应该怎么办，后来想想实际上很简单，此时只需要清除定时器，将暂存的 Op[]立即放置于 Redo Stack即可。

绘制

任何元素都是矩形，数据结构也是据此设计抽象出来的，在绘制的时候分为两层 Canvas重叠的方式，内层的 Canvas是用来绘制具体图形的，这里预计需要实现增量更新，而外层的 Canvas是用来绘制中间状态的，例如选中图形、多选、调整图形位置/大小等，在这里是会全量刷新的，并且后边可能会在这里绘制标尺。在实现交互的过程中我遇到了一个比较棘手的问题，因为不存在 DOM，所有的操作都是需要根据位置信息来计算的，比如选中图形后调整大小的点就需要在选中状态下并且点击的位置恰好是那几个点外加一定的偏移量，然后再根据 MouseMove事件来调整图形大小，而实际上在这里的交互会非常多，包括多选、拖拽框选、Hover效果，都是根据 MouseDown、MouseMove、MouseUp三个事件完成的，所以如何管理状态以及绘制 UI交互就是个比较麻烦的问题，在这里我只能想到根据不同的状态来携带不同的 Payload，进而绘制交互。

绘制状态

在实现绘制的时候，我一直在考虑应该如何实现这个能力，因为上边也说了这里是没有 DOM的，所以最开始的时候我通过 MouseDown、MouseMove、MouseUp实现了一个非常混乱的状态管理，完全是基于事件的触发然后执行相关副作用从而调用 Mask的方法进行重新绘制。再后来我觉得这样的代码根本没有办法维护，所以改动了一下，将我所需要的状态全部都存储到一个 Store中，通过我自定义的事件管理来通知状态的改变，最终通过状态改变的类型来严格控制将要绘制的内容，也算是将相关的逻辑抽象了一层，只不过在这里相当于是我维护了大量的状态，而且这些状态是相互关联的，所以会有很多的 if/else去处理不同类型的状态改变，而且因为很多方法会比较复杂，传递了多层，导致状态管理虽然比之前好了一些可以明确知道状态是因为哪里导致变化的，但是实际上依旧不容易维护。最终我又思考了一下，决定在绘图这里实现类似于 DOM的能力，因为我想实现的能力似乎本质上就是 DOM与事件的关联，而 DOM结构是一种非常成熟的设计了，这其中有一些很棒的点子，例如 DOM的事件流，我不需要扁平化地调整每个 Node的事件，而是只需要保证事件是从 ROOT节点起始，最终又在 ROOT上结束即可，并且整个树形结构以及状态是靠用户利用 DOM的 API来实现的，我们管理之需要处理 ROOT就好了，这样就会很方便，下个阶段的状态管理是准备用这种方式来实现的。

渲染与事件

在前边我们提到了我们想通过模拟 DOM来完成 Canvas的绘制与交互，那么在这里就很明显涉及到 DOM的两个重要内容，即 DOM渲染与事件处理。那么就先聊下渲染方面的内容，使用 Canvas实际上就很像将所有 DOM的 position设置为 absolute，所有的渲染都是相对于 Canvas这个 DOM元素的位置绘制，那么我们就需要考虑重叠的情况，那么想一个例子，A的 zIndex是 10，A的子元素 B的 zIndex是 100，C与 A是平级的且 zIndex为 20，那么当这三个元素重叠的时候，在最顶部的元素是 C，也就是说 zIndex实际上只看平级元素，再假如 A的 zIndex是 10，A的子元素 B的 zIndex是 1，那么在这两个元素重叠的时候，在最顶部的元素是 B，也就是说子元素通常都是渲染在父元素之上的。那么我们在这里也需要模拟这个行为，但是因为我们没有浏览器的渲染合成层，我们能够操作的只有一层，所以在这里我们需要根据一定的策略进行渲染，在渲染时我们与 DOM的渲染策略相同，即先渲染父元素再渲染子元素，类似于深度优先递归遍历的渲染顺序，不同的是我们需要在每个节点遍历之前，将子节点根据 zIndex排序来保证同层级的节点渲染重叠关系。

在渲染的基础上，我们还需要考虑事件的实现，例如我们的选中状态，八向调整元素大小的点一定是在选区节点的上层的，那么假如现在我们需要实现 onMouseEnter事件的模拟，那么因为 Resize这八个点位与选区节点是有一定重叠的，所以如果此时鼠标移动到重叠的点因为 Resize的实际渲染位置更高，所以只应该触发这个点的事件而不应该触发后边的选区节点事件，而实际上由于没有 DOM结构的存在我们就只能使用坐标计算，那么在这里我们最简单的方法就是保证整个遍历的顺序，也就是说高节点的遍历一定是要先于低节点的，当我们找到这个节点就结束遍历然后触发事件，事件的捕获与冒泡机制我们也需要模拟，实际上这个顺序跟渲染是反过来的，我们想要的是优点顶部的元素，优先更像树的右子树优先后序遍历，也就是把前序遍历的输出、左子树、右子树三个位置调换一下即可，但是问题来了，在 onMouseMove这种高频事件触发的时候，我们每次都去计算节点的位置并且采用深度优先遍历，是非常耗费性能的，所以在这里实现一个典型的空间换时间，将当前节点的子节点按顺序全部存储起来，如果有节点的变动，就直接通知该节点的所有每一层父节点重新计算，这里做成按需计算即可，这样当另一颗子树不变的时候还可以节省下次计算的时间，并且存储的是节点的引用，不会有太大的消耗，这样就变递归为迭代了，另外因为找到了当前的节点，在模拟捕获与冒泡的时候就不需要再递归触发了，通过两个栈即可模拟。

焦点

平时我做富文本相关的功能比较多，所以在实现画板的时候总想按照富文本的设计思路来实现，因为之前也说过要实现 History以及在编辑面板富文本的能力，所以焦点就很重要，如果焦点不在画板上的时候如果按下 Undo/Redo键画板是不应该响应的，所以现在就需要有一个状态来控制当前焦点是否在 Canvas上，经过调研发现了两个方案，方案一是使用 document.activeElement，但是 Canvas是不会有焦点的，所以需要将 tabIndex="-1"属性赋予 Canvas元素，这样就可以通过 activeElement拿到焦点状态了，方案二是在 Canvas上方再覆盖一层 div，通过 pointerEvents: none来防止事件的鼠标指针事件，但是此时通过 window.getSelection是可以拿到焦点元素的，此时只需要再判断焦点元素是不是设置的这个元素就可以了。

无限画布

之前因为没有打算实现平移拖拽也就是无限画布的能力，但是后来真的开始通过这个主框架来实现想做的业务功能的时候发现这样是不行的，所以在后期想把这个能力加上，虽然本身这个能力并不复杂，但是因为最开始没有设计这个能力，导致后边做的时候有点难受，比如 Mask批量刷新频率不对齐、ctx的 translate应该是偏移值取反、之前多处超出画布不绘制的计算有误等等，就感觉在没有设计的情况下突然增加功能确实是有点难受的，不过好处是不需要大规模重构，只是个别点位的修正。

此外多扯点别的，这个项目除了一些辅助性的工具例如 resize-observer以及组件库例如 arco-design都是自己写的，相当于实现了 Canvas的引擎，特别是在现在的 core-delta-plugin-utils结构设计下，是完全可以抽离处理作为工具包使用的，当然易用性与性能方面肯定比不上那些有名的开源框架。只不过今天我恰好看到了一个评论说的挺好的：如果是个人能力提升，那么最好是首先理解开源库，然后仿照实现开源库的功能，主要的目标是学习；而如果是商业化的使用，那就变成了知名的开源库优先，这样可以很大程度上降低成本。

性能优化

在实现的过程中，绘制的性能优化主要有:

可视区域绘制，完全超出画布的元素不绘制。
按需绘制，只绘制当前操作影响范围内的元素。
分层绘制，高频操作绘制在上层画布，基础元素绘制在下层画布。
节流批量绘制，高频操作节流绘制，上层画布收集依赖批量绘制。

超链接

众所周知 Canvas绘制出来就是纯粹的图片，而实际使用导出 PDF的超链接是可以点击的，而我们当前就单纯只是图片无法做到这一点，所以需要解决这个问题，我想到的一个解决方案是在导出的时候，通过 DOM生成透明的 a标签，覆盖在原本的超链接位置，这样就可以实现点击跳转效果了。PDF本身也是文件格式，所以是可以借助 PDFKit/PDFjs等 PDF排版生成工具来导出的，通过这种方式也可以直接在导出的时候直接将其写入固定位置，并且可以不受浏览器打印的分页限制。

TODO

因为前边提到了我现在还是比较简单的实现方式，所以很多功能都不完善，还有很多想做的能力：

层级调整，这个之前我想到了并且在 core中设计了这个能力，现在只是缺乏调整的按钮用来调用，这个 UI我还没考虑好应该怎么做。
页面配置，我发现很多同学的简历都是不是标准的 A4纸大小，所以这里还需要一个调整页面画布大小的问题。
导入导出 JSON，这个就不用多说了，就是把底层数据结构导入导出的能力。
排版 PDF导出，这个应该需要跟页面配置一起做，现在的 PDF导出是依赖浏览器的打印，会有一些分页的限制，如果自己排版的话就可以突破这个问题，多长的画布都是一页的简历大小。
复制粘贴模块，在编辑的时候这个操作是很有用的，需要增加这个模块。