iframe跨域消息通信postMessage和message事件
在现代Web开发中,跨域通信是一个常见的需求,尤其是在涉及多个子域或第三方服务的情况下。postMessage
和 message
事件是实现跨域通信的一种有效方式。本文将详细介绍如何利用这两种技术来进行iframe与父窗口之间的消息通信,并提供丰富的示例代码和实践技巧。
1. 基本概念与作用
1.1 postMessage
- 定义:
postMessage
是一种允许来自不同源的文档或脚本相互安全地进行通信的方法。 - 用途:通常用于实现iframe与其父页面之间的通信,也可以用于不同窗口间的通信。
1.2 message 事件
- 定义:当一个文档接收到另一个文档发送的消息时,会触发
message
事件。 - 用途:监听并处理通过
postMessage
发送过来的消息。
1.3 跨域限制
- 同源策略:浏览器为了防止XSS攻击,实施了同源策略。只有当两个资源具有相同的协议、主机名和端口时,才能互相访问。
- 跨域通信:
postMessage
提供了一种绕过同源策略的方式,允许不同源之间进行安全通信。
2. 基础用法
2.1 发送消息
示例一:父窗口向iframe发送消息
// 父窗口
function sendMessageToIframe(message) {
const iframe = document.getElementById('myIframe');
iframe.contentWindow.postMessage(message, 'https://target-origin.example.com');
}
2.2 接收消息
示例二:iframe接收父窗口发送的消息
// iframe
window.addEventListener('message', function(event) {
if (event.origin !== 'https://parent-origin.example.com') return;
console.log('Received message:', event.data);
});
3. 完整示例
3.1 父窗口示例
// 示例三:父窗口完整示例
document.addEventListener('DOMContentLoaded', function() {
const iframe = document.getElementById('myIframe');
// 监听iframe的消息事件
window.addEventListener('message', function(event) {
if (event.origin !== 'https://iframe-origin.example.com') return;
console.log('Received message from iframe:', event.data);
});
// 向iframe发送消息
function sendMessageToIframe(message) {
iframe.contentWindow.postMessage(message, 'https://iframe-origin.example.com');
}
// 示例按钮点击事件
document.getElementById('sendButton').addEventListener('click', function() {
sendMessageToIframe({ type: 'GREETING', data: 'Hello from parent!' });
});
});
3.2 iframe示例
<!-- 示例四:iframe页面的HTML结构 -->
<!DOCTYPE html>
<html lang="en">
<head>
<meta charset="UTF-8">
<title>Iframe Page</title>
</head>
<body>
<script>
window.addEventListener('message', function(event) {
if (event.origin !== 'https://parent-origin.example.com') return;
// 处理接收到的消息
console.log('Received message:', event.data);
// 向父窗口发送回应消息
event.source.postMessage({ type: 'RESPONSE', data: 'Hello back from iframe!' }, event.origin);
});
</script>
</body>
</html>
4. 功能使用思路
4.1 使用特定目标窗口
示例五:指定目标窗口
// 父窗口
function sendMessageToIframe(message) {
const iframe = document.getElementById('myIframe');
iframe.contentWindow.postMessage(message, '*'); // 允许任何来源
// 或者
// iframe.contentWindow.postMessage(message, iframe.src); // 指定来源
}
4.2 使用消息类型
- 用途:通过定义不同的消息类型,可以更容易地区分和处理不同类型的事件。
- 示例:在上面的示例中,我们使用
{ type: 'GREETING', data: 'Hello from parent!' }
这样的消息格式。
5. 实际工作中的应用场景
5.1 数据同步
- 场景:在多个窗口或iframe之间共享数据,比如登录状态或购物车信息。
- 实现:可以通过
postMessage
在不同窗口间发送数据,并通过message
事件处理这些数据。
5.2 协同编辑
- 场景:多个用户同时编辑一个文档,需要实时同步编辑内容。
- 实现:可以使用
postMessage
来发送用户的编辑操作,并在其他窗口中监听message
事件来更新文档内容。
6. 使用技巧与注意事项
6.1 安全性考虑
- 验证来源:始终验证消息的来源,只信任来自预期来源的消息。
- 数据验证:对接收到的数据进行验证,防止注入攻击。
6.2 性能优化
- 减少消息大小:尽量减少发送的消息大小,以提高性能。
- 批量发送:如果需要发送大量数据,可以考虑先在客户端进行处理,然后批量发送。
6.3 错误处理
- 监听
error
事件:虽然postMessage
没有内置的错误处理机制,但可以监听error
事件来捕捉可能出现的问题。
7. 自行拓展内容
7.1 扩展消息格式
- 结构化消息:可以使用更复杂的消息格式来扩展功能,例如添加额外的元数据或指令。
- 示例:在消息中添加时间戳或操作类型。
{
timestamp: Date.now(),
type: 'ACTION',
data: 'Action data'
}
7.2 实现双向通信
- 模式:使用
postMessage
和message
事件来实现双向通信。 - 示例:在上面的示例中,我们已经实现了简单的双向通信。
7.3 多窗口通信
- 场景:在一个多窗口的应用程序中,可能需要多个窗口之间进行通信。
- 实现:可以通过设置一个中心窗口作为消息代理,所有窗口都向这个中心窗口发送消息,然后再由中心窗口转发到相应的目标窗口。
8. 实战案例
8.1 实现一个简单的聊天应用
- 描述:创建一个简单的聊天应用,其中一个窗口作为消息输入,另一个窗口作为消息展示。
- 步骤:
- 设置一个主窗口,用于接收用户输入。
- 设置一个副窗口,用于显示消息。
- 主窗口通过
postMessage
发送用户输入的消息到副窗口。 - 副窗口监听
message
事件,显示接收到的消息。
8.2 实现一个数据同步系统
- 描述:创建一个数据同步系统,允许多个窗口或iframe之间共享数据。
- 步骤:
- 定义一套消息类型和格式。
- 在每个窗口中实现消息的发送和接收逻辑。
- 当某个窗口的数据发生变化时,向其他窗口发送更新消息。
- 其他窗口接收到消息后,更新自己的数据。
9. 结合实际案例
9.1 实现一个协作编辑器
- 描述:创建一个简单的在线协作编辑器,允许多个用户同时编辑文档。
- 步骤:
- 为每个用户分配一个窗口。
- 当用户在本地进行编辑时,通过
postMessage
发送编辑操作到其他窗口。 - 其他窗口监听
message
事件,根据接收到的编辑操作更新文档。
通过以上的示例和讨论,我们深入了解了如何利用 postMessage
和 message
事件来进行跨域通信。这种技术不仅为Web应用提供了强大的功能,还保证了安全性。希望这些知识能够帮助你在实际项目中更加灵活地运用这些技术。
以上就是关于 iframe
跨域消息通信的全部内容。希望这些知识能够帮助你在日常工作中更加高效地使用 postMessage
和 message
事件。
欢迎来到我的博客,很高兴能够在这里和您见面!希望您在这里可以感受到一份轻松愉快的氛围,不仅可以获得有趣的内容和知识,也可以畅所欲言、分享您的想法和见解。
推荐:DTcode7的博客首页。
一个做过前端开发的产品经理,经历过睿智产品的折磨导致脱发之后,励志要翻身农奴把歌唱,一边打入敌人内部一边持续提升自己,为我们广大开发同胞谋福祉,坚决抵制睿智产品折磨我们码农兄弟!
专栏系列(点击解锁) 学习路线(点击解锁) 知识定位 《微信小程序相关博客》 持续更新中~ 结合微信官方原生框架、uniapp等小程序框架,记录请求、封装、tabbar、UI组件的学习记录和使用技巧等 《AIGC相关博客》 持续更新中~ AIGC、AI生产力工具的介绍,例如stable diffusion这种的AI绘画工具安装、使用、技巧等总结 《HTML网站开发相关》 《前端基础入门三大核心之html相关博客》 前端基础入门三大核心之html板块的内容,入坑前端或者辅助学习的必看知识 《前端基础入门三大核心之JS相关博客》 前端JS是JavaScript语言在网页开发中的应用,负责实现交互效果和动态内容。它与HTML和CSS并称前端三剑客,共同构建用户界面。
通过操作DOM元素、响应事件、发起网络请求等,JS使页面能够响应用户行为,实现数据动态展示和页面流畅跳转,是现代Web开发的核心《前端基础入门三大核心之CSS相关博客》 介绍前端开发中遇到的CSS疑问和各种奇妙的CSS语法,同时收集精美的CSS效果代码,用来丰富你的web网页 《canvas绘图相关博客》 Canvas是HTML5中用于绘制图形的元素,通过JavaScript及其提供的绘图API,开发者可以在网页上绘制出各种复杂的图形、动画和图像效果。Canvas提供了高度的灵活性和控制力,使得前端绘图技术更加丰富和多样化 《Vue实战相关博客》 持续更新中~ 详细总结了常用UI库elementUI的使用技巧以及Vue的学习之旅 《python相关博客》 持续更新中~ Python,简洁易学的编程语言,强大到足以应对各种应用场景,是编程新手的理想选择,也是专业人士的得力工具 《sql数据库相关博客》 持续更新中~ SQL数据库:高效管理数据的利器,学会SQL,轻松驾驭结构化数据,解锁数据分析与挖掘的无限可能 《算法系列相关博客》 持续更新中~ 算法与数据结构学习总结,通过JS来编写处理复杂有趣的算法问题,提升你的技术思维 《IT信息技术相关博客》 持续更新中~ 作为信息化人员所需要掌握的底层技术,涉及软件开发、网络建设、系统维护等领域的知识 《信息化人员基础技能知识相关博客》 无论你是开发、产品、实施、经理,只要是从事信息化相关行业的人员,都应该掌握这些信息化的基础知识,可以不精通但是一定要了解,避免日常工作中贻笑大方 《信息化技能面试宝典相关博客》 涉及信息化相关工作基础知识和面试技巧,提升自我能力与面试通过率,扩展知识面 《前端开发习惯与小技巧相关博客》 持续更新中~ 罗列常用的开发工具使用技巧,如 Vscode快捷键操作、Git、CMD、游览器控制台等 《photoshop相关博客》 持续更新中~ 基础的PS学习记录,含括PPI与DPI、物理像素dp、逻辑像素dip、矢量图和位图以及帧动画等的学习总结 日常开发&办公&生产【实用工具】分享相关博客》 持续更新中~ 分享介绍各种开发中、工作中、个人生产以及学习上的工具,丰富阅历,给大家提供处理事情的更多角度,学习了解更多的便利工具,如Fiddler抓包、办公快捷键、虚拟机VMware等工具
吾辈才疏学浅,摹写之作,恐有瑕疵。望诸君海涵赐教。望轻喷,嘤嘤嘤
非常期待和您一起在这个小小的网络世界里共同探索、学习和成长。愿斯文对汝有所裨益,纵其简陋未及渊博,亦足以略尽绵薄之力。倘若尚存阙漏,敬请不吝斧正,俾便精进!