在 Koa 项目中使用 koa-multer 实现文件上传

概述

在前端开发中，文件上传是一个很常见的需求。在 Koa 中，实现文件上传可以使用 koa-multer 这个中间件。本文将介绍如何在 Koa 中使用 koa-multer 实现文件上传。

koa-multer 是什么？

koa-multer 是一个 Koa 中间件，用于处理文件上传。它基于 multer，支持多文件上传，并可以限制文件类型、文件大小等。

安装 koa-multer

首先，在您的 Koa 项目中安装 koa-multer。

npm install koa-multer --save

使用 koa-multer

使用 koa-multer，需要先实例化一个 Multer 对象，并使用它作为 Koa 的中间件。

示例代码：

// www.javascriptcn.com code example
const Koa = require('koa');
const Router = require('koa-router');
const multer = require('koa-multer');

const app = new Koa();
const router = new Router();

// 配置 Multer 对象
const storage = multer.diskStorage({
  destination: function (req, file, cb) {
    cb(null, './uploads/')
  },
  filename: function (req, file, cb) {
    cb(null, file.originalname)
  }
});
const upload = multer({ storage: storage })

// 添加上传路由
router.post('/upload', upload.single('file'), async (ctx, next) => {
  ctx.body = { message: '上传成功' };
});

// 添加路由中间件
app.use(router.routes()).use(router.allowedMethods());

在上面的示例中，我们先通过 multer.diskStorage 配置 Multer 的对象实例，设置了上传的目录和文件名，然后使用 multer 函数创建了一个 Multer 对象。最后，通过 upload.single 中间件来处理文件上传请求。

使用 upload.single 中间件会将上传的文件存储到指定的 upload 目录下（如果没有该目录，则会自动创建），文件名与上传的文件名相同。在 ctx.body 中设置了上传成功后的响应。

上传限制

除了限制上传的文件存储位置和文件名外，koa-multer 还支持限制文件类型、文件大小等。

示例代码：

// www.javascriptcn.com code example
// 配置 Multer 对象
const storage = multer.diskStorage({
  destination: function (req, file, cb) {
    cb(null, './uploads/')
  },
  filename: function (req, file, cb) {
    cb(null, file.originalname)
  }
});

const upload = multer({
  storage: storage,
  limits: {
    // 限制上传文件的大小（单位：字节）
    fileSize: 1024 * 1024 * 5,

    // 限制上传文件的类型
    fileFilter: function (req, file, cb) {
        const allowedTypes = ['image/jpeg', 'image/png', 'image/gif'];
        if (allowedTypes.includes(file.mimetype)) {
            cb(null, true);
        } else {
            cb(new Error('文件类型不支持'));
        }
    }
  }
});

在上面的示例中，通过在 Multer 对象中添加 limits 属性，可以配置限制上传的文件大小和类型。在 fileFilter 中间件中，通过 file.mimetype 获取上传文件的 MIME 类型，判断是否支持该类型文件的上传。

结语

在 Koa 项目中使用 koa-multer 实现文件上传是一个常见的需求，它可以让我们更好地控制上传文件的类型、大小等限制，并且易于集成到项目中。希望这篇文章能够帮助大家更好地掌握 koa-multer 的使用。

来源：JavaScript中文网 ，转载请注明来源 https://www.javascriptcn.com/post/67c93c8ae46428fe9e05eadb