Nest.js 整合 Winston 日志系统的实战教程

初步集成

创建项目:

bash 复制代码
nest new nest-winston-test -p npm

进入目录将服务跑起来:

bash 复制代码
npm run start:dev

安装 winston:

bash 复制代码
npm install winston

创建 logger.service.ts:

typescript 复制代码
import { Injectable, LoggerService } from '@nestjs/common';
import * as winston from 'winston';

@Injectable()
export class WinstonLoggerService implements LoggerService {
  private readonly logger: winston.Logger;

  constructor() {
    this.logger = winston.createLogger({
      transports: [
        new winston.transports.Console(),
        // 根据需要添加更多的 transports
      ],
      format: winston.format.combine(
        winston.format.timestamp(),
        winston.format.printf(
          (info) => `${info.timestamp} ${info.level}: ${info.message}`,
        ),
      ),
    });
  }

  log(message: string) {
    this.logger.log('info', message);
  }

  error(message: string, trace: string) {
    this.logger.log('error', `${message} - ${trace}`);
  }

  warn(message: string) {
    this.logger.log('warn', message);
  }

  // 根据需要添加更多的日志级别方法
}

注册:

使用:

访问下 localhost:3000:

成功打印了日志。但是和 nest 内置的日志格式不一样。我们可以模仿下。

添加更多

安装 dayjs 格式化日期:

bash 复制代码
npm install dayjs

安装 chalk 来打印颜色:

bash 复制代码
npm install chalk@4

注意:这里用的是 chalk 4.x 的版本。

然后来实现下 nest 日志的格式:

typescript 复制代码
import { LoggerService } from '@nestjs/common';
import * as chalk from 'chalk';
import * as dayjs from 'dayjs';
import { createLogger, format, Logger, transports } from 'winston';

export class WinstonLoggerService implements LoggerService {
  private logger: Logger;

  constructor() {
    this.logger = createLogger({
      level: 'debug',
      transports: [
        new transports.Console({
          format: format.combine(
            format.colorize(),
            format.timestamp({ format: 'YYYY-MM-DD HH:mm:ss' }),
            format.printf(({ context, level, message, time }) => {
              const appStr = chalk.green(`[NEST]`);
              const contextStr = chalk.yellow(`[${context}]`);

              return `${appStr} ${time} ${level} ${contextStr} ${message} `;
            }),
          ),
        }),
      ],
    });
  }

  getTime() {
    return dayjs(Date.now()).format('YYYY-MM-DD HH:mm:ss');
  }

  log(message: string, context: string) {
    this.logger.info(message, { context, time: this.getTime() });
  }

  error(message: string, context: string) {
    this.logger.error(message, { context, time: this.getTime() });
  }

  warn(message: string, context: string) {
    this.logger.warn(message, { context, time: this.getTime() });
  }
}

main.ts 替换 Nest.js 内置的 logger:

加下第二个上下文参数:

访问下页面:打印:

然后加一个 File 的 transport。

会生成日志文件:

封装成动态模块

我们可以将 winston 集成到 nest 中,社区也有对应的包:nest-winston,我们来自己封装下叭:

logger.service.ts:

然后在 AppModule 引入下:

改一下 main.ts 里用的 logger:

正常打印:

使用:

相关推荐
泡海椒2 分钟前
jquick-pdf 资源使用率报表模板:政务云集群水位的图表版与表格版怎么选
后端
用户5080070546283 分钟前
1元机器到手后,我拿它跑了一套微服务测试环境
后端
郭生10 分钟前
dedecms等php类cms静态生成速度慢或超时原因及解决方法
后端
Gopher_HBo10 分钟前
Go pprof:五个字段,凭什么管住六种剖析?
后端
生锈的键盘11 分钟前
Docker 环境下 uv 与 Playwright 最佳实践:从镜像构建到多服务版本对齐
后端
不可能片场12 分钟前
工程实践 雪花id进JS别当数字传
前端·electron
涛涛ing19 分钟前
AI帮我生成了一个炫酷的3D大屏,上线3天就卡崩了
前端
jerrywus29 分钟前
用 AMD Radeon Cloud 免费跑 ComfyUI:从开机到打开界面
前端·agent·claude
学以智用30 分钟前
CKEditor5 完整详解
前端·后端
掘金者阿豪38 分钟前
数据库性能优化:一次慢查询背后,可能不只是SQL的问题
前端·后端