Express入门指南：巧用log4js进行日志管理

2023-11-02 01:34:40

对于线上项目来说，日志是非常重要的一环。log4js是使用得比较多的一个日志组件，经常跟Express一起配合使用。本文从入门实例开始，讲解log4js的使用，以及如何跟Express进行整合。

1. 什么是log4js？

log4js是一个功能强大的日志组件，可以帮助您轻松记录和管理应用程序中的日志。它支持多种日志格式，包括文本、JSON、XML等，并且可以将日志输出到多种目的地，包括文件、控制台、网络等。

2. 安装log4js

log4js可以在NPM上安装，命令如下：

npm install log4js

安装完成后，您可以在项目中通过以下代码引入log4js：

const log4js = require('log4js');

3. 配置log4js

log4js的配置非常灵活，您可以根据自己的需要进行配置。以下是常见的配置项：

appenders ：日志输出目的地，例如文件、控制台、网络等。
categories ：日志类别，您可以为不同的模块或组件定义不同的日志类别。
levels ：日志级别，包括TRACE、DEBUG、INFO、WARN、ERROR、FATAL等。

您可以通过以下代码来配置log4js：

log4js.configure({
  appenders: {
    console: { type: 'console' },
    file: { type: 'file', filename: 'logs/app.log' }
  },
  categories: {
    default: { appenders: ['console', 'file'], level: 'INFO' }
  }
});

4. 使用log4js

配置完成后，您就可以开始使用log4js来记录日志了。您可以使用以下代码来记录日志：

const logger = log4js.getLogger('my-category');

logger.trace('This is a trace message.');
logger.debug('This is a debug message.');
logger.info('This is an info message.');
logger.warn('This is a warn message.');
logger.error('This is an error message.');
logger.fatal('This is a fatal message.');

5. 将log4js与Express整合

要将log4js与Express整合，您可以使用以下代码：

const express = require('express');
const log4js = require('log4js');

const app = express();

// 配置log4js
log4js.configure({
  appenders: {
    console: { type: 'console' },
    file: { type: 'file', filename: 'logs/app.log' }
  },
  categories: {
    default: { appenders: ['console', 'file'], level: 'INFO' }
  }
});

// 创建一个中间件来记录请求日志
const logger = log4js.getLogger('http');
app.use((req, res, next) => {
  logger.info('Received request: ', req.method, req.url);
  next();
});

// 启动服务器
app.listen(3000);

这样，当您运行Express应用程序时，所有请求都会被记录到logs/app.log文件中。

6. 常见问题

Q：如何更改日志级别？

A：您可以通过修改log4js的配置来更改日志级别。例如，要将默认日志级别更改为DEBUG，您可以使用以下代码：

log4js.configure({
  appenders: {
    console: { type: 'console' },
    file: { type: 'file', filename: 'logs/app.log' }
  },
  categories: {
    default: { appenders: ['console', 'file'], level: 'DEBUG' }
  }
});

Q：如何将日志输出到多个目的地？

A：您可以通过在log4js的配置中指定多个appender来将日志输出到多个目的地。例如，要将日志输出到控制台和文件，您可以使用以下代码：

log4js.configure({
  appenders: {
    console: { type: 'console' },
    file: { type: 'file', filename: 'logs/app.log' }
  },
  categories: {
    default: { appenders: ['console', 'file'], level: 'INFO' }
  }
});

Q：如何记录请求日志？

A：您可以通过在Express应用程序中使用中间件来记录请求日志。例如，以下代码会记录所有请求的URL和方法：

const express = require('express');
const log4js = require('log4js');

const app = express();

// 配置log4js
log4js.configure({
  appenders: {
    console: { type: 'console' },
    file: { type: 'file', filename: 'logs/app.log' }
  },
  categories: {
    default: { appenders: ['console', 'file'], level: 'INFO' }
  }
});

// 创建一个中间件来记录请求日志
const logger = log4js.getLogger('http');
app.use((req, res, next) => {
  logger.info('Received request: ', req.method, req.url);
  next();
});

// 启动服务器
app.listen(3000);