Nest通关秘籍

现在我们的日志都是直接打印在 console 的，这样开发时没问题，但是线上有时候我们要去查日志，这时候在 console 打印的日志就不是很方便。

所以我们要把日志保存在文件里，或者通过 http 发送到专门的日志服务器。

而 winston 等日志框架就是做这个的。

nest 集成 winston 直接用 nest-winston 这个包，没必要自己写。

在 backend 项目里安装下依赖：

npm install --save nest-winston winston

然后在 AppModule 引入下：

javascript

WinstonModule.forRootAsync({
  useFactory: () => ({
    level: 'debug',
    transports: [
      new winston.transports.File({
        filename: `${process.cwd()}/log`,
      }),
      new winston.transports.Console({
        format: winston.format.combine(
          winston.format.timestamp(),
          utilities.format.nestLike(),
        ),
      }),
    ],
  })
}),

我们指定日志输出级别是 debug，输出到的 transport 包括 console 和 file。

然后把 winston 的 logger 设置为 Nest 的默认 Logger：

javascript

app.useLogger(app.get(WINSTON_MODULE_NEST_PROVIDER));

跑下试试：

npm run start:dev

可以看到，除了 console 之外， log 文件中也输出了一份：

、

两个 transport 都生效了。

页面刷新下：

你会发现 typeorm 的日志并没有输出到文件。

这是因为 TypeORM 有自己的 Logger。

它当然也是可以自定义的。

我们在 src 下新建一个 CustomTypeOrmLogger.ts 文件：

javascript

import { WinstonLogger } from 'nest-winston';
import { Logger, QueryRunner } from 'typeorm';

export class CustomTypeOrmLogger implements Logger {

    constructor(private winstonLogger: WinstonLogger) {

    }

    log(level: 'log' | 'info' | 'warn', message: any) {
        this.winstonLogger.log(message);
    }

    logQuery(query: string, parameters?: any[], queryRunner?: QueryRunner) {
        this.winstonLogger.log({
            sql: query,
            parameters
        });
    }

    logQueryError(error: string | Error, query: string, parameters?: any[], queryRunner?: QueryRunner) {
        this.winstonLogger.error({
            sql: query,
            parameters
        });
    }

    logQuerySlow(time: number, query: string, parameters?: any[], queryRunner?: QueryRunner) {
        this.winstonLogger.log({
            sql: query,
            parameters,
            time
        });
    }

    logSchemaBuild(message: string, queryRunner?: QueryRunner) {
        this.winstonLogger.log(message);
    }

    logMigration(message: string, queryRunner?: QueryRunner) {
        this.winstonLogger.log(message);
    }

}

就是实现 typeorm 的 Logger 接口，实现各种方法就好了。

具体的实现也比较简单，就是通过构造器传入 WinstonLogger，然后分别调用 log、error 等方法打印下日志。

然后我们在 TypeOrmModule 用一下：

试下效果：

现在 console 和 file 里就有 typeorm 的日志了。

现在的日志都是保存在单个文件里，不断追加内容，这样文件会越来越大，不好维护。

我们改下 transport，换成按照日期来分割日志那种。

安装用到的包：

npm install --save winston-daily-rotate-file

用一下：

javascript

new winston.transports.DailyRotateFile({
  level: 'debug',
  dirname: 'daily-log',
  filename: 'log-%DATE%.log',
  datePattern: 'YYYY-MM-DD',
  maxSize: '10k'
}),

指定目录为 daily-log，然后指定文件名的格式和日期格式，文件最大的大小为 10k。

试试看：

多刷新几次页面：

可以看到，产生了几个文件，每个都是 10k 左右。

当然，最重要的是它会自动按照日期分割。

我们改下本地时间：

然后刷新页面，可以看到，日志被记录在了新的文件里：

也就是说，日志会按照日期为维度来分割，并且超过了一定 maxSize 也会分割。

这样，我们查日志的时候就可以找到当天的日期，在日志文件里搜索了。

把 winston 的配置也抽到 .env 里：

javascript

winston_log_level=debug
winston_log_dirname=daily-log
winston_log_filename=log-%DATE%.log
winston_log_date_pattern=YYYY-MM-DD
winston_log_max_size=1M

然后在 WinstonModule 里读取：

javascript

WinstonModule.forRootAsync({
  useFactory: (configService: ConfigService) => ({
    level: 'debug',
    transports: [
      new winston.transports.DailyRotateFile({
          level: configService.get('winston_log_level'),
          dirname: configService.get('winston_log_dirname'),
          filename: configService.get('winston_log_filename'),
          datePattern: configService.get('winston_log_date_pattern'),
          maxSize: configService.get('winston_log_max_size')
      }),
      new winston.transports.Console({
        format: winston.format.combine(
          winston.format.timestamp(),
          utilities.format.nestLike(),
        ),
      }),
    ],
  }),
  inject: [ConfigService]
}),

跑下试试：

没啥问题。

这样，我们的 winston 就集成成功了。

此外，如果你有单独的日志服务，那就更方便了，不需要去服务器查日志文件，可以通过日志服务来查。

假设我们有了这样的日志服务，那可以加一个 Http 的 transport 来上传日志。

javascript

new winston.transports.Http({
  host: 'localhost',
  port: 3002,
  path: '/log'
})

创建个 nest 项目作为日志服务来接收下：

nest new log-server

改下端口：

加个 /log 的路由：

把服务跑起来：

npm run start:dev

页面上触发下查询：

可以看到所有的日志都接收到了：

同时在 console、file、日志服务三个地方保存了日志，这就是 winston 的魅力。

案例代码上传了小册仓库

总结

这节我们集成了日志框架 winston。

没接入 winston 之前，我们都是在 console 打印日志，如果出了问题想查日志很不方便。

接入 winston 之后，日志会在 console 打印，还会保存到日志文件中，按照日期分割，另外还会发送到日志服务来保存。

现在想查日志可以通过日志服务，也可以在查找日期对应的日志文件里搜索。

我们用了 nest-winston 这个包，在 AppModule 引入了 WinstonModoule 之后，在 main.ts 里把它设置为 nest 的 logger。

此外，我们需要自定义 TypeOrm 的 logger，使用 winston logger 来实现它的方法。

这样，日志查询就方便多了。

总结 ​

总结