如何在NestJS中获取Prisma模型类型并转为数组返回前端

核心思路 #

利用TypeScript反射元数据结合NestJS原生工具，从CreateJobOfferDto中提取属性键与类型，生成前端动态表单所需的结构。该方案无需额外依赖，且能同步DTO的校验规则（如是否可选）。

步骤1：确保开启反射元数据 #

在项目根目录的tsconfig.json中启用以下配置（NestJS项目通常默认已开启）：

{
  "compilerOptions": {
    "experimentalDecorators": true,
    "emitDecoratorMetadata": true
  }
}

步骤2：编写元数据提取工具函数 #

创建src/utils/dto-metadata.util.ts文件，实现DTO属性与类型的提取逻辑：

import { Reflector } from '@nestjs/core';
import { getMetadata } from 'class-validator';

/**
 * 提取DTO的属性键、类型及可选状态
 * @param dtoClass DTO类的构造函数
 * @returns 前端表单所需的元数据结构
 */
export function getDtoProperties<T>(dtoClass: new () => T) {
  const reflector = new Reflector();
  // 获取DTO实例的所有属性键
  const propertyKeys = Object.getOwnPropertyNames(new dtoClass());

  return propertyKeys.map(key => {
    // 通过反射获取属性的原始类型
    const type = reflector.get('design:type', dtoClass.prototype, key);
    // 将类型名称转换为前端友好格式（如Number → 'number'）
    const typeName = type.name.toLowerCase();
    
    // 提取是否可选的元数据（来自class-validator的@IsOptional装饰器）
    const isOptional = !!getMetadata('class-validator:is-optional', dtoClass.prototype, key);

    return {
      key,
      type: typeName,
      optional: isOptional
    };
  });
}

步骤3：在控制器中暴露元数据接口 #

修改src/job-offers/job-offer.controller.ts，添加接口返回表单元数据：

import { Controller, Get } from '@nestjs/common';
import { CreateJobOfferDto } from './dto/create-job-offer.dto';
import { getDtoProperties } from '../utils/dto-metadata.util';

@Controller('job-offers')
export class JobOfferController {
  /**
   * 获取职位申请表单的元数据，用于前端动态生成表单
   */
  @Get('form-metadata')
  getFormMetadata() {
    return getDtoProperties(CreateJobOfferDto);
  }
}

方案优势 #

• 原生支持：基于NestJS的Reflector和class-validator元数据，无需引入第三方库
• 扩展性强：可轻松扩展提取更多校验规则（如IsString、IsEmail等），为前端提供更丰富的表单逻辑依据
• 类型安全：依赖TypeScript反射机制，确保属性与类型的准确性

额外方案：直接从Prisma模型提取 #

若需直接从Prisma模型生成元数据（而非DTO），可利用Prisma的元数据API：

import { PrismaClient } from '@prisma/client';

const prisma = new PrismaClient();

/**
 * 提取Prisma模型的属性与类型
 * @param modelName Prisma模型名称（如'JobOffer'）
 * @returns 表单元数据结构
 */
export function getPrismaModelProperties(modelName: string) {
  const modelMeta = prisma[modelName as keyof PrismaClient].$meta();
  return Object.entries(modelMeta.fields).map(([key, field]) => ({
    key,
    type: field.type.toLowerCase()
  }));
}

注意：Prisma模型的字段可能与DTO存在差异（如DTO会裁剪或添加可选属性），优先使用DTO方案更贴合前端表单需求。

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