Nestjs 中的操作日志：追溯用户数据操作的最佳实践

2024-01-06 10:27:44

前言

在现代软件系统中，记录用户对数据的操作至关重要。操作日志可以帮助我们跟踪数据变更的历史记录，便于故障排查、审计和安全分析。在 Nestjs 中，我们可以使用 TypeORM 的 subscriber 来监听数据库的变动，并使用 Nestjs 的模块化设计和依赖注入来构建一个灵活易用的日志记录系统。

实现步骤

1. 安装依赖

首先，我们需要安装 TypeORM 和 Nestjs 的相关依赖。

npm install --save typeorm nestjs-typeorm

2. 创建实体

接下来，我们需要创建一个实体类来表示我们要记录的操作日志。

import { Entity, Column, PrimaryGeneratedColumn } from 'typeorm';

@Entity()
export class OperationLog {

  @PrimaryGeneratedColumn()
  id: number;

  @Column()
  userId: number;

  @Column()
  tableName: string;

  @Column()
  operation: string;

  @Column()
  oldValue: string;

  @Column()
  newValue: string;

  @Column()
  createdAt: Date;

}

3. 创建 subscriber

接下来，我们需要创建一个 subscriber 来监听数据库的变动。

import { EntitySubscriberInterface, EventSubscriber, InsertEvent, UpdateEvent, DeleteEvent } from 'typeorm';
import { OperationLog } from './operation-log.entity';

@EventSubscriber()
export class OperationLogSubscriber implements EntitySubscriberInterface<OperationLog> {

  listenTo() {
    return OperationLog;
  }

  beforeInsert(event: InsertEvent<OperationLog>) {
    console.log(`New operation log: ${event.entity.userId} ${event.entity.tableName} ${event.entity.operation}`);
  }

  beforeUpdate(event: UpdateEvent<OperationLog>) {
    console.log(`Updated operation log: ${event.entity.userId} ${event.entity.tableName} ${event.entity.operation}`);
  }

  beforeDelete(event: DeleteEvent<OperationLog>) {
    console.log(`Deleted operation log: ${event.entity.userId} ${event.entity.tableName} ${event.entity.operation}`);
  }

}

4. 注册 subscriber

最后，我们需要在 Nestjs 模块中注册 subscriber。

import { Module } from '@nestjs/common';
import { TypeOrmModule } from '@nestjs/typeorm';
import { OperationLog } from './operation-log.entity';
import { OperationLogSubscriber } from './operation-log.subscriber';

@Module({
  imports: [
    TypeOrmModule.forFeature([OperationLog]),
  ],
  providers: [
    OperationLogSubscriber,
  ],
})
export class OperationLogModule {}

使用

现在，我们可以在 Nestjs 服务中使用 OperationLogService 来记录操作日志。

import { Injectable } from '@nestjs/common';
import { OperationLogService } from './operation-log.service';

@Injectable()
export class AppService {

  constructor(private readonly operationLogService: OperationLogService) {}

  async logOperation(userId: number, tableName: string, operation: string, oldValue: string, newValue: string) {
    await this.operationLogService.logOperation(userId, tableName, operation, oldValue, newValue);
  }

}