|
|
|
|
移动端
创建专栏

Koa2 之文件上传下载

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

作者:林鑫|2018-04-20 16:15

【新品产上线啦】51CTO播客,随时随地,碎片化学习

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

文件上传

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

  1. // app.js 
  2. const koa = require('koa'); 
  3. const app = new koa(); 
  4. const koaBody = require('koa-body'); 
  5. app.use(koaBody({ 
  6.     multipart: true
  7.     formidable: { 
  8.         maxFileSize: 200*1024*1024  // 设置上传文件大小最大限制,默认2M 
  9.     } 
  10. })); 
  11. app.listen(3001, ()=>{ 
  12.     console.log('koa is listening in 3001'); 
  13. }) 

使用中间件后,就可以在 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)
  1. const router = require('koa-router')(); 
  2. const fs = require('fs'); 
  3. router.post('/upload', async (ctx){ 
  4.     const file = ctx.request.body.files.file;   // 获取上传文件 
  5.     const reader = fs.createReadStream(file.path);  // 创建可读流 
  6.     const ext = file.name.split('.').pop();     // 获取上传文件扩展名 
  7.     const upStream = fs.createWriteStream(`upload/${Math.random().toString()}.${ext}`);     // 创建可写流 
  8.     reader.pipe(upStream);  // 可读流通过管道写入可写流 
  9.     return ctx.body = '上传成功'
  10. }) 

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

文件下载

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

  1. const router = require('koa-router')(); 
  2. const send = require('koa-send'); 
  3. router.post('/download/:name', async (ctx){ 
  4.     const name = ctx.params.name
  5.     const path = `upload/${name}`; 
  6.     ctx.attachment(path); 
  7.     await send(ctx, path); 
  8. }) 

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

  1. <button onclick="handleClick()">立即下载</button> 
  2. <script> 
  3.     const handleClick = () => { 
  4.         window.open('/download/1.png'); 
  5.     } 
  6. </script> 

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

  1. <button onclick="handleClick()">立即下载</button> 
  2. <iframe name="myIframe" style="display:none"></iframe> 
  3. <script> 
  4.     const handleClick = () => { 
  5.         window.open('/download/1.png''myIframe'); 
  6.     } 
  7. </script> 

批量下载

批量下载和单个下载也没什么区别嘛,就多执行几次下载而已嘛。这样也确实没什么问题。如果把这么多个文件打包成一个压缩包,再只下载这个压缩包,是不是体验起来就好一点了呢。

文件打包

archiver 是一个在 Node.js 中能跨平台实现打包功能的模块,支持 zip 和 tar 格式。

  1. const router = require('koa-router')(); 
  2. const send = require('koa-send'); 
  3. const archiver = require('archiver'); 
  4. router.post('/downloadAll', async (ctx){ 
  5.     // 将要打包的文件列表 
  6.     const list = [{name'1.txt'},{name'2.txt'}]; 
  7.     const zipName = '1.zip'
  8.     const zipStream = fs.createWriteStream(zipName); 
  9.     const zip = archiver('zip'); 
  10.     zip.pipe(zipStream); 
  11.     for (let i = 0; i < list.length; i++) { 
  12.         // 添加单个文件到压缩包 
  13.         zip.append(fs.createReadStream(list[i].name), { name: list[i].name }) 
  14.     } 
  15.     await zip.finalize(); 
  16.     ctx.attachment(zipName); 
  17.     await send(ctx, zipName); 
  18. }) 

如果直接打包整个文件夹,则不需要去遍历每个文件 append 到压缩包里

  1. const zipStream = fs.createWriteStream('1.zip'); 
  2. const zip = archiver('zip'); 
  3. zip.pipe(zipStream); 
  4. // 添加整个文件夹到压缩包 
  5. zip.directory('upload/'); 
  6. zip.finalize(); 

注意:打包整个文件夹,生成的压缩包文件不可存放到该文件夹下,否则会不断的打包。

中文编码问题

当文件名含有中文的时候,可能会出现一些预想不到的情况。所以上传时,含有中文的话我会对文件名进行 encodeURI() 编码进行保存,下载的时候再进行 decodeURI() 解密。

  1. ctx.attachment(decodeURI(path)); 
  2. await send(ctx, path); 

ctx.attachment 将 Content-Disposition 设置为 “附件” 以指示客户端提示下载。通过解码后的文件名作为下载文件的名字进行下载,这样下载到本地,显示的还是中文名。

然鹅,koa-send 的源码中,会对文件路径进行 decodeURIComponent() 解码:

  1. // koa-send 
  2. path = decode(path) 
  3. function decode (path) { 
  4.   try { 
  5.     return decodeURIComponent(path) 
  6.   } catch (err) { 
  7.     return -1 
  8.   } 

这时解码后去下载含中文的路径,而我们服务器中存放的是编码后的路径,自然就找不到对应的文件了。

要想解决这个问题,那么就别让它去解码。不想动 koa-send 源码的话,可使用另一个中间件 koa-sendfile 代替它。

  1. const router = require('koa-router')(); 
  2. const sendfile = require('koa-sendfile'); 
  3. router.post('/download/:name', async (ctx){ 
  4.     const name = ctx.params.name
  5.     const path = `upload/${name}`; 
  6.     ctx.attachment(decodeURI(path)); 
  7.     await sendfile(ctx, path); 
  8. }) 

【本文为51CTO专栏作者“林鑫”的原创稿件,转载请通过微信公众号联系作者获取授权】

戳这里,看该作者更多好文

【编辑推荐】

  1. swagger-decorator:注解方式为 Koa2 应用动态生成 Swagger 文档
  2. 移动端图片上传旋转、压缩的解决方案
  3. 91金融CTO宋传胜:金融大数据做得好不好,数据处理细节见分晓!
  4. 论如何下载一个在线的m3u8文件到本地成为一个mp4!
  5. 前端本地文件操作与上传
【责任编辑:武晓燕 TEL:(010)68476606】

点赞 0
分享:
大家都在看
猜你喜欢

热门职位+更多