【Express.js】异常分类和日志分级

阿里云国内75折回扣微信号：monov8

阿里云国际，腾讯云国际，低至75折。AWS 93折免费开户实名账号代冲值优惠多多微信号：monov8 飞机：@monov6

异常分类和日志分级

第一章已经介绍过全局的异常处理了但之前的做法过于简单一股脑的捕获并返回。这一节我们将对异常进行细致的分类并且日志也做标准化的分级。

准备工作

一个基础的 evp-express 项目

NodeJS Error

先了解一下 NodeJS 里面的异常

JavaScript 异常是由于无效操作或作为 throw 语句的目标而抛出的值。虽然不要求这些值是 Error 的实例或从 Error 继承的类但 Node.js 或 JavaScript 运行时抛出的所有异常都将是 Error 的实例。

在 NodeJS 中所有抛出throw的异常都可以被归为通用的 Error此外还内置了更细分的 AssertionError, SystemError, SyntaxError 等。

Error

new Error(message[, options])
error.cause引起 error 的根本原因可以在 new 时的options中加入
error.message错误的描述
error.stack错误栈产生 error 的位置

异常分类

evp-express 的错误中间件已经把异常分类做好了分成两部分 excather 和 exloggerexcatcher 捕获并处理异常exlogger 则记录日志。我们先来看怎么对异常自定义分类。

自定义分类

自定义分类的方法其实很简单无非是在抛出的异常上增加用以标识分类的属性即可。我没有选择这种方式手动抛出时要略微多写几行代码error.message 是一个描述字符串我选择抛出自定义异常时传递的message是一个json字符串json里面再放置具体描述分类信息以及其它等等的信息载体。

throw new Error(JSON.stringfy(
  code: 400,
  msg: "自定义异常1",
  back: true
));

接下来看看异常处理器如何处理自定义异常和其它异常。

excatcher

excatcher做了三件事捕获异常解析异常和根据策略调取异常处理器。

解析异常首先尝试将 err.message 作为 json 字符串解析如果能解析说明是我们自定义的异常如果解析失败说明是其它的异常就当作普通的 Error 处理。
处理自定义异常自定义异常的载体我总共设置了6个属性code分类码msg描述信息symbol业务码/异常码data数据back是否返回给前端具体描述和 statushttp状态码。back置非就返回通用的系统异常错误给前端back置是则根据 code分类码从异常处理策略中取出对应的处理器处理结果如果找不到对应的处理器或者 code 没传就还是返回统一的系统异常给前端。处理完异常之后把异常再传递给 exlogger 中间件去记录异常的日志。
异常处理策略在处理不同的异常上使用了策略模式增强代码的可维护性。

excatcher: (err, req, res, next) => {
  if (err) {
    try {
      const payload = JSON.parse(err.message);
      const {code,msg,symbol,data,back,status} = payload;
      if (back != false) {
        const handler = exhandleStrategy.get(code);
        if ( handler ) { handler(res,msg,symbol,data,status); }
        else { res.json(Resp.bad("System Exception")); }
      } else {
        res.json(Resp.bad("System Exception"));
      }
    } catch (_) { // cannot be parsed to JSON object => common error
      res.json(Resp.bad("System Exception"));
    }
    next(err);
  } else {
    next();
  }
},

exhandleStrategy

const exhandleStrategy = new Map();

exhandleStrategy.set(400, (res, ...args)=>{
  const [msg,symbol,data,status] = args;
  if (status) {
    res.status(status).json(Resp.fail(msg, symbol??-1, data??null));
  } else {
    res.json(Resp.fail(msg, symbol??-1, data??null));
  }
});

exhandleStrategy.set(500, (res, ...args)=>{
  const [msg,symbol,data,status] = args;
  if (status) {
    res.status(status).json(Resp.bad(msg));
  } else {
    res.json(Resp.bad(msg));
  }
})

接下来我们看看 exlogger

exlogger

exlogger 进行了一个判断如果当前日志级别 <= 10000即 DEBUG就记录完整的异常信息否则只记录异常的描述信息。

exlogger: (err,req,res,next)=>{
  if (logger.level.level <= 10000) {
    logger.error(err);
    return;
  }
  logger.error(err.message);
}

logger是什么呢这是 log4js 的日志器让我们来看看utils/logger.js

log4js标准化日志

我们使用 log4js.js 作为日志框架log4js.configure 配置了 log4js 的基本配置日志格式日志方式输出、文件等、日志级别等日志级别从 evp-express 的项目配置信息中读取而得。

const config = require('../config').get();
const log4js = require('log4js');

let logger = log4js.getLogger("");
    
log4js.configure({
  appenders: {
    out: {
      type: "stdout",
      layout: {
          "type": "pattern",
          "pattern": "[%d{yyyy-MM-dd hh:mm:ss}] %p %m"
      }
    }
  },
  categories: {
    default: {
      appenders: ["out"],
      level: config.log4js.level
    }
  }
})

module.exports = logger;

日志级别总共有 “ALL”“TRACE”, “DEBUG”, “INFO”, “WARN”, “ERROR”, “FATAL”致命, “MARK”, “OFF”关闭这几级大小写均支持重要性逐级递增在当前设置的 level 之下的日志将不会被记录如日志级别设置为 “INFO”则 logger.all, logger.trace, logger.debug 将不会进行日志记录。