內容概述
multer
是常用的Express文件上傳中間件。服務端如何獲取文件上傳的進度,是使用的過程中,很常見的一個問題。在SF上也有同學問了類似問題《nodejs multer有沒有查看文件上傳進度的方法?》。稍微回答了下,這里順便整理出來,有同樣疑問的同學可以參考。
下文主要介紹如何利用progress-stream
獲取文件上傳進度,以及該組件使用過程中的注意事項。
利用progress-stream
獲取文件上傳進度
如果只是想在服務端獲取上傳進度,可以試下如下代碼。注意,這個模塊跟Express、multer並不是強綁定關系,可以獨立使用。
var fs = require('fs');
var express = require('express');
var multer = require('multer');
var progressStream = require('progress-stream');
var app = express();
var upload = multer({ dest: 'upload/' });
app.post('/upload', function (req, res, next) {
// 創建progress stream的實例
var progress = progressStream({length: '0'}); // 注意這里 length 設置為 '0'
req.pipe(progress);
progress.headers = req.headers;
// 獲取上傳文件的真實長度(針對 multipart)
progress.on('length', function nowIKnowMyLength (actualLength) {
console.log('actualLength: %s', actualLength);
progress.setLength(actualLength);
});
// 獲取上傳進度
progress.on('progress', function (obj) {
console.log('progress: %s', obj.percentage);
});
// 實際上傳文件
upload.single('logo')(progress, res, next);
});
app.post('/upload', function (req, res, next) {
res.send({ret_code: '0'});
});
app.get('/form', function(req, res, next){
var form = fs.readFileSync('./form.html', {encoding: 'utf8'});
res.send(form);
});
app.listen(3000);
如何獲取上傳文件的真實大小
multipart類型,需要監聽length
來獲取文件真實大小。(官方文檔里是通過conviction
事件,其實是有問題的)
// 獲取上傳文件的真實長度(針對 multipart)
progress.on('length', function nowIKnowMyLength (actualLength) {
console.log('actualLength: %s', actualLength);
progress.setLength(actualLength);
});
3、關於progress-stream
獲取真實文件大小的bug?
針對multipart文件上傳,progress-stream 實例子初始化時,參數length需要傳遞非數值類型,不然你獲取到的進度要一直是0,最后就直接跳到100。
至於為什么會這樣,應該是 progress-steram
模塊的bug,看下模塊的源碼。當length
是number類型時,代碼直接跳過,因此你length一直被認為是0。
tr.on('pipe', function(stream) {
if (typeof length === 'number') return;
// Support http module
if (stream.readable && !stream.writable && stream.headers) {
return onlength(parseInt(stream.headers['content-length'] || 0));
}
// Support streams with a length property
if (typeof stream.length === 'number') {
return onlength(stream.length);
}
// Support request module
stream.on('response', function(res) {
if (!res || !res.headers) return;
if (res.headers['content-encoding'] === 'gzip') return;
if (res.headers['content-length']) {
return onlength(parseInt(res.headers['content-length']));
}
});
});