README.md · 韩小明同学/lucy-onlyoffice

## 介绍

`lucy-onlyoffice`是依赖于`onlyoffice`的`springboot`集成解决方案，该解决方案简化了`onlyoffice`的使用难度，支持对常见文档类型的预览，编辑和转化。该解决方案提供了功能的拓展实现，用户可以基于拓展接口，实现业务系统和该解决方案的集成。

- [x] 支持 doc、docx、xlsx、pptx 等常见 `office`格式文件的预览和编辑 ，完整支持列表如下:
  - **word** - 文本文档 （*.djvu、.doc、.docm、.docx、.docxf、.dot、.dotm、.dotx、.epub、.fb2、.fodt、.htm、.html、.mht、.mhtml、.odt、.oform、.ott、.oxps、.pdf、.rtf、.stw、.sxw、.txt、.wps、.wpt、.xml、.xps*），
  - **cell** - 电子表格 (*.csv、.et、.ett、.fods、.ods、.ots、.sxc、.xls、.xlsb、.xlsm、.xlsx、.xlt、.xltm、.xltx、.xml*），
  - **slide** - 演示文稿 （*.dps、.dpt、.fodp、.odp、.otp、.pot、.potm、.potx、.pps、.ppsm、.ppsx、.ppt、.pptm、.pptx、.sxi*）。
- [x] 支持 文件转化为 `pdf`
- [x] 支持 生成文件缩略图

## 安装

使用该功能之前，需要完成[【OnlyOffice安装】](https://lucy.apisev.cn/#/lucy-onlyoffice/onlyoffice)

`lucy-onlyoffice`支持`jar`引入集成和独立部署安装(下载源码自行打包部署)

### 1. 配置仓库源

在`pom.xml`中配置`jitpack`

```xml
<repositories>
        <repository>
            <id>jitpack.io</id>
            <url>https://www.jitpack.io</url>
        </repository>
</repositories>
```

### 2. 引入依赖

根据[更新日志](https://lucy.apisev.cn/#/lucy-onlyoffice/changelog)决定版本号引入依赖

`version`与更新日志对应

```xml
        <dependency>
            <groupId>com.gitee.lboot</groupId>
            <artifactId>lucy-onlyoffice</artifactId>
            <version>${version}</version>
        </dependency>
```

### 3. 修改配置文件

需要在`application.properties`配置`onlyoffice`服务地址 & 服务的部署地址

| 参数     | 介绍                                |      |
| :------- | :---------------------------------- | :--- |
| 服务地址 | `onlyoffice`部署的地址              |      |
| 回调地址 | 业务系统部署地址 + 接收编辑回调路由 |      |

> 测试接口配置可选，配置该值为 `true` 开启默认接口，可以直接使用，参考[快速上手](https://lucy.apisev.cn/#/lucy-onlyoffice/use)

```properties
# 服务地址 -> 将 http://office.example.cn 替换为 onlyoffice部署地址
onlyoffice.document.host=http://office.example.cn

# 回调地址 -> 将 http://onlytest.example.cn 替换为 业务系统部署地址
onlyoffice.document.callback.host=http://onlytest.example.cn/office/callback

# 测试接口
onlyoffice.api.enable=true
```

## 效果

[点击查看](https://lucy.apisev.cn/#/lucy-onlyoffice/use?id=%e9%a2%84%e8%a7%88)

## 完整文档

[点此查看](https://lucy.apisev.cn/#/lucy-onlyoffice/README)

韩小明同学/lucy-onlyoffice

简介

发行版

贡献者

近期动态

韩小明同学/lucy-onlyoffice .gitee-modal { width: 500px !important; }

简介

发行版

贡献者

近期动态

搜索帮助

韩小明同学/lucy-onlyoffice