使用Multer选项（包括导入）的最干净的实现

Question

由于nestjs是一个快速应用程序，因此可以使用任何库来处理使用嵌套的上传，并且由于它提供了Midlewares，因此也可以使用multer。我的问题是：使用nestjs处理文件上传的最佳方法是什么？

Answer 1

由@Kamyl在问题{{3}}上通知，因为v4.6.0可以使用公共文件拦截器使用multer上传文件到nestjs。

import { ... , UseInterceptors, FileInterceptor, UploadedFile } from '@nestjs/common'

... 

@UseInterceptors(FileInterceptor('file'))
async upload( @UploadedFile() file) {
  console.log(file)
}

这样变量file将有一个buffer

使用Multer选项

它还需要字段名称作为第一个参数，然后是一个带有Multer选项的数组

import { ... , UseInterceptors, FileInterceptor, UploadedFile } from '@nestjs/common'
import { diskStorage } from 'multer'
import { extname } from 'path'

...

@UseInterceptors(FileInterceptor('file', {
  storage: diskStorage({
    destination: './uploads'
    , filename: (req, file, cb) => {
      // Generating a 32 random chars long string
      const randomName = Array(32).fill(null).map(() => (Math.round(Math.random() * 16)).toString(16)).join('')
      //Calling the callback passing the random name generated with the original extension name
      cb(null, `${randomName}${extname(file.originalname)}`)
    }
  })
}))
async upload( @UploadedFile() file) {
  console.log(file)
}

这样变量file将包含filename，destination和path。

来自destination的{{1}}参数也可以是一个函数，带有参数并期望回调与diskStorage相同。通过传递filename文件将自动保存到目的地，并通过给定的文件名。

使用diskStorage和@UploadedFiles（复数）

也可以处理多个文件

Answer 2

一种更干净的方法是将配置提取到一个单独的文件，然后在拦截器方法中调用它

import { extname } from 'path';
import { existsSync, mkdirSync } from 'fs';
import { diskStorage } from 'multer';
import { v4 as uuid } from 'uuid';
import { HttpException, HttpStatus } from '@nestjs/common';

// Multer configuration
export const multerConfig = {
    dest: process.env.UPLOAD_LOCATION,
};

// Multer upload options
export const multerOptions = {
    // Enable file size limits
    limits: {
        fileSize: +process.env.MAX_FILE_SIZE,
    },
    // Check the mimetypes to allow for upload
    fileFilter: (req: any, file: any, cb: any) => {
        if (file.mimetype.match(/\/(jpg|jpeg|png|gif)$/)) {
            // Allow storage of file
            cb(null, true);
        } else {
            // Reject file
            cb(new HttpException(`Unsupported file type ${extname(file.originalname)}`, HttpStatus.BAD_REQUEST), false);
        }
    },
    // Storage properties
    storage: diskStorage({
        // Destination storage path details
        destination: (req: any, file: any, cb: any) => {
            const uploadPath = multerConfig.dest;
            // Create folder if doesn't exist
            if (!existsSync(uploadPath)) {
                mkdirSync(uploadPath);
            }
            cb(null, uploadPath);
        },
        // File modification details
        filename: (req: any, file: any, cb: any) => {
            // Calling the callback passing the random name generated with the original extension name
            cb(null, `${uuid()}${extname(file.originalname)}`);
        },
    }),
};

然后像这样在拦截器下调用它

import { ... , UseInterceptors, FileInterceptor, UploadedFile } from '@nestjs/common'
import { diskStorage } from 'multer'
import { extname } from 'path'
import { multerOptions } from 'src/config/multer.config';
...

@Post('/action/upload')
@UseInterceptors(FileInterceptor('file', multerOptions))
async upload( @UploadedFile() file) {
  console.log(file)
}

Answer 3

**

2021 年更新

**

现在要执行此操作，您需要像这样导入 FileInterceptor...

import { FileInterceptor } from '@nestjs/platform-express';

Answer 4

一种简单的方法是使用控制器。您需要定义一个上传控制器并将其添加到您的app.module中，这是一个控制器（后端）的示例：

@Controller()
export class Uploader {
  @Post('sampleName')
  @UseInterceptors(FileInterceptor('file'))
  uploadFile(@UploadedFile() file) {
  // file name selection 
    const path = `desired path`;
    const writeStream = fs.createWriteStream(path);  
    writeStream.write(file.buffer);
    writeStream.end();
    return {
      result: [res],
    };
  }
}

然后通过在前端获取来调用您的控制器：

    fetch('controller address', {
          method: 'POST',
          body: data,
        })
          .then((response) => response.json())
          .then((success) => {
            // What to do when succeed 
});
          })
          .catch((error) => console.log('Error in uploading file: ', error));

Answer 5

使用Multer选项（包括导入）的最干净的实现

感谢@VictorIvens提供最佳答案。

但是，我在代码中发现了以下问题。

最新版本的NestJS中的FileInterceptor包中没有名为@nestjs/common的导入。
使用Multer选项的代码在我看来有些混乱。

因此，为简化起见，我提出了以下解决方案。

import {
  Controller,
  Post,
  UseInterceptors,
  UploadedFile
} from "@nestjs/common";
import { FileInterceptor } from "@nestjs/platform-express";

import { diskStorage } from "multer";
import { extname } from "path";

// You may want to move this variable into a separate file then import it to make it cleaner
const storageOptions = diskStorage({
  destination: "./uploads",
  filename: (req, file, callback) => {
    callback(null, generateFilename(file));
  }
});

// You may want to move this function into a separate file then import it to make it cleaner
function generateFilename(file) {
  return `${Date.now()}.${extname(file.originalname)}`;
}

@Controller()
export class YourController {
  @Post("upload") // API path
  @UseInterceptors(
    FileInterceptor(
      "file", // name of the field being passed
      {
        storage: storageOptions
      }
    )
  )
  async upload(@UploadedFile() file) {
    return file;
  }
}

Answer 6

如果您通过 API 调用从用户那里获取数据，您可以将数据保存为缓冲区并使用 adm-zip 访问内容。下面是 nest.js 中的控制器方法实现。

@Post("/blackBoardUpload")
  @UseInterceptors(
    FileInterceptor('image', {
      storage: memoryStorage(),



      fileFilter: zipFileFilter,

    }),
  )
  async uploadedFile(@UploadedFile() file) {
    console.log(file)
    const response = {
      originalname: file.originalname,
      filename: file.filename,
    };
    var AdmZip = require('adm-zip');
    var zip = new AdmZip(file.buffer);

    var zipEntries = zip.getEntries();
    console.log(zipEntries.length);
    
    return {
      status: HttpStatus.OK,
      message: 'Received Zip file successfully!',
      data: response,
    };
  }

使用nestjs和multer上传文件

6 个答案:

使用Multer选项

2021 年更新

使用Multer选项（包括导入）的最干净的实现