前陣子在處理一個專案時,遇到這樣的需求:當使用者離開頁面的時候,需要快取頁面裡的一部分內容;但如果使用者只是重新整理,則不需要快取。也就是說,我希望能夠只在使用者真正離開時才觸發動作。查資料時發現有 onbeforeunload 與 onunload 兩個事件,然而 onbeforeunload 在使用者重新整理時也會觸發,這讓我折騰了好一陣子,於是乾脆把心得整理成一篇小結。
onbeforeunload 事件會在頁面即將離開(重新整理或關閉)時觸發。它可以用來彈出一個對話框,詢問使用者是要繼續瀏覽還是離開當前頁面。
對話框的預設提示文字會因瀏覽器而異,標準訊息類似「確定要離開此頁嗎?」,這段文字無法刪除,但你可以自訂訊息與標準訊息一起顯示。
注意:如果你沒有在 <body> 元素上指定 onbeforeunload,就需要在 window 物件上綁定事件,並透過 returnValue 屬性建立自訂訊息。另外,Firefox 只會顯示預設提醒,不顯示自訂訊息。
使用方式如下:
<!DOCTYPE html> <html lang="en"> <head> <meta charset="UTF-8"> <title>test</title> </head> <body onbeforeunload="return test()"> </body> <script type="text/javascript"> function test(){ return "你確定要離開嗎"; } </script> </html>
或者寫成:
<!DOCTYPE html> <html lang="en"> <head> <meta charset="UTF-8"> <title>test</title> </head> <body> </body> <script type="text/javascript"> window.onbeforeunload=function(){ return "你確定要離開嗎"; } </script> </html>
觸發時會彈出一個帶有「確定」與「取消」的對話框,按下確定便離開頁面,按下取消則留在本頁,而提示文字可以自訂。
那麼,如果只想在離開時執行、重新整理時不執行,該怎麼辦?可以這樣寫:
window.onbeforeunload = function() { var n = window.event.screenX - window.screenLeft; var b = n > document.documentElement.scrollWidth - 20; if (!(b && window.event.clientY < 0 || window.event.altKey)) { //window.event.returnValue = "真的要刷新頁面麼?"; //這裡放置我想執行快取的程式碼 cacheFunction(); } }
如此一來,離開頁面時會執行快取程式碼而不彈出提示框,重新整理時則既不彈框也不執行。值得一提的是,此時要將 Ajax 設為同步,也就是把 async 改成 false。
IE、Chrome、Safari 完美支援;Firefox 不支援自訂文字提醒;Opera 不支援;IE6、IE7 使用 onbeforeunload 時有 bug。
onunload 事件在使用者退出頁面時發生,用法與 onbeforeunload 類似:
window.onunload = function(){ return "你確定要離開嗎" }
瀏覽器相容狀況如下:IE6、IE7、IE8 在重新整理、關閉瀏覽器、頁面跳轉後都會執行;IE9 重新整理會執行,頁面跳轉與關閉瀏覽器則不會;Firefox(含 3.6)在關閉分頁、頁面跳轉、重新整理後能執行,但關閉瀏覽器不行;Safari 在重新整理、頁面跳轉後會執行,關閉瀏覽器不行;Opera、Chrome 則任何情況都不執行。
onunload 與 onbeforeunload 都是在重新整理或關閉時被呼叫,可以透過 <script> 中的 window.onunload 指定,也可以在 <body> 裡指定。兩者的差別在於 onbeforeunload 早於 onunload 執行,而且它還能阻止 onunload 的執行。
具體來說,onbeforeunload 是在即將向伺服器讀取新頁面時呼叫,此時尚未開始讀取;而 onunload 則是新頁面已經從伺服器讀取完畢、即將替換當前頁面時才呼叫。onunload 無法阻止頁面的更新或關閉,onbeforeunload 卻可以。
總結執行順序:頁面載入時只執行 onload;頁面關閉時先執行 onbeforeunload,最後執行 onunload;頁面重新整理時先執行 onbeforeunload,接著 onunload,最後 onload。