Ajax 已經是 Web 技術圈最熱的關鍵字。它的核心是一個名為 XMLHttpRequest 的 JavaScript 物件,讓客戶端開發者能不打斷使用者操作的情況下,直接透過 HTTP 送出與接收 XML 文件。但這也帶來一個新問題:原本只負責表單驗證與圖片特效的客戶端開發者,現在得去分析 XML 結構、跟 HTTP 標頭打交道——出錯的機率自然跟著上升。
沒有風險就沒有回報。以下要示範的不是又一個炫技的 Ajax 效果,而是反過來用 XMLHttpRequest 做一件以前做不到的事:把瀏覽器端發生的 JavaScript 錯誤自動回報到伺服器日誌。
當時主流瀏覽器(IE、Mozilla、Safari、Opera)都提供了 XMLHttpRequest 支援,也普遍支援 XML DOM。一如既往,微軟的實作略有不同——IE 需要建立一個同屬性的 ActiveXObject 物件,而非直接 new 一個原生類別。
var req;
function postXML(XMLDoc) {
if (window.XMLHttpRequest) req = new XMLHttpRequest();
else if (window.ActiveXObject) req = new ActiveXObject("Microsoft.XMLHTTP");
else return;
req.open(method, serverURI);
req.setRequestHeader('content-type', 'text/XML');
req.onreadystatechange = XMLPosted;
req.send(XMLDoc);
}
function XMLPosted() {
if (req.readyState != 4) return;
if (req.status == 200) {
var result = req.responseXML;
} else {
// 處理失敗
}
}
JavaScript 早期版本的錯誤處理非常陽春,新版瀏覽器則支援了類似 C++/Java 的 try / catch / finally,並提供 onerror 事件攔截任何執行期錯誤。
function riskyBusiness() {
try {
riskyOperation1();
riskyOperation2();
} catch (e) {
// e 至少具備 name 與 message 兩個屬性
} finally {
// 清理工作
}
}
window.onerror = handleError; // 架起捕獲錯誤的安全網
function handleError(message, URI, line) {
// 提示使用者此頁可能無法正常回應
return true; // 回傳 true 可抑制預設的錯誤訊息
}
把兩者接起來,就得到一個能主動通報的客戶端。設計目標是:這個類別全頁只會被 new 一次,並且不讓呼叫者去操心細節。
function Logger() {
// 屬性
this.req;
// 方法
this.errorToXML = errorToXML;
this.log = log;
}
Error 物件預設只有 name 與 message 兩個屬性,我們另外塞進一個自訂的 location,用來記錄出錯的位置。
function errorToXML(err) {
var xml = '<?xml version="1.0"?>\n' +
'<error>\n' +
'<name>' + err.name + '</name>\n' +
'<message>' + err.message + '</message>\n';
if (err.location) xml += '<location>' + err.location + '</location>';
xml += '</error>';
return xml;
}
這是整個腳本把兩個原則結合起來的核心。這裡必須用 POST——我們等於打造了一個只寫的客製化「服務」:每次成功的請求就新增一筆紀錄,用 GET 語意上不對,長度上也容易爆掉。
function log(err) {
// 環境嗅探
if (window.XMLHttpRequest) this.req = new XMLHttpRequest();
else if (window.ActiveXObject)
this.req = new ActiveXObject("Microsoft.XMLHTTP");
else return;
this.req.open("POST", "/cgi-bin/AjaxLogger.CGI");
// 若錯誤發生在被包含的 .js 檔中,REFERER 可能與真正出錯的頁面不同,
// 因此手動覆寫為當前頁面
this.req.setRequestHeader('REFERER', location.href);
this.req.setRequestHeader('content-type', 'text/XML');
this.req.onreadystatechange = errorLogged;
this.req.send(this.errorToXML(err));
// 10 秒內若無法完成,放棄並提示
this.timeout = window.setTimeout("abortLog();", 10000);
}
那個手動覆寫 REFERER 的細節很值得記住:瀏覽器自動帶的 referrer 指的是被載入的資源位址,而不是實際出錯的頁面,對除錯毫無幫助。
因為瀏覽器事件不會持有我們物件的參考,這兩個方法刻意放在類別外面,直接操作全域的 logger 實例。
var logger = new Logger();
function abortLog() {
logger.req.abort();
alert("Attempt to log the error timed out.");
}
function errorLogged() {
if (logger.req.readyState != 4) return;
window.clearTimeout(logger.timeout);
if (logger.req.status >= 400)
alert('Attempt to log the error failed.');
}
以上程式可以全寫在一支 Logger.js 裡,在任何頁面引入即可:
<script type="text/Javascript" src="Logger.JS"></script>
<script type="text/Javascript">
function trapError(msg, URI, ln) {
var error = new Error(msg);
error.location = URI + ', line: ' + ln; // 補上自訂屬性
logger.log(error);
warnUser();
return true; // 抑制瀏覽器預設的錯誤提示
}
window.onerror = trapError;
function foo() {
try {
riskyOperation();
} catch (err) {
err.location = location.href + ', function: foo()';
logger.log(err);
warnUser();
}
}
function warnUser() {
alert("An error has occurred while processing this page. Our engineers have been alerted!");
// 視需要導向錯誤頁
// location.href = '/path/to/error/page.html';
}
</script>
兩種攔截方式各有用途:window.onerror 是總catch,適合當最後防線;try/catch 則能標註出錯的函式名稱,位置資訊更精準。
剩下的就是接收與解析。這裡用 Perl 的 CGI 模組,搭配 XML::Simple 解析 XML,再用 CGI::Carp 把結果直接寫進 httpd 的錯誤日誌——這樣系統管理者不必再盯另一支日誌檔。
use CGI;
use CGI::Carp qw(set_progname);
use XML::Simple;
my $request = CGI->new();
my $method = $request->request_method();
if ($method eq 'POST') {
eval {
my $content_type = $request->content_type();
die "Invalid content type: $content_type\n" unless $content_type eq 'text/XML';
# POST 且 content-type 非表單編碼時,整包內容會落在 POSTDATA
my $error_XML = $request->param('POSTDATA');
my $ref = XML::Simple::XMLin($error_XML);
my ($name, $msg, $location) = ($ref->{'name'}, $ref->{'message'}, '');
$location = $ref->{'location'} if defined($ref->{'location'});
set_progname('Client-side error'); # 讓日誌裡的名稱變得容易辨識
carp "name: [$name], msg: [$msg], location: [$location]";
};
if ($@) {
print $request->header(-status => '500 Internal server error', -type => 'text/XML');
croak "Error while logging: $@";
} else {
# 204:成功,但客戶端不必期待任何內容
print $request->header(-status => '204 No content', -type => 'text/XML');
}
} else {
print $request->header(-status => '405 Method not supported', -type => 'text/XML');
croak "Unsupported method: $method";
}
狀態碼的選擇頗講究:成功時回 204(無內容)而非 200,明確告訴客戶端「收到了,不用等 body」;非 POST 回 405;content-type 不對回 415。這些語意正確的回應,讓客戶端的 errorLogged 得以用一行 status >= 400 判斷成敗。
從此當有問題的 JavaScript 溜進系統,日誌就會自動亮紅燈,而不必等使用者打電話來抱怨「頁面怪怪的」。
不過這個模式若要在今天上線,還有幾個地方必須補強:
abortLog 的原因:如果連記錄錯誤都失敗,除了放棄沒有更好的辦法,起碼不要讓它反過來把頁面弄壞。