跳到主要内容

Java Spring 示例

概述​

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

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

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

重要安全信息​

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

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

对于 Windows​

步骤 1. 安装 ONLYOFFICE 文档​

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

获取 ONLYOFFICE 编辑器

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

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

从我们的网站下载Java-Spring 示例。

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

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

其中 documentserver 是安装了 ONLYOFFICE 文档的服务器的名称，port 是任何可用的端口，而 files.storage 是创建和存储文件的路径（默认在项目文件夹中）。 您可以设置绝对路径。例如，D:\\folder。请注意，在 Windows 操作系统上，双反斜杠必须用作分隔符。

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

步骤 3. 安装先决条件​

要运行 Java-Spring 示例代码，请安装适用于您的操作系统和框架 Apache Maven 的 Java 版本 11：

步骤 4. 设置环境变量​

  1. 在 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%

  2. 设置 MAVEN_HOME 环境变量：

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

    C:\apache-maven-3.8.1

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

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

    单击环境变量按钮。

    在系统变量，单击新建。

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

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

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

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

    echo %MAVEN_HOME%

步骤 5. 使用 Maven 启动应用程序​

  1. 打开控制台并使用 cd 命令转到 java-spring 文件夹：

    cd C:\Program Files\document-server-integration\web\documentserver-example\java-spring

  2. 在打开的控制台中，输入以下命令：

    mvn clean
    mvn package
    mvn spring-boot:run

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

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

步骤 6. 检查可访问性​

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

对于 Linux​

步骤 1. 安装 ONLYOFFICE 文档​

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

获取 ONLYOFFICE 编辑器

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

步骤 2. 安装先决条件并使用编辑器运行网站​

  1. 按照此处说明安装 Java。

  2. 获取 Java-Spring 示例的方法有两种：

    • 下载包含 Java-Spring 示例的压缩文件并解压缩：
    wget https://github.com/ONLYOFFICE/document-server-integration/releases/latest/download/Java.Spring.Example.zip
    unzip Java.Spring.Example.zip
    • 克隆 git 存储库：
    git clone https://github.com/ONLYOFFICE/document-server-integration.git

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

    • 在归档中：
    cd Java\ Spring\ Example/
    • 在 git 存储库中：
    cd document-server-integration/web/documentserver-example/java-spring

  4. 编辑 src/main/resources/application.properties 配置文件。指定安装了 ONLYOFFICE 文档的本地服务器的名称。

    nano src/main/resources/application.properties

    编辑以下行：

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

    其中 documentserver 是安装了 ONLYOFFICE 文档的服务器的名称，port 是任何可用的端口，而 files.storage 是创建和存储文件的路径（默认在项目文件夹中）。您可以设置绝对路径。

  5. 安装 Maven:

    sudo apt-get install maven

  6. 构建：

    mvn package

  7. 启动 Java-Spring 示例：

    ./mvnw spring-boot:run

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

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

步骤 3. 检查可访问性​

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

对于 Docker​

步骤1. 安装ONLYOFFICE文档​

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

获取 ONLYOFFICE 编辑器

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

步骤2. 安装先决条件并使用编辑器运行网站​

  1. 按照此处说明安装 Java。

  2. 有两种方式获取 Java-Spring 示例：

    • 下载包含 Java-Spring 示例的存档并解压它：
    wget https://github.com/ONLYOFFICE/document-server-integration/releases/latest/download/Java.Spring.Example.zip
    unzip Java.Spring.Example.zip
    • 克隆 git 存储库：
    git clone https://github.com/ONLYOFFICE/document-server-integration.git

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

    • 在存档中：
    cd Java\ Spring\ Example/
    • 在 git 存储库中：
    cd document-server-integration/web/documentserver-example/java-spring

  4. 编辑 src/main/resources/application.properties 配置文件。指定安装了 ONLYOFFICE Docs 的本地服务器的名称：

    nano src/main/resources/application.properties

    编辑以下行：

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

    其中 documentserver 是安装了 ONLYOFFICE 文档的服务器的名称，port 是任何可用的端口，而 files.storage 是创建和存储文件的路径（默认在项目文件夹中）。您可以设置绝对路径。

  5. 在 Java-Spring 示例目录中运行下一个命令：

    docker-compose up

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

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

步骤3. 检查可访问性​

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