SpringBoot中整合ONLYOFFICE在线编辑

SpringBoot整合OnlyOffice

  • SpringBoot整合OnlyOffice实现在线编辑
    • 1. 搭建私有的OnlyOffice的服务
    • 2. SpringBoot进行交互
      • 2.1 环境
      • 2.2 我们的流程
      • 2.3 接口规划
        • 2.3.1 获取编辑器配置的接口
        • 2.3.2 文件下载地址
        • 2.3.3 文件下载地址
    • 3. 总结
      • 4. 注意
        • 4.1 你的项目的地址一定一定要和onlyoffice可以正常通讯,如果不行则一直不可能成功。
        • 4.2 TOKEN是可以可选项,建议一开始不要使用,后面有需要的时候再去添加。
        • 4.3 一定要看一下官网文档,文档真的很全很重要
        • 4.4 协同的话只要参数就是一个KEY,如果需要超过20个的限制直接重新编译即可,大神一大堆,很容易就可以找到。

SpringBoot整合OnlyOffice实现在线编辑

公司有一个需求,就是实现 *Word* , *Excel* ,等文件的在线编辑,市场上面进行了多方面的选型,考虑了 *[OpenOffice](https://openoffice.apache.org/)* , *[Office Online](https://www.microsoft.com/zh-cn/microsoft-365/free-office-online-for-the-web?legRedir=true&CorrelationId=13c8a865-b9b0-48ff-b3ed-3ea9ec31cd55)*, 但是最终还是选择了 *[OnlyOffice](https://www.onlyoffice.com/zh/)* 这个产品。
他的一个很大的优势在于开源,支持协同,社区比较活跃。api比较全面,还有中文的文档。还有一点比较好的就是支持协同,并且支持协同,虽然协同在社区版中存在限制,但是支持代码修改,可以重新编译。社区的大佬很多,很赞。唯一遗憾的就是效率比较低,在使用私有对象存储的时候存在延迟。其他的没有使用到,所以不进行评论。中文文档:[https://api.onlyoffice.com/zh/editors/basic](https://api.onlyoffice.com/zh/editors/basic)

1. 搭建私有的OnlyOffice的服务

搭建过程这里就不进行涉猎了,建议使用docker进行搭建,下载官方镜像包即可,(现在dockerhub被墙,自行解决,不建议自己再次打包,因为我在尝试的时候总是出现莫名奇妙的问题可能是我的问题。推荐使用官网原版镜像)。根据官方文档一步步操作即可。搭建过程中,如果是自己玩建议不要开启 **JWT** ,生产环境建议开一下。但是开的成本就是你对接的时候需要获取token然后在进行交互。

2. SpringBoot进行交互

2.1 环境

java: 17
boot: 3.0.5
页面:一个h5页面即可
需要的其他依赖

<!-- ... 其他的依赖自行添加即可,不重要,比如 fastjson2,jackson 等 --><!-- 这个JAR 主要的作用是与OnlyOffice交互的时候生成token使用的 -->
<dependency><groupId>com.inversoft</groupId><artifactId>prime-jwt</artifactId><version>1.3.1</version></dependency>

2.2 我们的流程

我们使用一个 H5 页面即可,页面通过加载一个 app.js 。然后通过一个 config 进行渲染,就可以实现一个编辑。app.js 是核心js文件

  1. only office 我只使用他的一个编辑的功能(这是一个核心,就是编辑文件,文件的来源和存储与它无关)
  2. 被编辑的文件从哪里获取?从 config 对象中的配置获取,这里就需要自行实现。
  3. 编辑后的文件如何获取?config对象中有一个回调地址,这个地址会给到服务器一个编辑的状态,并且携带一个获取编辑后文件的url(这个url就是only office 服务中的一个文件下载地址),根据这个url来获取编辑后的文件。然后在对这个文件进行存储。
    回调的实现参考:https://api.onlyoffice.com/zh/editors/callback#status

在这里插入图片描述

2.3 接口规划

一共设计三个接口,

  1. 获取编辑器的配置
  2. 获取需要编辑的文件流
  3. 编辑后保存文件的回调
    保存后的文件:注意,这里编辑后的文件并不是在回调里面以流的形式给,而是在回调接口里面给服务器一个状态,根据状态去获取一个下载编辑后文件的一个地址,然后根据地址去主动的获取文件。
2.3.1 获取编辑器配置的接口

/*** 被编辑文件的下载连接* 这里就是自己服务的配置地址* only office 调用你的服务的地址,一定是 onlyoffice服务可以ping通的你的项目地址。ping不通=白搭*/
@Value("${only.office.downUrl}")
private String downFileUrl = "";
/*** 这里是回调地址:例如 http://192.168.0.10:8080/office/edit/callback/{fileId}* 自行定义即可(就是后面自己编写的接口,但是一定要通可onlyoffice服务互通)* only office 调用你的服务的地址,一定是 onlyoffice服务可以ping通的你的项目地址。ping不通=白搭*/
@Value("${only.office.callBackUrl}")
private String editCallBackUrl = "";@Operation(summary = "根据文件的ID来获取在线编辑的配置和token")
@PostMapping("/token/{fileId}")
@Parameters({@Parameter(name = "fileId", description = "不是对象ID是文件的ID", in = ParameterIn.PATH)
})
public ResultVo<?> getToken(@PathVariable String fileId) {String fileKey ;if (redisUtil.hHasKey(RedisName.ONLY_OFFICE_FILE_KYE,fileId)) {fileKey = redisUtil.hget(RedisName.ONLY_OFFICE_FILE_KYE,fileId).toString();//return ResultVo.error(CustomExceptionType.ONLY_OFFICE_COORDINATION_ERROR);}else{fileKey = fileId + RandomUtil.randomNumbers(10);}String json = """{"document": {"title": "%s","key": "%s","fileType":"%s","lang": "zh-CN","permissions": {"comment": true,"commentGroups": {"edit": ["Group2", "Group1"],"remove": [""],"view": ""},"copy": true,"deleteCommentAuthorOnly": false,"download": true,"edit": true,"editCommentAuthorOnly": false,"fillForms": true,"modifyContentControl": true,"modifyFilter": true,"print": true,"review": true,"reviewGroups": ["Group1", "Group2", ""]},"url": "%s"},"editorConfig": {"customization":{"autosave": true,"forcesave": true}"lang": "zh-CN","callbackUrl": "%s","onEditing": {"mode": "fast","change": true},"mode": "edit","user": {"group": "Group1","id": "%s","name": "%s"}}}""";// TODO 这里文件的key可以通过redis进行保存,这样可以支持多人在线协同,现在不做处理json = String.format(json, fileInfo.getFileName(),fileKey,// TODO 这里是文件类型,自行定义'xlsx',// TODO 这里是文件下载地址,fileId 为文件的唯一标识,自行定义downFileUrl + fileId, // TODO 这里是定义回调地址,fileId 为文件的唯一标识用来区分是那个文件编辑的回调。editCallBackUrl + fileId,"userid","username");Map<String, Object> map = JSONObject.parseObject(json, new TypeToken<Map<String, Object>>() {}.getType());// TODO 这里是获取onlyoffice 交互的token,自己写的建议直接注释// String token = jwtManager.createToken(map);// map.put("token", token);// TODO 这个key可以直接注释,这里主要作用是协同redisUtil.hset(RedisName.ONLY_OFFICE_FILE_KYE,fileId,fileKey,60*60*24);return ResultVo.success(map);
}
2.3.2 文件下载地址

这个接口的作用就是获取一个文件流,根据ID来获取一个文件流

这里的地址就是上一个接口中下载文件的地址。

@GetMapping("down/file/{fileId}")
@Operation(summary = "根据参数下载一个文件")
public void downFolderById(@PathVariable String fileId, HttpServletResponse response){// TODO 1. 根据文件的唯一ID来获取数据库中的记录EtmfFileInfo fileInfo = fileInfoOpt.getById(fileId);// TODO 2. 根据下载路径从 minio 中获取文件流 (因为我们使用的是minio,其他的自行切换即可)try (InputStream inputStream = smoMinIoUtils.downloadFile(fileInfo.getFileUrl())) {downFileInfo(response, fileInfo, inputStream);} catch (ServerException | ErrorResponseException | InsufficientDataException | IOException |NoSuchAlgorithmException | InvalidKeyException | InvalidResponseException | XmlParserException |InternalException e) {JwtUtil.responseError(response, 500L, "文件下载失败:" + e.getMessage());}
}public static void downFileInfo(HttpServletResponse response, EtmfFileInfo fileInfo, InputStream inputStream) throws IOException {response.setCharacterEncoding("UTF-8");response.setContentType("application/octet-stream; charset=UTF-8");response.addHeader("Content-Disposition", "attachment;filename=" + URLEncoder.encode(fileInfo.getFileName(), StandardCharsets.UTF_8));ServletOutputStream stream = response.getOutputStream();IOUtils.copy(inputStream,stream);stream.flush();stream.close();
}
2.3.3 文件下载地址

这里是文件的回调地址,主要就是获取一个状态码,然后根据状态码判定是否保存文件。


@Operation(summary = "文件编辑之后的回调")
@Parameters({@Parameter(name = "fileId", description = "文件的ID", in = ParameterIn.PATH)
})
@PostMapping("/edit/callback/{fileId}")
public void editCallBack(@PathVariable String fileId, HttpServletRequest request, HttpServletResponse response) {try {PrintWriter writer = response.getWriter();String body;try {Scanner scanner = new Scanner(request.getInputStream());scanner.useDelimiter("\\A");body = scanner.hasNext() ? scanner.next() : "";scanner.close();} catch (Exception ex) {writer.write("get request.getInputStream error:" + ex.getMessage());return;}if (body.isEmpty()) {writer.write("empty request.getInputStream");return;}JSONObject jsonObj = JSON.parseObject(body);int status = (Integer) jsonObj.get("status");log.debug("================文件编辑获取到的参数是:{}", JSON.toJSONString(jsonObj));int saved = 0;if (List.of(2,3,6).contains(status)) {String downloadUri = (String) jsonObj.get("url");log.debug("================文件进行保存处理,需要保存的状态值是:{},可以获取到文件的路径是:{}", status,downloadUri);try {URL url = new URL(downloadUri);// 根据文件下载地址来获取编辑后的文件流HttpURLConnection connection = (HttpURLConnection) url.openConnection();InputStream stream = connection.getInputStream();if (stream == null) {throw new Exception("Stream is null");}// TODO 根据文件的唯一标识获取数据库中文件记录EtmfFileInfo fileInfo = fileInfoOpt.getById(fileId);// TODO 根据文件流创建一个文件File savedFile = new File(fileInfo.getFileName());try (FileOutputStream out = new FileOutputStream(savedFile)) {int read;final byte[] bytes = new byte[1024];while ((read = stream.read(bytes)) != -1) {out.write(bytes, 0, read);}out.flush();}// TODO 根据文件上传到 MINIO中boolean b = smoMinIoUtils.uploadFile(fileInfo.getFileUrl(), savedFile);log.info("编辑文件后,文件上传状态:{},上传的文件是:{},Id是:{}",b,fileInfo.getFileName(),fileId);savedFile.delete();connection.disconnect();} catch (Exception ex) {saved = 1;ex.printStackTrace();}finally {// 正常保存的时候剔除掉redis缓存if (status == TWO) {redisUtil.hdel(RedisName.ONLY_OFFICE_FILE_KYE,fileId);}}}writer.write("{\"error\":" + saved + "}");writer.flush();writer.close();log.debug("======================编辑完成--------------返回值是:{}","{\"error\":" + saved + "}");} catch (IOException e) {e.printStackTrace();throw new SmoGlobalException(CustomExceptionType.OTHER_ERROR);}
}

3. 总结

文件的在线编辑主要就是依托与onlyoffice实现的,而编辑器的配置是通过我们的接口来定义的,接口中的配置可以自由的定义编辑器的文件类型,窗口大小,文件来源,回调地址,保存类型等等。
你需要编辑的文件可以放在任意的位置,只要你的接口可以通过流的方式给到onlyofiice编辑器即可。
文件编辑后的处理都是在回调中处理的,最好先看一下文档的回调写法。回调的时候记得打印日志,观察一下接口的内容,一定要记得是通过回调中的url参数来获取编辑后的文件流的,并不是通过回调接口直接把文件流给到你。我在这里没有注意看饶了弯路。所以提醒一下。

4. 注意

4.1 你的项目的地址一定一定要和onlyoffice可以正常通讯,如果不行则一直不可能成功。
4.2 TOKEN是可以可选项,建议一开始不要使用,后面有需要的时候再去添加。
4.3 一定要看一下官网文档,文档真的很全很重要
4.4 协同的话只要参数就是一个KEY,如果需要超过20个的限制直接重新编译即可,大神一大堆,很容易就可以找到。

本文来自互联网用户投稿,该文观点仅代表作者本人,不代表本站立场。本站仅提供信息存储空间服务,不拥有所有权,不承担相关法律责任。如若转载,请注明出处:http://www.mzph.cn/diannao/39063.shtml

如若内容造成侵权/违法违规/事实不符,请联系多彩编程网进行投诉反馈email:809451989@qq.com,一经查实,立即删除!

相关文章

Java中的单元测试与集成测试最佳实践

Java中的单元测试与集成测试最佳实践 大家好&#xff0c;我是免费搭建查券返利机器人省钱赚佣金就用微赚淘客系统3.0的小编&#xff0c;也是冬天不穿秋裤&#xff0c;天冷也要风度的程序猿&#xff01;今天我们将深入探讨Java中的单元测试与集成测试最佳实践。在软件开发中&am…

三层交换基础

一、什么是三层交换 三层交换是一种在OSI模型第三层&#xff0c;即网络层上工作的网络设备技术&#xff0c;它整合了二层交换机的功能和路由器的部分功能&#xff0c;以实现更高效的网络数据转发和路由选择。三层交换技术的核心在于结合了二层交换技术和三层转发技术&#xff…

【RabbitMQ实战】Springboot 整合RabbitMQ组件,多种编码示例,带你实践 看完这一篇就够了

提示&#xff1a;文章写完后&#xff0c;目录可以自动生成&#xff0c;如何生成可参考右边的帮助文档 文章目录 前言一、对RabbitMQ管理界面深入了解1、在这个界面里面我们可以做些什么&#xff1f; 二、编码练习&#xff08;1&#xff09;使用direct exchange(直连型交换机)&a…

2024 年的 13 个 AI 趋势

2024 年的 13 个 AI 趋势 人工智能对环境的影响和平人工智能人工智能支持的问题解决和决策针对人工智能公司的诉讼2024 年美国总统大选与人工智能威胁人工智能、网络犯罪和社会工程威胁人工智能治疗孤独与对人工智能的情感依赖人工智能影响者中国争夺人工智能霸主地位人工智能…

Java中的机器学习模型集成与训练

Java中的机器学习模型集成与训练 大家好&#xff0c;我是免费搭建查券返利机器人省钱赚佣金就用微赚淘客系统3.0的小编&#xff0c;也是冬天不穿秋裤&#xff0c;天冷也要风度的程序猿&#xff01;今天我们将探讨在Java中如何进行机器学习模型的集成与训练。随着人工智能和机器…

【Lua小知识】Vscode中Emmylua插件大量报错的解决方法

起因 Vscode写Lua用的好好的&#xff0c;最近突然出现了大量报错。 看报错是有未定义的全局变量&#xff0c;这里查日志才发现是由于0.7.5版本新增诊断启用配置&#xff0c;所以导致了原先好的代码&#xff0c;现在出现了大量的报错。 解决方案一 最直接的方法当然是在配置中直…

用摄像头实现识别道路中的车道线、行人与车辆检测(级联分类器、HOG+SVM、行人检测)

基于树莓派的智能小车&#xff0c;用摄像头实现识别道路中的车道线识别、行人检测与车辆检测。 本项目旨在开发一套基于摄像头的智能道路环境感知系统&#xff0c;该系统能够实时识别道路中的车道线、行人与车辆&#xff0c;为自动驾驶汽车、智能交通管理以及辅助驾驶系统提供关…

LeetCode热题100刷题3:3. 无重复字符的最长子串、438. 找到字符串中所有字母异位词、560. 和为 K 的子数组

3. 无重复字符的最长子串 滑动窗口、双指针 class Solution { public:int lengthOfLongestSubstring(string s) {//滑动窗口试一下//英文字母、数字、符号、空格,ascii 一共包含128个字符vector<int> pos(128,-1);int ans 0;for(int i0,j0 ; i<s.size();i) {//s[i]…

python 中的生成器

目录 生成器示例基本生成器示例无限序列生成器使用生成器表达式实用示例&#xff1a;按行读取大文件生成器的 send、throw 和 close 方法 生成器和迭代器迭代器&#xff08;Iterator&#xff09;定义创建使用示例 生成器&#xff08;Generator&#xff09;定义创建使用示例 主要…

【python学习】自定义函数的一些高级用法-2

8. 生成器函数 生成器函数允许你定义一个可以“记住”其当前执行状态的函数&#xff0c;并在下次调用时从上次离开的位置继续执行。生成器函数使用yield关键字而不是return。 def simple_generator(): yield 1 yield 2 yield 3 gen simple_generator() print(next(gen)) # …

隐私计算实训营第二期第十课:基于SPU机器学习建模实践

隐私计算实训营第二期-第十课 第十课&#xff1a;基于SPU机器学习建模实践1 隐私保护机器学习背景1.1 机器学习中隐私保护的需求1.2 PPML提供的技术解决方案 2 SPU架构2.1 SPU前端2.2 SPU编译器2.3 SPU运行时2.4 SPU目标 3 密态训练与推理3.1 四个基本问题3.2 解决数据来源问题…

全新升级!中央集中式架构功能测试为新车型保驾护航

“软件定义汽车”新时代下&#xff0c;整车电气电气架构向中央-区域集中式发展已成为行业共识&#xff0c;车型架构的变革带来更复杂的整车功能定义、更多的新技术的应用&#xff08;如SOA服务化、智能配电等&#xff09;和更短的车型研发周期&#xff0c;对整车和新产品研发的…

OkHttp的源码解读1

介绍 OkHttp 是 Square 公司开源的一款高效的 HTTP 客户端&#xff0c;用于与服务器进行 HTTP 请求和响应。它具有高效的连接池、透明的 GZIP 压缩和响应缓存等功能&#xff0c;是 Android 开发中广泛使用的网络库。 本文将详细解读 OkHttp 的源码&#xff0c;包括其主要组件…

Qt实现手动切换多种布局

引言 之前写了一个手动切换多个布局的程序&#xff0c;下面来记录一下。 程序运行效果如下&#xff1a; 示例 需求 通过点击程序界面上不同的布局按钮&#xff0c;使主工作区呈现出不同的页面布局&#xff0c;多个布局之间可以通过点击不同布局按钮切换。支持的最多的窗口…

如何使用 AppML

如何使用 AppML AppML(Application Markup Language)是一种轻量级的标记语言,旨在简化Web应用的创建和部署过程。它允许开发者通过XML或JSON格式的配置文件来定义应用的结构和行为,从而实现快速开发和灵活扩展。AppML特别适用于构建数据驱动的企业级应用,它可以与各种后端…

pytorch跑手写体实验

目录 1、环境条件 2、代码实现 3、总结 1、环境条件 pycharm编译器pytorch依赖matplotlib依赖numpy依赖等等 2、代码实现 import torch import torch.nn as nn import torch.optim as optim import torchvision import torchvision.transforms as transforms import matpl…

burpsuite 设置监听窗口 火狐利用插件快速切换代理状态

一、修改burpsuite监听端口 1、首先打开burpsuite&#xff0c;点击Proxy下的Options选项&#xff1a; 2、可以看到默认的监听端口为8080&#xff0c;首先选中我们想要修改的监听&#xff0c;点击Edit进行编辑 3、将端口改为9876&#xff0c;并保存 4、可以看到监听端口修改成功…

typescript学习回顾(五)

今天来分享一下ts的泛型&#xff0c;最后来做一个练习 泛型 有时候&#xff0c;我们在书写某些函数的时候&#xff0c;会丢失一些类型信息&#xff0c;比如我下面有一个例子&#xff0c;我想提取一个数组的某个索引之前的所有数据 function getArraySomeData(newArr, n:numb…

JVM原理(十):JVM虚拟机调优分析与实战

1. 大内存硬件上的程序部署策略 这是笔者很久之前处理过的一个案例&#xff0c;但今天仍然具有代表性。一个15万PV/日左右的在线文档类型网站最近更换了硬件系统&#xff0c;服务器的硬件为四路志强处理器、16GB物理内存&#xff0c;操作系统为64位CentOS5.4&#xff0c;Resin…

js数组方法归纳——concat、join、reverse

1、concat( ) 用途&#xff1a;可以连接两个或多个数组&#xff0c;并将新的数组返回该方法不会对原数组产生影响 var arr ["孙悟空","猪八戒","沙和尚"];var arr2 ["白骨精","玉兔精","蜘蛛精"];var arr3 [&…