是否可以在 NestJs 中对 DTO 进行继承?
Is it possible to do inheritance for DTOs in NestJs?
我有一个用于搜索员工列表的 NestJs Get 控制器。
@Controller('employee')
export class EmployeeController {
private logger = new Logger('EmployeeController');
constructor(private employeeService:EmployeeService){}
@Get()
@UsePipes(new ValidationPipe({ transform: true }))
getEmployees(
@Query() filter:GetEmployeesFilterDto
):Promise<Employee[]>{
console.log(JSON.stringify(filter), filter.batch);
return this.employeeService.getEmployees(filter);
}
}
为了支持分页,该方法接受一个过滤器 DTO 以接受批量大小和页码等参数。看到这将如何成为其他 DTO classes 的通用参数,我想创建一个基本过滤器 DTO:
export class BaseQueryFilterDto{
@IsOptional()
@IsInt()
@UsePipes(ParseIntPipe)
batch:number;
@IsOptional()
@IsInt()
@UsePipes(ParseIntPipe)
skip:number;
}
然后为 GetEmployeesFilterDto 继承此 DTO:
export class GetEmployeesFilterDto extends BaseQueryFilterDto{
@IsOptional()
@IsNotEmpty()
search:string;
@IsOptional()
primarySupervisorId:string;
}
运行 以下请求 http://localhost:3000/employee?batch=30 将抛出以下异常:
[Nest] 27920 - 02/14/2020, 6:29:54 PM [ExceptionsHandler] Cannot assign to read only property 'batch' of object '#<GetEmployeesFilterDto>' +606974ms
TypeError: Cannot assign to read only property 'batch' of object '#<GetEmployeesFilterDto>'
at _loop_1 (C:\ng-proj\nestjs-tutorial\node_modules\class-transformer\TransformOperationExecutor.js:242:47)
at TransformOperationExecutor.transform (C:\ng-proj\nestjs-tutorial\node_modules\class-transformer\TransformOperationExecutor.js:260:17)
at ClassTransformer.plainToClass (C:\ng-proj\nestjs-tutorial\node_modules\class-transformer\ClassTransformer.js:17:25) at Object.plainToClass (C:\ng-proj\nestjs-tutorial\node_modules\class-transformer\index.js:20:29)
at ValidationPipe.transform (C:\ng-proj\nestjs-tutorial\node_modules\@nestjs\common\pipes\validation.pipe.js:55:41)
at transforms.reduce (C:\ng-proj\nestjs-tutorial\node_modules\@nestjs\core\pipes\pipes-consumer.js:15:33)
at process._tickCallback (internal/process/next_tick.js:68:7)
但是,当我将所有属性从超级 class 移动到 GetEmployeesFilterDto 时,如下所示:
export class GetEmployeesFilterDto extends BaseQueryFilterDto{
@IsOptional()
@IsNotEmpty()
search:string;
@IsOptional()
primarySupervisorId:string;
//Moved from BaseQueryFilterDto
@IsOptional()
@IsInt()
@UsePipes(ParseIntPipe)
batch:number;
@IsOptional()
@IsInt()
@UsePipes(ParseIntPipe)
skip:number;
}
请求运行成功。
我在这里遗漏了什么或者我不能在 NestJs 中实现对控制器 DTO 的继承?
感谢@JayMcDoniel 指出我不应该在属性上使用 @UsePipes()
。
这是适合我的解决方案。
export class BaseQueryFilterDto{
@IsOptional()
@Type(() => Number)
batch:number;
@IsOptional()
@Type(() => Number)
skip:number;
}
我有一个用于搜索员工列表的 NestJs Get 控制器。
@Controller('employee')
export class EmployeeController {
private logger = new Logger('EmployeeController');
constructor(private employeeService:EmployeeService){}
@Get()
@UsePipes(new ValidationPipe({ transform: true }))
getEmployees(
@Query() filter:GetEmployeesFilterDto
):Promise<Employee[]>{
console.log(JSON.stringify(filter), filter.batch);
return this.employeeService.getEmployees(filter);
}
}
为了支持分页,该方法接受一个过滤器 DTO 以接受批量大小和页码等参数。看到这将如何成为其他 DTO classes 的通用参数,我想创建一个基本过滤器 DTO:
export class BaseQueryFilterDto{
@IsOptional()
@IsInt()
@UsePipes(ParseIntPipe)
batch:number;
@IsOptional()
@IsInt()
@UsePipes(ParseIntPipe)
skip:number;
}
然后为 GetEmployeesFilterDto 继承此 DTO:
export class GetEmployeesFilterDto extends BaseQueryFilterDto{
@IsOptional()
@IsNotEmpty()
search:string;
@IsOptional()
primarySupervisorId:string;
}
运行 以下请求 http://localhost:3000/employee?batch=30 将抛出以下异常:
[Nest] 27920 - 02/14/2020, 6:29:54 PM [ExceptionsHandler] Cannot assign to read only property 'batch' of object '#<GetEmployeesFilterDto>' +606974ms
TypeError: Cannot assign to read only property 'batch' of object '#<GetEmployeesFilterDto>'
at _loop_1 (C:\ng-proj\nestjs-tutorial\node_modules\class-transformer\TransformOperationExecutor.js:242:47)
at TransformOperationExecutor.transform (C:\ng-proj\nestjs-tutorial\node_modules\class-transformer\TransformOperationExecutor.js:260:17)
at ClassTransformer.plainToClass (C:\ng-proj\nestjs-tutorial\node_modules\class-transformer\ClassTransformer.js:17:25) at Object.plainToClass (C:\ng-proj\nestjs-tutorial\node_modules\class-transformer\index.js:20:29)
at ValidationPipe.transform (C:\ng-proj\nestjs-tutorial\node_modules\@nestjs\common\pipes\validation.pipe.js:55:41)
at transforms.reduce (C:\ng-proj\nestjs-tutorial\node_modules\@nestjs\core\pipes\pipes-consumer.js:15:33)
at process._tickCallback (internal/process/next_tick.js:68:7)
但是,当我将所有属性从超级 class 移动到 GetEmployeesFilterDto 时,如下所示:
export class GetEmployeesFilterDto extends BaseQueryFilterDto{
@IsOptional()
@IsNotEmpty()
search:string;
@IsOptional()
primarySupervisorId:string;
//Moved from BaseQueryFilterDto
@IsOptional()
@IsInt()
@UsePipes(ParseIntPipe)
batch:number;
@IsOptional()
@IsInt()
@UsePipes(ParseIntPipe)
skip:number;
}
请求运行成功。 我在这里遗漏了什么或者我不能在 NestJs 中实现对控制器 DTO 的继承?
感谢@JayMcDoniel 指出我不应该在属性上使用 @UsePipes()
。
这是适合我的解决方案。
export class BaseQueryFilterDto{
@IsOptional()
@Type(() => Number)
batch:number;
@IsOptional()
@Type(() => Number)
skip:number;
}