Node.js：上傳文件，服務端如何獲取文件上傳進度

時間 2019-12-05

標籤 node.js node 上傳文件服務如何獲取進度欄目 Node.js 简体版

原文原文鏈接

內容概述

multer是經常使用的Express文件上傳中間件。服務端如何獲取文件上傳的進度，是使用的過程當中，很常見的一個問題。在SF上也有同窗問了相似問題《nodejs multer有沒有查看文件上傳進度的方法？》。稍微回答了下，這裏順便整理出來，有一樣疑問的同窗能夠參考。javascript

下文主要介紹如何利用progress-stream獲取文件上傳進度，以及該組件使用過程當中的注意事項。html

利用`progress-stream`獲取文件上傳進度

若是隻是想在服務端獲取上傳進度，能夠試下以下代碼。注意，這個模塊跟Express、multer並非強綁定關係，能夠獨立使用。java

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事件，實際上是有問題的）node

// 獲取上傳文件的真實長度（針對 multipart)
progress.on('length', function nowIKnowMyLength (actualLength) {
    console.log('actualLength: %s', actualLength);
    progress.setLength(actualLength);
});

關於`progress-stream`獲取真實文件大小的bug？

針對multipart文件上傳，progress-stream 實例子初始化時，參數length須要傳遞非數值類型，否則你獲取到的進度要一直是0，最後就直接跳到100。git

至於爲何會這樣，應該是 progress-steram 模塊的bug，看下模塊的源碼。當length是number類型時，代碼直接跳過，所以你length一直被認爲是0。github

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']));
        }
    });
});