任何语言框架都少不了日志模块，在node这种及其开发的环境中，日志模块真是又多又杂，网上也有很多比较的帖子，这里都不多说了，最近项目中用到了log4js，结合自己的实践，介绍下这个模块。

log4js是从log4j衍生出来的，如果用log4j的使用经验，则上手log4js会很快。

陈列文档

• 文档介绍
• github

简单上手

安装

yarn add log4js
或者
npm install log4js

使用

var log4js = require('log4js');
var logger = log4js.getLogger();
logger.level = 'debug';
logger.debug("Some debug messages");

上述代码就会在控制台输入:

[2020-02-22 19:43:37.387] [DEBUG] [default] - Some debug messages

配置介绍

在使用该日志框架时，至少要关心三个问题，所有的配置也是围绕这三个问题展开：

• 日志级别
• 日志分类
• 日志落盘

日志级别 （Level）

所有的日志框架提供的日志级别都是大同小异的，而且使用的方式也基本相同

  // https://github.com/log4js-node/log4js-node/blob/master/lib/levels.js#L91-L99  ALL: { value: Number.MIN_VALUE, colour: 'grey' },TRACE: { value: 5000, colour: 'blue' },DEBUG: { value: 10000, colour: 'cyan' },INFO: { value: 20000, colour: 'green' },WARN: { value: 30000, colour: 'yellow' },ERROR: { value: 40000, colour: 'red' },FATAL: { value: 50000, colour: 'magenta' },MARK: { value: 9007199254740992, colour: 'grey' }, // 2^53OFF: { value: Number.MAX_VALUE, colour: 'grey' }

级别从 ALL -> OFF 依次增高，当我们设定级别后，等于或高于该级别的日志都会输出。

举例来说，我们定义level为 INFO，则 INFO及以上都会输出

default: { appenders: ['console', 'runtime'], level: 'info' }

日志分类 (Category)

分类是从另外一个维度来区分日志，可以提供多种分类，在实例化 LOGGER 实例的时候传入，这样该实例打印的日志都在该分类下，比如下方示例：

categories: {access: { appenders: ['console', 'access'], level: 'debug' }, // access 分类default: { appenders: ['console', 'runtime'], level: 'debug' } // 默认分类
}

提供了两个分类，如果想使用 access 分类，则按照下方的实例化即可：
const LOGGER = log4js.getLogger('access')

则 LOGGER 则使用了 debug 级别，并且使用 console 和 access 两个 appender

日志落盘 （Appender）

    access: {type: 'DateFile', // 输出的类型，比如console;file;DateFile等pattern: '-yyyy-MM-dd.log', // 文件时间的命名方式daysToKeep: 5, // 日志保留几天filename: './logs/access.log', // 日志文件名compress: true // 是否压缩保存}

实战演练

了解了上述几个配置之后，基本可以配置出我们想要的日志输出方式了，比如下方配置：

const log4js = require('log4js')log4js.configure({appenders: { // 定义输出到哪console: {type: 'stdout'},runtime: {type: 'DateFile',pattern: '-yyyy-MM-dd.log',daysToKeep: 5, // 删除5天前的日志filename: './logs/runtime.log',keepFileExt: false,compress: true},access: {type: 'DateFile',pattern: '-yyyy-MM-dd.log',daysToKeep: 5,filename: './logs/access.log',keepFileExt: false,compress: true}},categories: { // 定义两个分类，外部实例化的时候可以任选其一access: { appenders: ['console', 'access'], level: 'debug' },default: { appenders: ['console', 'runtime'], level: 'debug' }}
})module.exports = function getLogger(category) {return log4js.getLogger(category)
}

我们对外暴露了统一实例化获取Logger的方式，外部获取到实例之后，调用对应的输出方法输出即可：

const runtimeLogger = require('../log4js')()runtimeLogger.info(`构造Service实例, header: ${JSON.stringify(header)})// 输出： [2020-02-20T00:32:48.184] [INFO] default - 构造Service实例，header: xx

总结

本文介绍了log4js的基本使用，log4js还可以通过中间件和express,koa等框架结合，在各个入口或者出口打边界日志。log4js在使用起来很简单，也很强大，正常的项目肯定是足够用的。