ifram消息传递

发表于

在各种项目中, 我们常常遇到需要在iframe之间互相传递信息的场景

同域

  1. 父页面获取子页面

    1
    2
    3
    4
    // 可以获取到iframe内的window对象，包括iframe内自行声明的全局方法等。
    document.querySelector('#XXXX').contentWindow

    window.frames[x]

    window.frames注意事项：

    • 该属性返回窗口中所有命名的框架(
    • 直接打印window.frames不是数组对象。
    • frames.length 来获取框架的数量。
    • 可以通过window.frames[数字]直接获取iframe内的window对象

  2. 子页面获取父页面

    1
    2
    // 可以获取到父页面的window对象，包括父页面内自行声明的全局方法等。
    window.parent

跨子域

修改document.domain实现跨域通信

比如: 当前域名为bot.4paradigm.com 可以直接改成其顶级域名: document.domain = ‘4paradigm.com’

跨主域

窗口间消息传递方法:

发送方

1
otherWindow.postMessage(message, targetOrigin, [transfer]);
  • otherWindow, 其他窗口的一个引用, 比如:

​ （1）iframe的contentWindow属性、
​ （2）执行window.open返回的窗口对象、
​ （3）或者是命名过或数值索引的window.frames。
​ （4）父级parent.window对象

  • message

    将要发送到其他 window的数据。它将会被结构化克隆算法序列化。这意味着你可以不受什么限制的将数据对象安全的传送给目标窗口而无需自己序列化。

  • targetOrigin

    通过窗口的origin属性来指定哪些窗口能接收到消息事件，其值可以是字符串”*”（表示无限制）或者一个URI。

    在发送消息的时候，如果目标窗口的协议、主机地址或端口这三者的任意一项不匹配targetOrigin提供的值，那么消息就不会被发送；只有三者完全匹配，消息才会被发送。这个机制用来控制消息可以发送到哪些窗口；例如，当用postMessage传送密码时，这个参数就显得尤为重要，必须保证它的值与这条包含密码的信息的预期接受者的orign属性完全一致，来防止密码被恶意的第三方截获。如果你明确的知道消息应该发送到哪个窗口，那么请始终提供一个有确切值的targetOrigin，而不是*。不提供确切的目标将导致数据泄露到任何对数据感兴趣的恶意站点。

  • transfer

    是一串和message 同时传递的 Transferable 对象. 这些对象的所有权将被转移给消息的接收方，而发送一方将不再保有所有权。

监听方

1
2
3
4
window.onmessage =function(e){
  // e 为MessageEvent
  console.log('onmessage2',e);
}

https://developer.mozilla.org/zh-CN/docs/Web/API/MessageEvent

MessageEvent

MessageEvent.data 只读
​ 返回 DOMString, Blob 或者 ArrayBuffer，包含来自发送者的数据。
MessageEvent.origin
返回一个表示消息发送者来源的USVString
MessageEvent.lastEventId 只读
​ DOMString representing a unique ID for the event.
MessageEvent.source
​ MessageEventSource (可以是 WindowProxy, MessagePort, 或 ServiceWorker 对象) 代表消息发送者.
MessageEvent.ports
​ MessagePort对象数组，表示消息正通过特定通道（数据通道）发送的相关端口（适用于通道消息传输或者向一个共享线程（shared work ）发送消息时）。

实践

父向子

1
2
3
4
5
6
7
8
9
//父:
document.querySelector('#xx').onclick = function(){
    window.frames[0].postMessage('testPost','*'); 
    //document.querySelector('#Yiframe').contentWindow.postMessage('testPost','*'); 也可以
}
//子：
window.onmessage =function(e){
    console.log('onmessage2',e,document.domain);
}

子向父

1
2
3
4
5
6
7
8
9
//子:
document.querySelector('#btn5').addEventListener('click',function(){
    parent.window.postMessage('testChildPost','*');
});

//父：
window.onmessage = function(e){ 
    console.log('onmessage父',e) 
}

兼容性:

3060550691-594cbe7c71477_articlex

注意

  1. iframe内的路由变化，iframe的src值不会变！！！
  2. 要获取iframe内的当前url，用document.querySelector(‘#Yiframe’).contentWindow.location.href;(只在不跨域时可以使用)
  3. parent.window 在没有父级的时候 parent.window = window;