摘要:當應用程式崩潰時,往往會給使用者一個提交錯誤資訊的機會,這些資訊能幫助開發者追蹤並修正問題。本文將說明如何在你的 JavaScript/AJAX 應用中實現這樣的功能。
如果能存取終端使用者的電腦,JavaScript 錯誤自然容易調試;但既然做不到,那就不如讓使用者主動把修正問題所需的內容送回來。
像 Mozilla 這類應用程式崩潰時,會啟動一個錯誤回報程式,詢問使用者是否願意提交報告;若願意,便請他們盡可能詳細地描述崩潰時的情況,連同程式自身分析的數據一併送到郵件中心,供開發者與工程經理分析。這種機制對開發者極有用處——由於程式運行於客戶端,這是取得「在自己系統上無法重現的錯誤」的唯一途徑,還能統計特定錯誤的頻率與嚴重性,決定優先修正順序。
本文將示範如何在 JavaScript/AJAX 程式中支援這種錯誤回報功能:一旦你的代碼出錯,系統便彈出一個視窗,讓使用者提交錯誤資訊。
如何在 JavaScript/AJAX 應用中安裝一個使用者錯誤回報程式?
把代碼放進一個包裝器中,讓使用者能提交一封包含詳細錯誤資訊的電子郵件。
(一)捕獲錯誤
相關下載源碼包括:talkback.JS(系統完整源碼)與 test.Html(使用 talkback.JS 的示例腳本)。test.Html 中的 JavaScript 會拋出一個異常:頁面把 fun_a() 掛為 body 的 onload 處理器,fun_a() 呼叫 fun_b(),fun_b() 再呼叫 fun_c(),最後 fun_c() 存取一個不存在物件的不存在屬性,觸發真正的 JavaScript 異常。
首先,在使用者看到錯誤之前先把它捕獲,這樣既能給他們提交錯誤的機會,又能避免讓他們看到其他內容。做法是把主程式包進包裝器:
function fun()
{
// 程式在此.
}
fun = tb_wrap(fun);
如此一來,fun() 就被放進一個能捕獲並處理任何異常的包裝器裡,使用者不會看到 fun() 中發生的異常。
(二)收集錯誤資訊
捕獲錯誤後,要盡可能多地提取資訊——送回越多,開發者越可能定位並修正。遺憾的是,錯誤物件在不同瀏覽器下的屬性不盡相同,多數情況下可依賴 name 與 message;stack 屬性雖含有極有用的堆 ourselves 蹤跡,卻僅在新版 Mozilla 系瀏覽器可用。
(三)創建 mailto 連結
為讓使用者回報錯誤,應提供一個可點擊的連結——這既尊重了他們的意願,也能避免重複回報。這個 mailto 連結會打開使用者的郵件程式,並自動帶入主旨與正文,例如:
Subject: Error from https://myserver.com/myapp/index.CGI?id=234 Body: ReferenceError: nonexistent_variable is not defined fun_c()@https://myserver.com/myapp/index.CGI?id=234:19 fun_b()@https://myserver.com/myapp/index.CGI?id=234:14 fun_a()@https://myserver.com/myapp/index.CGI?id=234:9 ...
使用者還可自行補充任何資訊,然後寄出。
(四)實現細節
talkback.JS 中定義了以下函數:
◆ tb_wrap(fun):把函數 fun 包進包裝器,捕獲異常並給使用者回報機會。發生異常時,它把錯誤物件加入異常列表,並提供提交連結;若發生更深層的異常,也一併加入列表與連結。
◆ tb_show_talkback_link():顯示一個小型浮動視窗,提示「An error has occurred in this page. To report this error, please click here: Report Error」。此窗僅在首次異常時出現,之後停留在頁面內容之上;若再有異常,資訊會併入既有的 mailto 連結。
◆ tb_set_link_contents():每次拋出異常都先加入列表,再掃描整個列表提取有用資訊,打包進 mailto 連結;首次拋出時顯示連結,此後一直保留。
如今開發者越來越多地以 JavaScript 與 AJAX 打造功能豐富的應用,對應用級支援的需求也隨之提升。這個小型回報系統有助於搜集盡可能多的錯誤資訊,並給使用者一個 mailto 連結來提交;使用者當然也能補充任何有助於定位錯誤的線索。