痛点
- 无法快速定位到发生错误的代码位置，因为脚手架构建时会用 webapck 自动帮我们压缩代码，而上线版本又通常不会保留 source map（开源贡献者除外）
- 无法第一时间通知开发人员异常发生
- 不知道用户 OS 与浏览器版本、请求参数（如页面 ID）；而对于页面逻辑是否错误问题，通常除了用户 OS 与浏览器版本外，需要的是报错的堆栈信息及具体报错位置。
前端异常捕获
在 ES3 之前 js 代码执行的过程中，一旦出现错误，整个 js 代码都会停止执行，非常不健壮。从 ES3 开始，js 也提供了类似的异常处理机制，从而让 js 代码变的更健壮。js 异常的特点是，出现不会导致 JS 引擎崩溃，最多只会终止当前执行的任务。
如何在程序异常发生时捕捉并进行对应的处理呢？在 Javascript 中，我们通常有以下异常捕获机制。
try…catch 语句
能捕捉到的异常，必须是线程执行已经进入 try catch 但 try catch 未执行完的时候抛出来的,以下都是无法被捕获到的情形。
- 异步任务抛出的异常（执行时 try catch 已经从执行完了）
- promise（异常内部捕获到了，并未往上抛异常，使用 catch 处理）
- 语法错误（代码运行前，在编译时就检查出来了的错误）
优点：能够较好地进行异常捕获，不至于使得页面由于一处错误挂掉 缺点：显得过于臃肿，大多代码使用 try … catch 包裹，影响代码可读性。
全局异常监听 window.onerror
window.onerror 最大的好处就是同步任务、异步任务都可捕获，可以得到具体的异常信息、异常文件的 URL、异常的行号与列号及异常的堆栈信息，再捕获异常后，统一上报至我们的日志服务器，而且可以全局监听，代码也简洁很多。
缺点：
- 此方法有一定的浏览器兼容性
- 跨域脚本无法准确捕获异常，跨域之后 window.onerror 捕获不到正确的异常信息，而是统一返回一个 Script error，可通过在<script>使用 crossorigin 属性来规避这个问题
Promise 内部异常
前文已经提到，onerror 以及 try-catch 也无法捕获 Promise 实例抛出的异常，只能最后在 catch 函数上处理，但容易忘记写 catch。
如果你的应用用到很多的 Promise 实例的话，你不知道什么时候这些异步请求会抛出异常而你并没有处理它，所以最好添加一个 Promise 全局异常捕获事件 unhandledrejection。
window.addEventListener("unhandledrejection", (e) => {
console.log("unhandledrejection", e);
});
vue 工程异常
window.onerror 并不能捕获.vue 文件发生的获取，Vue 2.2.0 以上的版本中增加了一个 errorHandle，使用 Vue.config.errorHandler 这样的 Vue 全局配置，可以在 Vue 指定组件的渲染和观察期间未捕获错误的处理函数。这个处理函数被调用时，可获取错误信息和 Vue 实例。
//main.js
import { createApp } from "vue";
import App from "./App.vue";
let app = createApp(App);
app.config.errorHandler = function (e) {
console.log(e);
//错误上报...
};
app.mount("#app");
综上，Vue 项目中可以将几种方式有效结合起来，笔者这里是在 vue-cli 框架中做的处理，其余类似：
import { createApp } from "vue";
import App from "./App.vue";
let app = createApp(App);
window.addEventListener(
"error",
(e) => {
console.log(e);
//TODO:上报逻辑
return true;
},
true
);
// 处理未捕获的异常，主要是promise内部异常，统一抛给 onerror
window.addEventListener("unhandledrejection", (e) => {
throw e.reason;
});
// 框架异常统一捕获
app.config.errorHandler = function (err, vm, info) {
//TODO:上报逻辑
console.log(err, vm, info);
};
app.mount("#app");
sourcemap
生产环境下所有的报错的代码行数都在第一行了，为什么呢？
通常在该环境下的代码是经过 webpack 打包后压缩混淆的代码，否则源代码泄漏易造成安全问题，在生产环境下，我们的代码被压缩成了一行。而保留了 sourcemap 文件就可以利用 webpack 打包后的生成的一份.map 的脚本文件就可以让浏览器对错误位置进行追踪了，但这种做法并不可取，更为推荐的是在服务端使用 Node.js 对接收到的日志信息时使用 source-map 解析，以避免源代码的泄露造成风险
vue.config.js 配置里通过属性 productionSourceMap: true 可以控制 webpack 是否生成 map 文件
webpack 自定义插件实现 sourcemap 自动上传
为了我们每一次构建服务端能拿到最新的 map 文件，我们编写一个插件让 webpack 在打包完成后触发一个钩子实现文件上传，在 vue.config.js 中进行配置
//vue.config.js
let SourceMapUploader = require("./source-map-upload");
module.exports = {
configureWebpack: {
resolve: {
alias: {
"@": resolve("src"),
},
},
plugins: [new SourceMapUploader({ url: "http://localhost:3000/upload" })],
},
// chainWebpack: (config) => {},
};
//source-map-upload.js
const fs = require("fs");
const http = require("http");
const path = require("path");
class SourceMapUploader {
constructor(options) {
this.options = options;
}
/**
* 用到了hooks，done表示在打包完成之后
* status.compilation.outputOptions就是打包的dist文件
*/
apply(compiler) {
if (process.env.NODE_ENV == "production") {
compiler.hooks.done.tap("sourcemap-uploader", async (status) => {
// console.log(status.compilation.outputOptions.path);
// 读取目录下的map后缀的文件
let dir = path.join(status.compilation.outputOptions.path, "/js/");
let chunks = fs.readdirSync(dir);
let map_file = chunks.filter((item) => {
return item.match(/\.js\.map$/) !== null;
});
// 上传sourcemap
while (map_file.length > 0) {
let file = map_file.shift();
await this.upload(this.options.url, path.join(dir, file));
}
});
}
}
//调用upload接口，上传文件
upload(url, file) {
return new Promise((resolve) => {
let req = http.request(`${url}?name=${path.basename(file)}`, {
method: "POST",
headers: {
"Content-Type": "application/octet-stream",
Connection: "keep-alive",
},
});
let fileStream = fs.createReadStream(file);
fileStream.pipe(req, { end: false });
fileStream.on("end", function () {
req.end();
resolve();
});
});
}
}
module.exports = SourceMapUploader;
错误上报
两种方式：
- img 标签： 这种方式无需加载任何通讯库，而且页面是无需刷新的，相当于 get 请求，没有跨域问题。缺点是有 url 长度限制，但一般来讲足够使用了。
- ajax： 与正常的接口请求无异，可以用 post
这里采用第一种，通过动态创建一个 img,浏览器就会向服务器发送 get 请求。将需要上报的错误数据放在 url 中，利用这种方式就可以将错误上报到服务器了。
确定上报的内容，应该包含异常位置（行号，列号），异常信息，在错误堆栈中包含了绝大多数调试有关的信息，我们通讯的时候只能以字符串方式传输，我们需要将对象进行序列化处理。
- 将异常数据从属性中解构出来，存入一个 JSON 对象
- 将 JSON 对象转换为字符串
- 将字符串转换为 Base64
后端接收到信息后进行对应的反向操作，就可以在日志中记录。
function uploadErr({ lineno, colno, error: { stack }, message, filename }) {
let str = window.btoa(
JSON.stringify({
lineno,
colno,
error: { stack },
message,
filename,
})
);
let front_ip = "http://localhost:3000/error";
new Image().src = `${front_ip}?info=${str}`;
}
后端服务
用 koa 搭一个简单后台服务，代码比较简单，按功能拆开来讲
上传文件接口
文件流写入：
router.post("/upload", async (ctx) => {
const stream = ctx.req;
const filename = ctx.query.name;
let dir = path.join(__dirname, "source-map");
//判断source文件夹是否存在
if (!fs.existsSync(dir)) {
fs.mkdirSync(dir);
}
let target = path.join(dir, filename);
const ws = fs.createWriteStream(target);
stream.pipe(ws);
});
错误日志
使用 log4js 记录我们的错误日志，这个也是非常流行的日志插件了，直接贴代码。
const path = require("path");
const log4js = require("log4js");
log4js.configure({
appenders: {
info: {
type: "dateFile",
filename: path.join(__dirname, "logs", "info", "info"),
pattern: "yyyy-MM-dd.log",
encoding: "utf-8",
alwaysIncludePattern: true,
},
error: {
// 错误日志
type: "dateFile",
filename: path.join(__dirname, "logs", "error", "error"),
pattern: "yyyy-MM-dd.log",
encoding: "utf-8",
alwaysIncludePattern: true,
},
},
categories: {
default: { appenders: ["info"], level: "info" },
info: { appenders: ["info"], level: "info" },
error: { appenders: ["error"], level: "error" },
},
});
/**
* 错误日志记录方式
* @param {*} content 日志输出内容
*/
function logError(content) {
const log = log4js.getLogger("error");
log.error(content);
}
/**
* 日志记录方式
* @param {*} content 日志输出内容
*/
function logInfo(content) {
const log = log4js.getLogger("info");
log.info(content);
}
module.exports = {
logError,
logInfo,
};
错误解析
这个接口就是对上报的错误信息进行解析，得到错误堆栈对象。比如我们已经拿到 colno 为 2319，lineno 为 1，接下来需要安装一个插件帮助我们找到对应压缩前的代码位置。
npm install source-map -S
先读取对应的 map 文件（按 filename 对应），然后只需传入压缩后的报错行号列号即可，就会返回压缩前的错误信息。打个比喻：简单地说相当于一本书的目录，我们根据目录可以快速找到某一部分内容的页数
router.get("/error", async (ctx) => {
const errInfo = ctx.query.info;
// 转码 反序列化
let obj = JSON.parse(Buffer.from(errInfo, "base64").toString("utf-8"));
let fileUrl = obj.filename.split("/").pop() + ".map"; // map文件路径
// 解析sourceMap
// 1.sourcemap文件的文件流，我们已经上传
// 2.文件编码格式
let consumer = await new sourceMap.SourceMapConsumer(
fs.readFileSync(path.join(__dirname, "source-map/" + fileUrl), "utf8")
);
// 解析原始报错数据
let result = consumer.originalPositionFor({
line: obj.lineno, // 压缩后的行号
column: obj.colno, // 压缩后的列号
});
// 写入到日志中
obj.lineno = result.line;
obj.colno = result.column;
log4js.logError(JSON.stringify(obj));
ctx.body = "";
});
数据存储 日志可视化
看了一下许多平台对错误日志的分析和可视化都使用了 ELK，ELK 在服务器运维界应该是运用的非常成熟了，很多成熟的大型项目都使用 ELK 来作为前端日志监控、分析的工具。我对运维这一块兴趣不大，有兴趣的可以自行搭建，整出来界面还是挺炫酷的。
而我又不想每一次都跑去服务器查看日志，于是想到了可以建个表来把错误信息给存起来。用起老三样 koa+mongodb+vue，我们这项目就算是齐活了。（mongodb，省去了建表许多功夫）
npm install mongodb –save
新建一个文件 db.js 封装一下 mongo 连接，方便复用：
// db.js
const MongoClient = require("mongodb").MongoClient;
const url = "mongodb://localhost:27017/";
const dbName = "err_db";
const collectionName = "errList";
class Db {
// 单例模式，解决多次实例化时候每次创建连接对象不共享的问题，实现共享连接数据库状态
static getInstance() {
if (!Db.instance) {
Db.instance = new Db();
}
return Db.instance;
}
constructor() {
// 属性 存放db对象
this.dbClient = "";
// 实例化的时候就连接数据库，增加连接数据库速度
this.connect();
}
// 连接数据库
connect() {
return new Promise((resolve, reject) => {
// 解决数据库多次连接的问题，要不然每次操作数据都会进行一次连接数据库的操作，比较慢
if (!this.dbClient) {
// 第一次的时候连接数据库
MongoClient.connect(
url,
{ useNewUrlParser: true, useUnifiedTopology: true },
(err, client) => {
if (err) {
reject(err);
} else {
// 将连接数据库的状态赋值给属性，保持长连接状态
this.dbClient = client.db(dbName);
resolve(this.dbClient);
}
}
);
} else {
// 第二次之后直接返回dbClient
resolve(this.dbClient);
}
});
}
// 增加一条数据
insert(json) {
return new Promise((resolve, reject) => {
this.connect().then((db) => {
db.collection(collectionName).insertOne(json, (err, result) => {
if (err) {
reject(err);
} else {
resolve(result);
}
});
});
});
}
//查询 --
find(query = {}) {
return new Promise((resolve, reject) => {
this.connect().then((db) => {
let res = db.collection(collectionName).find(query);
res.toArray((e, docs) => {
if (e) {
reject(e);
return;
}
resolve(docs);
});
});
});
}
}
module.exports = Db.getInstance();
let db = require("./db");
//...
log4js.logError(JSON.stringify(obj));
//插入数据
await db.insert(obj);
ctx.body = "";
增加一个查询接口：
router.get("/errlist", async (ctx) => {
let res = await db.find({});
ctx.body = {
data: res,
};
});
为了丰富错误信息，我们还可以在上报的时候增加报错时间，用户浏览器信息，自定义错误类型统计，引入图表可视化展示，更加直观地追踪
待完善的点
- 应该做错误类型区分，如业务错误与接口错误等
- 过多的日志在业务服务器堆积，造成业务服务器的存储空间不够的情况，在迁到 mongodb 后在考虑不要日志
- 上报频率做限制。如类似 mouseover 事件中的报错应该考虑防抖般的处理