0
0

SpringBoot项目集成ONLYOFFICE

ONLYOFFICE 文档8.2版本已发布：PDF 协作编辑、改进界面、性能优化、表格中的 RTL 支持等更新

文章目录

前言

提示：这里可以添加本文要记录的大概内容：

随着互联网技术的发展，越来越多的企业和个人开始寻求高效的在线文档处理解决方案。传统的本地文档编辑软件虽然功能强大，但在多用户协同工作方面存在诸多不便。为了满足这一需求，市场上涌现出了许多优秀的在线文档编辑工具，其中OnlyOffice因其出色的性能和灵活的集成能力而受到广泛好评。本文将详细介绍如何在Spring Boot项目中集成OnlyOffice，实现文档的在线编辑功能，并分享OnlyOffice的产品特点和用户体验。

ONLYOFFICE 产品简介

OnlyOffice是一套完整的开源办公套件，旨在为企业和个人提供高效的文档处理解决方案。它包含文字处理、电子表格和演示文稿三种类型的文档编辑器，支持多种文档格式的读取和编辑。OnlyOffice不仅提供了丰富的桌面应用程序，还拥有强大的Web版编辑器——

OnlyOffice Document Server

，后者可以方便地集成到各类Web应用中，实现文档的在线编辑和协作。

功能与特点

  • 全面的文档支持：支持DOCX、XLSX、PPTX等多种文档格式的编辑和转换。
  • 实时协作编辑：允许多个用户同时编辑同一文档，所有更改实时同步。
  • 权限管理：提供细粒度的文档访问权限控制，确保文档的安全性。
  • 版本管理：自动记录文档的历史版本，便于追踪修改记录和恢复早期版本。
  • 插件扩展：支持通过插件扩展编辑器的功能，满足更多个性化需求。
  • API接口丰富：提供RESTful API和JavaScript API，方便开发者集成到现有系统中。

Spring Boot 项目中集成 OnlyOffice

1. 环境准备

  • Java环境：确保已经安装了Java环境（建议JDK 1.8及以上版本）。在这里插入图片描述
  • 构建工具：安装Maven或Gradle作为项目的构建工具。在这里插入图片描述
  • Spring Boot项目：可以通过Spring Initializr快速创建一个Spring Boot项目基础框架。在这里插入图片描述

2. 部署OnlyOffice Document Server

  • 安装OnlyOffice：可以选择在本地或云服务器上安装OnlyOffice Document Server。官方提供了详细的安装指南，可以根据自己的操作系统选择合适的安装方法。在这里插入图片描述
  • 检查安装：安装完成后，确保Document Server能够正常访问，通常可以通过浏览器访问http://<your_server_ip>:80来检查是否成功安装。在这里插入图片描述

3. 配置Spring Boot项目

在这里插入图片描述

  • 添加配置：在Spring Boot项目的application.properties文件中添加OnlyOffice服务器的相关配置信息，如服务器地址等。
  onlyoffice.server.url=http://<your_server_ip>
  onlyoffice.server.secret=<your_secret_key>
  • 创建控制器：创建一个控制器(Controller)用于处理前端请求，调用OnlyOffice API进行文档的加载、保存等操作。
@RestController@RequestMapping("/documents")publicclassDocumentController{@Value("${onlyoffice.server.url}")privateString serverUrl;@Value("${onlyoffice.server.secret}")privateString secretKey;@GetMapping("/{id}")publicResponseEntity<?>getDocument(@PathVariableString id){// 调用OnlyOffice API获取文档编辑所需参数// ...}@PostMapping("/{id}")publicResponseEntity<?>saveDocument(@PathVariableString id,@RequestBodyDocument document){// 处理文档保存逻辑// ...}}

4. 实现文档编辑功能

  • 前端集成：利用OnlyOffice提供的JavaScript API，在前端页面中嵌入文档编辑器。
<divid="document-editor"></div><scriptsrc="https://<your_server_ip>/web-apps/apps/api/documents/api.js"></script><script>functiononDocumentReady(){var docEditor =newDocsAPI.DocEditor("document-editor",{"document":{"fileType":"docx","key":"<document_id>","title":"Sample Document","url":"https://<your_server_ip>/documents/<document_id>"},"documentType":"word","editorConfig":{"callbackUrl":"https://<your_backend_url>/documents/<document_id>","mode":"edit","lang":"en"},"customization":{"actionBar":false,"chat":false}});}</script>

5. 文档保存与版本控制

  • 保存文档：当用户完成编辑并保存文档时，OnlyOffice会将更新后的文档发送回指定的回调URL。
@PostMapping("/{id}")publicResponseEntity<?>saveDocument(@PathVariableString id,@RequestBodyDocument document){// 将文档保存到数据库或文件系统中// 记录版本信息returnResponseEntity.ok().build();}
  • 版本管理：记录文档的历史版本，便于追踪修改记录和恢复早期版本。

以下是Spring Boot项目中集成OnlyOffice的完整代码部分：

（1）配置文件

application.properties

onlyoffice.server.url=http://<your_server_ip>
onlyoffice.server.secret=<your_secret_key>

（2）依赖管理

pom.xml

<dependencies><!-- Spring Boot Web Starter --><dependency><groupId>org.springframework.boot</groupId><artifactId>spring-boot-starter-web</artifactId></dependency><!-- Spring Boot Thymeleaf Starter (可选，用于模板引擎) --><dependency><groupId>org.springframework.boot</groupId><artifactId>spring-boot-starter-thymeleaf</artifactId></dependency><!-- Spring Boot Security Starter (可选，用于安全控制) --><dependency><groupId>org.springframework.boot</groupId><artifactId>spring-boot-starter-security</artifactId></dependency><!-- JSON处理库 --><dependency><groupId>com.fasterxml.jackson.core</groupId><artifactId>jackson-databind</artifactId></dependency></dependencies>

（3）控制器

DocumentController.java

packagecom.example.onlyoffice.controller;importcom.example.onlyoffice.config.OnlyOfficeConfig;importcom.example.onlyoffice.model.Document;importcom.example.onlyoffice.service.DocumentService;importorg.springframework.beans.factory.annotation.Autowired;importorg.springframework.http.ResponseEntity;importorg.springframework.web.bind.annotation.*;@RestController@RequestMapping("/documents")publicclassDocumentController{@AutowiredprivateOnlyOfficeConfig onlyOfficeConfig;@AutowiredprivateDocumentService documentService;@GetMapping("/{id}")publicResponseEntity<Document>getDocument(@PathVariableString id){Document document = documentService.getDocumentById(id);if(document ==null){returnResponseEntity.notFound().build();}returnResponseEntity.ok(document);}@PostMapping("/{id}")publicResponseEntity<Void>saveDocument(@PathVariableString id,@RequestBodyDocument document){
        documentService.saveDocument(id, document);returnResponseEntity.ok().build();}@GetMapping("/config/{id}")publicResponseEntity<Object>getConfig(@PathVariableString id){returnResponseEntity.ok(onlyOfficeConfig.getConfig(id));}}

（4）配置类

OnlyOfficeConfig.java

packagecom.example.onlyoffice.config;importorg.springframework.beans.factory.annotation.Value;importorg.springframework.stereotype.Component;importjava.util.HashMap;importjava.util.Map;@ComponentpublicclassOnlyOfficeConfig{@Value("${onlyoffice.server.url}")privateString serverUrl;@Value("${onlyoffice.server.secret}")privateString secretKey;publicMap<String,Object>getConfig(String documentId){Map<String,Object> config =newHashMap<>();
        config.put("document",Map.of("fileType","docx","key", documentId,"title","Sample Document","url", serverUrl +"/documents/"+ documentId
        ));
        config.put("documentType","word");
        config.put("editorConfig",Map.of("callbackUrl", serverUrl +"/documents/"+ documentId,"mode","edit","lang","en"));
        config.put("customization",Map.of("actionBar",false,"chat",false));return config;}}

（5）文档服务类

DocumentService.java

packagecom.example.onlyoffice.service;importcom.example.onlyoffice.model.Document;importorg.springframework.stereotype.Service;importjava.util.HashMap;importjava.util.List;importjava.util.Map;importjava.util.ArrayList;importjava.util.Collections;@ServicepublicclassDocumentService{privatefinalMap<String,Document> documents =newHashMap<>();privatefinalMap<String,List<Document>> history =newHashMap<>();publicDocumentgetDocumentById(String id){return documents.get(id);}publicvoidsaveDocument(String id,Document document){Document currentDocument = documents.get(id);if(currentDocument !=null){
            history.computeIfAbsent(id, k ->newArrayList<>()).add(currentDocument);}
        documents.put(id, document);}publicList<Document>getHistory(String id){return history.getOrDefault(id,Collections.emptyList());}}

（6）文档模型类

Document.java

packagecom.example.onlyoffice.model;importlombok.Data;@DatapublicclassDocument{privateString content;// 其他字段...}

（7）前端页面

index.html

<!DOCTYPEhtml><htmllang="en"><head><metacharset="UTF-8"><title>OnlyOffice Document Editor</title></head><body><divid="document-editor"style="height: 600px;"></div><scriptsrc="https://<your_server_ip>/web-apps/apps/api/documents/api.js"></script><script>asyncfunctionloadDocumentEditor(){const response =awaitfetch('/documents/config/<document_id>');const config =await response.json();newDocsAPI.DocEditor("document-editor", config);}

    window.onload = loadDocumentEditor;</script></body></html>

（8）用户服务类

UserService.java

（可选）

packagecom.example.onlyoffice.service;importorg.springframework.stereotype.Service;@ServicepublicclassUserService{publicbooleanhasAccess(String username,String documentId){// 这里实现具体的权限验证逻辑// 示例：假设所有用户都有访问权限returntrue;}}

（9）修改控制器以添加权限验证

DocumentController.java

packagecom.example.onlyoffice.controller;importcom.example.onlyoffice.config.OnlyOfficeConfig;importcom.example.onlyoffice.model.Document;importcom.example.onlyoffice.service.DocumentService;importcom.example.onlyoffice.service.UserService;importorg.springframework.beans.factory.annotation.Autowired;importorg.springframework.http.HttpStatus;importorg.springframework.http.ResponseEntity;importorg.springframework.security.core.annotation.AuthenticationPrincipal;importorg.springframework.security.core.userdetails.UserDetails;importorg.springframework.web.bind.annotation.*;@RestController@RequestMapping("/documents")publicclassDocumentController{@AutowiredprivateOnlyOfficeConfig onlyOfficeConfig;@AutowiredprivateDocumentService documentService;@AutowiredprivateUserService userService;@GetMapping("/{id}")publicResponseEntity<Document>getDocument(@PathVariableString id,@AuthenticationPrincipalUserDetails userDetails){if(!userService.hasAccess(userDetails.getUsername(), id)){returnResponseEntity.status(HttpStatus.FORBIDDEN).build();}Document document = documentService.getDocumentById(id);if(document ==null){returnResponseEntity.notFound().build();}returnResponseEntity.ok(document);}@PostMapping("/{id}")publicResponseEntity<Void>saveDocument(@PathVariableString id,@RequestBodyDocument document,@AuthenticationPrincipalUserDetails userDetails){if(!userService.hasAccess(userDetails.getUsername(), id)){returnResponseEntity.status(HttpStatus.FORBIDDEN).build();}
        documentService.saveDocument(id, document);returnResponseEntity.ok().build();}@GetMapping("/config/{id}")publicResponseEntity<Object>getConfig(@PathVariableString id,@AuthenticationPrincipalUserDetails userDetails){if(!userService.hasAccess(userDetails.getUsername(), id)){returnResponseEntity.status(HttpStatus.FORBIDDEN).build();}returnResponseEntity.ok(onlyOfficeConfig.getConfig(id));}}

以上代码涵盖了从配置文件、依赖管理、控制器、配置类、服务类、模型类到前端页面的完整实现。希望这些代码能帮助你在Spring Boot项目中成功集成OnlyOffice。如果有任何问题或需要进一步的帮助，请随时提问。

6. 安全性和权限管理

  • 权限控制：通过OnlyOffice提供的API设置文档的访问权限，例如只读、编辑等。
  • 后端验证：在Spring Boot后端实现相应的权限验证逻辑，确保只有授权用户才能访问特定的文档。

体验与测评

在实际使用中，OnlyOffice的表现令人满意。其界面设计简洁直观，用户可以轻松上手；编辑器响应速度快，即使在网络条件不佳的情况下也能保持流畅的操作体验。OnlyOffice对中文文档的支持也相当不错，无论是字体显示还是排版布局都达到了较高的水平。

  • 更快的文件加载速度：为了加快编辑器的打开速度，我们优化了加载脚本。与之前的版本相比：

打开普通文件 – 最高提速 

21%

打开演示文稿 – 最高提速 

17%

Excel：
请添加图片描述
PPT：
请添加图片描述
PDF：
在这里插入图片描述

当然也有一些不足之处需要注意。部分高级功能需要购买商业许可证才能使用，这可能会增加企业的成本负担。另外与其他一些在线文档编辑工具相比，OnlyOffice的社区活跃度稍显不足，遇到问题时可能难以获得及时的帮助和支持。
在这里插入图片描述

8.2 版本的其他更新：

协作编辑 PDF 文件；

文本文档中的域代码；

从第三方来源插入文本；

预设阿拉伯语数字编号；

电子表格中的迭代计算；

电子表格编辑器中的丝滑滚动；

在幻灯片上绘图；

演示文稿中的随机切换效果；

所有语言的词典更新和拼写检查改进；

新的图表类型，如直方图、瀑布图、漏斗图等。

结尾：ONLYOFFICE 项目介绍

OnlyOffice不仅仅是一款文档编辑工具，它背后是一个充满活力的开源项目。该项目始于2009年，由

Ascensio System SIA

公司发起并维护。多年来，OnlyOffice不断发展壮大，形成了一个包括文档编辑器、邮件客户端、项目管理等多个子项目的生态系统。目前，OnlyOffice在全球范围内拥有数百万用户，得到了广泛的认可和好评。

ONLYOFFICE 官网

标签： spring boot 后端 java
本文转载自: https://blog.csdn.net/weixin_50171134/article/details/143496126
版权归原作者 球球？ 所有， 如有侵权，请联系我们删除。
登录后发布评论

“SpringBoot项目集成ONLYOFFICE”的评论:

还没有评论
关于作者
...
overfit同步小助手
文章同步
相关阅读

网络安全法-网络运行安全

使用selenium/drissionpage时如何阻止chrome自动跳转http到https

docker desktop 里部署的Open WebUI 管理员密码忘记了的处理方法

在ubuntu20.04中搭建onsite比赛运行环境

利用开源的低代码表单设计器FcDesigner高效管理和渲染复杂表单结构

Kafka学习笔记

【前端】浏览器输入url到页面呈现发生了什么？

文章导航