NestJS Form Data 项目教程

1. 项目介绍

nestjs-form-data 是一个用于处理 multipart/form-data 的 NestJS 中间件，主要用于文件上传。它简化了在 NestJS 应用中处理表单数据的过程，特别是当表单中包含文件上传时。

2. 项目快速启动

安装

首先，你需要安装 nestjs-form-data 包：

npm install nestjs-form-data

配置

在你的 NestJS 项目中，你需要在模块中导入 NestjsFormDataModule：

import { Module } from '@nestjs/common';
import { NestjsFormDataModule } from 'nestjs-form-data';

@Module({
  imports: [
    NestjsFormDataModule.config({
      storage: MemoryStoredFile,
    }),
  ],
  controllers: [],
  providers: [],
})
export class AppModule {}

使用

在你的控制器中，你可以使用 @FormDataRequest() 装饰器来处理表单数据：

import { Controller, Post, Body } from '@nestjs/common';
import { FormDataRequest } from 'nestjs-form-data';
import { FormDataTestDto } from './dto/form-data-test.dto';

@Controller()
export class NestjsFormDataController {
  @Post('upload')
  @FormDataRequest()
  async uploadFile(@Body() formData: FormDataTestDto) {
    console.log(formData);
    return formData;
  }
}

DTO 定义

你可以定义一个 DTO 来验证表单数据：

import { FileSystemStoredFile, HasMimeType, IsFile, MaxFileSize } from 'nestjs-form-data';

export class FormDataTestDto {
  @IsFile()
  @MaxFileSize(1e6)
  @HasMimeType(['image/jpeg', 'image/png'])
  file: FileSystemStoredFile;
}

3. 应用案例和最佳实践

文件上传

nestjs-form-data 最常见的应用场景是文件上传。通过使用 @FormDataRequest() 装饰器，你可以轻松地将文件和其他表单数据一起处理。

数据验证

使用 DTO 和装饰器（如 @IsFile、@MaxFileSize、@HasMimeType）可以确保上传的文件符合预期的格式和大小要求。

错误处理

在处理文件上传时，建议添加适当的错误处理机制，以应对文件大小超出限制、文件类型不匹配等情况。

4. 典型生态项目

NestJS

nestjs-form-data 是 NestJS 生态系统中的一个重要组件，与 NestJS 的其他模块（如 @nestjs/common、@nestjs/platform-express）无缝集成。

Multer

nestjs-form-data 内部使用了 multer 来处理文件上传，因此它与 multer 的配置选项兼容，可以进一步定制文件上传的行为。

TypeORM

在处理文件上传后，你可能需要将文件信息存储到数据库中。nestjs-form-data 可以与 TypeORM 结合使用，将文件信息保存到数据库中。

通过以上步骤，你可以轻松地在 NestJS 项目中集成 nestjs-form-data，并实现文件上传功能。