Tampermonkey被@require脚本如何暴露函数供其他用户脚本调用?
自定义事件方案的合理性
你想的这个自定义事件方案是完全能用的,本来就是油猴沙箱隔离场景下的标准解法。
- 好处很直观:不需要依赖
unsafeWindow,不会往页面全局作用域塞东西,兼容性拉满,不管是哪种油猴运行模式、哪个浏览器版本都能稳定跑,也不会被页面的JS脚本探测到。 - 但也有绕不开的缺点:
- 事件传递是异步的,没法直接拿到被调用函数的返回值,要拿结果还得额外加一层反向的事件回传逻辑,功能越复杂冗余代码越多
- 每次调用都得手动拼事件对象,参数多了写着麻烦,也没有代码提示,调试的时候经常容易传错参数
- 调用栈不关联,真出问题了定位位置比直接调函数麻烦很多
之前写
window挂载拿不到函数的原因 你之前的写法失效,本质是油猴沙箱的机制导致的,和开不开unsafeWindow权限没关系:
- 油猴沙箱里的
window是包装过的代理对象,既不是真实的页面全局窗口,也不是跨脚本共享的全局作用域。你在被@require的脚本里给window.functionName赋值,这个函数只会存在于被加载脚本自己的执行上下文里,不会自动共享给后面跑的消费脚本。就算你在消费脚本里开了unsafeWindow,只要被依赖的脚本是把函数挂在自己沙箱的window代理上,你从真实的unsafeWindow上当然也找不到,因为这两个根本不是同一个对象。 - 如果被@require的脚本本身是单独安装在油猴里的,那两个脚本的沙箱是完全隔开的。你通过@require拉的只是被依赖脚本的源码文本,和它本身独立运行的脚本实例根本没共享变量,当然拿不到对方的内部函数。
更优的不用
unsafeWindow的实现 方案1:直接用@require的作用域拼接特性(最推荐)
油猴处理@require资源的时候,默认会把所有引入的脚本源码直接拼在当前消费脚本的最前面,和消费脚本的代码跑在同一个执行上下文里。这个时候根本没必要把函数往window上挂,只要在被@require的脚本里,别拿闭包把代码全裹起来,直接在顶层声明要暴露的函数就行:
// 被@require的脚本内容 function functionName() { console.log('Called from @required script') }
这种写法的好处比事件方案多得多:
- 完全不需要碰
unsafeWindow,没有跨沙箱的权限问题 - 函数调用是同步的,能直接拿返回值,IDE有正常的代码提示,调试的时候调用栈清清楚楚
- 没有事件传递的额外开销
用的时候注意几个坑就行: - 被@require的脚本别拿IIFE把整段代码包起来,不然顶层声明的函数会被闭包锁死,外面根本拿不到
- 别在顶层瞎写严格模式导致作用域收缩,不然容易出现变量看不见的问题
方案2:优化后的事件通信(适用于没有@require依赖的跨脚本场景)
如果是两个完全独立、互相没有@require依赖的油猴脚本要互相调用,事件通信是唯一靠谱的方案。可以把你之前想的switch逻辑优化成函数映射表的形式,少写很多重复代码:
在被依赖的脚本里维护函数对照表,统一监听调用事件:
// 被依赖脚本的核心逻辑 const funcMap = { functionName: () => { console.log('Called from required script') } } window.addEventListener('__tampermonkey_call__', (e) => { const { funcName, args = [], callId } = e.detail const targetFunc = funcMap[funcName] let result if (targetFunc) { result = targetFunc(...args) } // 回传执行结果 window.dispatchEvent(new CustomEvent('__tampermonkey_result__', { detail: { callId, result } })) })
消费脚本只要封装一个统一的调用方法就行,不用每次手动拼事件、写一堆switch判断。
内容的提问来源于stack exchange,提问作者user3354777
相关产品推荐
相关产品推荐

