SpringBoot实战（二十八）集成 Collabora Online 实现在线编辑

目录

    • 一、什么是 Collabora Online？
    • 二、Docker 下载并启动 CODE
      • 2.1 拉取镜像
      • 2.2 启动镜像
      • 2.3 访问界面
      • 2.4 补充：nextcloud 的镜像启动
    • 三、SpringBoot 实现 WOPI 服务
      • 3.1 什么是WOPI？
      • 3.2 Spring Boot 简单实现
      • 3.3 另一种实现方式
      • 3.4 总结
    • 四、补充：coolwsd.xml 核心配置介绍
      • coolwsd.xml 核心配置1：<alias_groups>
      • coolwsd.xml 核心配置2：\<ssl\>
      • coolwsd.xml 核心配置3：\<frame_ancestors>
      • coolwsd.xml 核心配置4：\<service_root>
    • 五、踩坑记录
      • 5.1 nginx配置踩坑

  • Collabora Online 官网地址： https://www.collaboraoffice.com/
  • SDK官网地址： https://sdk.collaboraonline.com/
  • 官方文档： https://sdk.collaboraonline.com/
  • GitHub： https://github.com/CollaboraOnline/online
  • WOPI 官方文档： https://api.onlyoffice.com/zh/editors/wopi/discovery
  • 官方 nodejs demo： https://github.com/CollaboraOnline/collabora-online-sdk-examples//tree/master/webapp/nodejs

一、什么是 Collabora Online？

Collabora Onlnien 是一款 开源的 基于 LibreOffice 的云办公套件，它允许用户在浏览器中 创建、编辑和协作处理文档、电子表格、演示文稿和绘图。它是由 Collabora Productivity Ltd 开发的，这家公司是 LibreOffice 社区的主要贡献者之一。

页面如下所示：

在这里插入图片描述

点进 Collabora Online 的主页我们可以看到，它的核心产品主要包含如下三类：

  • Collabora Online： 是一款基于 Web 的在线办公套件，用户可以通过浏览器访问和使用，不需要在本地计算机上安装任何软件。
  • Collabora Office： 是一款桌面版的办公套件，可在 Windows、macOS 和 Linux 上本地安装。
  • Collabora Online Development Edition： 缩写为 CODE，直译过来就是 Collabora Online 的 开发版，可以在项目中集成后使用。

这里我们主要使用的就是其中的开发版的 CODE。在 CODE 中已经实现了很多的成熟的集成方式：

  • Alfresco integration：（Java集成）
    git clone https://github.com/CollaboraOnline/alfresco-collabora-online.git
  • EGroupware integration：
    git clone https://github.com/EGroupware/collabora.git
  • Mattermost integration：
    git clone https://github.com/CollaboraOnline/collabora-mattermost.git
  • Collaborative document editing：
    git clone https://github.com/learnweb/moodle-mod_collabora.git
  • Collaborative submissions：
    git clone https://github.com/CollaboraOnline/collabora-mattermost.git
  • Nextcloud integration：（PHP集成）
    git clone https://github.com/CollaboraOnline/richdocumentscode.git
  • ownCloud integration：（PHP集成）
    git clone https://github.com/CollaboraOnline/richdocumentscode-owncloud.git

（参考：https://sdk.collaboraonline.com/docs/available_integrations.html）

下面是我们使用 SpringBoot 集成 Collabora Online 后的请求过程：

在这里插入图片描述

下面我们就来说一下如何下载并启动 CODE 镜像以及如何使用 SpringBoot 集成后实现文件的在线编辑和预览。

二、Docker 下载并启动 CODE

2.1 拉取镜像

  • 官方的镜像地址： https://hub.docker.com/r/collabora/code/

首先，使用如下命令拉取镜像：

docker pull collabora/code:latest

拉取过程如下，速度会有些慢：

在这里插入图片描述

可以使用阿里的镜像源，加快拉取速度：

{
   
 "registry-mirrors":["https://6kx4zyno.mirror.aliyuncs.com"]
}

拉取完毕之后，镜像如下所示：

在这里插入图片描述

2.2 启动镜像

镜像拉取完毕之后，使用如下命令启动镜像即可：

docker run \
--name "collabora_code" \
-t \
-d \
-p 0.0.0.0:9980:9980 \
-e "username=admin" \
-e "password=Pwd4C0De" \
--cap-add MKNOD \
--privileged \
-v /etc/collabora/coolwsd.xml:/etc/coolwsd/coolwsd.xml \
collabora/code:latest

补充：--privileged 是让当前容器的用户即使不是 root，也可以执行任何需要root权限的操作。

coolwsd.xml 是 Collabora Online 的配置文件，它控制着 Collabora Online 服务中 是否启用 TSL/SSL 加密、字体资源位置、对特定 IP 或域名的访问控制 等各种参数的设置。

  • coolwsd：Collabora Online Web Service Daemon 的缩写，它是一个守护进程，运行在服务器上，是 Collabora Online 办公套件的核心组件之一。coolwsd 主要负责提供后台服务，是的用户能够 通过 Web 浏览器访问和使用 LibreOffice 功能，从而实现在线文档编辑和写作。

CODE 镜像 docker run 常用挂载项：

  • 指定 coolwsd.xml 配置文件，里面包含了 CODE 的最最核心配置：

    -v /yourPath/coolwsd.xml:/etc/coolwsd/coolwsd.xml

  • 指定标签页上面的icon图标：

    -v /yourPath/favicon.ico:/usr/share/coolwsd/favicon.ico

  • 指定页面内的系统logo图案：

    -v /yourPath/toolbar-bg-logo.svg:/usr/share/coolwsd/browser/dist/images/toolbar-bg-logo.svg

  • 指定页面内可供使用的字体：（Windows字体可以去 C:\Windows\Fonts\ 路径下找）

    -v /yourPath/winFonts:/opt/cool/systemplate/usr/share/fonts/truetype \

    -v /yourPath/winFonts:/usr/share/fonts/truetype \
    -v /yourPath/winFonts:/opt/collaboraoffice/share/fonts/truetype

  • 指定页面上工具栏哪些可以显示：

    -v /yourPath/bundle.js:/usr/share/coolwsd/browser/dist/bundle.js

2.3 访问界面

  • 在线编辑地址： http://localhost:9980/browser/5303504/cool.html?WOPISrc=http%3A%2F%2F192.168.1.195%3A8080%2Fwopi%2Ffiles%2F92&lang=zh-CN&access_token=123

注意：

  1. 在线编辑地址后面的 WOPISrc 要拼接 WOPI 服务地址的，所以目前还不能访问。可以先访问下管理系统地址。
  2. 通过cool.html访问时，后面传输的任何参数，例如 access_token 都会被转发到对应的 WOPI 服务的请求上，用于鉴权等操作。
  • 管理界面地址： http://localhost:9980/browser/dist/admin/admin.html

访问地址后，界面如下所示：

在这里插入图片描述

2.4 补充：nextcloud 的镜像启动

nextcloud 使用了 PHP 语言集成了 Collabora Online 的一套成熟的系统。

  • 官网地址： https://nextcloud.com/

首先使用如下命令拉取镜像：

docker pull nextcloud:latest

使用如下命令启动镜像：

docker run \
--name nextcloud_test \
-d \
--restart=always \
-p 8880:80 \
  • 访问地址： http://localhost:8880/
  • 账号/密码： admin/Pwd4C0De（由 CODE 启动时指定）

三、SpringBoot 实现 WOPI 服务

3.1 什么是WOPI？

WOPI：全称为 Web Office Protocol Interface，是一种由微软提出的协议，旨在允许 Web 应用程序能够无缝地与 Office 文档进行交互。WOPI 主要应用于在线编辑和预览 Microsoft Office 文档的场景，使得用户可以在 Web应用中直接打开、编辑和保存 Office 文档，而无需下载文档到本地或安装 Office 套件。

  • 官方文档： https://api.onlyoffice.com/zh/editors/wopi/discovery

其实 WOPI 协议就是一系列规定了接口地址、入参/出参的 RESTful 接口规范。核心的接口主要有3个：

  1. 获取文件信息接口：/wopi/file/{id}，Get请求

    这个接口可以 获取文件的名称、大小、是否可编辑等信息。

    （参考：https://api.onlyoffice.com/zh/editors/wopi/restapi/checkfileinfo）

  2. 获取文件内容接口：/files/{id}/contents，GET请求

    这个接口可以 读取文件的信息，以字节流的形式返回。

    （参考：https://api.onlyoffice.com/zh/editors/wopi/restapi/getfile）

  3. 写入文件内容接口：/files/{id}/contents，POST请求

    这个接口用于 写入文件内容，即保存编辑后的内容，将文件流写入文件。

    （参考：https://api.onlyoffice.com/zh/editors/wopi/restapi/putfile）

3.2 Spring Boot 简单实现

WopiController.java

（接口类，用于校验权限、操作文件）

import com.demo.common.model.auth.details.LoginUserUtil;
import com.demo.common.web.Result;
import com.demo.online.vo.WopiFileInfoVO;
import io.swagger.annotations.ApiOperation;
import lombok.extern.slf4j.Slf4j;
import org.springframework.web.bind.annotation.*;

import javax.annotation.Resource;
import javax.servlet.ServletInputStream;
import javax.servlet.http.HttpServletRequest;
import java.io.IOException;
import java.nio.file.Paths;
import java.nio.file.StandardCopyOption;
import java.util.Objects;

/**
 * <p> @Title WopiController
 * <p> @Description WOPI在线编辑Controller
 *
 * @author ACGkaka
 */
@Slf4j
@RestController
@RequestMapping("/wopi")
public class WopiController {
   

    @Resource
    private FileInfoService fileInfoService;

    @ApiOperation("在线编辑-根据ID查询文件信息")
    @GetMapping("/files/{id}")
    public WopiFileInfoVO findWopiFileInfoById(@PathVariable("id") String id) {
   
        // 查询信息
        FileInfo file = fileInfoService.getAndCheckPermissionById(id);
        Integer fileSize = file.getSize();
        // 记录日志
        LoginUser loginUser = LoginUserUtil.getLoginUser();
        log.info(">>>>>>>>>>【INFO】WOPI文件信息，uid：{}，userName：{}，eid：{}，orgName：{}，fileInfoId：{}，fileInfoName：{}，editFlag：{}",
                loginUser.getId(), loginUser.getUsername(), loginUser.getEid(), loginUser.getOrgName(), id, fileInfo.getFileInfoName(), fileInfo.getEditFlag());
        // 封装返回
        return new WopiFileInfoVO(fileInfo.getFileInfoName(), fileSize, Objects.equals(fileInfo.getEditFlag(), "1"));
    }

    @ApiOperation("在线编辑-根据ID查询文件内容")
    @GetMapping("/files/{id}/contents")
    public byte[] findWopiFileContentsById(@PathVariable("id") String id) {
   
        fileInfo file = fileInfoService.getAndCheckPermissionById(id);
        return fileInfoService.getBytes(file.getId());
    }

    @ApiOperation("在线编辑-根据ID查询文件内容")
    @PostMapping("/files/{id}/contents")
    public Result<Object> saveWopiFileContentsById(@PathVariable("id") String id, HttpServletRequest request) {
   
        fileInfo fileInfo = fileInfoService.getAndCheckPermissionById(id);
        if (!Objects.equals(fileInfo.getEditFlag(), "1")) {
   
            LoginUser loginUser = SysUserUtil.getloginUser();
            log.error(">>>>>>>>>>【ERROR】暂无权限在线编辑该文件，请确认后重试，fileInfo.getEditFlag()：{}，fileInfo.getId()：{}，uid：{}",
                    fileInfo.getEditFlag(), fileInfo.getId(), loginUser.getId());
            throw new IllegalArgumentException("暂无权限在线编辑该文件，请确认后重试");
        }
        FileInfo fileInfo = fileInfoService.getFileInfo(fileInfo.getFileInfoId());
        if (fileInfo == null) {
   
            log.error(">>>>>>>>>>【ERROR】在线文件信息未找到，请刷新后重试，fileInfoId：{}", fileInfo.getFileInfoId());
            throw new IllegalArgumentException("在线文件信息未找到，请刷新后重试");
        }
        writeToFile(Paths.get(fileInfo.getCatalogue() + fileInfo.getPath()), request);
        return Result.succeed();
    }

    /**
     * 将 request 内容写入文件
     */
    private void writeToFile(java.nio.file.Path path, HttpServletRequest request) {
   
        ServletInputStream inputstream;
        try {
   
            inputstream = request.getInputStream();
            java.nio.file.Files.copy(inputstream, path, StandardCopyOption.REPLACE_EXISTING);
        } catch (IOException e) {
   
            log.error(">>>>>>>>>>【ERROR】在线文件写入失败，请刷新后重试，原因：{}", e.getMessage(), e);
            throw new IllegalArgumentException("在线文件写入失败，请刷新后重试");
        }
    }
}

WopiFileInfoVO.java

（实体类，用于封装文件信息）

import com.demo.common.model.auth.details.LoginUserUtil;
import com.alibaba.fastjson.JSONObject;
import com.fasterxml.jackson.annotation.JsonProperty;
import lombok.AllArgsConstructor;
import lombok.Data;
import lombok.NoArgsConstructor;
import lombok.extern.slf4j.Slf4j;

/**
 * <p> @Title WopiFilesByIdVO
 * <p> @Description 文件信息封装（参考文档：https://api.onlyoffice.com/zh/editors/wopi/restapi/checkfileinfo）
 *
 * @author ACGkaka
 * @date 2024/5/28 19:34
 */
@Slf4j
@Data
@NoArgsConstructor
@AllArgsConstructor
public class WopiFileInfoVO {
   

    /**
     * 文件名称（例：test.docx）
     */
    @JsonProperty("BaseFileName")
    private String BaseFileName;
    /**
     * 版本（每次编辑和保存文档时，都必须更改版本。 给定文件的版本号不得重复。例：Khirz6zTPdfd7）
     */
    @JsonProperty("Version")
    private String Version = "Version";
    /**
     * 面包屑导航——客户端向用户显示的名称，用于指示 WOPI 服务器的品牌名称。
     */
    @JsonProperty("BreadcrumbBrandName")
    private String BreadcrumbBrandName = "5G随e签";
    /**
     * 面包屑导航——当用户单击显示 BreadcrumbBrandName的 UI 时，WOPI 客户端导航到的网页的 URL。
     */
    @JsonProperty("BreadcrumbBrandUrl")
    private String BreadcrumbBrandUrl = "https://esign.it.10086.cn/saas/#/login";
//    /**
//     * 面包屑导航——WOPI 客户端向用户显示的文件名。如果未指定此参数，则使用 BaseFileName 参数。
//     */
//    @JsonProperty("BreadcrumbDocName")

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

如若内容造成侵权/违法违规/事实不符，请联系我们进行投诉反馈qq邮箱809451989@qq.com，一经查实，立即删除！

相关文章

SpringBoot集成beetl模板快速入门

SpringBoot集成beetl模板快速入门

在pom文件引入maven依赖 <dependency><groupId>com.ibeetl</groupId><artifactId>beetl-framework-starter</artifactId><version>1.1.81.RELEASE</version></dependency>写一个controller /*** author * create * descripti…
阅读更多...
Java开发-实际工作经验和技巧-0005-使用MapStruct进行两个实体类的转换,出现所有属性值都为null的情况

Java开发-实际工作经验和技巧-0005-使用MapStruct进行两个实体类的转换,出现所有属性值都为null的情况

Java开发-实际工作经验和技巧-0005-使用MapStruct进行两个实体类的转换,出现所有属性值都为null的情况 更多内容欢迎关注我&#xff08;持续更新中&#xff0c;欢迎Star✨&#xff09; Github&#xff1a;CodeZeng1998/Java-Developer-Work-Note 技术公众号&#xff1a;Code…
阅读更多...
推荐系统三十六式学习笔记：原理篇.MAB问题|16|简单却有效的Bandit算法

推荐系统三十六式学习笔记：原理篇.MAB问题|16|简单却有效的Bandit算法

目录 推荐就是选择MAB问题Bandit算法1.汤普森采样算法2.UCB算法3.Epsilon贪婪算法4.效果对比 冷启动总结 推荐系统的使命就是建立用户和物品之间的连接。建立连接可以理解成;为用户匹配到最佳的物品&#xff1b;但也有另一个理解就是&#xff0c;在某个时间某个位置为用户选择最…
阅读更多...
Redis 管道(Pipeline)是什么？有什么用？

Redis 管道(Pipeline)是什么？有什么用？

目录 1. redis 客户端-服务端模型的不足之处 2. redis 管道是什么&#xff1f;有什么好处&#xff1f; 3. 管道的使用场景 4. 管道使用的注意事项 1. redis 客户端-服务端模型的不足之处 众所周知&#xff0c;redis 是一个客户端-服务端的模型设计&#xff0c;客户端向服务…
阅读更多...
Zoom视颊会议软件使用

Zoom视颊会议软件使用

GPT-3.5 (OpenAI) Zoom是一款极受欢迎的视频会议软件。使用Zoom可以方便地进行视频会议、远程授课、在线研讨会等活动。以下是Zoom的使用步骤&#xff1a; 1. 下载Zoom客户端 可以在Zoom官网上下载对应平台的Zoom客户端。下载并完成安装后&#xff0c;双击打开客户端。 2. 创建…
阅读更多...
大数据开发中如何计算用户留存及SQL示例

大数据开发中如何计算用户留存及SQL示例

在大数据开发领域&#xff0c;用户留存是一个关键指标&#xff0c;它反映了产品吸引并保留用户的能力。 留存率的计算不仅有助于评估产品的健康状况&#xff0c;还能为产品优化和市场策略提供重要依据。 本文将详细介绍如何在大数据开发中计算用户留存&#xff0c;并附带具体…
阅读更多...
大数据之路 读书笔记 Day2

大数据之路 读书笔记 Day2

大数据之路 读书笔记 Day2 日志采集——浏览器的页面采集 一、分类 #mermaid-svg-8c9sRexRDdSB9pWA {font-family:"trebuchet ms",verdana,arial,sans-serif;font-size:16px;fill:#333;}#mermaid-svg-8c9sRexRDdSB9pWA .error-icon{fill:#552222;}#mermaid-svg-8c9…
阅读更多...
【论文解读】CVPR2024：DUSt3R: Geometric 3D Vision Made Easy

【论文解读】CVPR2024：DUSt3R: Geometric 3D Vision Made Easy

论文“”https://openaccess.thecvf.com/content/CVPR2024/papers/Wang_DUSt3R_Geometric_3D_Vision_Made_Easy_CVPR_2024_paper.pdf 代码&#xff1a;GitHub - naver/dust3r: DUSt3R: Geometric 3D Vision Made Easy DUSt3R是一种旨在简化几何3D视觉任务的新框架。作者着重于…
阅读更多...
002-关于Geogebra软件的介绍及与MatLab的区别

002-关于Geogebra软件的介绍及与MatLab的区别

为什么要学Geogebra&#xff1f; 因为和MatLab的科学计算相比&#xff0c;GeoGebra重点突出教学展示&#xff0c;对于教师、学生人群来讲再合适不过了&#xff0c;尤其是可以融入到PPT里边呈现交互式动画&#xff0c;想想听众的表情&#xff01;这不就弥补了看到PPT播放数学公…
阅读更多...
邮箱smtp发送邮件失败的原因？怎么做排查？

邮箱smtp发送邮件失败的原因？怎么做排查？

邮箱smtp发送邮件失败的解决方法&#xff1f;SMTP错误代码解析&#xff01; 在使用SMTP发送邮件时&#xff0c;我们时常会遇到各种问题&#xff0c;导致邮件发送失败。了解这些问题的根本原因可以帮助我们更好地解决它们。AoKSend将详细探讨邮箱SMTP发送邮件失败的几大原因&am…
阅读更多...
在 WebGPU 与 Vulkan 之间做出正确的选择（Making the Right Choice between WebGPU vs Vulkan）

在 WebGPU 与 Vulkan 之间做出正确的选择（Making the Right Choice between WebGPU vs Vulkan）

在 WebGPU 与 Vulkan 之间做出正确的选择&#xff08;Making the Right Choice between WebGPU vs Vulkan&#xff09; WebGPU 和 Vulkan 之间的主要区别WebGPU 是什么&#xff1f;它适合谁使用&#xff1f;Vulkan 是什么&#xff1f;它适合谁使用&#xff1f;WebGPU 和 Vulkan…
阅读更多...
mac 上 Docker Desktop的免费开源的替代工具Colima

mac 上 Docker Desktop的免费开源的替代工具Colima

当谈到在macOS上运行容器时&#xff0c;Docker长期以来一直是首选。但是&#xff0c;必须解决使用适用于macOS的Docker Desktop时出现的一些限制&#xff0c;特别是对于大中型公司&#xff0c;最大的问题是需要购买许可证。另外&#xff0c;macOS 版Docker Desktop的性能问题也…
阅读更多...
单调栈（左小大，右小大）

单调栈（左小大，右小大）

①寻找每个数左边第一个比它小的数 给定一个长度为 N 的整数数列&#xff0c;输出每个数左边第一个比它小的数&#xff0c;如果不存在则输出 −1。 输入样例&#xff1a; 3 4 2 7 5 输出样例&#xff1a; -1 3 -1 2 2 从左到右遍历&#xff0c;用单调递增&#xff08;栈底到栈顶…
阅读更多...
c-＞c++(二):class

c-＞c++(二):class

本文主要探讨C类的相关知识。 构造和析构函数 构造函数(可多个)&#xff1a;对象产生时调用初始化class属性、分配class内部需要的动态内存 析构函数&#xff08;一个&#xff09;&#xff1a;对对象消亡时调用回收分配动态内存 C提供默认构造和析构,…
阅读更多...
行人检测技术：思通数科大模型在自动驾驶安全中的应用

行人检测技术：思通数科大模型在自动驾驶安全中的应用

在自动驾驶技术飞速发展的今天&#xff0c;行人检测已成为确保道路交通安全的关键技术之一。本文将探讨如何结合思通数科大模型和计算机视觉技术&#xff0c;实现在城市交通环境中对行人的高效检测&#xff0c;为自动驾驶车辆提供必要的行人安全保障。 引言 行人检测技术是利…
阅读更多...
Dubbo内部通信流程

Dubbo内部通信流程

我当时在学习的过程中搭建过demo&#xff0c;具体流程就是&#xff0c;我先定义了一个api接口模块&#xff0c;还定义一个服务提供者模块&#xff0c;然后服务提供方实现该接口&#xff0c;定义该方法具体的实现impl类&#xff0c;服务提供方启动时&#xff0c;将要暴露的服务和…
阅读更多...
【架构-20】死锁

【架构-20】死锁

什么是死锁&#xff1f; 死锁(Deadlock)是指两个或多个线程/进程在执行过程中,由于资源的互相占用和等待,而陷入一种互相等待的僵局,无法继续往下执行的情况。 产生死锁的四个必要条件: &#xff08;1&#xff09;互斥条件(Mutual Exclusion)&#xff1a;至少有一个资源是非共享…
阅读更多...
跨阻放大器

跨阻放大器

#创作灵感# 最近涉及到微电流的监测项目&#xff0c;而里面的核心就是跨阻放大器&#xff0c;所以这里做一个简单的介绍&#xff0c;后续等项目完成了&#xff0c;再做一个实例的介绍。 #正文# 跨阻放大器&#xff08;Transimpedance Amplifier, TIA&#xff09;是一种将输入电…
阅读更多...
Windows编程之多线程事件对象（Event Object）用法详解

Windows编程之多线程事件对象（Event Object）用法详解

目录 一、前言 二、基础用法 三、API详解 1.创建事件对象 2控制事件状态 3.等待事件对象&#xff1a; 四、实战案例 1.案例描述 2.代码设计 3.总设计代码 4.运行结果 一、前言 事件对象&#xff08;Event Object&#xff09;是我们在大型项目中&#xff0c;进行多线…
阅读更多...
股价持续低迷，业绩颓势不减，冀光恒难救平安银行？

股价持续低迷，业绩颓势不减，冀光恒难救平安银行？

文&#xff5c;新熔财经 作者&#xff5c;宏一 周一一上班&#xff0c;就听到旁边的同事感慨今年股市行情很不错&#xff0c;尤其是银行股&#xff0c;上半年累计上涨了17.02%&#xff0c;是涨幅最大的板块。 听到这里&#xff0c;我美滋滋地打开自己的账户&#xff0c;结…
阅读更多...
最新文章

Copyright @ 2022~2023

友情链接： 我的编程经验分享 一条长河网 尧图网站开发 尧图建网站