前言
Koa是一个基于Node.js的下一代Web框架,它的特色是不绑定任何中间件,它本身就提供了很多丰富的中间件给我们使用,并且大多数社区都很成熟,配合中间件开发效率真的高~
比如路由(koa-router),日志(koa-logger),都可以找到相应的中间件库,即npm包,然后通过app.use(…)引进来
本文的主题: 实现文件上传就是通过引用相应的中间来实现的
我查了一下资料,发现可以实现文件上传的中间件有3个,选择其中一个就可以了:
- koa-body
- busboy
- koa-multer
关于以上三种中间件的差异可以自行网上查资料,这里我就使用 koa-body
Koa代码实现
步骤一:下载koa-body npm包
npm install koa-body --save
步骤二:在koa项目中引用koa-body中间件
const Koa = require('koa');
const koaBody = require('koa-body');
const app = new Koa();
app.use(koaBody({
multipart: true, // 开启文件上传
formidable: {
maxFileSize: 200*1024*1024, // 设置上传文件大小最大限制,默认2M
keepExtensions: true // 保留文件拓展名
}
}))
步骤三:使用koa-body中间件后,即可通过ctx.request.files获取上传的文件
这里注意一下 ↓
新版本的koa-body通过
ctx.request.files
获取上传的文件旧版本的koa-body(v4版本以下)通过
ctx.request.body.files
获取上传的文件
步骤四:获取到文件之后,通过fs将文件保存到服务器的指定目录
- 上传单个文件:
router.post('/uploadfile', async (ctx, next) => {
// 上传单个文件
const file = ctx.request.files.file; // 获取上传文件
// 创建可读流
const reader = fs.createReadStream(file.path);
let filePath = path.join(__dirname, 'public/upload/') + `/${file.name}`;
// 创建可写流
const upStream = fs.createWriteStream(filePath);
// 可读流通过管道写入可写流
reader.pipe(upStream);
return ctx.body = "上传成功!";
});
- 上传多个文件::
router.post('/uploadfiles', async (ctx, next) => {
// 上传多个文件
const files = ctx.request.files.file; // 获取上传文件
for (let file of files) {
// 创建可读流
const reader = fs.createReadStream(file.path);
// 获取上传文件扩展名
let filePath = path.join(__dirname, 'public/upload/') + `/${file.name}`;
// 创建可写流
const upStream = fs.createWriteStream(filePath);
// 可读流通过管道写入可写流
reader.pipe(upStream);
}
return ctx.body = "上传成功!";
});
前端表单提交
顺便把前端的代码也附上,前端通过提交表单,把文件发送到服务器
<form action="http://localhost:8080/api/upload" method="post" enctype="multipart/form-data">
<input type="file" name="file" id="file" value="" multiple="multiple" />
<input type="submit" value="提交"/>
</form>
结语
注意一下,koa-body版本升级带来的一些改变,比如步骤三中获取文件上传的本地绝对路径,如果没有留意的话,拿到的就是undefined,会影响后续 koa-static 生成静态服务,在此做个记录~
关于这块的更新,最好参考koa官方文档,或者直接去koa-body的npm社区上看