跳到主要内容

Java Spring 示例

概述​

此示例将帮助您将 ONLYOFFICE 文档集成到用 Java with Spring Boot 编写的 Web 应用程序中。

Spring Boot 有很多功能，但它最重要的特性是：依赖管理、自动配置和内置的 servlet 容器。

警告

它用于测试和演示编辑器的功能。如果没有适当的代码修改，请不要在自己的服务器上使用此集成示例。如果您启用了测试示例，请在投入生产之前将其禁用。

重要安全信息​

在使用测试示例时，请记住以下几方面的安全事项：

  • 由于不需要授权，因此无法保护存储免受未经授权的访问。
  • 没有检查链接中的参数替换，因为参数是由代码根据预先安排的脚本生成的。
  • 在编辑后保存文件的请求中没有数据检查，因为每个测试示例仅适用于来自 ONLYOFFICE 文档的请求。
  • 没有禁止使用来自其他网站的测试示例，因为它们用于与来自另一个域的 ONLYOFFICE 文档进行交互。

安装​

步骤 1. 安装 ONLYOFFICE 文档​

下载并安装 ONLYOFFICE 文档（打包为文档服务器）：

获取 ONLYOFFICE 编辑器

请参阅详细指南以了解如何安装适用于 Windows的 ONLYOFFICE 文档。

步骤 2. 下载用于编辑器集成的 Java 代码​

下载发布存档并解压，或从 GitHub 克隆源代码：

curl --output Java.Spring.Example.zip --location https://github.com/ONLYOFFICE/document-server-integration/releases/latest/download/Java.Spring.Example.zip
tar -xf Java.Spring.Example.zip

将当前目录更改为项目目录：

cd "Java Spring Example"

步骤 3. 安装先决条件​

安装适用于您的操作系统和框架 Apache Maven 的 Java 版本 11：

在 Windows 上安装 Java 后，将 JAVA_HOME 环境变量设置为指向 Java 安装目录。

找出 Java 的安装位置。如果您在安装过程中没有更改路径，它将是这样的：

C:\Program Files\Java\jdk11

在 Windows 7 中，右键单击我的电脑并选择属性，然后单击高级。

在 Windows 8中，进入控制面板并选择系统，然后单击高级系统设置。

单击环境变量按钮。

在系统变量，单击新建。

在变量名称字段中，如果您安装了JDK（Java 开发工具包），请输入 JAVA_HOME；如果您安装了 JRE（Java 运行时环境），请输入JRE_HOME。

在变量值字段中，输入您的 JDK 或 JRE 安装路径，例如 C:\Program Files\Java\jdk11。

检查命令提示符中的 echo 命令是否成功创建变量：

echo %JAVA_HOME%

设置 MAVEN_HOME 环境变量：

使用 Maven 将下载的压缩文件解压缩到任意目录。它会是这样的：

C:\apache-maven-3.8.1

在 Windows 7 中，右键单击我的电脑并选择属性，然后单击高级。

在 Windows 8中，进入控制面板并选择系统，然后单击高级系统设置。

单击环境变量按钮。

在系统变量，单击新建。

在变量名称字段中，输入 MAVEN_HOME。

在变量值字段中，输入您的 Maven 安装路径，例如 C:\apache-maven-3.8.1。

在系统变量中，找到 PATH，单击编辑...按钮。在编辑环境变量对话框中，单击新建按钮并将 C:\apache-maven-3.8.1\bin 添加到 PATH 系统变量。

检查命令提示符中的 echo 命令是否成功创建变量：

echo %MAVEN_HOME%

步骤 4. 配置应用程序​

要将编辑器连接到您的网站，请在 src/main/resources/application.properties 文件中指定编辑器安装的路径和存储文件夹的路径：

files.storage=
server.port=port
files.docservice.url.site=https://documentserver/

其中 documentserver 是安装了 ONLYOFFICE 文档的服务器的名称，port 是任何可用的端口，而 files.storage 是创建和存储文件的路径（默认在项目文件夹中）。您可以注册一个免费的 ONLYOFFICE 云，并使用其公共 IP 地址或公共 DNS，这些地址或 DNS 可以在云控制台的实例部分找到。 您可以设置绝对路径。例如，D:\\folder。请注意，在 Windows 操作系统上，双反斜杠必须用作分隔符。

如果要试验编辑器配置，请修改 src/main/webapp/editor.jsp 文件中的参数。

步骤 5. 配置 JWT​

打开 src/main/resources/application.properties 文件，并与 ONLYOFFICE 文档指定相同密钥 以启用 JWT：

docservice.security.key=secret

步骤 6. 构建并运行​

在项目目录中，输入以下命令：

mvn clean
mvn package
mvn spring-boot:run

使用 server.address 和 server.port 打开浏览器：

http://server.address:server.port/

步骤 7. 检查可访问性​

如果示例和 ONLYOFFICE 文档安装在不同的计算机上，请确保安装了示例的服务器可以访问您指定地址的 ONLYOFFICE 文档，而不是配置文件中的 documentserver。

确保 ONLYOFFICE 文档能够访问安装了示例的服务器，该示例使用您指定的地址而不是配置文件中的 example.com。您可以注册一个免费的 ONLYOFFICE 云，并使用其公共 IP 地址或公共 DNS，这些地址或 DNS 可以在云控制台的实例部分找到。