有了 XMLHttpRequest 與 JavaScript 錯誤處理的基礎,接下來看一個把兩者結合的實作:攔截客戶端錯誤,並把它記錄回伺服器端。
你可能覺得 JavaScript 錯誤在開發階段那個「黃色死亡三角」裡看到就够了,但事實上仍有不少錯誤一路流到線上站點。與其讓它們默默消失,不如設計一套機制把它們收集起來,讓問題能被修補。
先建立一個作為日誌記錄器的類,把細節都封裝起來。
// 類的構造函數
function Logger() {
// 欄位
this.req;
// 方法
this.errorToXML = errorToXML;
this.log = log;
}
接著定義序列化方法,把 Error 物件轉成 XML。Error 預設只有 name 與 message 兩個屬性,我們額外加上 location,因為它時常有用。
// 把錯誤映射到 XML 文件中
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;
}
再來是 log 方法,它是整個腳本的核心。這裡刻意採用 POST:我們其實是在建立一個自訂的、只寫的 Web 服務,每個成功請求都會產生一筆新記錄,POST 是唯一合適的選擇。
// 日誌記錄類的 log 方法
function log(err) {
// 檢查瀏覽器能力
if (window.XMLHttpRequest) this.req = new XMLHttpRequest();
else if (window.ActiveXObject) this.req = new ActiveXObject("Microsoft.XMLHTTP");
else return; // 不支援,放棄
// 設定方法與 URI
this.req.open("POST", "/cgi-bin/AjaxLogger.CGI");
// 設定請求標頭。REFERER 是頂層 URI;若錯誤發生在別的 .js 檔中,
// 其位置可能與錯誤位置不同
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);
}
// 全域唯一實例
var logger = new Logger();
最後兩個函數處理瑣碎的事務管理。記錄錯誤時若發生問題,除了驚動使用者之外我們幾乎無能為力,但仍要做點收尾。它們不是類的方法,因為事件處理器拿不到我們物件的指標,只會指向 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>
剩下的工作是定義接收與轉換訊息的方法。我選用最基礎的通用命名方式,用 Perl 寫一支 CGI:以 XML::Simple 解析 post 資料,再用 CGI::Carp 把結果直接寫進 httpd 的錯誤日誌——這樣系統管理者不必再翻另一份日誌。腳本也示範了如何適切地記錄各種成功與失敗條件。
use CGI;
use CGI::Carp qw(set_progname);
use XML::Simple;
my $request = CGI->new();
my $method = $request->request_method();
# 方法必須是 POST
if ($method eq 'POST') {
eval {
my $content_type = $request->content_type();
if ($content_type eq 'text/xml') {
print $request->header(-status => '415 Unsupported Media Type',
-type => 'text/xml');
croak "Invalid content type: $content_type\n";
}
# 方法是 POST、內容既非 URL 編碼也非 multipart 時,
# 整個 post 會被放進 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 {
# 表示成功,但客戶端不應期待任何內容
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";
}
完成之後,當某段難以理解的 JavaScript 潛進系統,你就能期待自己的日誌監視器開始閃紅燈,而客戶端開發人員在深夜接到電話。
順帶提醒:這個端點接受任何來源匿名 POST 並寫入伺服器日誌,等同一個可被濫用的寫入介面。上線前請加上來源驗證、速率限制與輸入長度檢查,否則它本身就是新的風險點。