Express进阶之log4js实用入门指南

Express进阶之log4js实用入门指南是一篇讲述Express框架下如何使用log4js库实现日志功能的教程。具体内容涉及了对log4js库的介绍、安装、配置、使用及注意事项等方面。

下面将对该攻略的内容按照目录逐一进行详细讲解：

一、log4js库介绍

介绍了log4js库的基本概念以及其在Node.js中的应用，同时与Node.js内置的console模块进行了对比，强调了log4js库的的优势和必要性。

二、安装log4js库

讲解了使用npm安装log4js库的方法，包括全局安装和局部安装两种方式，并介绍了相关的命令和参数。

// 全局安装
npm install -g log4js

// 局部安装
npm install log4js

三、log4js的配置

详细介绍了log4js库的配置方式，包括配置文件和代码中手动配置两种方式。配置文件的格式主要包括appenders（输出源）和categories（输出分类）两个部分。介绍了常用的输出源和分类，以及它们的配置方法。

以下是一个配置文件的示例：

{
  "appenders": {
    "console": {
      "type": "console"
    },
    "file": {
      "type": "file",
      "filename": "logs/access.log",
      "maxLogSize": 10485760,
      "backups": 3,
      "compress": true
    }
  },
  "categories": {
    "default": {
      "appenders": ["console", "file"],
      "level": "debug"
    }
  }
}

四、log4js的使用

展示了如何在Express框架中使用log4js库。通过创建一个logger对象，并指定输出源和输出分类，实现对日志的记录和输出。

以下是一个使用的示例：

const log4js = require('log4js');
const logger = log4js.getLogger();
logger.level = 'debug';

app.use(log4js.connectLogger(logger, { level: 'auto', format: ':method :url' }));

五、log4js的注意事项

列举了使用log4js库时需要注意的一些问题，包括日志级别、输出位置、日志文件命名等。

示例说明

以下提供两个示例，分别对log4js的配置和使用进行讲解。

示例1：使用配置文件进行配置

创建一个log4js.json文件，内容如下：

{
  "appenders": {
    "console": {
      "type": "console"
    },
    "file": {
      "type": "file",
      "filename": "logs/access.log",
      "maxLogSize": 10485760,
      "backups": 3,
      "compress": true
    }
  },
  "categories": {
    "default": {
      "appenders": ["console", "file"],
      "level": "debug"
    }
  }
}

在代码中使用如下语句加载配置文件，并创建一个logger对象：

const log4js = require('log4js');
log4js.configure('log4js.json');
const logger = log4js.getLogger();

示例2：将日志输出到控制台和文件

在Express应用程序中，使用log4js记录GET请求的信息，并将日志输出到控制台和文件。

首先，在配置文件中定义两种输出源，分别为控制台和文件：

{
  "appenders": {
    "console": {
      "type": "console"
    },
    "file": {
      "type": "file",
      "filename": "logs/access.log",
      "maxLogSize": 10485760,
      "backups": 3,
      "compress": true
    }
  },
  "categories": {
    "default": {
      "appenders": ["console", "file"],
      "level": "debug"
    }
  }
}

然后，使用log4js的connectLogger中间件，将日志记录到控制台和文件中：

const log4js = require('log4js');
const logger = log4js.getLogger();
logger.level = 'debug';

app.use(log4js.connectLogger(logger, { level: 'auto', format: ':method :url' }));

此时，控制台输出类似于以下信息：

GET /api/users 200 28.782 ms - 734

而access.log文件中则记录了所有的日志信息。