附實例！實現iframe父窗體與子窗體的通訊

時間 2019-11-10

標籤實例實現 iframe 窗體通訊欄目 HTML 简体版

原文原文鏈接

歡迎你們前往騰訊雲+社區，獲取更多騰訊海量技術實踐乾貨哦~javascript

本文由前端林子發表於雲+社區專欄css

本文主要會介紹如何基於MessengerJS，實現iframe父窗體與子窗體間的通訊，傳遞數據信息。同時本文會提供一個可運行的實例代碼，實如今父窗體中，獲取到來自子窗體的數據的效果。html

0.背景介紹

(1)須要在當前的前端項目中，使用iframe嵌套別的站點頁面。前端

(2)當子窗體觸發了一個事件後，要給父窗體傳一個跳轉地址的url。父窗體監聽到這個事件後，根據接收到的url，來更新當前父窗體的url，實現頁面的跳轉。java

1.採用方案

1.1 MessengerJS方案

能夠採用MessengerJS方案，該方案能夠實現父窗體與iframe之間的通訊、多個iframe之間的通訊。不過要前提是要確保對不一樣域的頁面有修改權限，而且父窗體、子窗體頁面都要同時加載這個MessengerJS。git

1.2 使用方法

(1) 在須要通訊的父窗體、和子窗體的文檔中，都須要引入MessengerJS。github

(2) 父窗體和子窗體各自的文檔（document）中，都須要本身的Messenger與其餘文檔通訊，父窗體和子窗體的window對象都對應着有且僅有一個Messenger對象，該Messenger對象會負責當前window的全部通訊任務。所以，每一個Messenger對象都須要惟一的名字，這樣它們之間才能夠知道是在跟誰通訊。另外，MessengerJS方案推薦指定項目名稱，（相似命名空間的做用），以加強代碼健壯性與組件複用性，避免將來與其餘項目衝突。(注意: 項目名稱應使用字符串類型)瀏覽器

父窗體與子窗體初始化Messenger對象：機器學習

// 父窗口中 - 初始化Messenger對象
 // 推薦指定項目名稱, 避免Mashup類應用中, 多個開發商之間的衝突
 var messenger = new Messenger('Parent', 'projectName');

 // iframe中 - 初始化Messenger對象
 // 注意! Messenger之間必須保持項目名稱一致, 不然沒法匹配通訊
 var messenger = new Messenger('iframe1', 'projectName');

 // 多個iframe, 使用不一樣的名字
 var messenger = new Messenger('iframe2', 'projectName');

(3) 在發現消息前，目標文檔要確保已經監聽了消息事件：學習

messenger.listen(function(msg){
 	alert("收到消息: " + msg);
 });

(4) 父窗體想給子窗體發信息，要添加消息對象，明確告知當前的父窗體，要發送消息的子窗體的window引用與messenger對象的名字：

// 父窗口中 - 添加消息對象, 明確告訴父窗口iframe的window引用與名字
 messenger.addTarget(iframe1.contentWindow, 'iframe1');

 // 父窗口中 - 能夠添加多個消息對象
 messenger.addTarget(iframe2.contentWindow, 'iframe2');

(5) 發消息時，要指定messenger的名字和消息，例如父窗體要給子窗體發消息：

// 父窗口中 - 向單個iframe發消息
 messenger.targets['iframe1'].send(msg1);
 messenger.targets['iframe2'].send(msg2);
 // 父窗口中 - 向全部目標iframe廣播消息
 messenger.send(msg);

2.實例

基於上面的介紹，下面要實現開篇提出的需求了（實例代碼只是示例如何傳遞數據，沒有更改父窗體url）。這裏分別是父窗體和子窗體的代碼實現，可直接在瀏覽器中打開查看效果，其中messenger.js能夠在這裏下載，放到項目目錄下。

父窗體：

<!DOCTYPE html>
<html lang="en">

<head>
    <meta charset="UTF-8">
    <title>父窗體</title>
    <style type="text/css"></style>
    <!-- 這個messenger.js可下載放到項目目錄下 -->
    <script type="text/javascript" src="./messenger.js"></script>

</head>

<body>
    <div>這是父窗體</div>
    <div id="msg"></div>
    <iframe id="iframe1" name="iframe1" src="./child.html" width="600px" height="316px" style="z-index: 100000;position: absolute;">
    </iframe>
</body>
<script type="text/javascript">
    //父頁面中,註冊一個messager到一個統一的項目中,第一個參數爲本身頁面的名稱，第二個參數爲項目名稱
    var messenger = new Messenger('parent', 'monitor'),
        iframe1 = document.getElementById('iframe1');

    //父頁面中綁定監聽消息事件，當接受到iframe1發來的消息後執行
    messenger.listen(function (msg) {
        // alert(msg);
        var oDiv = document.getElementById("msg");
        oDiv.innerHTML += msg;
        //todo
    });
</script>

</html>

子窗體：

<!DOCTYPE html>
<html lang="en">

<head>
    <meta charset="UTF-8">
    <title>子窗體</title>
    <style type="text/css"></style>
    <!-- 這個messenger.js可下載放到項目目錄下 -->
    <script type="text/javascript" src="./messenger.js"></script>

</head>

<body>
    <div style="background: #8CB08B;height:300px;">
        <div>這是子窗體</div>
        <input type="button" onclick="sendMessage('這是一條來自子窗體的消息!')" value="按鈕" />
    </div>
</body>
<script type="text/javascript">
    //子頁面中,註冊一個messager到一個統一的項目中,第一個參數爲本身頁面的名稱，第二個參數爲項目名稱
    var messenger = new Messenger('iframe1', 'monitor');

    //添加消息對象, 明確告訴子窗口iframe的window引用與名字
    messenger.addTarget(window.parent, "parent");

    function sendMessage(msg) {
        messenger.targets["parent"].send(msg);
    }
</script>

</html>

代碼解釋：

父窗體中嵌入iframe，要先引入messenger.js，同時初始化messenger到一個統一的項目中，其中第一個參數爲本身頁面messenger對象的名字，第二個參數爲項目名稱；而後父窗體要綁定監聽消息事件，當接收到iframe子窗體發來的消息後執行。

子窗體也要先引入messenger.js，同時初始化一個messenger到一個統一的項目中，其中第一個參數爲本身頁面messenger對象的名字，第二個參數爲項目名稱；而後添加消息對象，告知子窗體的window引用與messenger對象的名字。而後在觸發onclick事件時，向父窗口傳遞消息。發消息時，要指定接收消息的父窗體的messenger的名字，以及傳遞的消息。