HTML5 window.postMessage 與跨域

熊建剛發表於2019-03-04
HTML跨域

在前一篇文章中，講到瀏覽器同源策略，即阻止不同域的頁面間訪問彼此的方法和屬性，並對解決同源策略跨域問題提出的解決方案進行闡述：子域代理、JSONP、CORS。本篇將詳細闡述HTML5 window.postMessage，藉助postMessage API，文件間可以以安全可控的方式實現跨域通訊，第三方JavaScript程式碼也可以與iframe內載入的外部文件進行通訊。

先來看一個postMessage例項

有需要可以看看相關程式碼

HTML5 window.postMessage API

HTML5 window.postMessage是一個安全的、基於事件的訊息API。

postMessage傳送訊息

在需要傳送訊息的源視窗呼叫postMessage方法即可傳送訊息。

  • 源視窗
    源視窗可以是全域性的window物件，也可以是以下型別的視窗:

    • 文件視窗中的iframe:

      
  var iframe = document.getElementById(`my-iframe`);
  var win = iframe.documentWindow;複製程式碼

    • JavaScript開啟的彈窗：

      
  var win = window.open();複製程式碼

    • 當前文件視窗的父視窗：

      
  var win = window.parent;複製程式碼

    • 開啟當前文件的視窗：

      
  var win = window.opener();複製程式碼

找到源window物件後，即可呼叫postMessage API向目標視窗傳送訊息：

```win.postMessage(`Hello`, `ttp://jhssdemo.duapp.com/`);```複製程式碼

postMessage函式接收兩個引數：第一個為將要傳送的訊息，第二個為源視窗的源。

注：只有當目標視窗的源與postMessage函式中傳入的源引數值匹配時，才能接收到訊息。

接收postMessage訊息

要想接收到之前源視窗通過postMessage發出的訊息，只需要在目標視窗註冊message事件並繫結事件監聽函式，就可以在函式引數中獲取訊息。


    window.onload = function() {
        var text = document.getElementById(`txt`);    
        function receiveMsg(e) {
            console.log("Got a message!");
            console.log("
Message: " + e.data);
            console.log("
Origin: " + e.origin);
            // console.log("Source: " + e.source);
            text.innerHTML = "Got a message!<br>" +
                "Message: " + e.data +
                "<br>Origin: " + e.origin;
        }
        if (window.addEventListener) {
            //為視窗註冊message事件，並繫結監聽函式
            window.addEventListener(`message`, receiveMsg, false);
        }else {
            window.attachEvent(`message`, receiveMsg);
        }
    };複製程式碼

message事件監聽函式接收一個引數，Event物件例項，該物件有三個屬性：

  • data 傳送的具體訊息
  • origin 傳送訊息源
  • source 傳送訊息視窗的window物件引用

說明

  • 可以將postMessage函式第二個引數設為*，在傳送跨域訊息時會跳過對傳送訊息的源的檢查。
  • postMessage只能傳送字串資訊。

例項

  • 源視窗

    <!DOCTYPE html>
    <html lang="en">
    <head>
        <meta charset="UTF-8">
        <title>Html5 postMessage</title>
        <style>
            #otherWin {
                width: 600px;
                height: 400px;
                background-color: #cccccc;
            }
        </style>
    </head>
    <body>
        <button id="btn">open</button>
        <button id="send">send</button>
         <!-- 通過 iframe 嵌入子頁面(接收訊息目標視窗) --> 
         <iframe src="http://jhssdemo.duapp.com/demo/h5_postmessage/win.html" 
                     id="otherWin"></iframe> 
         <br/><br/> 
         <input type="text" id="message"><input type="button" 
                 value="Send to child.com" id="sendMessage" /> 
        <script>
            window.onload = function() {
                var btn = document.getElementById(`btn`);
                var btn_send = document.getElementById(`send`);
                var sendBtn = document.getElementById(`sendMessage`);
                var win;
                btn.onclick = function() {
                    //通過window.open開啟接收訊息目標視窗
                    win = window.open(`http://jhssdemo.duapp.com/demo/h5_postmessage/win.html`, `popUp`);
                }
                btn_send.onclick = function() {    
                    // 通過 postMessage 向子視窗傳送資料        
                    win.postMessage(`Hello`, `http://jhssdemo.duapp.com/`);
                }
                function sendIt(e){ 
                     // 通過 postMessage 向子視窗傳送資料
                     document.getElementById("otherWin").contentWindow 
                     .postMessage( 
                         document.getElementById("message").value, 
                        "http://jhssdemo.duapp.com/"); 
                } 
                sendBtn.onclick = function(e) {
                    sendIt(e);
                };
            };
        </script>
    </body>
    </html>複製程式碼
  • 目標視窗

win.html


    <!DOCTYPE html>
    <html lang="en">
    <head>
        <meta charset="UTF-8">
        <title>Html5 postMessage</title>
        <style>
            #txt {
                width: 500px;
                height: 300px;
                background-color: #cccccc;
            }
        </style>
    </head>
    <body>
        <h1>The New Window</h1>
        <div id="txt"></div>
        <script>        
            window.onload = function() {
                var text = document.getElementById(`txt`);  
                //監聽函式，接收一個引數--Event事件物件
                function receiveMsg(e) {
                    console.log("Got a message!");
                    console.log("
Message: " + e.data);
                    console.log("
Origin: " + e.origin);
                    text.innerHTML = "Got a message!<br>" +
                        "Message: " + e.data +
                        "<br>Origin: " + e.origin;
                }
                if (window.addEventListener) {
                    //為window註冊message事件並繫結監聽函式
                    window.addEventListener(`message`, receiveMsg, false);
                }else {
                    window.attachEvent(`message`, receiveMsg);
                }
            };
        </script>
    </body>
    </html>複製程式碼

回顧

通過本篇的學習，瞭解了使用HTML5的postMessage API在視窗間進行通訊，也知道可以藉助其實現跨域通訊；現代瀏覽器基本都支援postMessage，而對於一些老式瀏覽器如IE7-等，可以使用一定的替代方案，進行資料通訊，如window.name、url查詢字元和hash片段等。

歡迎訪問我的個人部落格

相關文章