社区编辑申请
注册/登录
对前端来说开发一个在线文档需要啥技术?
开发 前端
这几年随着云的概念流行,越来越多的“云”软件代替了本地化的 APP, 例如 在线设计 Figma、在线白板软件、在线 Excel、在线文档等等,非常多的应用已经“云”化,web 能力不断增强,对前端开发者来说也是一种考验,今天就带大家了解一下对前端来说开发一个在线文档需要啥技术呢?

前言

开发一个在线文档我们可能要解决的问题:

  • 最基础的文本编辑功能(哦?好像textarea就可以完成,那如果是富文本呢?)我们需要一个文档模型来描述文档;
  • 富文本编辑器,提供富文本的编辑和渲染能力;
  • 协同功能,不同的用户对同一份文档的编辑需要保持大家看到的都是一样的;
  • 协同网络模型,保证服务器和客户端之间的文档模型一致;

名词解释

OT:一种解决协同问题的算法;

OP:operation的简称,在OT中指的是一次操作;

etherpad: 一个实现文档协同功能的开源库;

easysync: etherpad中实现文档协同的核心算法,是OT算法的一种,主要用来处理文本协同;

ot-json:ot算法的一种,顾名思义,是主要用来处理结构化数据;

Changeset: 一种描述文档更改的数据格式,用来表示整个文档的一次修改;

ClientVars  表示一篇文档的初始化数据,一般由连续的changeset组合而成;

符号解释

​|​​ :移动光标;

​·​​:叠加;

正文

OT算法

什么是OT算法呢?我们先从头说起,如果要实现一个多人共同编辑文档的功能,我们最简单暴力的做法是啥?

编辑锁

顾名思义,假如A在编辑文档,服务端直接将这个文档加锁,B如果在这个时候也加入了编辑,由于锁的存在,B的编辑直接被丢弃。可以看出,这种编辑锁的实现方式非常粗暴,体验极其糟糕,当然了,在很多公司(比如我们的某死对头公司)的一些wiki系统就是用这种实现方式,由于这种实现方式比较简单,而且体验很糟糕(内容丢失
& 无法实时),我们这里就不做讨论了。

Linux中的diff-patch

Linux中有两个命令:diff和patch;如果我们能在JS中实现这套算法,那么多人协同编辑可以这样做:

  1. 用户打开文档后和服务端建立长链接,保存文档副本;
  2. 用户编辑的时候如果有停顿(比如3s),则将现有的文档和副本进行diff对比,将结果传给服务端,更新副本;
  3. 服务端更新文档,将diff结果通过长链接通知到其它用户,其它用户使用patch方法更新本地的文档;

我们来测试下:

# 本地文档
$ echo '复仇者联盟
钢铁侠
美国队长' > test-local.txt
# 生成用户A编辑后的文档
$ echo '复仇者联盟
钢铁侠
绿巨人' > test-userA.txt
# diff两个文档
$ diff test-local.txt test-userA.txt > diff-test.patch
# 查看diff-test.patch内容
$ cat diff-test.patch
3c3
< 美国队长
---
> 绿巨人

从diff-test.patch内容可以看出,已经找出了两个文档不同的地方,然后我们再模拟下用户B的行为:

# 生成用户B编辑的文档
$ echo '复仇者联盟
黑寡妇
美国队长' > test-userB.txt
# patch方法更新文档
$ patch test-userB.txt < diff-test.patch
# 查看test-userB.txt内容
$ cat test-userB.txt
复仇者联盟
黑寡妇
绿巨人

可以看到,用户B文档的第三行已经更新为了用户A修改后的“绿巨人”。但这种实现方式有个问题,因为他是基于行来进行对比的,就会导致很容易出现冲突,比如:

# 生成文件1
$ echo '复仇者联盟' > local.txt
# 生成文件2
$ echo '复仇者联盟钢铁侠' > userA.txt
# diff对比
$ diff local.txt userA.txt > diff.patch

查看diff.patch内容:

1c1
< 复仇者联盟
---
> 复仇者联盟钢铁侠

这就意味着如果两个人同时修改同一行,那必然就会产生冲突,我们测试下:

# 生成文件3
$ echo '复仇者联盟美国队长' > userB.txt
# patch
$ patch userB.txt < diff.patch

以上我们发现,假如原始文档是“复仇者联盟”,用户A修改为“复仇者联盟钢铁侠”,将diff结果传给服务端,服务端传给用户B,而用户B只是将文档改为了“复仇者联盟美国队长”,直觉上我们可以看出,这两处是不冲突的,完全可以合并成“复仇者联盟钢铁侠美国队长”,但实际上的patch结果却是这样的:

$ cat userB.txt.rej
***************
*** 1
- 复仇者联盟
--- 1 -----
+ 复仇者联盟钢铁侠

因此这种基于行的算法还是比较粗糙,体验上比编辑锁虽然好了一点,但实际弊端还是比较大,既然基于行的实现无法满足需求,那有木有可能去基于字符进行diff呢?

diff-patch算法

diff-match-patch[1]是另一种diff-patch算法的实现,它是基于字符去进行diff的,这里不介绍该算法的细节了,它的算法在这:diff-match-patch JS实现源码[2]。我们直接测试下它的效果

// 示例1
const localText = '复仇者联盟';
const userAText = '复仇者联盟钢铁侠';
const userBText = '复仇者联盟美国队长';

// 结果为:复仇者联盟钢铁侠美国队长
// 示例2
const localText = '复仇者联盟';
const userAText = '复仇者联盟美国队长';
const userBText = '复仇者联盟钢铁侠';

// 结果为:复仇者联盟钢铁侠美国队长
// 示例3
const localText = '复仇者联盟';
const userAText = '复仇者联盟 美国队长';
const userBText = '复仇者联盟 钢铁侠';

// 结果为:复仇者联盟 美国队长 钢铁侠

如上示例已经解决了Linux的diff-patch基于行diff的弊端,但仍然存在问题,如上的示例1和示例2如果没有符号分割,那么结果是一样的。

const localText = '复仇者 Iron Man';
const userAText = 'Iron Man 钢铁侠';
const userBText = '复仇者 Caption';
// 结果为:Caption

原始文档为“复仇者 Iron Man”,用户A修改为了“Iron Man 钢铁侠”,用户B修改为了“复仇者 Caption”,直觉上其实可以合并为“Caption 钢铁侠”,但实际上却修改为了“Caption ”(注意Caption后面有个空格,钢铁侠没了),

也就是说diff-match-patch存在丢字符的情况,这个富文本格式的文档中会是致命的问题,比如丢失了某个 > 可能整个文档都会乱掉,那么有木有既解决了行匹配冲突问题又解决了丢字符问题的解决方案呢?答案就是本文的重点——OT算法

operation transformation

示例

ot.js[3]是针对纯文本的一种JS实现,我们看下它的实现效果,针对同样的示例:

const str = '复仇者 Iron Man';
const operation0 = new ot.TextOperation().delete('复仇者 ').retain(8).insert(' 钢铁侠');
const operation1 = new ot.TextOperation().retain(4).delete('Iron Man').insert('Captain');

const op = ot.TextOperation.transform(operation0, operation1);
// 结果:Captain 钢铁侠

可以看到这正是符合我们预期的结果。

原理

看了很多讲OT的文档,基本每一篇都很长,云山雾罩,但其实它的核心原理很简单。在OT中,我们将文档的操作分为三个类型,通过组合这三个原子操作完成对整个文档的编辑工作:

  • insert(插入字符);
  • delete(删除字符)
  • retain(保持n个字符,也就是移动光标);

注: 实际上diff-match-patch算法也将操作分为三类:insert,delete,equal(不变的字符),insert、delete和OT中含义类似,equal是指对比diff过程中那些没有改变的字符,diff-match-patch会给这些不同类型的字符打标,后面patch的时候再根据不同类型的字符做对应的逻辑处理。

insert

|

复仇者联盟|

如上|代表的是光标的位置,从上到下模拟用户操作的行为,以上操作使用ot.js来描述:

const str = '';
const operation = new ot.TextOperation().insert('复仇者联盟');
const result = operation.apply(str);
console.log(result); // 复仇者联盟

op创建时会有一个虚拟光标位于字符的开头,在一个op结束时,光标一定要在字符串的末尾,其中insert会自动移动光标位置,因此我们这里不需要手动去移动光标;

retain

|复仇者联盟

复仇者联盟|

复仇者联盟钢铁侠|

如上过程用ot.js来描述:

const str = '复仇者联盟';
const operation = new ot.TextOperation().retain(5).insert('钢铁侠');
const result = operation.apply(str);
console.log(result);// 复仇者联盟钢铁侠
delete

|复仇者联盟钢铁侠

复仇者联盟|钢铁侠

复仇者联盟|

如上过程用ot.js描述:

const str = '复仇者联盟钢铁侠';
const operation = new ot.TextOperation().retain(5).delete('钢铁侠');
const result = operation.apply(str);
console.log(result);// 复仇者联盟

删除字符时可以输入字符,也可以输入字符数,实际上源码中是直接取的​​'钢铁侠'.length​​ 因此对于delete中字符串而言,只要长度正确就可以达到目的,上面代码改成​​delete('123')​​不会有任何影响。

transform

前面的代码我们看到过ot.js的这个方法,正是这个方法实现了diff-match-patch的丢失字符的问题,而transform正是OT中的核心方法。我们先不罗列他的源码,先看几个例子:

示例1

原始文档内容(空白文档):|

用户A编辑后的文档内容:钢铁侠

用户B编辑后的文档内容:雷神

对应代码实现:

const str = ' ';
const operation0 = new ot.TextOperation().insert('钢铁侠');
const operation1 = new ot.TextOperation().insert('雷神');
const op = ot.TextOperation.transform(operation0, operation1);
console.log('transform后op操作:', op[0].toString(), ' | ', op[1].toString());
// transform后op操作:insert '钢铁侠', retain 2 | retain 3, insert '雷神'
console.log('transform后操作后的字符串:', op[0].apply(operation1.apply(str)), ' | ', op[1].apply(operation0.apply(str)));
// transform后操作后的字符串: 钢铁侠雷神 | 钢铁侠雷神

最终结果是“钢铁侠雷神”;

transform的操作过程:

循环次数

op1

op2

operation1prime

operation2prime

1

3

2

insert('钢铁侠')

retain(3)

2

undefined

2

retain(2)

insert('雷神')

示例2

原始文档:复仇者联盟

用户A:复仇者钢铁侠联盟

用户B:复仇者联盟美国队长

对应代码实现:

const str = '复仇者联盟';
const operation0 = new ot.TextOperation().retain(3).insert('钢铁侠').retain(2);
const operation1 = new ot.TextOperation().retain(5).insert('美国队长');
const op = ot.TextOperation.transform(operation0, operation1);
console.log('transform后op操作:', op[0].toString(), ' | ', op[1].toString());
// transform后op操作:retain 3, insert '钢铁侠', retain 6 | retain 8, insert '美国队长'
console.log('transform后操作后的字符串:', op[0].apply(operation1.apply(str)), ' | ', op[1].apply(operation0.apply(str)));
// transform后操作后的字符串: 复仇者钢铁侠联盟美国队长 | 复仇者钢铁侠联盟美国队长

最终结果是“复仇者钢铁侠联盟美国队长”;

transform的操作过程:

循环次数

op1

op2

operation1prime

operation2prime

1

3

5

retain(3)

retain(3)

2

'钢铁侠'

2

insert('钢铁侠')

retain(3)

3

2

2

retain(2)

retain(2)

4

undefined

'美国队长'

retain(4)

insert('美国队长')

示例3

原始文档:复仇者联盟钢铁侠美国队长

用户A:复仇者联盟钢铁侠

用户B:复仇者联盟美国队长

对应代码实现:

const str = '复仇者联盟钢铁侠美国队长';
const operation0 = new ot.TextOperation().retain(5).delete('钢铁侠').retain(4);
const operation1 = new ot.TextOperation().retain(8).delete('美国队长');
const op = ot.TextOperation.transform(operation0, operation1);
console.log('transform后op操作:', op[0].toString(), ' | ', op[1].toString());
// transform后op操作:retain 5, delete 3 | retain 5, delete 4
console.log('transform后操作后的字符串:', op[0].apply(operation1.apply(str)), ' | ', op[1].apply(operation0.apply(str)));
// transform后操作后的字符串: 复仇者联盟 | 复仇者联盟

最终结果是“复仇者联盟”;

操作过程:

循环次数

op1

op2

operation1prime

operation2prime

1

5

8

retain(5)

retain(5)

2

-3

3

delete(3)

-

3

4

-4

-

delete(4)

最终结果是“复仇者联盟”;

示例4

原始文档:复仇者联盟钢铁侠美国队长'

用户A:复仇者联盟

用户B:复仇者联盟美国队长

对应代码实现:

const str = '复仇者联盟钢铁侠美国队长';
const operation0 = new ot.TextOperation().retain(5).delete('钢铁侠美国队长');
const operation1 = new ot.TextOperation().retain(5).delete('钢铁侠').retain(4);
const op = ot.TextOperation.transform(operation0, operation1);
console.log('transform后op操作:', op[0].toString(), ' | ', op[1].toString());
//transform后op操作:retain 5, delete 4 | retain 5
console.log('transform后操作后的字符串:', op[0].apply(operation1.apply(str)), ' | ', op[1].apply(operation0.apply(str)));
// transform后操作后的字符串: 复仇者联盟 | 复仇者联盟

最终结果是“复仇者联盟”;

操作过程:

循环次数

op1

op2

operation1prime

operation2prime

1

5

5

retain(5)

retain(5)

2

-7

-3

-

-

3

-4

4

delete(4)

-

ot.js中transform的源码如下:

TextOperation.transform = function (operation1, operation2) {
// ...
var operation1prime = new TextOperation();
var operation2prime = new TextOperation();
var ops1 = operation1.ops, ops2 = operation2.ops;
var i1 = 0, i2 = 0;
var op1 = ops1[i1++], op2 = ops2[i2++];
while (true) {
//...
// 对应示例1第一次循环的操作逻辑
if (isInsert(op1)) {
operation1prime.insert(op1);
operation2prime.retain(op1.length);
op1 = ops1[i1++];
continue;
}
// 对应示例1第二次循环的操作逻辑
if (isInsert(op2)) {
operation1prime.retain(op2.length);
operation2prime.insert(op2);
op2 = ops2[i2++];
continue;
}
// ...

var minl;
// 对应示例2循环
if (isRetain(op1) && isRetain(op2)) {
if (op1 > op2) {
minl = op2;
op1 = op1 - op2;
op2 = ops2[i2++];
// 对应示例2第三次循环的操作逻辑
} else if (op1 === op2) {
minl = op2;
op1 = ops1[i1++];
op2 = ops2[i2++];
// 对应示例2的第一次循环操作逻辑
} else {
minl = op1;
op2 = op2 - op1;
op1 = ops1[i1++];
}
operation1prime.retain(minl);
operation2prime.retain(minl);
// 对应示例4的第二次循环
} else if (isDelete(op1) && isDelete(op2)) {
if (-op1 > -op2) {
op1 = op1 - op2;
op2 = ops2[i2++];
} else if (op1 === op2) {
op1 = ops1[i1++];
op2 = ops2[i2++];
} else {
op2 = op2 - op1;
op1 = ops1[i1++];
}
// 示例3的第二次循环
} else if (isDelete(op1) && isRetain(op2)) {
if (-op1 > op2) {
minl = op2;
op1 = op1 + op2;
op2 = ops2[i2++];
} else if (-op1 === op2) {
minl = op2;
op1 = ops1[i1++];
op2 = ops2[i2++];
} else {
minl = -op1;
op2 = op2 + op1;
op1 = ops1[i1++];
}
operation1prime['delete'](minl "'delete'");
// 示例3的第三次循环
} else if (isRetain(op1) && isDelete(op2)) {
if (op1 > -op2) {
minl = -op2;
op1 = op1 + op2;
op2 = ops2[i2++];
} else if (op1 === -op2) {
minl = op1;
op1 = ops1[i1++];
op2 = ops2[i2++];
} else {
minl = op1;
op2 = op2 + op1;
op1 = ops1[i1++];
}
operation2prime['delete'](minl "'delete'");
} else {
throw new Error( The two operations aren't compatible );
}
}

return [operation1prime, operation2prime];
};

如上4个示例覆盖了​​transform​​所有分支的操作。核心原理其实很简单,就是通过循环去将两个操作重新进行排列组合,按照操作的类型作出不同的逻辑处理,这是OT中非常核心的方法,除此之外还有​​compose​​,​​apply​​等方法,这里就不一一罗列了。

上面过程经常用一个菱形图来表示transform过程:

图片图片

transform(a, b) = (a', b');

compose

顾名思义,这个方法是用来合并两次操作OP的,比如:

const str = '复仇者联盟';
const operation0 = new ot.TextOperation().retain(5).insert('钢铁侠');
const operation1 = new ot.TextOperation().retain(8).insert('黑寡妇');
const op = operation0.compose(operation1);
console.log('compose后op操作:', op.toString());
console.log('结果:', op.apply(str)); // 复仇者联盟钢铁侠黑寡妇

compose的实现和transform类似,罗列两个OP所有的组合可能性,分别作出对应的逻辑处理。相关源码可以去github[4]这里查看。当然ot.js的API远不止这两个,比如客户端的undo/redo方法用来实现文档的撤销/重做,这里就不一一过了

时序控制

基于以上示例和代码相信OT的核心原理大家应该比较清晰了,但OT算法基于顺序来进行转换的,假如用户A操作了两次文档,但因为网络原因,第二次比第一次先到达了服务器,而服务器基于收到的顺序来分发给其它用户那么必然会出现问题。流程图如下:

图片

因此我们需要对每次的操作进行一个版本控制,在每次提交的时候加上一个版本标识,类似git的commitID,每次提交版本都自增1,来标识每次的OP操作;客户端和服务端各自维护一份版本;

客户端:发送出的请求返回确认后,本地版本+1;

服务端:完成一次OP时,版本+1;

因此客户端的版本一定是小于等于服务端的。

图片

相关转换过程如图,这里就不细说了,其实就是上面菱形的延伸。感兴趣可以去http://operational-transformation.github.io/index.html这里模拟体验整个过程。github上有很多js版本的OT实现库,比如https://github.com/marcelklehr/changesets也是OT算法的实现,感兴趣同学也可以去了解下。

状态控制

OT将操作的状态三为三种:

  • Synchronized:没有提交OP,等待新的OP
  • AwaitingConfirm:有新的OP提交了,等待后台确认,在此期间没有新的编辑行为产生;

此阶段收到后台新的OP,会进行一次transform

transform(OP1, OP) = (OP1', OP');其中OP'会被应用到本地

  • OP1是本地提交后但未被确认的OP;
  • AwaitingWithBuffer:有新的OP提交了,等待后台确认,在此期间有新的编辑行为产品了新OP;

此阶段产生的新的OP,会和上次本地编辑的OP做一次compose,合并为一个新的OP

此阶段收到后台新的OP,会进行两次transform和一次compose:

​OP3 = OP1.compose(OP2);​

​transform(OP1, OP) = (OP1', OP');​

​transform(OP3 , OP') = (OP3', OP'');​

最终OP''会被应用到本地,然后更新OP1 = OP1' 和OP3 = OP3'

OP:服务端推送的新的OP;

  • OP1:本地提交后但未被确认的OP;
  • OP2:此阶段产生的新的编辑操作;
  • OP3:是OP1和OP2 compose后生成的OP;

图片

OT算法很适合用用来处理文本的协同,最早提出时间可以追溯到1989年,也有各种语言的具体实现,相对比较成熟,目前在Google Docs,腾讯文档,包括我司的飞书文档都是用的OT算法,但OT目前是没法做到点对点通信的,随着Web通信协议的发展(比如WebRTC),点对点的通信已经成为C/S架构的可替代方案,CRDT算法也是一种协同算法,大概在2006年提出,目前在Atom、Figma等产品中都有落地使用,CRDT在支持C/S架构模型的同时也可以支持点对点的传输,但目前各个文档其实还是主要使用OT,下面这个视频有讲说CRDT随着文本内容的增加复杂度会远大于OT,具体原因还没了解,感兴趣的同学可以一起研究下。

https://youtu.be/PWzrbg9qqK8

CRDT相关论文:https://www.researchgate.net/publication/310212186_Near_Real-Time_Peer-to-Peer_Shared_Editing_on_Extensible_Data_Types

CRDT介绍:https://crdt.tech/resources

CRDT开源实现:https://github.com/yjs/yjs

Easysync

以上介绍了协同处理算法中的OT算法,我们的例子也都是用的纯文本,但实际上的在线文档不可能如此简单的,比如有各种各样的block,富文本的支持,评论,选中等等功能;如果单纯去使用ot.js来去做的话,无异于挖坑自埋。而easysync也是OT算法的一种实现,它被使用在etherpad中。

关于Etherpad

easysync这套算法作者是申请了专利的,专利地址:https://www.freepatentsonline.com/y2012/0110445.html,凭借这套算法作者创立了etherpad公司,后面被google收购,然后将etherpad开源了。

起初etherpad是一套跑在Java虚拟机上,可以用JS来写逻辑的服务,但更多的功能还是以jar包的形式提供,这样搞也主要是为了easysync只需要实现一份JS的版本就可以同时跑在前端和后台,后面随着功能的迭代完善官方也发觉了这套东西很难维护,后面推出了nodejs版本的etherpad-lite[5],不在需要维护jar包。

简单说etherpad就是个google开源(Apache 协议)的富文本编辑器(demo地址[6]),而协同算法用的是OT算法之一的easysync算法。

描述文档(clientVars)

在easysync中使用一种数据结构来描述整个文档。

图片

对于上面截图中的文档的描述:

{
attribs : *0+5|1+1*1*2*3*4*5+1*6+3*2|1+1 ,
text : 复仇者联盟\n*钢铁侠\n
}

上面这个对象描述的是整个文档的内容和格式,text存储的是整个文档的内容包括换行符等符号,attribs存储的是对文档内容格式的描述,上图中的属性中*+都不是我们印象中的乘法加法,这里面的数字只代表序号。翻译下具体符号的含义:

  • *n:第n个属性;
  • |n: 影响n行;
  • +n: 取出n个字符数;

:easysync里面的数字大都是36进制的,主要目的是为了缩短传输字符的长度;

具体的属性(加粗斜体等)描述在另一个属性apool中。上面文档中对应的属性描述如下:

{
apool :{
numToAttrib :{
0 :[
lineguid ,
HwV9Nr
],
1 :[
align ,
left
],
2 :[
author ,
52000000000000025
],
3 :[
fragmentguid ,
1981193224752831644
],
4 :[
insertorder ,
first
],
5 :[
lmkr ,
1
],
6 :[
lineguid ,
sQgJ38
],
7 :[
store ,
{\ contentConfig\ :{\ 0 \ :[1,2,3],\ 1 \ :[1,2,3],\ 2 \ :[1,2,3,4,5],\ 3 \ :[1,4,5],\ 4 \ :[]}}
]
},
nextNum :8
}
}

如上的numToAttrib属性里面存储的序号就是上面中数字。结合apool里面的属性值我们就可以把 ​​*0+5|1+1*1*2*3*4*5+1*6+3*2|1+1​​ ****给翻译出来了:

  • 第0个属性,应用于前5个字符(复仇者联盟),影响一行;
  • 取出1个字符应用第1,2,3,4,5属性(这里的属性2是author,即当前编辑这部分文本的用户);
  • 取出1个字符应用属性6;
  • 取出3个字符(钢铁侠)应用属性2,影响一行;
  • 取出1个字符(换行);

可以看出这其实就是一份描述文档的数据结构,理论上我们只要实现了对应平台的渲染器,那就不仅可以把它渲染成html,同样也可以应用在native。但这种格式是按文行和列来描述,遇到表格这种一行里面分格子的需求就很难做了。

描述文档的变更(changeset)

上面easysync定义了一组数据结构来描述整个文档内容,但在协同的场景下如何处理变更也会是一个很棘手的问题。在easysync定义了一个叫changeset的概念去描述文档的变更。文档在一开始创建或是导入的时候会生成一个初始化的内容结构,之后所有的更改都会用changeset来表示。对文档做一下变更,则会产生一次changeset:

Z:c>3|1=7=4*0+3$ 黑寡妇

如果用通信协议来理解changeset的话,可以分为包头和包体,包头主要用来描述字符长度,而上面的Z似乎是个Magicnumber,每一个changeset都会以Z开头。而包体则用来描述具体的操作(比如新增字符,删除字符等)。$ 后面的被叫做charbank,所有这次变更新增的字符都是从charbank里面取出来的。在changeset中符号代表的含义如下:

  • Z: Magicnumber,目测没啥含义;
  • :n: 之前文档的长度(在easysnc中一般都用36进制来表示数字);
  • >n: 新增字节;
  • <n: 删除字节;
  • |n:影响了第n行;
  • *n: 应用属性n;
  • +n:取出n个字符数;
  • -n: 从当前位置开始,删除3个字符;
  • =n: 字节不变;

上面的changeset翻译如下:

之前的文本长度是c(十进制的12),影响了第1行,保留了7个字符,保留4个字符,插入3个字符应用属性0。

而这里的​​+、-、=​​在某种意义上对应的就是ot.js中的​​insert,delete和retain​​三个原子操作;

我们再看一个删除字符(删除了黑寡妇)的例子:

Z:f<3|1=7=4-3$

之前的文本长度是f(十进制的15),影响了第1行,保留7个字符,保留4个字符,从这个位置开始,删除3个字符;

在删除的changeset中charbank是空的,因为是删除,没有新增字符;官方文档参考:https://github.com/ether/etherpad-lite/blob/develop/doc/easysync/easysync-notes.pdf

协同

在实际操作中changeset会非常的多,很频繁,比如现在的我在疯狂码字一样,那么对于changeset的合并(compose)就很重要,它可以极大地缩短传输字符的长度,而在协同的场景下,用户A和用户B提交的changeset就需要去合并,我们上面提到过的ot.js中的transform方法,在easysync中它叫做follow。回顾下前面的ot.js我们会发现

  • ot.js中的一次OP => easysync中的changeset;
  • ot.js中tranform方法 => easysync中的follow方法;
compose

用户B本地操作:插入字符”美国队长“,对应changeset是:

Z:c>4|1=7=4*0+4$ 美国队长

用户B紧接着操作:插入字符”雷神“,对应changeset为:

Z:g>2|1=7=8*0+2$ 雷神

两次操作假设相隔很短,那么完全可以合并为一次changeset:

const cs1 = 'Z:c>4|1=7=4*0+4$ 美国队长';
const cs2 = 'Z:g>2|1=7=8*0+2$ 雷神';
console.log(Changeset.compose(cs1, cs2, false, null));
// Z:c>6|1=7=4*0+6$ 美国队长雷神

注意,compose是有合并顺序的,参数1一定是参数2的前置操作。下文中我们将 compose方法省略。 状态A和状态B合并为状态C(状态A是状态B的前置操作),记为 C = AB

merge

compose合并的是有前后操作关系的状态,但在文档协同中更多的是并发冲突问题,merge是easysync中解决并发冲突的算法,比如用户A和用户B同时编辑了一份文档:

用户A插入 黑寡妇 :

Z:c>3|1=7=4*0+3$ 黑寡妇

用户B插入 美国队长 :

Z:c>4|1=7=4*0+4$ 美国队长

merge就是将操作A和B进行合并的,合并后的状态我们记为C,即 C = m(A, B);

 ​​m​​ 的约束条件: ​​A​​  ​​B​​ 的顺序可以是任意的,即 ​​m(A, B) = m(B, A)​​ 

follow

上面的例子生成的状态C
= m(B, A),其实是应用于服务端的状态,假设服务端状态 X => X'。那么可记为X' = Xm(B, A)。X'是通过X 和
m(B,
A)合并得到的,但对客户端来说无法直接去这样操作,因为对用户A来说,状态C并不是A的前置,无法直接去合并,我们需要一个算法去做转换,这个实现就是follow方法,还是上面的例子:

const A = 'Z:b>3|1=4*0+3$ 黑寡妇';
const B = 'Z:b>4|1=4*0+4$ 美国队长';

const A1 = follow(B, A, false, null);
const B1 = follow(A, B, true, null);
console.log(A1, B1);
// Z:f>3|1=4=4*0+3$ 黑寡妇 Z:e>4|1=4*0+4$ 美国队长
const A2 = compose(A, B1);
const B2 = compose(B, A1);
console.log(A2, B2);
// Z:b>7|1=4*0+7$ 美国队长黑寡妇 Z:b>7|1=4*0+7$ 美国队长黑寡妇

可以看到用户A和B,最终的changeset分别是A2和B2,A2和B2是完全相等的。

这里我们将follow方法记为f, 当服务端收到用户A和用户B的并发操作的时候处理过程,假设服务端目前的状态是X,收到了用户A的操作A,然后apply到字符串变成了XA,此时又收到了用户B的操作B,很明显,此时直接应用XAB是不行的,因为A和B都是基于X来变更的,A并不是B的前置,此时就需要一个B',来实现XAB',且有XAB' = XBA'。

 也就是上面例子中的follow结果,B' = f(A, B),A' = f(B, A)。由此可得到:XAf(A, B) = XBf(B, A)。即,Af(A, B) = B f(B, A) ;这个公式就是follow算法的核心。

C/S模型

前面也提到过OT算法必然需要一个Server去中转,不支持点对点。我们来看下客户端和服务端分别是怎么工作的:

客户端

图片

前面说过在OT中客户端可以把用户的操作分为三种状态,在easysync中也有三种状态:

A: 服务端最新内容,未进行修改;

X:changeset已经提交了,还没被确认;

Y: 客户端产生的还没提交到服务端的变更集;

还有一种特殊的changeset,就是在X期间,又产生了新的changeset,我们用E来代替。

E: ****changeset提交期间产生的新的编辑;

etherpad官方文档里面写的巨复杂,我简单梳理下这里客户端的状态变化和操作(注意:下文中的=和≠都是传统数学意义上的符号,直接合并即使用compose/merge合并):

  1. 拉取最新文档,未进行编辑

此时X = Y = A = In(初始状态)

  1. 开始产生编辑行为

用户产生新的编辑E,此时Y有两种状态,一种是初始状态Y = In,一种是之前产生了编辑,Y ≠ In。但无论Y是否等于In,操作E都是合并到Y中,此时Y = Y · E;这样可以不间断的更新Y,不至于丢失用户数据;

  1. 提交变更集到服务器(未收到ack);

此时,变更集Y会变成已提交状态,同时Y的状态重置,X = Y,Y = In;

  1. 收到服务器ack确认;

此时X变成了已确认的状态,A状态转变为最新的X,X状态重置,也就是A = X;X = In;

  1. 收到用户B的变更集B;
  • 前置条件:对B的约束条件是,A 必须是 B 的前置,即运算 A · B 是可执行的(为什么要有这个约束条件,大家可以思考下)此时的变化是比较复杂的,前面AXY的变迁规则已无法适应这种场景,需要作出调整。用户 A 需要吸收 B 生成,A'、X'、Y'来回归到前面的变迁行为。由于此时 AXY 是已经展现给用户的状态了,我们用 V 来表示最终的文档变更状态。
  • A 吸收 B 变为 A':​​A' = AB​​;
  • X 吸收 B 变为 X': B 和 X 有相同的前置 A,使用follow方法合并即可,​​X' = f(B, X)​​,​​B' = f(X, B)​​;可推断出ABX' =AXB'
  • Y 吸收 B 变为 Y':
  • 由ab两点可知,A'B' = ABX' = AXB ' (follow算法) 前面说了B的前置是A,但Y的前置是X,因此需要转化一下B' = f(X, B),使得B'和Y都有相同的前置X,然后生成Y' = f(B', Y);即Y' = f(f(X, B), Y)

  • 生成最终状态V:
  • V = A'X'Y'

    = AB · f(B, X) · f(f(X, B), Y)

    = A · Bf(B, X) · f(f(X, B), Y)

    = A · Xf(X, B) · f(f(X, B), Y)

    = AX · f(X, B) · f(f(X, B), Y)

    = AX · Y · f(Y, f(X,B))

    = AXY · f(Y, f(X, B)

此时再将新的A',X',Y'赋值给AXY

服务端

这里服务端的处理逻辑相对前端来说要简单很多,主要做两件事:

  1. 响应客户端请求,建立链接,并返回文档最新状态;
  2. 处理客户端提交上来的变更集,返回确认信息;

其中处理变更集的逻辑比较值得一说,当服务端收到一个变更集C的时候,会做以下五件事:

  1. 从客户端版本记录中,获取​​C​​ 的前置版本​​S​​​​c​​(客户端的初始版本);
  2. 注意服务器记录的最后一个变更集(Changeset)​​S​​​​h​​与​​Sc​​ 之间可能还存在多次变更集(Changeset)记录(此时可能有其它用户已经推送了新的版本,但还未下发到当前客户端)。此时需要计算出​​C​​ 相对​​S​​​​h​​的后置​​C'​​ 。这样才能「叠加」到当前文档上;
  3. 发送​​C'​​ 到其它客户端;
  4. 发送确认(ACK)给当前客户端;
  5. 将​​C'​​ 添加到记录列表中,同时更新版本;

后记

比较粗浅的了解了以上和在线文档相关的一些技术,其中的一些细节实现和难题都充满了挑战,这个方向确实是道阻且长,很多看似简单的功能背后都充满着工程师的心血(比如协同中的文字选中)。

参考资料

[1]diff-match-patch: https://github.com/google/diff-match-patch/tree/master/javascript

[2]diff-match-patch JS实现源码: https://github.com/google/diff-match-patch/blob/master/javascript/diff_match_patch_uncompressed.js

[3]ot.js: https://github.com/Operational-Transformation/ot.js/blob/master/lib/text-operation.js

[4]github: https://github.com/Operational-Transformation/ot.js/blob/master/lib/text-operation.js#L238

[5]etherpad-lite: https://github.com/ether/etherpad-lite

[6]demo地址: https://rich.etherpad.com/p/re3434hkj

[7]《OT协同》: https://bytedance.feishu.cn/wiki/wikcnn505JVvliIX3Z0JKJEDQqh#zdaw84

[8]Etherpad 协同概述: https://bytedance.feishu.cn/wiki/wikcnQ0bGESsmnJr6HegIno15Gg

责任编辑:庞桂玉 来源: 前端大全
相关推荐

2022-04-29 08:55:43

前端开发规范

2022-02-27 15:38:49

前端开发API

2022-04-27 09:48:56

JS前端开发

2022-01-23 11:12:29

2011-11-01 10:12:09

Web

2022-04-13 11:18:48

渗透测试Mock

2011-05-25 17:17:54

2022-03-10 11:04:04

Vue3Canvas前端

2022-02-22 11:54:05

跨域项目前后端

2021-08-30 17:35:17

2022-02-17 18:11:53

PostCSS流程API

2020-03-08 13:43:57

前端开发前端开发

2020-04-22 14:27:44

前端工具开发

2020-10-23 19:20:34

前端开发工程师

2020-10-18 17:09:14

前端开发技术

2020-03-15 13:53:42

前端开发工具

2020-09-04 15:38:19

Web前端开发项目

2021-04-13 09:43:10

前端开发技术

2021-04-01 13:44:50

开发前端Web

2021-01-04 14:41:28

开发前端工具

同话题下的热门内容

如何创建一个无代码的自助客户聊天机器人Java 服务 Docker 容器化优秀实践程序员不得不知道的 API 接口常识如何提高 TypeScript 的代码质量?聊聊 13 种锁的实现方式11个 ES2022(ES13)中惊人的 JavaScript 新特性使用 Vite 和 TypeScript 带你从零打造一个属于自己的 Vue3 组件库Hooks时代,如何写出高质量的react和vue组件?

编辑推荐

太厉害了,终于有人能把TCP/IP协议讲的明明白白了!牛人5次面试腾讯不成功的经验HBase原理–所有Region切分的细节都在这里了Javascript如何监听页面刷新和关闭事件如何搭建一个HTTPS服务端
我收藏的内容
点赞
收藏

51CTO技术栈公众号