如何在NestJS应用中集成KeystoneJS v6并扩展REST API端点？

针对你遇到的问题——无法用extendExpressApp在NestJS中扩展Keystone的REST端点，且现有两种变通方案存在明显缺陷——这里提供一种直接将KeystoneJS作为核心库集成到NestJS的方案，既能复用Keystone的访问控制、数据模型等能力，又能在NestJS中顺畅扩展REST API。

核心思路 #

直接在NestJS项目中初始化Keystone的核心上下文（Context），通过Keystone提供的API执行数据查询/操作，自动继承Keystone中定义的访问控制规则，无需绕路GraphQL或单独维护Prisma客户端。

实施步骤 #

1. 复用Keystone配置

从已部署的Keystone项目中导出核心配置（包括数据模型、权限规则、会话配置等），方便NestJS直接引用：

// 原Keystone项目的keystone.ts
import { config } from '@keystone-6/core';
import { lists } from './schema';
import { withAuth, session } from './auth';

// 导出完整配置，供NestJS使用
export const keystoneConfig = withAuth(
  config({
    db: {
      provider: 'postgresql',
      url: process.env.DATABASE_URL,
    },
    lists,
    session,
    // 保留原Keystone的其他配置项
  })
);

2. 在NestJS中创建Keystone服务

通过NestJS的自定义服务封装Keystone上下文的初始化和管理，确保生命周期与NestJS应用同步：

// NestJS项目/src/keystone/keystone.service.ts
import { Injectable, OnModuleInit, OnModuleDestroy } from '@nestjs/common';
import { createContext, KeystoneContext } from '@keystone-6/core/context';
import { keystoneConfig } from '../../path/to/your/keystone/keystone'; // 调整为实际路径
import { PrismaClient } from '@prisma/client';

@Injectable()
export class KeystoneService implements OnModuleInit, OnModuleDestroy {
  private prisma: PrismaClient;

  async onModuleInit() {
    // 初始化与Keystone共用的Prisma客户端
    this.prisma = new PrismaClient();
    await this.prisma.$connect();
  }

  async onModuleDestroy() {
    // 应用关闭时断开数据库连接
    await this.prisma.$disconnect();
  }

  // 创建带会话的Keystone上下文，自动应用访问控制
  getContext(session?: any): KeystoneContext {
    return createContext({
      config: keystoneConfig,
      prisma: this.prisma,
      session,
    });
  }

  // 示例：封装数据查询方法，直接复用Keystone的访问规则
  async getUserById(userId: string, session?: any) {
    const context = this.getContext(session);
    return context.db.User.findOne({
      where: { id: userId },
    });
  }
}

3. 注册Keystone模块

将Keystone服务注册为NestJS模块，方便其他控制器或服务注入使用：

// NestJS项目/src/keystone/keystone.module.ts
import { Module } from '@nestjs/common';
import { KeystoneService } from './keystone.service';

@Module({
  providers: [KeystoneService],
  exports: [KeystoneService], // 导出供其他模块使用
})
export class KeystoneModule {}

4. 在REST控制器中使用Keystone服务

在NestJS的REST控制器中注入Keystone服务，直接调用封装的方法实现业务逻辑，同时传入会话信息以应用权限控制：

// NestJS项目/src/users/users.controller.ts
import { Controller, Get, Param, Request } from '@nestjs/common';
import { KeystoneService } from '../keystone/keystone.service';

@Controller('users')
export class UsersController {
  constructor(private readonly keystoneService: KeystoneService) {}

  @Get(':id')
  async getUserDetail(@Param('id') userId: string, @Request() req) {
    // 从请求中解析出Keystone格式的会话（比如从JWT令牌转换）
    const userSession = req.user;
    // 调用Keystone服务的方法，自动应用访问控制
    return this.keystoneService.getUserById(userId, userSession);
  }
}

方案优势 #

• 权限复用：完全继承Keystone中定义的访问控制规则，无需重复编写权限逻辑
• 性能优化：直接通过Keystone上下文操作数据库，避免GraphQL客户端的网络开销
• 开发高效：使用Keystone的类型安全查询语法，无需维护大量GraphQL查询字符串
• 架构清晰：Keystone与NestJS可部署在同级目录，避免框架代码混合

内容的提问来源于stack exchange，提问作者Mohammad Esmaeilzadeh