附實例!實現iframe父窗體與子窗體的通信

歡迎大家前往騰訊雲+社區,獲取更多騰訊海量技術實踐乾貨哦~

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

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

0.背景介紹

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

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

1.採用方案

1.1 MessengerJS方案

可以採用MessengerJS方案,該方案可以實現父窗體與iframe之間的通信、多個iframe之間的通信。不過要前提是要確保對不同域的頁面有修改權限,並且父窗體、子窗體頁面都要同時加載這個MessengerJS。

1.2 使用方法

(1) 在需要通信的父窗體、和子窗體的文檔中,都需要引入MessengerJS。

(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的名字,以及傳遞的消息。

3.小結

本文主要是介紹了一個MessengerJS方案及其使用方法,來解決父窗體與子窗體的通信問題。同時提供了一個完整的實例,可以實現子窗體向父窗體傳遞消息,父窗體通過監聽消息事件,來獲取子窗體消息的目的。如有問題,歡迎指正。

相關閱讀
【每日課程推薦】機器學習實戰!快速入門在線廣告業務及CTR相應知識

此文已由作者授權騰訊雲+社區發佈,更多原文請點擊

搜索關注公衆號「雲加社區」,第一時間獲取技術乾貨,關注後回覆1024 送你一份技術課程大禮包!

海量技術實踐經驗,盡在雲加社區

發表評論
所有評論
還沒有人評論,想成為第一個評論的人麼? 請在上方評論欄輸入並且點擊發布.
相關文章