Koa2 之文件上传下载的示例代码

前端之家收集整理的这篇文章主要介绍了Koa2 之文件上传下载的示例代码前端之家小编觉得挺不错的,现在分享给大家,也给大家做个参考。

前言

上传下载在 web 应用中还是比较常见的,无论是图片还是其他文件等。在 Koa 中,有很多中间件可以帮助我们快速的实现功能

文件上传

在前端中上传文件,我们都是通过表单来上传,而上传文件,在服务器端并不能像普通参数一样通过 ctx.request.body 获取。我们可以用 koa-body 中间件来处理文件上传,它可以将请求体拼到 ctx.request 中。

app.use(koaBody({
multipart: true,formidable: {
maxFileSize: 20010241024 // 设置上传文件大小最大限制,默认2M
}
}));

app.listen(3001,()=>{
console.log('koa is listening in 3001');
})

使用中间件后,就可以在 ctx.request.body.files 中获取上传文件内容。需要注意的就是设置 maxFileSize,不然上传文件一超过默认限制就会报错。

接收到文件之后,我们需要把文件保存到目录中,返回一个 url 给前端。在 node 中的流程为

  1. 创建可读流 const reader = fs.createReadStream(file.path)
  2. 创建可写流 const writer = fs.createWriteStream('upload/newpath.txt')
  3. 可读流通过管道写入可写流 reader.pipe(writer)
router.post('/upload',async (ctx){
const file = ctx.request.body.files.file; // 获取上传文件
const reader = fs.createReadStream(file.path); // 创建可读流
const ext = file.name.split('.').pop(); // 获取上传文件扩展名
const upStream = fs.createWriteStream(upload/${Math.random().toString()}.${ext}); // 创建可写流
reader.pipe(upStream); // 可读流通过管道写入可写流
return ctx.body = '上传成功';
})

方法适用于上传图片、文本文件、压缩文件等。

文件下载

koa-send 是一个静态文件服务的中间件,可用来实现文件下载功能

router.post('/download/:name',async (ctx){
const name = ctx.params.name;
const path = upload/${name};
ctx.attachment(path);
await send(ctx,path);
})

在前端进行下载,有两个方法: window.open 和表单提交。这里使用简单一点的 window.open 。

这里 window.open 默认是开启一个新的窗口,一闪然后关闭,给用户的体验并不好,可以加上第二个参数 window.open('/download/1.png','_self'); ,这样就会在当前窗口直接下载了。然而这样是将 url 替换当前的页面,则会触发 beforeunload 等页面事件,如果你的页面监听了该事件做一些操作的话,那就有影响了。那么还可以使用一个隐藏的 iframe 窗口来达到同样的效果