Prisma扩展实现NestJS数据库钩子操作

在现代应用开发中，我们经常需要在数据库操作（如创建、更新或删除记录）成功完成后执行一些附带的业务逻辑，例如发送邮件通知、更新缓存、记录日志或触发其他服务。如果将这些“副作用”逻辑直接硬编码在API控制器或服务方法中，会导致代码紧密耦合、难以维护和复用。例如，Django框架提供了“信号”（Signals）机制来优雅地处理这类需求。在NestJS与Prisma结合的场景中，我们可以借助Prisma提供的客户端扩展（Client Extensions）机制，实现类似数据库操作后置钩子（Post-Operation Hooks）的功能，从而实现业务逻辑的解耦。

Prisma客户端扩展简介

Prisma客户端扩展允许开发者在Prisma客户端的查询生命周期中注入自定义逻辑。通过扩展，你可以在查询执行前、执行后或者完全替换某个查询行为。这为实现中间件、数据转换、审计日志以及我们这里讨论的后置钩子提供了强大的能力。

核心思想是利用$extends方法，在query级别定义对特定模型和操作的拦截。当对应的数据库操作被调用时，我们定义的扩展逻辑就会被触发。

实现数据库操作后置钩子

以下将通过一个具体的示例，展示如何在NestJS中集成PrismaService，并利用客户端扩展实现一个在创建Post记录后发送通知的逻辑。

1. 创建并配置PrismaService

首先，确保你的NestJS项目中已经配置了Prisma，并且有一个PrismaService来管理Prisma客户端实例。这个服务通常会继承PrismaClient并实现OnModuleInit接口，以便在模块初始化时连接数据库。

// src/prisma/prisma.service.ts
import { INestApplication, Injectable, OnModuleInit } from '@nestjs/common';
import { PrismaClient } from '@prisma/client';

@Injectable()
export class PrismaService extends PrismaClient implements OnModuleInit {
  constructor() {
    super(); // 调用PrismaClient的构造函数
  }

  async onModuleInit(): Promise {
    await this.$connect(); // 连接数据库
    // 将客户端扩展应用到当前PrismaService实例
    Object.assign(this, this.clientExtensions);
  }

  // 可选：在应用关闭时断开数据库连接
  async enableShutdownHooks(app: INestApplication) {
    this.$on('beforeExit', async () => {
      await app.close();
    });
  }

  /**
   * 定义Prisma客户端扩展
   * 这里我们将定义在post模型上创建操作后的钩子
   */
  clientExtensions = this.$extends({
    query: {
      post: {
        async create({ args, query }) {
          // 1. 执行原始的数据库创建操作
          const result = await query(args);

          // 2. 数据库操作成功后，执行自定义的后置逻辑
          // 确保只有在查询成功后才执行此逻辑
          console.log(`新帖子已创建，标题: ${result.title}。正在发送通知...`);
          // 示例：调用一个发送通知的方法
          // await this.sendNotificationToAdmins(result);

          return result; // 返回原始查询结果
        },
        // 你也可以为update、delete等其他操作添加类似的扩展
        // async update({ args, query }) { /* ... */ },
        // async delete({ args, query }) { /* ... */ },
      },
      // 你也可以为其他模型添加扩展
      // user: { /* ... */ },
    },
  });

  // 示例：一个发送通知的方法
  // async sendNotificationToAdmins(post: any) {
  //   // 实际的通知发送逻辑，例如调用第三方服务、发送邮件、推送消息等
  //   console.log(`管理员已收到新帖子 "${post.title}" 的创建通知。`);
  //   // 模拟异步操作
  //   await new Promise(resolve => setTimeout(resolve, 100));
  // }
}

2. 解释核心逻辑

• onModuleInit(): 在NestJS模块初始化时，我们首先调用await this.$connect()连接数据库。然后，关键一步是Object.assign(this, this.clientExtensions);。这一行代码将我们定义的clientExtensions对象中的扩展配置合并到当前的PrismaService实例中。这样，当通过this.prisma.post.create()调用时，就会触发我们定义的扩展。
• clientExtensions = this.$extends({...}): 这是定义扩展的核心部分。
  • query: 表示我们正在扩展查询操作。
  • post: 指定我们希望对Post模型进行扩展。
  • create({ args, query }): 这是一个拦截器函数，它会在每次调用prisma.post.create时被执行。
    • args: 包含了原始create方法的所有参数（即要创建的数据）。
    • query: 这是一个函数，调用它会执行原始的prisma.post.create操作。
• const result = await query(args);: 这一行至关重要。它首先执行了实际的数据库创建操作。我们等待这个操作完成并获取其结果。
• 后置逻辑: console.log(...) 和 await this.sendNotificationToAdmins(result); 代表了在数据库操作成功后需要执行的自定义逻辑。由于query(args)是在await中调用的，这确保了只有在数据库操作成功完成（没有抛出错误）之后，后续的后置逻辑才会被执行。
• return result;: 最后，必须返回query(args)的结果，以确保调用方能够获取到数据库操作的最终结果。

3. 在模块中注册PrismaService

确保在你的NestJS模块中提供了PrismaService。

// src/app.module.ts
import { Module } from '@nestjs/common';
import { AppController } from './app.controller';
import { AppService } from './app.service';
import { PrismaService } from './prisma/prisma.service'; // 导入PrismaService

@Module({
  imports: [],
  controllers: [AppController],
  providers: [AppService, PrismaService], // 提供PrismaService
})
export class AppModule {}

4. 在其他服务中使用PrismaService

现在，当你在其他服务中注入并使用PrismaService进行post.create操作时，定义的后置钩子就会自动触发。

// src/post/post.service.ts
import { Injectable, InternalServerErrorException, Logger } from '@nestjs/common';
import { PrismaService } from '../prisma/prisma.service';
import { CreatePostDto } from './dto/create-post.dto';
import { v4 as uuidv4 } from 'uuid';

@Injectable()
export class PostService {
  private readonly logger = new Logger(PostService.name);

  constructor(private readonly prisma: PrismaService) {}

  async createPost(createPostDto: CreatePostDto) {
    let post;
    try {
      // 这里的create操作将触发PrismaService中定义的扩展
      post = await this.prisma.post.create({
        data: {
          uuid: uuidv4(),
          author: createPostDto.author,
          // categoryId: postCategory.id, // 假设postCategory已获取
          title: createPostDto.title,
          content: createPostDto.content,
          createdAt: new Date(),
          updatedAt: new Date(),
        },
      });
      return post;
    } catch (err) {
      this.logger.error(err);
      throw new InternalServerErrorException('Failed to create the post');
    }
  }
}

注意事项

1. 错误处理: 确保你的后置逻辑能够健壮地处理错误。如果后置逻辑失败，它不应该影响到原始数据库操作的成功状态（除非你明确希望如此）。在上述示例中，如果sendNotificationToAdmins抛出错误，它将会在createPost方法中被捕获。
2. 异步操作: 后置逻辑通常涉及异步操作（如网络请求）。务必使用await关键字确保这些操作正确执行并完成。
3. 性能影响: 复杂的后置逻辑会增加数据库操作的整体响应时间。评估其对应用性能的潜在影响，并考虑是否需要将特别耗时的操作 offload 到消息队列或后台任务中。
4. 事务一致性: 默认情况下，扩展中的后置逻辑与原始数据库操作不在同一个事务中。这意味着即使后置逻辑失败，数据库操作仍然可能成功提交。如果你的后置逻辑需要与数据库操作保持严格的事务一致性，可能需要更复杂的策略，例如使用两阶段提交（2PC）或补偿事务。对于发送通知这类非强一致性要求的功能，当前方案是足够的。
5. 扩展其他操作: 除了create，你还可以为update、delete、upsert等其他Prisma操作定义类似的扩展。
6. 全局与局部扩展: 客户端扩展可以在全局（如PrismaService中定义）生效，也可以在特定查询链中临时应用。对于通用的后置钩子，全局定义是更合适的选择。

总结

通过利用Prisma客户端扩展，我们可以在NestJS应用中优雅地实现数据库操作后置钩子。这种模式有效地将核心业务逻辑与次要副作用解耦，提升了代码的模块化、可读性和可维护性。它提供了一种强大且灵活的方式来响应数据库事件，而无需在每个API端点中重复编写相同的处理逻辑，从而构建出更加健壮和可扩展的NestJS应用。