@UsePipes(ValidationPipe) 不适用于泛型(抽象控制器)

2024-04-01

我正在使用构建 APINest.js和MySQL。由于敏捷性和 DRY 原则,我正在创建一个 OOP 结构,它为给定实体(来自 TypeORM)设置所有基本 CRUD 端点。主要目标是避免为不同的实体编写相同的通用方法。

为了实现这一目标,我使用了一种策略TypeScript 泛型。我仍然需要创建所有常用文件(.controller.ts, .service.ts, .module.ts, .entity.ts)对于每个实体,但我不必编写它的方法。相反,我只是扩展了两个类:RestController and RestService。这些类已经实现了常用方法,但我必须传递一些T types作为参数,以便 TypeORM 可以将正确的存储库注入到服务中。

问题: The @UsePipes当我在父类中使用装饰器时,它没有被调用(RestController),但是当我覆盖 de 时它可以正常工作休息控制器在子类中创建方法(SubcategoriesController).

休息控制器.ts:

import { Get, Post, Body, Param, Put, Delete, UsePipes, ValidationPipe } from '@nestjs/common';
import { RestService } from './rest.service';
import { ObjectLiteral } from 'typeorm';

export abstract class RestController<T, C = T, U = T> {
  constructor(protected service: RestService<T, C, U>) {}

  @Get()
  async index(): Promise<T[]> {
    return this.service.getAll();
  }

  @Post('create')
  @UsePipes(ValidationPipe) //HERE!
  async create(@Body() data: C): Promise<T> {
    return this.service.create(data as C);
  }
}

休息.服务.ts:

import { Repository, UpdateResult, DeleteResult, Entity, DeepPartial } from 'typeorm';
import { InjectRepository } from '@nestjs/typeorm';

export interface RestClass<T, C = T, U = T> {
  // Properties
  repository: Repository<T>;

  // Default Methods
  getAll(): Promise<T[]>;
  create(model: T | C | U): Promise<T>;
}

export class RestService<T, C = T, U = T> implements RestClass<T, C, U> {
  constructor(
    public repository: Repository<T>,
  ) {}

  getAll = async () => {
    return await this.repository.find({relations:: this.repository.metadata.ownRelations.map(r => r.propertyName)});
  }

  create = async (model: C) => {
    return await this.repository.save(model as C);
  }
}

以下是我如何设置真实的实体端点,扩展上述类:

子类别.controller.ts:

import { Controller, Get, Post, UsePipes, ValidationPipe, Body } from '@nestjs/common';
import { SubcategoriesService } from './subcategories.service';
import { Subcategory } from './subcategory.entity';
import { RestController } from '../rest.controller';
import { CreateSubcategoryDTO } from './dto/createSubcategory.dto';

//NOTE THE TYPE PARAMS IN <>
@Controller('subcategories')
export class SubcategoriesController extends RestController<Subcategory, CreateSubcategoryDTO> {
  constructor(public service: SubcategoriesService) {
    super(service);
  }    
}

子类别.service.ts

import { Injectable } from '@nestjs/common';
import { InjectRepository } from '@nestjs/typeorm';
import { Subcategory } from './subcategory.entity';
import { Repository } from 'typeorm';
import { RestService } from '../rest.service';
import { CreateSubcategoryDTO } from './dto/createSubcategory.dto';

//NOTE THE TYPE PARAMS IN <>
@Injectable()
export class SubcategoriesService extends RestService<Subcategory, CreateSubcategoryDTO> {

  constructor(
    @InjectRepository(Subcategory) repository: Repository<Subcategory>,
  ) {
    super(repository);
  }
}

创建子类别.dto.ts

import { IsString, Length, IsInt } from 'class-validator';

export class CreateSubcategoryDTO {

  @IsString()
  @Length(5, 60)
  name: string;

  @IsString()
  @Length(0, 140)
  summary: string;

  @Length(0, 140)
  icon: string;

  @IsInt()
  category: number;
}

可以看到父类接受3种类型参数:

  • T:实体
  • C:CreateDTO,可选
  • U:UpdateDTO,可选

然而,上面的代码完美地创建了端点它不验证有效负载 in the /create,正如预期的那样验证管道.

如果我覆盖 the createSubcategoriesController 中的方法,并在其中添加 UsePipes,it works!

我认为这可能是指 Nests 生命周期的错误,它可能不支持在抽象类中使用 Pipes。

有人有主意吗?

P.S。没有转译错误、lint 警告或运行时异常。


解决此问题的一种方法是为控制器创建一个工厂函数,该函数将接受您的 body param 类作为参数,然后将其传递给自定义 ValidationPipe 扩展,如下所示:

@Injectable()
export class AbstractValidationPipe extends ValidationPipe {
  constructor(
    options: ValidationPipeOptions,
    private readonly targetTypes: {
      body?: Type<any>;
      query?: Type<any>;
      param?: Type<any>;
      custom?: Type<any>;
    },
  ) {
    super(options);
  }

  async transform(value: any, metadata: ArgumentMetadata) {
    const targetType = this.targetTypes[metadata.type];
    if (!targetType) {
      return super.transform(value, metadata);
    }
    return super.transform(value, { ...metadata, metatype: targetType });
  }
}

export interface IController<T> {
  hello(body: T);
}

export function Factory<T>(bodyDto: ClassType<T>): ClassType<IController<T>> {
  @Controller()
  class ControllerHost<T> implements IController<T> {
    @Post()
    @UsePipes(new AbstractValidationPipe({whitelist: true, transform: true}, {body: bodyDto}))
    hello(@Body() body: T) {
      return "hello"
    }
  }
  return ControllerHost;
}

export class MyDto {
  @Expose()
  @IsDefined()
  @IsString()
  hello: string;
}

export class AppController extends Factory<MyDto>(MyDto) {}

没有关于 Reflection 可用的泛型的信息,因此标准 ValidationPipe 无法从中获取任何有意义的信息metadata.metatype。我正在通过为其提供可选类型参数来解决这个问题,它可以使用它来覆盖内容metadata.metatype。它有一个很好的功能,它也适用于正常用例(没有泛型)。如果你想覆盖query or param也只是通过提供适当的值targetTypes param.

本文内容由网友自发贡献,版权归原作者所有,本站不承担相应法律责任。如您发现有涉嫌抄袭侵权的内容,请联系:hwhale#tublm.com(使用前将#替换为@)

@UsePipes(ValidationPipe) 不适用于泛型(抽象控制器) 的相关文章