开发富文本编辑器的一些经验教训

曾经终败给现在 2022-04-13 15:06 422阅读 0赞

此文已由作者刘诗川授权网易云社区发布。

欢迎访问[网易云社区][Link 1]，了解更多网易技术产品运营经验。

最近我们的产品有一个需求是要在PC端做一个面向用户的书评编辑器，让用户和编辑在蜗牛读书上能方便快捷的编辑和产出一些优质的文章，它的主要难点就是富文本编辑器部分。

这虽然是个业务需求，但是做业务的同时也要兼顾技术，所以在跟需求商量好不支持IE8之后，决定采用Vue来作为前端部分的技术架构。

## 前端架构 ##

### webpack配置 ###

Vue是一个非常优秀的前端MVVM框架，轻量、快速、文档友好又详细，代码组织也非常优雅，是我比较偏爱的MVVM架构。Vue官方提供了非常方便快速上手的脚手架Vue-cli，但是由于跟我们这边使用的Java Web架构有一些不太适合的地方，所以我并没有使用它，不过我也是对Vue-cli做了一番详细的学习后来搭建自己的webpack配置。

下面是我的生产环境的部分webpack配置，其实并不复杂，因为我的业务场景也并不复杂，现在的各种插件功能也足够强大。

webpack.prod.config.js

devtool: 'source-map', plugins: [     new CleanWebpackPlugin(['dist']),     new ExtractTextPlugin('[name].css'),     new webpack.DefinePlugin({         'process.env': {             NODE_ENV: '"production"'         }     }),     new webpack.optimize.CommonsChunkPlugin({         name: 'vendor',         minChunks: function(module, count) {             return (                 module.resource &&                 /\.js$/.test(module.resource) &&                 module.resource.indexOf('node_modules') >= 0             )         }     }),     new webpack.optimize.CommonsChunkPlugin({         name: 'manifest',         filename: 'manifest.js',         chunks: ['vendor']     }),     new webpack.optimize.UglifyJsPlugin({         sourceMap: true,         compress: {             warnings: false         }     }), ]

主要就是借鉴了Vue-cli中的code split思路，开发环境的webpack配置区别不大，只是sourcmap设置改为了devtool: '\#cheap-module-eval-source-map',去掉了代码压缩等。

需要注意的一点是，我在生成环境下的webpack配置中使用了vue-loader附带的postcss预处理器中的cssnano插件进行css部分的代码压缩，但是这个插件打包时会将z-index:10压缩成z-index:1，需要添加设置zindex: false才能避免这个问题,而且cssnano插件默认还有一个特性就是会删除没有使用到的css部分，比如我们为CSS3动画所需构建的keyframes，居然也会被cssnano认为是没有被使用的css，压缩过程中也删掉了，这个就有点费解了，所以为了避免这种情况，我们需要增加设置discardUnused: false：

webpack.prod.config.js

rules: [{     test: /\.vue$/,     loader: 'vue-loader',     options: {         loaders: {             css: ExtractTextPlugin.extract({                 use: 'css-loader',                 fallback: 'vue-style-loader'             }),             scss: ExtractTextPlugin.extract({                 use: ['css-loader','sass-loader'],                 fallback: 'vue-style-loader'             })         },         postcss: [             require('autoprefixer')({                 browsers: ['> 1%']             }),             require('cssnano')({                 zindex: false,                 discardUnused: false             })         ],      } }]

###     ###

### 与Java Web的结合 ###

为了将css文件抽离出来，我在开发环境也没有使用Hot Module Reload机制(使用了ExtractTextPlugin抽离css文件后，修改css样式不能通过HMR自动更新，需手动刷新)。

我们部门这边的Java Web除了一些简单的静态活动页，主要页面的承载页都会配置在另外的一个存放freeMarker的ftl文件的文件夹中，有别于静态文件的存放位置，这是部门中的Java Web一直沿用的文件结构，不好也没太大必要去改变它。

这就使得Vue-cli或者一些常见的webpack配置中的根据文件hash生成打包文件再使用html-webpack-plugin自动注入承载页的功能不太好实现，所以就需要结合部门自己的情况定制比较符合自己项目的打包流程。

我们有个网站应用自动部署平台，它的功能除了解析和编译后端工程代码，还会自动分析页面引用的静态资源，然后将资源的URL替换为对应的CDN域名的下的资源链接并添加资源MD5值相关的查询值后缀，比如/static/js/app.js会在自动部署后变成//yuedust.yuedu.126.net/snail\_st/static/js/app.js?a63ed8a8。

所以既然目前项目中已经有了CDN域名替换和文件hash计算的功能，我在webpack打包中就没必要再多此一举了，而且，我还可以利用这一特性，固定的设置承载页引用的静态资源的URL，部分代码如下：

index.ftl

<!doctype html> <html> <head>     <meta charset="utf-8">     <meta http-equiv="X-UA-Compatible" content="IE=edge,chrome=1">     <meta name="viewport" content="width=device-width, initial-scale=1, user-scalable=no">     <link rel="shortcut icon" href="/static/images/favicon.ico" />     <title>蜗牛阅读-书评编辑</title>        <link rel="stylesheet" href="/static/bookreview/dist/app.css"> </head> <body>     <input type="hidden" id="csrfToken" name="csrfToken" value="${csrfToken!?html}" />     <div id="app"></div>         <script src="/static/bookreview/dist/manifest.js"></script>     <script src="/static/bookreview/dist/vendor.js"></script>     <script src="/static/bookreview/dist/app.js"></script> </body> </html>

这样设置好后无论本地开发还是部署线上都不需要再修改ftl文件的内容了，既有效的利用到了Code Split加快打包速度和缓存利用率高的优点，也使得开发和部署变得简单，页面引用的静态资源一旦添加，就不需要再去更改路径了。

当然，这只是结合自己项目的Java Web工程结构和特点设置的一套webpack使用方式，仅供参考

##     ##

## 开发富文本编辑器的教训 ##

由于项目的时间较紧张，我在页面上应用了Vue框架的背景下，想当然的想要把Vue也应用于富文本编辑器的开发，事实证明这是不太可行的。

### 富文本中的数据渲染 ###

Vue是数据和展现双向绑定的，这使得特定格式的数据渲染成对应的html非常的方便。

但是网页上的富文本编辑器普遍都是利用的是元素的contenteditable属性，这个属性是无法实现双向绑定的，要想实时保存富文本数据，只能监控元素的输入事件，然后读取元素的innerText后再去修改数据，但是一旦修改了数据，就会触发Vue的视图更新，导致你编辑元素的innerText被重新渲染，元素一旦被重新渲染，用户输入时的获取的光标焦点就消失了，而且在windows和mac os下的输入法实现有些不一样,mac下的输入法输入中文会先将用户输入的拼写填充到输入元素中，导致获取的innerText不准确，所以想要利用Vue的数据双向绑定机制来开发富文本部分，又想要实现数据的实时保存，存在很多问题。

### 富文本中的不可编辑区域 ###

我们的书评内容的数据结构是一个各种item类型组成数组，item的类型有：文字、图片、书籍和笔记，富文本编辑器需要将这些数据展现出来并且可编辑，其中书籍和笔记的数据结构只能添加或者删除，而不能修改，这就与传统的富文本编辑器存在一定的区别，即富文本编辑器区域需要插入或者删除不能修改的元素。这个需求使得一个普通的富文本编辑器变得特殊起来，一开始我的思路是在contenteditable="true"的编辑器主体内插入contenteditable="false"的dom结构，这导致插入部分的文本无法与编辑器很好的交互，包括删除、撤销、选中等，最后找到了另外一种比较理想的解决办法。

## 开发富文本编辑器的一些经验 ##

以下是我在开发一个本业务场景下的富文本编辑器的一些经验：

### 在开源富文本编辑器的基础上开发 ###

知乎上有个问题，叫做[为什么都说富文本编辑器是天坑？][Link 2]，里面提到的很多开发富文本编辑器会遇到的一些难点，而我的第一版也是想着自己从头开始开发，但是的确碰到了很多没想到的问题，修修补补最终结果还是不满意。

所以如果是需要一个常规功能的富文本编辑器，尽量选择成熟稳定的开源项目，保证稳定可靠，如果需要像我一样开发一个符合特定业务场景的富文本编辑器，也尽量在开源项目的基础上进行二次开发，这样虽然会有一些代码冗余，但是能帮助你避开许多前人已经踩过的坑，而且也能从阅读这些项目的源码中学习到不少忽视的知识和特性。

我选择的是国内的一个个人开发者维护的叫做[wangEditor][]的项目，它比较轻量，源码也比较清晰便于二次开发。

### 基于DOM的数据渲染 ###

要想在WEB端实现富文本编辑，经过我踩的一些坑，我觉得最终还是要回归于DOM的，Vue或者其他MVVM框架确实给开发和维护带来很大的遍历，但是在富文本编辑这块，还是没有DOM API来的可控。我的方案是根据服务端提供的一篇书评的items，组织出相应的HTML，然后再交给富文本编辑器进行初始化。

### 基于浏览器的document.execCommand API进行开发 ###

当一个HTML文档处于设计模式(designMode)或者一个HTML元素设置了contentEditable="true"时，我们可以使用execCommand方法，运行一些命令来操纵可编辑区域的内容，这个API可以快速可靠的对富文本区域的选区内容进行一系列的操作，最关键是，支持撤销和重做功能，并且在撤销和重做的过程中能够完美的保持选区的状态，这一点非常重要，我们可以通过保存html来实现内容的撤销和重做，但是选区或者说光标的撤销和重做，用Javascript很难完美的控制,如果只是保存之前选区的range对象，是不能复原选区或者光标的。

具体支持的API可以参考[MDN][]的文档。

即使对于一些文档中不支持的API，也建议通过以上API来组合实现，比如一段HTML内容的替换，应该先通过Javascript建立相应的选区，然后运行delete命令删除该段内容，再通过insertHTML来插入所需的HTML，这样才能充分的利用浏览器的撤销和重做功能，并且与其他的操作串联起来。

### 富文本中的换行 ###

富文本编辑器中的换行是一个值得注意的问题，我在开发书评编辑器的时候，遇到了一些问题：

富文本中展示换行看起来很容易，有几个方案，比如设置CSS的white-space再配合换行符，或者在DOM中添加<br>元素，看起来都能达到目的。但是书评编辑器特殊的地方在于，这是一个已经制定好了数据结构并且在客户端上也有编辑器，这就涉及到Web、iOS、Andorid三个端的一致性问题。

*  因为在客户端上是没有<br>概念的,客户端编辑器上需要换行位置插入的都是回车符，也就是\\n，而这些换行符在WEB上如果需要显示成换行，就需要设置white-space为pre或者pre-line
 *  如果设置为white-space: pre;，确实可以原样显示文本换行，但是如果是这样一条数据：

![20181130102911b4b10f56-4bf5-419f-9a43-d22834a97524.jpg][]

这是书评中的一条文本数据，其中有两个换行符，代表要展示成三行，其中有一个空行，实际需要展示的效果是下图这样的：

![201811301029235bc939e7-15cf-4b46-8269-ab9142250d8e.jpg][]

这样的数据如果要展示在一个DOM节点中，设置为white-space: pre;,换行虽然保留了，但是由于第一行数据是连续的，white-space: pre;原样保持了数据的换行，导致了第一行超出了DOM的最大宽度，这样的方式显然就行不通了。

![201811301029351c594728-0802-44c6-a67e-171679a71ce0.jpg][]

*  如果设置成white-space: pre-line，pre-line可以在正确显示换行符的同时让超出一行的文字自动换到下一行，看起来很完美。但是，一旦在换行符之后（比如中间空的那行）输入文字，问题又出现了，在white-space: pre-line的元素中，如果在换行符之后输入文字，换行符会被删除，文字将会跳动到上一行继续显示，这样显然是不行的。
 *  最终的方案只有剩插入<br>元素来实现换行了，通过<br>实现的换行，不会出现输入文字换行失效的问题，也不需要父元素设置white-space: pre;，所以我们需要将客户端在文本中插入的\\n转换成<br>，最后把HTML结构重新解析成书评数据的时候，又需要将它们转换回来以便保证客户端编辑和展示的一致性，当然这中间还有一系列的转换逻辑,包括针对客户端老版本的编辑器的一些BUG做的兼容，最后为了实现一致还是废了一番功夫的。

### ![20181130102949d67cc3ac-ef82-4c0f-8d17-f52ae00c4cbb.jpg][]    ###

### 富文本中的不可编辑区域 ###

如上面两图，我们的书评中有一部分内容是用户引用的某一本书籍、或是用户在阅读时记录的书籍原文，这些数据结构都是不能被修改的，只能插入或者删除，一开始我的思路是把该部分DOM结构设置为contenteditable="false",但是这样的设置代码上不管怎么去弥补体验上都不够好。

后来我转变了思路，既然这就是一段不可编辑只能观看的DOM，而富文本编辑器里插入的图片是能够很好的与文字一起被很好的操作和维护的，那么为什么不把不可编辑的展示区域直接转换为图片插入到富文本区域呢，事实证明这个思路最后的体验非常好，除了一个小的技术问题，下面一点会说明。

### 将DOM转换为图片 ###

要将一个DOM转化为图片，社区里已经有不少很成熟的开源库可以使用，比如我使用的是[dom-to-image][]，需要注意的就是一个问题：DOM转化为图片，基本都利用到了canvas的toDataUrl()功能将图片转化转化为base64编码的URL，这里面有一个安全策略，就是如果canvas中绘制的DOM结构中有图片，而该图片与当前页面的域名不一样（这在我们的开发场景中很常见），出于安全策略的限制，此时浏览器是不允许调用canvas的toDataUrl()方法的，而我们的书籍卡片中必定会有书籍的封面，该封面的域名是我们的CDN域名，所以转换成图片被限制了。

![20181130103002a3745a4b-6bdf-4764-9c8d-4ab204c035b2.jpg][]

要想解决这个办法，就涉及到一个前端的IMG标签的属性：crossOrigin,如果将这个属性设置为anonymous,浏览器就会为这张图片的请求的Request Headers 中附带Origin为当前域名的这一行信息，告诉图片所在的静态资源服务器，这张图片我需要跨域访问以及我的域名，请在图片的Response Headers中附加Access-Control-Allow-Methods和Access-Control-Allow-Origin这两行信息,如下图：

![20181130103015d6eb5162-24a0-4d4a-8987-57b99762f2bf.jpg][]

这样请求得到的图片渲染到canvas中，浏览器才不会限制该canvas转化为base64的URL。

这一特性需要服务端的支持，有的服务端就算附加了这个Request Headers字段依然不会返回想要的Response。

但是在支持这一特性的服务端，有时候设置了crossOrigin="anonymous"依然显示这个错误，不是这个属性没生效，而是我们的图片一般是存放在CDN上的，而CDN为了更快的返回用户的请求，会把图片的响应缓存下来，而这些缓存下来的响应显然是没有Access-Control-Allow-Methods和Access-Control-Allow-Origin这两行信息的，所以这时候即使我们认为自己的请求包含了crossOrigin="anonymous"，CDN服务器不认为这是一个不同的请求，所以返回给我们的响应是之前就缓存好的，导致了这个问题的发生。

这种情况就需要我们为我们请求的图片URL后添加一个时间戳来避免CDN服务器的缓存。

### 避免使用CDN来提高渲染速度 ###

前端开发中说到提高页面的加载速度，一般都会提到最大限度的利用CDN缓存静态资源，以提高静态资源的访问速度，从而更快的将网页内容呈现给用户。

但是，我上面提到的将含有跨域CDN图片的DOM节点渲染成图片的情况下，向CDN代理节点请求图片资源反而会比我们直接向静态资源源站点请求要来的慢，其实这也很好理解：

*  为了将含有跨域CDN图片的DOM利用HTML5\`\`canvasAPI渲染成图片，我们就需要为该图片的添加crossOrigin="anonymous"属性，并且为图片的请求URL添加一个时间戳
 *  如果我们访问的是CDN域名下的图片，同时又为URL添加了一个全新的时间戳，那么这个图片资源的请求对于CDN代理节点来说肯定是全新的，也就是会认为本节点上没有这个资源的缓存
 *  CDN代理节点遇到一个自己没有缓存的资源，它就会向静态资源的源站点去请求，得到结果后再转发给用户，这等于说我们这个带有时间戳的图片URL的请求，不但没能利用的CDN的缓存提速，反而由CDN代理节点充当了一次中介，这显然会增加资源的返回耗时

![201811301030349d9728d4-c5af-4c3b-a063-31ea47752726.jpg][]

![201811301030344bd6162d-b1bb-4876-941d-b39e5aff44e7.jpg][]

上面两图分别就是请求CDN域名图片的耗时和请求源站点图片的耗时，经过多次测试，可以发现请求CDN域名图片的耗时基本在200ms以上，而向源站点的请求基本都在100ms以下，所以，有的时候，比如这种特殊情况下，请求CDN域名下的资源可能反而会增加请求的耗时。

### Promise大法好 ###

根据上面提到的流程，需要我把从服务端拿到的一个包含各种类型item的数组解析成一个HTML字符串，其中包含了书籍和笔记类型的item需要转化成的base64格式的图片，这就出现了时序上的问题：

文本和图片类型的item，可以直接得到对应的HTML字符串，而书籍和笔记类型的item，则需要通过网络请求和canvas转换，但是最终我又需要得到整个的初始HTML内容来初始化富文本编辑器，然后再让用户可以去在这些HTML DOM节点上进行编辑，这就需要用到Promise.all这个API了，代码示例如下：

App.vue

/**  * 将服务端返回的书评items转换为html string传输给富文本编辑器  * @param  {json array} items 书评items  * @return {promise}       所有items处理好后返回resolve(htmlStr), 否则reject(error)  */ convertItemsToHtml(items){     return new Promise ( (resolve, reject) => {         let htmlStr = '';         let itemStr = '';         let itemPromises = items.map( item => {             return new Promise( (resolve, reject) => {                 switch(item.resourceType){                     case 'Text':                         itemStr =  `<p>"Text">${item.text}</p>`;                         resolve(itemStr);                         break;                     ...                     case 'BookNote':                         let $BookNoteEle = $(`<div>${item.bookNote.markText}</div>`).appendTo($('body'));                         domtoimage.toPng($BookNoteEle[0], {style: {opacity: 1, zIndex: 1}})                             .then(function (dataUrl) {                                 itemStr =  `<p>"BookNote"><img >"BookNote" >'${escape(JSON.stringify(item))}' src="${dataUrl}"></p>`;                                 $BookNoteEle.remove();                                 resolve(itemStr);                             })                             .catch(function (error) {                                 console.error('图片生成失败', error);                                 reject(error);                             });                         break;                 }             })         })         Promise.all(itemPromises).then( ([...itemStrs]) => {             htmlStr = itemStrs.reduce( (acc, val) => {                 return acc + val             }, '');             resolve(htmlStr);         }).catch( (error) => {             reject(error);         })     }) },

利用Promise.all和其他一些ES6的特性，可以使我们的代码变得更加强大而简洁。

以上就是我在开发特定业务需求的富文本编辑器中遇到的一些问题和总结的一些经验，可能会有一些错误，希望帮忙指正。 其他一些常见的富文本编辑中会遇到的问题，可以通过学习一些开源的成熟富文本编辑器项目来得到解答。

[免费领取验证码、内容安全、短信发送、直播点播体验包及云服务器等套餐][Link 3]

更多网易技术、产品、运营经验分享请[点击][Link 1]。

相关文章：  
【推荐】 [Kubernetes性能测试实践][Kubernetes]  
【推荐】 [网易有数的搭积木原则阐述][Link 4]  
【推荐】 [云创大会来了！全行业关心的热点都在这里][Link 5]

[Link 1]: https://sq.163yun.com/blog?tag=M_tg_873_72
[Link 2]: https://www.zhihu.com/question/38699645
[wangEditor]: http://www.wangeditor.com/
[MDN]: https://developer.mozilla.org/zh-CN/docs/Web/API/Document/execCommand
[20181130102911b4b10f56-4bf5-419f-9a43-d22834a97524.jpg]: /images/20220413/683017013c1f4de0b103e07a5f89a8db.png
[201811301029235bc939e7-15cf-4b46-8269-ab9142250d8e.jpg]: /images/20220413/2d980f85d3b74be29b185ec2f85ef993.png
[201811301029351c594728-0802-44c6-a67e-171679a71ce0.jpg]: /images/20220413/5d3ef8c85f0149128045eb5d6ee8a942.png
[20181130102949d67cc3ac-ef82-4c0f-8d17-f52ae00c4cbb.jpg]: /images/20220413/d60e1d0c184b4badac6ca9e585f03056.png
[dom-to-image]: https://github.com/tsayen/dom-to-image
[20181130103002a3745a4b-6bdf-4764-9c8d-4ab204c035b2.jpg]: /images/20220413/0d76d71954d9437b919092d979e5cf1a.png
[20181130103015d6eb5162-24a0-4d4a-8987-57b99762f2bf.jpg]: /images/20220413/23607430499245a9a2f5e114b6416074.png
[201811301030349d9728d4-c5af-4c3b-a063-31ea47752726.jpg]: /images/20220413/cb8126a9fbc7490f87c84e346f76fef6.png
[201811301030344bd6162d-b1bb-4876-941d-b39e5aff44e7.jpg]: /images/20220413/2a9813ba75d948378dfd3bcc1913d349.png
[Link 3]: https://www.163yun.com/free?tag=M_tg_873_72
[Kubernetes]: https://www.jianshu.com/p/2371b79296d3
[Link 4]: https://www.jianshu.com/p/bdf3bd37da2c
[Link 5]: https://blog.csdn.net/wangyiyungw/article/details/80938190