SpringBoot项目集成ONLYOFFICE

最新推荐文章于 2025-05-30 09:29:07 发布
最新推荐文章于 2025-05-30 09:29:07 发布
阅读量1.2k 收藏 25
点赞数 29
分类专栏： 面试 学习路线 阿里巴巴 文章标签： spring boot 后端 java
版权声明：本文为博主原创文章，遵循 CC 4.0 BY-SA 版权协议，转载请附上原文出处链接和本声明。
本文链接：https://blog.youkuaiyun.com/m0_66323401/article/details/145923245
版权

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”)
    public class DocumentController {

      @Value("${onlyoffice.server.url}")
  private String serverUrl;

  @Value("${onlyoffice.server.secret}")
  private String secretKey;

  @GetMapping("/{id}")
  public ResponseEntity<?> getDocument(@PathVariable String id) {
      // 调用OnlyOffice API获取文档编辑所需参数
      // ...
  }

  @PostMapping("/{id}")
  public ResponseEntity<?> saveDocument(@PathVariable String id, @RequestBody Document document) {
      // 处理文档保存逻辑
      // ...
  }

    }

4. 实现文档编辑功能

  • 前端集成：利用OnlyOffice提供的JavaScript API，在前端页面中嵌入文档编辑器。

5. 文档保存与版本控制

  • 保存文档：当用户完成编辑并保存文档时，OnlyOffice会将更新后的文档发送回指定的回调URL。

    @PostMapping(“/{id}”)
    public ResponseEntity<?> saveDocument(@PathVariable String id, @RequestBody Document document) {
    // 将文档保存到数据库或文件系统中
    // 记录版本信息
    return ResponseEntity.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
package com.example.onlyoffice.controller;

import com.example.onlyoffice.config.OnlyOfficeConfig;
import com.example.onlyoffice.model.Document;
import com.example.onlyoffice.service.DocumentService;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.http.ResponseEntity;
import org.springframework.web.bind.annotation.*;

@RestController
@RequestMapping("/documents")
public class DocumentController {

    @Autowired
    private OnlyOfficeConfig onlyOfficeConfig;

    @Autowired
    private DocumentService documentService;

    @GetMapping("/{id}")
    public ResponseEntity<Document> getDocument(@PathVariable String id) {
        Document document = documentService.getDocumentById(id);
        if (document == null) {
            return ResponseEntity.notFound().build();
        }
        return ResponseEntity.ok(document);
    }

    @PostMapping("/{id}")
    public ResponseEntity<Void> saveDocument(@PathVariable String id, @RequestBody Document document) {
        documentService.saveDocument(id, document);
        return ResponseEntity.ok().build();
    }

    @GetMapping("/config/{id}")
    public ResponseEntity<Object> getConfig(@PathVariable String id) {
        return ResponseEntity.ok(onlyOfficeConfig.getConfig(id));
    }
}
（4）配置类 OnlyOfficeConfig.java
package com.example.onlyoffice.config;

import org.springframework.beans.factory.annotation.Value;
import org.springframework.stereotype.Component;

import java.util.HashMap;
import java.util.Map;

@Component
public class OnlyOfficeConfig {

    @Value("${onlyoffice.server.url}")
    private String serverUrl;

    @Value("${onlyoffice.server.secret}")
    private String secretKey;

    public Map<String, Object> getConfig(String documentId) {
        Map<String, Object> config = new HashMap<>();
        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
package com.example.onlyoffice.service;

import com.example.onlyoffice.model.Document;
import org.springframework.stereotype.Service;

import java.util.HashMap;
import java.util.List;
import java.util.Map;
import java.util.ArrayList;
import java.util.Collections;

@Service
public class DocumentService {

    private final Map<String, Document> documents = new HashMap<>();
    private final Map<String, List<Document>> history = new HashMap<>();

    public Document getDocumentById(String id) {
        return documents.get(id);
    }

    public void saveDocument(String id, Document document) {
        Document currentDocument = documents.get(id);
        if (currentDocument != null) {
            history.computeIfAbsent(id, k -> new ArrayList<>()).add(currentDocument);
        }
        documents.put(id, document);
    }

    public List<Document> getHistory(String id) {
        return history.getOrDefault(id, Collections.emptyList());
    }
}
（6）文档模型类 Document.java
package com.example.onlyoffice.model;

import lombok.Data;

@Data
public class Document {
    private String content;
    // 其他字段...
}
（7）前端页面 index.html
<!DOCTYPE html>
<html lang="en">
<head>
    <meta charset="UTF-8">
    <title>OnlyOffice Document Editor</title>
</head>
<body>
<div id="document-editor" style="height: 600px;"></div>
<script src="https://<your_server_ip>/web-apps/apps/api/documents/api.js"></script>
<script>
    async function loadDocumentEditor() {
        const response = await fetch('/documents/config/<document_id>');
        const config = await response.json();

        new DocsAPI.DocEditor("document-editor", config);
    }

    window.onload = loadDocumentEditor;
</script>
</body>
</html>
（8）用户服务类 UserService.java（可选）
package com.example.onlyoffice.service;

import org.springframework.stereotype.Service;

@Service
public class UserService {

    public boolean hasAccess(String username, String documentId) {
        // 这里实现具体的权限验证逻辑
        // 示例：假设所有用户都有访问权限
        return true;
    }
}
（9）修改控制器以添加权限验证 DocumentController.java
package com.example.onlyoffice.controller;

import com.example.onlyoffice.config.OnlyOfficeConfig;
import com.example.onlyoffice.model.Document;
import com.example.onlyoffice.service.DocumentService;
import com.example.onlyoffice.service.UserService;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.http.HttpStatus;
import org.springframework.http.ResponseEntity;
import org.springframework.security.core.annotation.AuthenticationPrincipal;
import org.springframework.security.core.userdetails.UserDetails;
import org.springframework.web.bind.annotation.*;

@RestController
@RequestMapping("/documents")
public class DocumentController {

    @Autowired
    private OnlyOfficeConfig onlyOfficeConfig;

    @Autowired
    private DocumentService documentService;

    @Autowired
    private UserService userService;

    @GetMapping("/{id}")
    public ResponseEntity<Document> getDocument(@PathVariable String id, @AuthenticationPrincipal UserDetails userDetails) {
        if (!userService.hasAccess(userDetails.getUsername(), id)) {
            return ResponseEntity.status(HttpStatus.FORBIDDEN).build();
        }
        Document document = documentService.getDocumentById(id);
        if (document == null) {
            return ResponseEntity.notFound().build();
        }
        return ResponseEntity.ok(document);
    }

    @PostMapping("/{id}")
    public ResponseEntity<Void> saveDocument(@PathVariable String id, @RequestBody Document document, @AuthenticationPrincipal UserDetails userDetails) {
        if (!userService.hasAccess(userDetails.getUsername(), id)) {
            return ResponseEntity.status(HttpStatus.FORBIDDEN).build();
        }
        documentService.saveDocument(id, document);
        return ResponseEntity.ok().build();
    }

    @GetMapping("/config/{id}")
    public ResponseEntity<Object> getConfig(@PathVariable String id, @AuthenticationPrincipal UserDetails userDetails) {
        if (!userService.hasAccess(userDetails.getUsername(), id)) {
            return ResponseEntity.status(HttpStatus.FORBIDDEN).build();
        }
        return ResponseEntity.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 官网

springboot集成onlyoffice（部署+开发）
m0_74825565的博客
02-06 2542
最近有个项目需求是实现前端页面可以对word文档进行编辑，并且可以进行保存，于是一顿搜索，找到开源第三方onlyoffice，实际上onlyOffice有很多功能，例如文档转化、多人协同编辑文档、文档打印等，我们只用到了文档编辑功能。目 录前言1、onlyoffice的部署2、代码逻辑开发2.1、前端代码2.2、后端代码3、问题总结3.1、访问案例失败3.2、加载word文档失败3.3、系统后端有token验证问题3.4、使用文档地址访问问题4、后记开始敲黑板了。
OnlyOffice集成Springboot以及web端
世上哪有什么岁月静好,不过是有人替你负重前行
10-19 3281
上次我们已经搭建好了onlyoffice的服务，不知道如何搭建的伙伴可以看看上篇文章。以下是springboot和前端web简单集成的页面，亲测jdk8和jdk17都适用。
SpringBoot实现的在线实时编辑文档整合PageOffice：高效在线协作新体验
最新发布
gitblog_06762的博客
05-30 240
SpringBoot实现的在线实时编辑文档整合PageOffice：高效在线协作新体验 【下载地址】SpringBoot实现的在线实时编辑文档整合PageOffice 本项目基于SpringBoot框架，集成了PageOffice组件，实现在线实时编辑Word和Excel文档的功能。通过清晰的步骤解析，开发者可以快速掌握...
java整合onlyoffice的各种坑
Ntotl_的博客
06-16 8440
onlyoffice
Java集成Onlyoffice以及安装和使用示例，轻松实现word、ppt、excel在线编辑功能协同操作，Docker安装Onlyoffice
热门推荐
chenthe1的专栏
09-28 1万+
拉取onlyoffice镜像查看镜像是否下载完成启动onlyoffice以下是将本机的9001端口映射到docker的80端口上，访问时通过服务器ip：9001访问，并且用 -v 将本机机==/data/aws_s3/file-storage==文件夹挂载到docker的 /var/www/onlyoffice/documentserver/web-apps/wsData文件下，后续直接通过http请求读取对应的文件夹打开浏览器输入ip:9001出现以下页面就安装成功。
SpringBoot中整合ONLYOFFICE在线编辑
Logic_YSY的博客
07-01 7005
文件的在线编辑主要就是依托与onlyoffice实现的，而编辑器的配置是通过我们的接口来定义的，接口中的配置可以自由的定义编辑器的文件类型，窗口大小，文件来源，回调地址，保存类型等等。你需要编辑的文件可以放在任意的位置，只要你的接口可以通过流的方式给到onlyofiice编辑器即可。文件编辑后的处理都是在回调中处理的，最好先看一下文档的回调写法。回调的时候记得打印日志，观察一下接口的内容，一定要记得是通过回调中的url参数来获取编辑后的文件流的，并不是通过回调接口直接把文件流给到你。
ONLYOFFICE 文档8.2版本已发布：全新界面，全新功能，性能全面提升
记录学习路上的一些拙见
11-01 1157
ONLYOFFICE 是一个开源项目，专注于高级和安全的文档处理。坐拥全球超过 1500 万用户，ONLYOFFICE 是在线办公领域的创新者。ONLYOFFICE 办公套件提供文本文档、电子表格、幻灯片、表单和 PDF 编辑器。ONLYOFFICE 文档高度兼容 OOXML 文件，并提供数百种格式化和样式工具，以及多种协作功能。ONLYOFFICE 的编辑器具有实时和段落锁定两种共同编辑模式、评论和审阅、内置聊天和版本历史等多种功能。
springboot vue 初步集成onlyoffice
Mr_Wanter
08-08 6936
对接onlyoffice，实现文档的预览和在线编辑功能。
SpringBoot项目集成ONLYOFFICE如何离线部署
05-20
要在Spring Boot项目中集成ONLYOFFICE，你可以使用ONLYOFFICE Document Server API来实现。以下是离线部署的步骤： 1. 下载ONLYOFFICE Document Server的压缩包，解压到服务器上。 2. 在Spring Boot项目中集成ONLY...
SpringBoot集成onlyoffice实现word文档编辑保存
weixin_28746223的博客
08-27 1211
说明onlyoffice为一款开源的office在线编辑组件，提供word/excel/ppt编辑保存操作以下操作均基于centos8系统，officeonly镜像版本7.1.2.23镜像下载地址：https://yunpan.360.cn/surl_y87CKKcPdY4（提取码：1f92）已解除20连接限制已导入常...
springboot+vue2整合onlyoffice实现文档在线协同编辑
小黄鸭编程法
07-09 3564
为了保证onlyoffice配置不被修改，我这里将onlyoffice配置信息通过后端接口的形式获取，这里将onlyoffice配置信息配置在SpringBoot的配置文件中，如果不需要的话可以将这些配置直接写在前端的js代码中。这里需要注意的是：在对onlyoffice配置进行jwt加密时需要用到一个依赖。
Spring-boot+Vue 前后端快速集成onlyoffice
QQ909988322的博客
08-12 1万+
只介绍集成 不介绍搭建环境 可以引用 搭建环境的文章 前端集成 后端集成 权限验证 储存集成 上传与下载
springboot 集成onlyoffice 在线协同办公demo
daqinzl的专栏
07-16 2510
springboot 集成onlyoffice 在线协同办公demo
vue+springboot集成onlyoffice
10-22
Vue和Spring Boot都是非常流行和强大的开发框架，集成OnlyOffice可以提供一个完整的在线文档协作和编辑平台。 OnlyOffice是一个强大的在线办公套件，它支持多人协同编辑文档、电子表格和演示文稿等。Vue是一个用于构建用户界面的JavaScript框架，而Spring Boot是一个用于构建Java应用程序的框架。集成OnlyOffice即意味着我们可以在Vue和Spring Boot应用程序中实现在线文档协作和编辑功能。 在集成OnlyOffice时，首先我们需要在Vue中引入OnlyOffice的JavaScript SDK或使用其提供的Vue组件。这些组件可以用来在Vue应用程序中显示OnlyOffice文档编辑器。我们还可以使用OnlyOffice的API来实现文档的上传、下载和保存等功能。 在后端，我们可以使用Spring Boot提供的RESTful API来处理与OnlyOffice编辑器的交互。通过这些API，我们可以接收来自编辑器的请求并提供文档的相关操作，比如保存、下载和协同编辑等。 为了实现真正的协同编辑功能，我们可以使用WebSocket技术来实现实时通信。Vue和Spring Boot都有相应的WebSocket支持，我们可以使用它们来建立客户端和服务器之间的双向通信，以便在多个用户之间实现文档的协同编辑。 总结来说，Vue和Spring Boot集成OnlyOffice可以为我们提供一个完整的在线文档协作和编辑平台。在前端，我们可以使用Vue和OnlyOffice的JavaScript SDK或Vue组件来实现在线文档编辑器的显示和操作。在后端，使用Spring Boot提供的API来处理与OnlyOffice编辑器的交互，并借助WebSocket技术实现实时通信和协同编辑功能。通过这样的集成，我们可以轻松构建一个强大的在线文档协作平台。
评论
添加红包

请填写红包祝福语或标题

个

红包个数最小为10个

元

红包金额最低5元

当前余额3.43元 前往充值 >
需支付：10.00元
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付元
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明：

1.余额是钱包充值的虚拟货币，按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载，可以购买VIP、付费专栏及课程。

余额充值