# Spring-Boot-onlyOffice **Repository Path**: daydayup_future/spring-boot-only-office ## Basic Information - **Project Name**: Spring-Boot-onlyOffice - **Description**: springboot集成onlyOffice的实现。在参考网络上的资料结合自身实际情况总结,让集成oo方便快捷。 封装了oo服务的API和统一了配置。 - **Primary Language**: Java - **License**: MulanPSL-2.0 - **Default Branch**: master - **Homepage**: None - **GVP Project**: No ## Statistics - **Stars**: 0 - **Forks**: 81 - **Created**: 2024-03-07 - **Last Updated**: 2024-03-07 ## Categories & Tags **Categories**: Uncategorized **Tags**: None ## README # Spring-Boot-onlyOffice(集成onlyOffice服务) springboot集成onlyOffice的实现。在参考网络上的资料结合自身实际情况总结,让集成oo方便快捷。 封装了oo服务的API和统一了配置。 - 在线编辑,查看,转换 * onlyOffice.yml配置文件 * 如果解决了你地方问题,请给个 **star** ----------------------------------- # 对外使用的java类 —— OnlyServiceAPI ## 核心方法
方法名称 | 参数 | 参数说明 | 返回值 |
---|---|---|---|
openDocument() | Map<String,Object> map | 文件数据信息 { 必填 fileId 必填 fileName 必填 fileType 必填 fileSize 可用携带其它值 } |
{ "editorConfig": { "mode": "edit", "customization": { "feedback": { "visible": false }, "help": false, "goback": { "blank": false }, "macros": false, "autosave": false, "comments": false, "review": {}, "hideRightMenu": true, "anonymous": { "request": false }, "forcesave": true, "logo": {}, "hideNotes": true }, "plugins": { "pluginsData": [], "autostart": [] }, "callbackUrl": "http://172.31.240.1:9090/onlyOffice/save", "lang": "zh-CN", "user": { "name": "TongHuic7bba5", "id": "c7bba5" } }, "docServiceApiUrl": "http://172.31.240.1:8886/web-apps/apps/api/documents/api.js", "documentType": "word", "document": { "permissions": { "edit": true, "chat": false, "review": false }, "title": "fdfs.docx", "fileType": "docx", "key": "63f560ec03a94654b10cd4fdeebec05a", "url": "http://172.31.240.1:9090/download/09cee8767dd3476280fa865bacfaf213", "info": { "sharingSettings": [{ "isLink": true, "permissions": ["Full Access"], "user": "TongHuic7bba5" }], "created": "2023-08-05 21:38:25" } }, "type": "desktop", "token": "" } |
String mode | 打开方式 edit view |
||
boolean collaborativeEditing | 是否协同编辑 | ||
handlerStatus() | JSONObject jsonObject | onlyOffice 回调传来的值。 https://api.onlyoffice.com/editors/callback |
|
save():触发保存回调。 | String key | 是openDocument()返回值中的key | String : 提示信息 |
String userId | 用户Id | ||
converted() | String filetype | 文件类型 | 转换后的文件下载地址 |
String fileId | 文件Id | ||
String outputtype | 转化类型 | ||
String title | 转换后的文件名称 | ||
String password | 文档密码 |
方法名称 | 方法说明 | 参数 | 参数说明 | 返回值 |
---|---|---|---|---|
saveBeforeInitialization() | 保存前置方法 | Map<String, Object> map | 在openDocument()方法中传入的文件数据信息 | |
byte[] bytes | 文件二进制数据 | |||
String fileExtension | 文件后缀 | |||
save() | 保存方法,实现自己的保存逻辑 | Map<String, Object> map | 在openDocument()方法中传入的文件数据信息 | Map<String, Object> 更新内存中的信息 |
byte[] bytes | 文件二进制数据 | |||
byte[] changes | 当前文件和保存之前文件的区别。changes.zip | |||
String key | 是openDocument()返回值中的key | |||
saveAfterInitialization() | 保存后置方法 | Map<String, Object> map | 在openDocument()方法中传入的文件数据信息 | |
byte[] bytes | 文件二进制数据 | |||
String fileExtension | 文件后缀 |