Node.js 使用日志记录库 (如 Winston)

安装 Winston

Winston 是一个流行的日志记录库，支持多种传输方式，包括控制台、文件、HTTP 等。使用 Winston 可以方便地记录和管理应用程序的日志信息。

首先，你需要安装 Winston 库。可以通过 npm 来安装：

npm install winston

安装完成后，你可以在你的 Node.js 项目中引入 Winston。

基本使用

创建日志实例

你可以通过 createLogger 方法来创建一个日志记录器。默认情况下，它会将日志输出到控制台。下面是一个简单的示例：

const winston = require('winston');

const logger = winston.createLogger({
  transports: [
    new winston.transports.Console()
  ]
});

记录不同级别的日志

Winston 提供了多种日志级别，如 info, warn, error 等。每个级别对应不同的日志严重程度。以下是一些常见的日志记录方法：

logger.info('这是信息级别的日志');
logger.warn('这是警告级别的日志');
logger.error('这是错误级别的日志');

自定义日志格式

默认情况下，Winston 的日志格式是固定的，但你可以根据需要自定义日志的输出格式。例如，你可以使用 format 模块来自定义日志格式：

// www.javascriptcn.com code example
const { createLogger, format, transports } = require('winston');

const logger = createLogger({
  format: format.combine(
    format.label({ label: 'MyApp' }),
    format.timestamp(),
    format.printf(info => `${info.timestamp} [${info.level}] ${info.message}`)
  ),
  transports: [
    new transports.Console()
  ]
});

logger.info('这是带有标签和时间戳的日志');

将日志写入文件

除了控制台输出，你还可以将日志写入文件。Winston 支持多种传输方式，包括文件传输。下面是如何将日志写入文件：

// www.javascriptcn.com code example
const { createLogger, format, transports } = require('winston');

const logger = createLogger({
  format: format.combine(
    format.label({ label: 'MyApp' }),
    format.timestamp(),
    format.printf(info => `${info.timestamp} [${info.level}] ${info.message}`)
  ),
  transports: [
    new transports.File({ filename: 'error.log', level: 'error' }),
    new transports.File({ filename: 'combined.log' })
  ]
});

logger.info('这是写入文件的日志');
logger.error('这是写入 error 文件的日志');

配置不同的环境

在开发和生产环境中，你可能希望使用不同的日志配置。可以通过环境变量来实现这一点：

// www.javascriptcn.com code example
const winston = require('winston');

const logger = winston.createLogger({
  level: process.env.NODE_ENV === 'production' ? 'warn' : 'debug',
  transports: [
    new winston.transports.Console()
  ]
});

logger.info('这是在开发环境下的日志');
logger.warn('这是在生产环境下的日志');

错误处理

在处理错误时，可以使用 Winston 的 error 级别来记录详细的错误信息：

try {
  // 一些可能会出错的操作
} catch (err) {
  logger.error(err);
}

日志轮转

为了避免日志文件过大，可以使用日志轮转功能。Winston 提供了 winston-daily-rotate-file 插件来实现日志轮转：

npm install winston-daily-rotate-file

然后在代码中配置日志轮转：

// www.javascriptcn.com code example
const { createLogger, format, transports } = require('winston');
const DailyRotateFile = require('winston-daily-rotate-file');

const logger = createLogger({
  format: format.combine(
    format.label({ label: 'MyApp' }),
    format.timestamp(),
    format.printf(info => `${info.timestamp} [${info.level}] ${info.message}`)
  ),
  transports: [
    new DailyRotateFile({ filename: 'application-%DATE%.log' }),
    new transports.Console()
  ]
});

logger.info('这是带有日志轮转功能的日志');

高级配置

Winston 还提供了许多高级配置选项，如日志的分类、日志的优先级等。你可以根据实际需求进行调整和扩展。

通过以上介绍，你应该能够开始使用 Winston 来记录和管理 Node.js 应用程序的日志信息了。希望这些示例能帮助你更好地理解和应用 Winston。