NestJS FileInterceptor+DTO实现Swagger文件上传报错及最佳实践咨询

问题根因 #

你遇到的"logo should not be empty"报错核心原因很简单：

• multipart/form-data请求经过Multer（也就是NestJS里FileInterceptor用的底层解析库）处理时，文件类型字段会被单独解析挂载到req.file/req.files属性上，只有普通文本字段才会被写入req.body。内置的ValidationPipe在做DTO校验时，只会读取req.body里的字段，自然拿不到logo值，直接触发@IsNotEmpty()的校验规则。
• 你控制器里的@UploadedFile('file')写法有误：FileInterceptor配置的接收字段名是logo，这里传的'file'参数是多余的，正确写法是直接写@UploadedFile() file，否则会出现拿不到文件对象的问题。

关于你写的FileExtender拦截器的评价 #

你手动把req.file.buffer塞到req.body里绕过校验的方案能跑，但绝对不算最佳实践，存在几个明显问题：

• 没有做空值兜底，只要请求不传logo字段，访问req.file.buffer会直接抛500服务端错误
• 把文件解析、参数校验的逻辑揉在自定义拦截器里，和NestJS内置的Multer、ValidationPipe职责重叠，后续加文件大小、类型限制时逻辑分散不好维护
• 二进制文件数据直接塞进body对象再流转，多了一层无意义的赋值操作

符合NestJS设计规范的实现方案 #

不用写自定义拦截器，用框架内置能力就能实现，逻辑更清晰也更好维护：

1. 调整DTO定义 #

把文件字段从普通DTO里剥离，普通DTO只校验文本字段：

import { ApiProperty } from '@nestjs/swagger';
import { Expose } from 'class-transformer';
import { IsNotEmpty, IsBooleanString } from 'class-validator';

export class CreateGatewayDto {  
  @ApiProperty({ default: 'foo' })
  @IsNotEmpty()
  @Expose()
  name: string;
  
  @ApiProperty({default: 'XXXX:YYYY'})
  @IsNotEmpty()
  @Expose()
  token: string;

  @ApiProperty({default: '123'})
  @IsNotEmpty()
  @Expose()
  channelId: string;
  
  @ApiProperty({ default: 'true' })  
  @IsBooleanString() // 比单纯的@IsNotEmpty更合理，会校验值是否是合法的布尔字符串
  @IsNotEmpty()
  @Expose()
  public: string;
}

2. 控制器配置 #

直接给FileInterceptor传配置项完成文件校验，不用额外写拦截器：

import { Post, HttpCode, HttpStatus, UseInterceptors, UploadedFile, Body, Request, BadRequestException } from '@nestjs/common';
import { FileInterceptor } from '@nestjs/platform-express';
import { ApiConsumes, ApiBody, ApiCreatedResponse } from '@nestjs/swagger';

// 控制器方法
@Post('/')
@ApiConsumes('multipart/form-data')
@ApiBody({
    schema: {
        type: 'object',
        required: ['name', 'token', 'channelId', 'public', 'logo'], // 把必填字段加上，Swagger文档会正确标识
        properties: {
            name: { type: 'string', default: 'foo' },
            token: { type: 'string', default: '11:22' },
            channelId: { type: 'string', default: '1234' },
            public: { type: 'string', default: 'true' },
            logo: { type: 'string', format: 'binary' },
        },
    },
})
@UseInterceptors(FileInterceptor('logo', {
  limits: {
    fileSize: 2 * 1024 * 1024, // 按需调整文件大小限制，这里是2M
  },
  fileFilter: (req, file, cb) => {
    // 按需限制文件类型，这里示例只允许上传图片
    if (!file.mimetype.startsWith('image/')) {
      return cb(new BadRequestException('logo仅支持上传图片格式'), false);
    }
    cb(null, true);
  }
}))
@HttpCode(HttpStatus.CREATED)
@ApiCreatedResponse(GatewayConfigSwagger.API_CREATE_GATEWAY)
public async create(
    @UploadedFile() file: Express.Multer.File,
    @Body() data: CreateGatewayDto,
    @Request() request
) {
    // 手动校验文件必填，逻辑更直观
    if (!file) {
      throw new BadRequestException('logo不能为空');
    }

    // 组装存入MongoDB的数据
    const createPayload = {
      ...data,
      public: data.public === 'true', // 把字符串转成布尔值再存
      logo: file.buffer,
      logoMimeType: file.mimetype // 建议额外存文件类型，后续读取返回给前端时要用到
    };

    return this.gatewayService.create(request.user.userId._id, createPayload);
}

MongoDB存储文件注意事项 #

• MongoDB单文档有16M的硬大小限制，如果要存超过16M的文件，不要直接存Buffer，用GridFS实现
• 小体积文件比如头像、图标直接存Buffer没问题，大体积文件建议存专业对象存储，MongoDB只存文件访问地址，性能更好
• 存文件Buffer时一定要同步存MIME类型，否则后续读取文件返回给前端时无法正确识别文件格式

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