Koa2 之檔案上傳下載

前言

上傳下載在 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-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);
})
複製程式碼