阅读 353

开源富文本编辑器技术的演进

我对富文本编辑器最初的印象可能停留在 UEditor、CKEditor这类编辑器上,如下所示

2018年入职Workitle后,接触到Worktile中在线网盘的功能,感觉在线网盘简直太好用了,Markdown语法让你不太需要考虑排版问题就可以写出结构良好的文章

在2019年8月份左右的时候,我们开始开发自己的知识库产品PingCode Wiki,然后对于在线文档、知识库以及背后的富文本编辑器技术都有了更深刻了解和认识,我也算是正式入坑富文本编辑器领域,也因此找到了可以持续学习和努力的方向。

聊聊富文本编辑器之伤

大家公认的富文本编辑器领域在前端里面是天坑的存在。

总结下就是存在一个矛盾:

落后的生产力与人们日益增长的需求之间的矛盾

落后的生产力:

  1. 编辑内容相关标准推进缓慢
  2. 浏览器厂商对于相同操作或者场景实现方式的不同,导致兼容性的问题
  3. 使用HTML DOM描述富文本内容有太多不可控制的情况

日益增长的需求:

  1. 不确定的交互意图,比如按Delete键,不同的焦点位置有不同的情况需要考虑
  2. 内容输入的多样性,比如有:打字键入、粘贴、拖拽等,每个处理起来都相当复杂
  3. 大量需要拦截阻止和代理的浏览器默认行为,保证数据的完整性和正确性
  4. 用户对于编辑器的使用要求越来越高,比如:合并单元格、列表多级嵌套、协同编辑、版本对比、段落标注,大家都认为这是基本需求,其实这里面的技术难度是超出大家的想象的。

开源富文本编辑器技术

尽管标准不完善,但是通过开源还是让编辑器技术得以沉淀和发展,这里我主要从技术实现以及编程思想的演变,介绍编辑器这10年间的变化与发展。

大概要说到下面这几款编辑器:

CKEditor 1-4(2008)

UEditor (2012)

Quill.js(2012)

CKEditor 5(2014)

Prosemirror(2015)

Draft.js(2015)

Slate(2016)

因为每一款编辑器想研究明白都需要花费几个月甚至半年的时间,所以这里主要说说我对这些编辑器的一个理解,介绍下他们的特点以及他们之间的区别,点到为止。

编辑器技术阶段划分

通常大家把编辑器技术分为三个阶段

Level 0(不知道为啥从零开始)是编辑器的起始阶段,代表旧一代的编辑器的实现

Level 1 第二阶段,是在第一阶段发展过来的,有一定的先进性,也引入了主流的一些编程思想,对于富文本内容有一定的抽象

Level 2 第三阶段,完全不依赖浏览器的编辑能力,独立的实现光标和排版

下面我在介绍的编辑器的时候也会对它们所处的阶段进行简单的归纳,方便大家理解。

2008 - CKEditor 1-4

CKEditor 1-4可以代表传统编辑器的技术路线(同类型技术的主要是UEditor),主要依赖于浏览器原生的编辑能力,用户内容的输入是浏览器直接处理,加粗、斜体、回车等这类的处理则是捕获浏览器的事件来覆盖浏览器默认行为来实现,再辅以一些DOM的嵌套规则(dtd)和复杂数据输入(如粘贴)的过滤规则来约束数据的正确性,这类编辑器整体思路还是比较清晰的。

内容的可编辑主要依赖DOM的contentEditable属性,基于原生execCommand或者自定义扩展的execCommand去操作DOM实现富文内容的修改。

ps: 上图是根据个人理解绘制的架构构想图,跟实际可能会有些出入

  1. 文本输入基本上是浏览器的默认行为
  2. 复杂的样式或者格式操作则会进入交互判断逻辑,如果有默认行为不满足要求(比如不同浏览器之间表现不一致)的则会阻止默认行为,由开发者进行自定义的操作,也就是自主实现对DOM 或者 Range的更新。

特点

  • 依赖浏览器原生的编辑能力(Level 0
  • 基于浏览器execCommand或者扩展的指令集
  • 基于DOM的嵌套规则和过滤
  • 输出富文本内容是HTML字符串

优点

  • 基于浏览器原生编辑能力,输入非常流畅
  • 没有令人头疼的IME(组合输入)问题

缺点

  • 不可以预测的交互,容易出现数据混乱(拖拽、复制粘贴、删除)
  • 相同操作不同浏览器可能有不同的实现(比如基本的加粗、斜体、Enter),很难实现表现和数据完全统一
  • 特定结构的富文本内容(图片+Caption)实现复杂
  • 对于协同编辑器支持困难(CKEditor 5重头开始做的根本原因)

因为CKEditor 4本质还是直接操作DOM,根据我所理解的阶段划分,我把它归为第一阶段(Level 0),其实在这之前应该还有使用textarea实现的编辑器,比如代码编辑器Codemirror,它们大体上都是属于第一阶段。

2012 - Quill.js

2012最具代表性的编辑器就是Quill.js,它的出现给富文本编辑器带了很多新的东西,也是目前开源编辑器里面受众非常大的一款编辑器,github star数量高达27.7k,石墨文档背后的富文本内容编辑就是基于Quill.js实现的,我们的PingCode Agile最初在进行编辑器技术选型的时候也是选择了Quill.js,基于Quill.js封装了一个Angular的组件。

Quill.js 底层还是依赖DOM的contentEditable特性,但是Quill对DOM Tree以及数据的修改操作进行了抽象,这意味着编辑器开发者大部分场景下其实不是直接通过修改DOM完成编辑器功能的,而是通过Quill提供的模型操作API来完成操作的,主角变成了:DeltaParchment & Blots

Delta

Quill使用Delta来描述编辑器的内容及其变化,Delta 非常简洁,却极富表现力。

Delta 是JSON的一个子集,只包含一个 ops 属性,它的值是一个对象数组,每个数组项代表对编辑器的一个操作(以编辑器初始状态为空为基准)。

下面是一段富文本内容描述:

用 Delta 进行描述如下:

{
    "ops": [
        {
            "insert": "Hello "
        },
        {
            "attributes": {
                "bold": true
            },
            "insert": "Quill"
        },
        {
            "insert": "!"
        }
    ]
}
复制代码

Delta只有3种动作和1种属性,却足以描述任何富文本内容和任意内容的变化。

3种动作:

  • insert:插入
  • retain:保留
  • delete:删除

1种属性:

  • attributes:格式属性

Delta 的一个特点是只描述内容的变化,最终的内容是由一系列的变化组成的。

对于协同编辑器有一些了解的同学看到Delta数据模型应该很熟悉,Delta其实是OT模型的一种实现,OT操作是做协同编辑的一种思路,所以Quill可以说是为协同而生的编辑器。

Parchment & Blots

Quill.js中对于DOM的抽象,Parchment其实是与DOM树对应的结构,Parchment由Blots组成,Blot即与DOM的Node对应,Quill.js文档怎么渲染完全由Blot决定,那么这层模型其实就是Delta数据与最终UI之间的一个中间层;

对应关系:

Editor Container <====> Parchment

DOM Node <====> Blot

有了这层抽象的模型,最大的改变就是开发者直接操作的内容从极难约束的DOM变成了可以被严格约束的Parchment & Blots,最终DOM的修改被限制在Blots中完成(当然还是操作DOM)。

LinkBlot示例:

Delta中数据形态:

架构图

  1. 文本输入基本上是浏览器的默认行为,Quill.js会监控DOM的变化(MutationObserver),最终把DOM的更改同步到Delta模型数据中。
  2. 复杂的样式或者格式操作等非浏览器默认行为,则会直接更新Delta模型数据,由Delta驱动Parchment & Blots的更新,然后最终才到UI的变化。

特点

  • 依赖浏览器原生的编辑能力(Level 1)
  • 数据更新主体是Delta,DOM的更新由单独的Parchment & Blots描述
  • 输出数据可以是HTML的字符串也可以由Delta描述的一系列操作(也就是JSON),但是可读性补不好一般很少作为结果数据保存
  • Quill.js主体、Parchment、Delta都是独立的仓储,架构良好

因为引入了数据模型、抽象出了数据变化的操作,所以把Quill.js定义Level 1阶段,后面出来的编辑器多少都有借鉴Quill.js的实现思路。

2015 - ProseMirror

大名鼎鼎的Confluence就是基于ProseMirror开发的,所以对于ProseMirror的扩展能力和稳定性应该毋庸质疑,因为ProseMirror不同模块是分仓储的,所以我不太能准确的把握它的具体的创建时间(从社区大佬的说明看大概在2015年)

从实现原理上看ProseMirror也是依赖contentEditable,不过非常厉害的是ProseMirror将主流的前端的架构理念应用到了编辑器的开发中,比如彻底使用纯JSON数据描述富文本内容,引入不可变数据以及Virtual DOM的概念,还有插件机制、分层、Schemas(范式)等等,所以感觉ProseMirror是一款理念先进且体系相对比较完善的一款编辑器(或者说框架)。

JSON描述富文本内容

比如:

用JSON描述如下:

Schemas(范式)

下图是代办项功能插件的例子,使用Spec描述了节点具有的属性,以及如何根据属性渲染这个节点的内容:

有了数据以及数据类型对应的范式的定义,从JSON数据到DOM的更改是可以完全由ProseMirror接管,ProseMirror是在中间做了一层虚拟DOM来完成数据到DOM的驱动更新。

attrs:存储节点的自定义属性

content:对子元素的约束描述(正则匹配)

toDOM:根据节点数据渲染DOM的定义

parseDOM:提取todo-item的DOM节点属性的定义

主要想说的是toDOM,这种写法类似于React使用JSX定义渲染DOM的指令,但是感觉它应该没有JSX强大。

Transform

ProseMirror有一个单独的模块来定义和实现文档的修改,这样内容的修改被统一起来,并且最终都会转化为底层的原子操作(为协同编辑提供可能),而且可以在任何插件中做拦截处理,比如实现:记录数据更改操作来实现撤销和重做等。

到ProseMirror这里可以有一张状态图:

到这里前端同学看起来应该很熟悉了:

  1. 引入不可变数据的概念,统一了内容的修改,把原来的更改DOM的方式改为对不可变数据的修改
  2. 和React类似的方式实现了单向数据驱动,所以编辑器整个的数据处理有了一个完整的数据流,稳定切可控。

特点

  • 依赖浏览器原生的编辑能力(Level 1)
  • 嵌套的文档模型(区别于Delta的OT模型,它的文档模型是通常意义上的JS对象模型,对应的模型数据可以作为结果直接存储)
  • Schemas(范式)约定模型嵌套以及渲染规则
  • 统一数据更新流,采用单向数据流、不可变数据及虚拟DOM避免直接操作DOM(这一点确实融合了主流的函数式编程的思想)
  • 输出的数据是纯JSON
  • 个人认为唯一不足的就是它需要开发者重新学习它独有的描述DOM的范式(相对于Slate)

ProseMirror是CodeMirror作者的另一力作,理念应该说非常新了,而且实现上它代理了浏览器大部分的默认行为,把操作转换为数据的变换,进而更新UI,可以说是当之无愧的Level 1阶段。

2015 - Draft.js

Draft.js是第一个把富文本编辑器与React结合的开源作品,开发者在进行编辑器开发时既不用操作DOM、也不用单独学习一套构建UI的范式,而是可以直接编写React组件实现编辑器的UI,某种意义上是生产力的巨大提升,因为Draft.js和React一样也是Facebook团队开源的框架,所以Draft.js整体理念与React非常的吻合,也代表了主流的编程思想,比如使用状态管理保存富文本数据、使用Immutable.js库、数据的修改基本全部代理了浏览器的默认行为,通过状态管理的方式修改富文本数据。

知乎的富文本编辑器就是用draft.js实现的

当然它也有一定的局限性,因为它只为使用React框架富文本编辑器服务,其它框架想使用它应该非常难。

Draft的大概情况

我打开Demo试了下,发现即使这种引用或者列表它也使用打平的数据结构来实现,通过type来区分block类型;

可以看出draft.js虽然也抽象了基于JSON的数据模型,但是它对于嵌套数据的支持是有些弱的,这也是它的硬伤。

特点

  • 依赖浏览器原生的编辑能力(Level 1 Pro
  • React 作为UI层
  • 与React结合的富文本数据的管理(状态管理)
  • 毋容置疑Draft.js因为没有做伤筋动骨的架构更新,它的稳定性、细节处理应该相较于其它框架(Slate)有很大优势
  • Draft对于文档数据的描述过于死板,比如需要嵌套节点的表格就不那么容易实现,即使能把一个表格当做富文组件嵌到Draft编辑器中,它的局限性也很大(比如单元格中基本的加粗、斜体、链接就没办法借助编辑器的能力实现了),所以它的数据模型是不太完善的。

因为Draft.js直接把富文本编辑器开发与React集成,开发者拓展编辑器功能其实相当于写React组件,这是一个巨大的提升,并且完全使用状态管理的思想管理富文本数据,技术上已经有相当大的进步,所以把它定义为第二阶段的加强版(Level 1 Pro)

2016 - Slate

Slate可以说是世界上最牛逼的编辑器框架(个人见解),相较于前面介绍的一系列编辑器它的出场是最晚的,但也因此它汲取了其它编辑器的一些经验,并且由于作者有极致的追求,Slate的架构也在不断的重构升级,目前仍然处在beta版本,最新版本是0.58.x。

Slate从一出来大量借鉴了Quill、ProseMirror、Draft.js的优点,虽然是主流编辑器中出道比较晚的,但是由于结构良好,理念新颖,还有作者对于架构的持续改进,目前还是比较受欢迎的一款编辑器。

架构图

可以看出Slate是可以称为编辑器框架的,它不提供开箱即用的功能,只提供开发编辑器的基础架构,如果想实现一款编辑器需要基于这套架构实现一系列的编辑功能的插件。

特点

  1. 依赖浏览器原生的编辑能力(Level 1 Pro)
  2. Shchema 定义数据的约束规则(ProseMirror)
  3. Nest Data Model(ProseMirror)
  4. React作为视图层(Draft.js)
  5. 插件作为一等公民,开发者对于交互拥有很大的控制权(Draft.js)
  6. Immutable、统一的数据更改Commands(Draft.js)

这个时期的Slate有的更多是其它编辑器的影子,集众家之长。

可以看下最初的Slate数据:

2018 - Slate Core

  1. 抽取独立的视图层,底层不在强依赖React

这让Angular、Vue框架使用Slate框架成为可能,不过这也有一定的门槛,因为需要重新实现一个视图层

Slate的Issue中就有提到,目前以及以后的很长时间官方都不会提供Angular的视图层。

这时候的Slate数据:

相较于最初结构上了有了一些优化。

架构图

2019 - Slate Migration

2019年年底的时候,Slate对于它自己进行了一次大的架构升级,这次被称为大修的升级(0.50.x)可以说亮点非常多,首先是TypeScript对所有代码重新实现,其次是把原来复杂的插件机制简化,还有把不可变数据的模型改为更简洁对新手更友好的Immer,同样是视图层与核心实现分离,虽然目前还有不少缺陷,包括中文输入以及浏览器兼容性的问题,但是通过实践发现这些都可以在视图层进行修复的。

架构图

特点

  1. 非常简洁的数据模型
  2. 设计出了一套抽象度非常高的编辑器业务Hook,业务方可以进行重写和拓展,可以作为插件的替代品,它非常易于理解和调试
  3. 使用Immer作为不可变数据模型
  4. 编码思路采用纯函数+接口的方式,思路和代码都非常之简洁

最新版Slate的数据:

目前来说最简洁的结构

Slate虽然集大家之所长并且在不断的推进架构的升级,但它仍然要依赖浏览器的可编辑能力,也要为如何同步Slate行为与浏览器默认行为做很多小心的处理,中文输入处理依然是一个头疼的事情,所以它本质上还是第二阶段的加强版(Level 1 Pro)

2021 - Slate

Slate在使用TypeScript重构后,API风格和概念都更简洁了,对新手也更友好,社区对Slate的反响也更高热烈,比较突出的是基于Slate的一个插件库 slate-plugins ,Slate自身也在不断的提升对TypeScript泛型的支持,还有对多编辑器、iframe、android、协同等更多特殊场景的支持。

编辑器的未来

其实未来早已来临,早在2010年Google Doc就使用了全新的技术来实现富文本编辑器,就是大家通常说的第三阶段(Level 2),可以实现文本的独立排版,不再依靠浏览器的任何编辑功能,自主实现选区光标和内容排版,只不过目前还没有一款基于这套架构的开源技术。

虽然自己自主实现排版可以解决很多存在的问题,但是实施难度太大,小公司承担不起这个成本。因此,基于浏览器的contenteditable技术方案仍然是当前的最佳选择。并且随着内容输入相关事件标准的统一和技术的发展,许多存在的问题也可以逐步解决,所以contenteditable也是编辑的未来。

总结

得益于开源技术,编辑器的实践经验得以延续和发展,没有绝对的好坏,每一款编辑器都有自己的特点,CKEditor是发展时间最久,它的技术线路清晰可寻,发展时间最长,跨越了编辑器技术的第一阶段和第二阶段,从CKEditor 4到CKEditor 5更是经历完全的重构,从根本上解决协同编辑的问题,Quill.js也可以称为老牌的编辑器了,受众非常大,从市面使用Quill.js的产品(石墨文档、ClickUp)也可以看出它的可塑性非常强,ProseMirror可以说是非常稳定的编辑器,知乎上也有人专门拿它和Slate做过对比,况且有Confluence做背书自然差不了,最晚出来的Slate,则一路大刀阔斧的重构,目前整体架构异常优雅和简洁,又搭载了TypeScript,感觉势头非常强劲,都是非常值得学习的。

最后用一张时间线的图重新回顾下开源富文本编辑器的历史

最后介绍下 slate-angular

个人非常喜欢Slate框架,我们团队的前端栈是Angular,为了能够在Angular中使用Slate,我们参照官方的 slate-react 开发了基于Angular的视图层 slate-angular,个人觉得开发基于Angular的视图层是一个很有意义的过程,并且当前开源社区中还没有使用Angular开发Slate编辑器的实现,所以我们想把我们的这种实践成果开源出去,以回馈Slate 和 Angular社区,让更多的Angular开发这可以使用Slate开发富文本编辑器。

当前 slate-angular 已经支持企业级 Wiki 产品 PingCode Wiki 稳定运行超过1年,最初版本是基于Slate@0.47.0版本(JavaScript版本Slate),第二版是基于最新Slate的实现(TypeScript),当前已经是第三版,从年初就开始准备,包括公开Github仓储、统一底层的实现及API风格、搭建在线Demo等。

Github:github.com/worktile/sl… 

Live Demo :slate-angular.ngnice.com/

如有任何问题,欢迎大家给 slate-angular 提 Issue!

文章分类
前端
文章标签