如今的前端早已不像幾年前那樣單純,各種框架、各種面向對象層出不窮,項目一大就會抽取出大量公共模塊。這些模塊 UI 一致,差異只在後台邏輯。今天想聊聊在這種複雜環境下,如何做好調試與日志記錄。
以企業差旅系統為例,我們通常會做一個「成本中心」的 JS 公共模塊,客戶在預訂機票時填寫,而這個模塊同時分佈在 online、offline 和 app 等多個預訂端,方便後續與客戶公司月結算。
項目做大、複雜化、SOA 化之後,問題也接踵而至。Web 裡有句名言:所有前端的數據都是不可信的。那對方團隊的接口數據又何嘗可信呢?項目小的時候不會這麼「不自信」,通常只在邏輯錯誤時記錄日志,正常流程很少記錄——畢竟 info 日志看著不美觀,還會消耗服務器帶寬、拖累性能。
但項目一大,當你某天遇到一個奇怪的 bug,靠著殘缺不全的日志好不容易逐行追溯到接口,卻因參數太多無法還原接口數據;你 100% 確信是接口返回的問題,卻拿不出完整報文,於是根本無從與接口方對質。那一刻真是無比無奈:多希望每行都有日志啊。
有了教訓,記錄流程日志變得越來越有必要。既然是公共 JS 模塊,它一定封裝了自己的方法,也絕不允許第三方程序直接操作它的文本結點。比如下面這樣:
<!--third module -->
公司:<input type="text" id="company" value="xxx有限公司" />
員工姓名:<input type="text" id="username" value="張三" />
<!-- -->
<script type="text/javascript">
// 成本中心
var costCenter = (function () {
var company = (document.getElementById("company") || "") && document.getElementById("company").value;
var username = (document.getElementById("username") || "") && document.getElementById("username").value;
var result = {
getInfo: function () {
return { company: company, username: username };
},
validation: function () {
return Boolean(company && username);
}
};
return result;
})();
</script>
為了簡化操作,第三方 UI 提供了公司名和員工姓名的節點,並封裝了一個 costCenter 類來提供讀取方法。這樣,預訂程序只需調用 costCenter.getInfo 即可,同時起到了封裝的作用。
但問題恰恰出在這裡:項目實戰中,常因各種原因導致 costCenter 取不到值(也可能是公共 UI 的 bug)。而當時你未必能確定是否真的取到了值,邏輯上又不能因此阻止訂單提交。於是為了徹底追蹤 bug,我寫了一個 logCenter 單例類來記錄日志。
這種方式最容易想到,但用原生 XMLHttpRequest 需要考慮瀏覽器兼容;不用原生則要借助第三方框架(如 jQuery),可很多公司並不使用 jQuery,所以要結合實際情況取捨。
// 日志中心
var logCenter = (function () {
var result = {
info: function (title, message) {
// ajax 操作
$.get("https://xxx.com", { "title": title, "message": message }, function () {
}, "post");
}
};
return result;
})();
DOM 中有一個 Image 對象,我們可以動態給它的 src 賦值來向後台 url 發起請求,同時把 title 和 message 拼接到 url 上。這種動態給 image.src 的方式無需考慮瀏覽器兼容,非常實用。
// 日志中心
var logCenter = (function () {
var result = {
info: function (title, message) {
// ajax 操作
$.get("https://xxx.com", { "title": title, "message": message }, function () {
}, "post");
},
info_image: function (title, message) {
// image
var img = new Image();
img.src = "https://www.baidu.com?title=" + title + "&message=" + message + "&temp=" + (Math.random() * 100000);
}
};
return result;
})();
以上就是本次分享的主要內容。良好的日志記錄習慣,能讓我們在面對複雜系統的 bug 時不再束手無策,後續還將繼續深入探討這一話題。