onlyoffice历史版本功能实现

news2024/11/16 3:34:57

一：开启客户端配置

如果不开启，回调请求里面的history和changeUrl是空

二：客户端主要实现2个回调函数

1.实现onRequestHistory事件，该事件会在ui点击查看历史的时候发起,用于展示历史列表
关键在于获取到history的内容，调用refreshHistory方法

docEditor.refreshHistory(// show the document version history
{
	currentVersion: "31",
	history: historyList
})

historyList 的数据结构

[{
	"serverVersion": "7.4.0",//来源回调的history，第一个版本无需该字段
	"changes": [{//来源回调的history，第一个版本该字段为null
		"created": "2023-09-28 02:01:25",
		"user": {
			"id": "uid-2",
			"name": "group-2 xxx"
		}
	}, {
		"created": "2023-09-28 02:01:49",
		"user": {
			"id": "uid-3",
			"name": "group-3 Hamish Mitchell"
		}
	}],
	"key": "__ffff_200.200.170.119new.docx291695866450703",来源回调的key
	"version": 30,//需要自己维护
	"created": "2023-09-28 02:01:25",//自己维护，一般是打开文档的时候记录
	"user": {//自己维护，一般是打开文档的时候记录
		"id": "uid-2",
		"name": "group-2 xxx"
	}
}]

回调的数据结构如下(仅供参考)

 {
  key: '1696822265751m4sq5vs50j',
  status: 2,
  url: 'http://xxx/cache/files/data/1696822265751m4sq5vs50j_9201/output.docx/output.docx?md5=jljJJVUlAm4pYX_6mvC_Lw&expires=1696823346&filename=output.docx',
  changesurl: 'http://xxxx/cache/files/data/1696822265751m4sq5vs50j_9201/changes.zip/changes.zip?md5=ivaLJ_lI0MK5nBdCqy8HLw&expires=1696823346&filename=changes.zip',
  history: { serverVersion: '7.4.0', changes: [ [Object] ] },
  users: [ '64773bdb97acf80031f4ef56' ],
  actions: [ { type: 0, userid: '64773bdb97acf80031f4ef56' } ],
  lastsave: '2023-10-09T03:33:46.000Z',
  notmodified: true,
  filetype: 'docx'
}

historyList 排序要求：按version升序排序

2.实现onRequestHistoryData事件，该事件会ui点击查看具体的某个历史的时候触发
关键在于获取某个版本的具体historyData，调用setHistoryData方法发起请求

function onRequestHistoryData(data) {
		var version = data.data;//对应点击哪个版本
        docEditor.setHistoryData(historyData);
}

historyData的数据结构

{
"fileType": "docx",
"version": 25,
"key": "xxxxxx",
"url": "http://xxxxx/history?fileName=new.docx&file=prev.docx&ver=25&useraddress=xxx",//当前版本下载的url
"directUrl": null,
"previous": {//上一个版本的信息，如果无上个版本，可以不要这个字段，例如第一个版本
	"fileType": "docx",
	"key": "new.docx231684394201684",
	"url": "http://xxx/history?fileName=new.docx&file=prev.docx&ver=24&useraddress=xxxx",
	"directUrl": null
},
"changesUrl": "http://xxxx&file=diff.zip&ver=24",//下载当前版本历史记录存储的diff.zip文件
"token": "eyJhbGciOiJIUzI1NiIsInR"//当条数据签名
}

三：服务端所有工作都是围绕实现上述的数据

1.处理onlyoffice发起的回调函数，将保存history信息，更新文件，保存历史文件，保存changeUrl的zip文件，刷新key

例如，刚新建个文件的时候就添加个历史记录版本是1，客户端编辑后，回调的处理，保存版本号是2的历史记录，创建个版本号是2的目录，里面存放上个版本的文件，和回调changeUrl里的文件，拼接historyData的changesUrl就用对应版本号里面对应的信息，url也是。changeUrl的内容是当前版本和上个版本的对比