Node.js 应用：Koa2 之文件上传下载

lin-xin commented 6 years ago

前言

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

文件上传

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

// app.js
const koa = require('koa');
const app = new koa();
const koaBody = require('koa-body');

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

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

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

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

创建可读流 const reader = fs.createReadStream(file.path)
创建可写流 const writer = fs.createWriteStream('upload/newpath.txt')
可读流通过管道写入可写流 reader.pipe(writer)

const router = require('koa-router')();
const fs = require('fs');

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-body 是将上传的文件放到了系统的临时文件里，然后我们再从临时文件里读取到 upload/ 目录下。其实 koa-body 还可以通过 formidable.uploadDir 属性直接设置存储目录

app.use(koaBody({
    multipart: true,
    formidable: {
        maxFileSize: 200*1024*1024, // 设置上传文件大小最大限制，默认2M
        uploadDir: 'upload/',
        onFileBegin: (name, file)=>{    // 文件存储之前对文件进行重命名处理
            const fileFormat = file.name.split('.');
            file.name = `${Date.now()}.${fileFormat[fileFormat.length-1]}`
            file.path = `upload/${file.name}`;
        }
    }
}));

然后就可以通过 ctx.request.body.files.file 直接获得到上传的文件了。

const router = require('koa-router')();
const fs = require('fs');

router.post('/upload', async (ctx){
    const file = ctx.request.body.files.file;   // 获取上传文件
    return ctx.body = file.path;    // upload/xxx.xx
})

文件下载

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

const router = require('koa-router')();
const send = require('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。

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

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

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

批量下载

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

文件打包

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

const router = require('koa-router')();
const send = require('koa-send');
const archiver = require('archiver');

router.post('/downloadAll', async (ctx){
    // 将要打包的文件列表
    const list = [{name: '1.txt'},{name: '2.txt'}];
    const zipName = '1.zip';
    const zipStream = fs.createWriteStream(zipName);
    const zip = archiver('zip');
    zip.pipe(zipStream);
    for (let i = 0; i < list.length; i++) {
        // 添加单个文件到压缩包
        zip.append(fs.createReadStream(list[i].name), { name: list[i].name })
    }
    await zip.finalize();
    ctx.attachment(zipName);
    await send(ctx, zipName);
})

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

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

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

中文编码问题

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

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

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

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

// koa-send
path = decode(path)

function decode (path) {
  try {
    return decodeURIComponent(path)
  } catch (err) {
    return -1
  }
}

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

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

const router = require('koa-router')();
const sendfile = require('koa-sendfile');

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

julyL commented 6 years ago

线上博客用的是hexo theme还是自己写的

lin-xin commented 6 years ago

@julyL 基于 hexo 的 Next 主题改的

jgchenu commented 6 years ago

@lin-xin 前辈，按照你的写法，本地没问题，但是在线上部署，会有502 的报错，我把写入流这一段注释了，发现就不会报错了，是超时问题吗？还是说写入流是异步的？ 02b0753d3998cba060bac06955455ca

xiangrenya commented 5 years ago

router.post('/upload', async (ctx){
    const file = ctx.request.body.files.file;   // 获取上传文件
    return ctx.body = file.path;    // upload/xxx.xx
})
# 上面代码中ctx.request.body是空对象，文件信息还是放在ctx.request.files.file里
router.post('/upload', async (ctx){
    const file = ctx.request.files.file;    // 获取上传文件
    return ctx.body = file.path;    // upload/xxx.xx
})

breaking-changes-in-v3/4