OnlyOffice二次开发:解析文档按钮获取最新文档地址教程

在对OnlyOffice进行二次开发时,很多小伙伴会遇到这样的需求:在外部窗口添加解析文档按钮,而解析功能需要依赖OnlyOffice文档的最新地址。这时候通过触发downloadAs事件,再借助浏览器的postMessage机制,就能轻松拿到所需的文档地址啦!

核心原理

其实整个过程就像"两个隔河相望的窗口":外部窗口(父页面)想让OnlyOffice窗口(Iframe)提供最新文档地址,但两者直接没法传数据。而浏览器的postMessage就像一座"通信桥梁",再配合监听器,就能让数据顺利跨窗口传递~

具体实现步骤

父页面先绑定"消息监听器"

在调用downloadAs方法之前,父页面得先"竖起耳朵",准备接收OnlyOffice传过来的消息。通过window.addEventListener绑定message监听器,代码逻辑如下(核心是提前占位接收消息):

javascript 复制代码
// 父页面绑定message监听器,准备接收OnlyOffice的消息
window.addEventListener('message', function(handler) {
    // 后续收到消息后处理逻辑放这
});
触发OnlyOffice的downloadAs事件

父页面点击自己添加的"解析文档"按钮时,调用OnlyOffice Iframe的API,触发下载事件(这里不是真要下载,是借这个事件拿地址):

javascript 复制代码
// 触发docx格式的下载事件,OnlyOffice会返回对应文档地址
window.docEditor.downloadAs('docx');
OnlyOffice通过postMessage传数据

OnlyOffice内部检测到onDownloadAs事件被触发后,会自动通过postMessage这个"桥梁",把包含最新文档地址(URL)的事件和数据,主动发送给父页面。

父页面提取地址,调用解析接口

父页面的监听器收到消息后,做两个关键判断:

  • 消息类型是onDownloadAs(确保是我们要的事件)
  • 消息里包含data.url(确保有文档地址)

确认无误后,直接提取这个URL,就能拿去调用解析接口啦!完整逻辑示例:

javascript 复制代码
// 父页面完整监听逻辑
window.addEventListener('message', function(event) {
    // 判断是否是OnlyOffice返回的onDownloadAs事件,且包含地址
    if (event.data.event === 'onDownloadAs' && event.data.data.url) {
        // 提取最新文档地址
        const docLatestUrl = event.data.data.url;
        // 调用自己的解析接口,传入地址
        callMyParseApi(docLatestUrl);
    }
});

总结

整个流程核心就3点:

  1. 父页面提前绑监听器(准备接收消息)
  2. 触发downloadAs让OnlyOffice"吐地址"
  3. 通过postMessage跨窗口传地址,父页面提取使用

不用纠结底层原理,记住postMessage是"跨窗口通信桥梁",onDownloadAs事件是"拿地址的触发点"

相关推荐
暴走的小呆11 小时前
Vue 2 中 Object 的变化侦测:从 getter/setter 到 Dep、Watcher、Observer
vue.js
英勇无比的消炎药11 小时前
TinyVue v-auto-tip: 文本超长自动提示的优雅方案
vue.js
时光足迹13 小时前
腾讯云 TRTC UniApp SDK 从入门到上线
前端·vue.js·uni-app
时光足迹13 小时前
uni-app 里把加密视频嵌入页面播放?我分析了 4 种方案,只有 1 种接近完美
前端·vue.js·uni-app
时光足迹14 小时前
JPush UniApp UTS 插件完全参考手册:API、事件与厂商通道一网打尽
vue.js·ios·uni-app
时光足迹14 小时前
极光推送全攻略(下):uni-app 代码实现与 iOS 排查实战
vue.js·ios·uni-app
疯狂的魔鬼15 小时前
一个"懂分寸"的文本省略组件是怎样炼成的
前端·vue.js·设计
裕波15 小时前
AI 正在重写应用开发。Vue 与 Vite,给出新的答案。
javascript·vue.js
妙码生花15 小时前
现代前端的极致性能 icon 加载方案(死磕成功版)
前端·vue.js·typescript
用户21366100357219 小时前
Vue2脚手架工程化与Axios集成
前端·vue.js