我正在使用 Nest.js 和MySQL构建API。由于敏捷性和DRY原理,我正在创建一个OOP结构,该结构设置给定实体(来自TypeORM)的所有基本CRUD端点。主要目标是避免为不同的实体编写相同的通用方法。
要实现这一目标,我正在使用 TypeScript Generics 的策略。我仍然必须为每个实体创建所有通用文件(.controller.ts
,.service.ts
,.module.ts
,.entity.ts
),但不必编写其方法。相反,我只扩展了两个类:RestController
和RestService
。这些类已经实现了常用方法,但是我必须传递一些 T类型作为参数,以便TypeORM可以向服务注入正确的存储库。
问题:在父类(@UsePipes
)中使用RestController
装饰器时未调用它,但是当我覆盖de RestController 子类(SubcategoriesController
)中的创建方法。
rest.controller.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);
}
}
rest.service.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);
}
}
这是我设置真实实体端点的方法,扩展了上述类:
subcategories.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);
}
}
subcategories.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);
}
}
createSubcategory.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,可选上面的代码完美地创建了端点,但是它没有验证/create
中的有效载荷,正如 ValidationPipe 所期望的那样。
如果我覆盖SubcategoriesController中的 create 方法,并在其中添加UsePipes,则有效!
我认为这可能是涉及Nests生命周期的错误,它可能不支持在抽象类中使用Pipes。
有人有主意吗?
PS 。没有翻译错误,棉绒警告或运行时异常。
答案 0 :(得分:0)
您可能正在寻找InheritValidation装饰器
答案 1 :(得分:0)
一种解决方案是为您的控制器创建一个工厂函数,该函数将接受您的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
或param
,只需通过targetTypes
参数提供适当的值即可。