本文详解前端JavaScript代码异常监控机制,重点解析window.onerror事件的五个参数及其浏览器兼容性问题。通过构建名为badJsReport的轻量级上报库,实现错误信息的收集、自定义参数合并及异步上报。文章还涵盖了跨域脚本的错误获取配置、压缩代码定位难点及具体使用示例,帮助开发者建立完善的线上错误监控体系。
阅读目录
- 什么是前端代码异常
- window.onerror
- 写一个js报错的上报库
- 注意点:
- 缺点:
前端代码异常监控的必要性
在日常开发工作中,JavaScript报错属于常见现象。部分错误在本地测试环境中难以复现,往往在代码发布至线上环境后才会暴露。若能在第一时间发现并修复,损失尚可控制;但若响应滞后,则可能导致严重的业务影响。因此,建立前端代码异常监控并及时上报机制,对于快速定位和解决问题至关重要。
基于上述背景,本文将深入探讨前端代码异常监控的具体实现方案。
前端代码异常的定义与分类
什么是前端代码异常
通常情况下,无论是语法错误还是运行时错误,浏览器控制台(Console)都会记录详细的错误信息,包括出错的文件路径、行号以及调用堆栈数据。
这里明确前端代码异常的定义,主要包含以下两种情形:
1. JavaScript脚本中存在语法错误;
2. JavaScript脚本在执行过程中发生运行时错误。
例如以下类型的错误表现:
for(var i=0;i<l;i++){
console.log(i);
}

针对此类异常,主要有两种捕获手段:
第一种方案是使用try...catch语句块;
第二种方案是利用window.onerror事件。
由于try...catch仅能捕获其作用域内的错误,无法处理全局层面的异常,因此本文排除该方案,
重点采用第二种方案,即window.onerror方法。
window.onerror事件详解与兼容性
window.onerror
启用浏览器开发者工具后,当页面发生错误时,控制台会立即显示提示,并告知错误发生的具体位置及调用堆栈信息。
利用window.onerror可以捕获页面上各类脚本执行异常,从而获取关键调试信息。然而,该方法存在浏览器兼容性问题,不同浏览器提供的数据完整度不一致,
部分老旧浏览器仅能提供部分参数。其基本用法如下:
window.onerror = function (message, url, lineNo, columnNo, error)
该方法接收五个参数,具体含义如下:
1、message {String}:错误信息。这是直观的错误描述,但在脚本压缩后,报错信息可能晦涩难懂,难以直接解读。
2、url {String}:发生错误的脚本路径,例如是http://a.js还是http://b.js报错。
3、lineNo {Number}:错误发生的行号。
4、columnNo {Number}:错误发生的列号。
5、error {Object}:具体的Error对象,包含更详细的调用堆栈信息,这对定位错误极具帮助。
兼容性问题
不同浏览器对同一错误的message字段解析存在差异。
在IE10以下版本浏览器中,仅能获取message、url和lineNo这三个参数,无法获取columnNo和error对象。
不过,window.event对象提供了errorLine和errorCharacter属性,可用于对应行列号信息。
在使用onerror时,可通过arguments.callee.caller递归获取调用堆栈,这类信息是最直接的错误线索,必须捕获并上报。后续将通过JavaScript代码进行演示。
不同浏览器默认可获取的参数值对比如下:

构建badJsReport上报库
写一个js报错的上报库
既然明确了window.onerror的用法,接下来我们编写一个JavaScript库来监控前端JS代码。直接开始实现。
实现思路如下:
1、收集window.onerror返回的五个参数;
2、除上述五个参数外,支持添加自定义参数;
3、将数据发送至后台服务器。
我们将该库命名为badJsReport。
原理较为简单,核心代码实现如下:
/**
* Name: badJsReport.js
* Version 1.1.0
* Author xianyulaodi
* Address: https://github.com/xianyulaodi/badJsReport
* Released on: December 22, 2016
*/
;(function(){
'use strict';
if (window.badJsReport){
return window.badJsReport
};
/*
* 默认上报的错误信息
*/
var defaults = {
msg:'', //错误的具体信息
url:'', //错误所在的url
line:'', //错误所在的行
col:'', //错误所在的列
error:'', //具体的error对象
};
/*
*ajax封装
*/
function ajax(options) {
options = options || {};
options.type = (options.type || "GET").toUpperCase();
options.dataType = options.dataType || "json";
var params = formatParams(options.data);
if (window.XMLHttpRequest) {
var xhr = new XMLHttpRequest();
} else {
var xhr = new ActiveXObject('Microsoft.XMLHTTP');
}
xhr.onreadystatechange = function () {
if (xhr.readyState == 4) {
var status = xhr.status;
if (status >= 200 && status < 300) {
options.success && options.success(xhr.responseText, xhr.responseXML);
} else {
options.fail && options.fail(status);
}
}
}
if (options.type == "GET") {
xhr.open("GET", options.url + "?" + params, true);
xhr.send(null);
} else if (options.type == "POST") {
xhr.open("POST", options.url, true);
//设置表单提交时的内容类型
xhr.setRequestHeader("Content-Type", "application/x-www-form-urlencoded");
xhr.send(params);
}
}
/*
*格式化参数
*/
function formatParams(data) {
var arr = [];
for (var name in data) {
arr.push(encodeURIComponent(name) + "=" + encodeURIComponent(data[name]));
}
arr.push(("v=" + Math.random()).replace(".",""));
return arr.join("&");
}
/*
* 合并对象,将配置的参数也一并上报
*/
function cloneObj(oldObj) { //复制对象方法
if (typeof(oldObj) != 'object') return oldObj;
if (oldObj == null) return oldObj;
var newObj = new Object();
for (var prop in oldObj)
newObj[prop] = oldObj[prop];
return newObj;
};
function extendObj() { //扩展对象
var args = arguments;
if (args.length < 2) {return;}
var temp = cloneObj(args[0]); //调用复制对象方法
for (var n = 1,len=args.length; n <len; n++){
for (var index in args[n]) {
temp[index] = args[n][index];
}
}
return temp;
}
/**
* 核心代码区
**/
var badJsReport=function(params){
if(!params.url){return}
window.onerror = function(msg,url,line,col,error){
//采用异步的方式,避免阻塞
setTimeout(function(){
//不一定所有浏览器都支持col参数,如果不支持就用window.event来兼容
col = col || (window.event && window.event.errorCharacter) || 0;
defaults.url = url;
defaults.line = line;
defaults.col = col;
if (error && error.stack){
//如果浏览器有堆栈信息,直接使用
defaults.msg = error.stack.toString();
}else if (arguments.callee){
//尝试通过callee拿堆栈信息
var ext = [];
var fn = arguments.callee.caller;
var floor = 3; //这里只拿三层堆栈信息
while (fn && (--floor>0)) {
ext.push(fn.toString());
if (fn === fn.caller) {
break;//如果有环
}
fn = fn.caller;
}
ext = ext.join(",");
defaults.msg = error.stack.toString();
}
// 合并上报的数据,包括默认上报的数据和自定义上报的数据
var reportData=extendObj(params.data || {},defaults);
// 把错误信息发送给后台
ajax({
url: params.url, //请求地址
type: "POST", //请求方式
data: reportData, //请求参数
dataType: "json",
success: function (response, xml) {
// 此处放成功后执行的代码
params.successCallBack&¶ms.successCallBack(response, xml);
},
fail: function (status) {
// 此处放失败后执行的代码
params.failCallBack&¶ms.failCallBack(status);
}
});
},0);
return true; //错误不会console浏览器上,如需要,可将这样注释
};
}
window.badJsReport=badJsReport;
})();
/*===========================
badJsReport AMD Export
===========================*/
if (typeof(module) !== 'undefined'){
module.exports = window.badJsReport;
}
else if (typeof define === 'function' && define.amd) {
define([], function () {
'use strict';
return window.badJsReport;
});
}
代码封装了原生Ajax请求,并实现了上报参数对象的合并功能,同时暴露了一个全局方法badJsReport供外部调用。
使用方法:
1、在加载其他业务JS文件之前,先引入badJsReport.js;
2、基础使用方式(该方法必须在其他业务代码执行前调用):
badJsReport({
url:'http://www.baidu.com', //发送到后台的url *必须
})
3、如需新增上报参数或监听发送回调,可使用以下配置方法:
badJsReport({
url:'http://www.baidu.com', //发送到后台的url *必须
data:{}, //自定义添加上报参数,比如app版本,浏览器版本 -可省略
successCallBack:function(response, xml){
// 发送给后台成功的回调,-可省略
},
failCallBack:function(error){
// 发送给后台失败的回调,-可省略
}
})
使用注意事项与局限性
注意点:
1、对于跨域加载的JS资源,window.onerror无法获取详细信息,需在资源请求中添加额外头部信息。
静态资源请求需配置Access-Control-Allow-Origin头部,即后端需返回该头部,同时前端script引入外链标签时需添加crossorigin属性。配置完成后,即可获取准确的出错信息。
2、由于代码末尾返回true,若有错误信息,浏览器控制台将不再打印错误。若需保留控制台输出,可注释掉最后的return true语句。
缺点:
对于经过压缩处理的代码,虽然能获取错误信息,但难以精确定位到具体行数。例如jQuery源码压缩后可能仅占3行,导致单行代码过长,难以定位具体错误位置。
完整代码已托管至GitHub:https://github.com/xianyulaodi/badJsReport
以上就是本文的全部内容,希望本文的内容对大家的学习或者工作能带来一定的帮助,同时也希望多多支持本站!