2022 年 10 月 13 日

可恢復的檔案上傳

使用 fetch 方法上傳檔案相當容易。

如何在失去連線後繼續上傳?沒有內建選項可以做到這點,但我們有辦法實作它。

可恢復的上傳應該要能顯示上傳進度,因為我們預期檔案很大(如果我們需要繼續上傳)。因此,由於 fetch 不允許追蹤上傳進度,我們將使用 XMLHttpRequest

進度事件不太實用

要繼續上傳,我們需要知道在連線中斷前已上傳多少。

xhr.upload.onprogress 可追蹤上傳進度。

不幸的是,它無法協助我們在此處繼續上傳,因為它會在資料傳送時觸發,但伺服器是否已收到資料?瀏覽器不知道。

資料可能已由區域網路代理伺服器暫存,或遠端伺服器程序可能已死機而無法處理資料,或資料可能已在傳輸途中遺失,而未傳送到接收端。

這就是為什麼此事件只適用於顯示漂亮的進度條。

若要繼續上傳,我們需要精確知道伺服器已接收的位元組數。而只有伺服器知道這一點,因此我們會提出額外的要求。

演算法

  1. 首先,建立檔案識別碼,以唯一識別我們要上傳的檔案

    let fileId = file.name + '-' + file.size + '-' + file.lastModified;

    這是繼續上傳所需要的,以告知伺服器我們要繼續上傳什麼。

    如果名稱、大小或最後修改日期變更,則會有另一個 fileId

  2. 傳送要求至伺服器,詢問伺服器已有的位元組數,如下所示

    let response = await fetch('status', {
      headers: {
        'X-File-Id': fileId
      }
    });
    
    // The server has that many bytes
    let startByte = +await response.text();

    這假設伺服器會透過 X-File-Id 標頭追蹤檔案上傳。應在伺服器端實作。

    如果檔案尚未存在於伺服器,則伺服器回應應為 0

  3. 然後,我們可以使用 Blob 方法 slicestartByte 傳送檔案

    xhr.open("POST", "upload");
    
    // File id, so that the server knows which file we upload
    xhr.setRequestHeader('X-File-Id', fileId);
    
    // The byte we're resuming from, so the server knows we're resuming
    xhr.setRequestHeader('X-Start-Byte', startByte);
    
    xhr.upload.onprogress = (e) => {
      console.log(`Uploaded ${startByte + e.loaded} of ${startByte + e.total}`);
    };
    
    // file can be from input.files[0] or another source
    xhr.send(file.slice(startByte));

    在此,我們將檔案識別碼作為 X-File-Id 傳送至伺服器,因此伺服器知道我們上傳的是哪個檔案,並將起始位元組作為 X-Start-Byte 傳送至伺服器,因此伺服器知道我們不是最初上傳檔案,而是繼續上傳。

    伺服器應檢查其記錄,如果該檔案有上傳記錄,且目前上傳的大小正好為 X-Start-Byte,則將資料附加到檔案中。

以下是使用 Node.js 編寫的客戶端和伺服器程式碼示範。

它只會在此網站上部分運作,因為 Node.js 在另一個名為 Nginx 的伺服器之後,Nginx 會暫存上傳內容,並在完全完成時將其傳遞給 Node.js。

但你可以下載它並在本地執行,以進行完整的示範

結果
server.js
uploader.js
index.html
let http = require('http');
let static = require('node-static');
let fileServer = new static.Server('.');
let path = require('path');
let fs = require('fs');
let debug = require('debug')('example:resume-upload');

let uploads = Object.create(null);

function onUpload(req, res) {

  let fileId = req.headers['x-file-id'];
  let startByte = +req.headers['x-start-byte'];

  if (!fileId) {
    res.writeHead(400, "No file id");
    res.end();
  }

  // we'll files "nowhere"
  let filePath = '/dev/null';
  // could use a real path instead, e.g.
  // let filePath = path.join('/tmp', fileId);

  debug("onUpload fileId: ", fileId);

  // initialize a new upload
  if (!uploads[fileId]) uploads[fileId] = {};
  let upload = uploads[fileId];

  debug("bytesReceived:" + upload.bytesReceived + " startByte:" + startByte)

  let fileStream;

  // if startByte is 0 or not set, create a new file, otherwise check the size and append to existing one
  if (!startByte) {
    upload.bytesReceived = 0;
    fileStream = fs.createWriteStream(filePath, {
      flags: 'w'
    });
    debug("New file created: " + filePath);
  } else {
    // we can check on-disk file size as well to be sure
    if (upload.bytesReceived != startByte) {
      res.writeHead(400, "Wrong start byte");
      res.end(upload.bytesReceived);
      return;
    }
    // append to existing file
    fileStream = fs.createWriteStream(filePath, {
      flags: 'a'
    });
    debug("File reopened: " + filePath);
  }


  req.on('data', function(data) {
    debug("bytes received", upload.bytesReceived);
    upload.bytesReceived += data.length;
  });

  // send request body to file
  req.pipe(fileStream);

  // when the request is finished, and all its data is written
  fileStream.on('close', function() {
    if (upload.bytesReceived == req.headers['x-file-size']) {
      debug("Upload finished");
      delete uploads[fileId];

      // can do something else with the uploaded file here

      res.end("Success " + upload.bytesReceived);
    } else {
      // connection lost, we leave the unfinished file around
      debug("File unfinished, stopped at " + upload.bytesReceived);
      res.end();
    }
  });

  // in case of I/O error - finish the request
  fileStream.on('error', function(err) {
    debug("fileStream error");
    res.writeHead(500, "File error");
    res.end();
  });

}

function onStatus(req, res) {
  let fileId = req.headers['x-file-id'];
  let upload = uploads[fileId];
  debug("onStatus fileId:", fileId, " upload:", upload);
  if (!upload) {
    res.end("0")
  } else {
    res.end(String(upload.bytesReceived));
  }
}


function accept(req, res) {
  if (req.url == '/status') {
    onStatus(req, res);
  } else if (req.url == '/upload' && req.method == 'POST') {
    onUpload(req, res);
  } else {
    fileServer.serve(req, res);
  }

}




// -----------------------------------

if (!module.parent) {
  http.createServer(accept).listen(8080);
  console.log('Server listening at port 8080');
} else {
  exports.accept = accept;
}
class Uploader {

  constructor({file, onProgress}) {
    this.file = file;
    this.onProgress = onProgress;

    // create fileId that uniquely identifies the file
    // we could also add user session identifier (if had one), to make it even more unique
    this.fileId = file.name + '-' + file.size + '-' + file.lastModified;
  }

  async getUploadedBytes() {
    let response = await fetch('status', {
      headers: {
        'X-File-Id': this.fileId
      }
    });

    if (response.status != 200) {
      throw new Error("Can't get uploaded bytes: " + response.statusText);
    }

    let text = await response.text();

    return +text;
  }

  async upload() {
    this.startByte = await this.getUploadedBytes();

    let xhr = this.xhr = new XMLHttpRequest();
    xhr.open("POST", "upload", true);

    // send file id, so that the server knows which file to resume
    xhr.setRequestHeader('X-File-Id', this.fileId);
    // send the byte we're resuming from, so the server knows we're resuming
    xhr.setRequestHeader('X-Start-Byte', this.startByte);

    xhr.upload.onprogress = (e) => {
      this.onProgress(this.startByte + e.loaded, this.startByte + e.total);
    };

    console.log("send the file, starting from", this.startByte);
    xhr.send(this.file.slice(this.startByte));

    // return
    //   true if upload was successful,
    //   false if aborted
    // throw in case of an error
    return await new Promise((resolve, reject) => {

      xhr.onload = xhr.onerror = () => {
        console.log("upload end status:" + xhr.status + " text:" + xhr.statusText);

        if (xhr.status == 200) {
          resolve(true);
        } else {
          reject(new Error("Upload failed: " + xhr.statusText));
        }
      };

      // onabort triggers only when xhr.abort() is called
      xhr.onabort = () => resolve(false);

    });

  }

  stop() {
    if (this.xhr) {
      this.xhr.abort();
    }
  }

}
<!DOCTYPE HTML>

<script src="uploader.js"></script>

<form name="upload" method="POST" enctype="multipart/form-data" action="/upload">
  <input type="file" name="myfile">
  <input type="submit" name="submit" value="Upload (Resumes automatically)">
</form>

<button onclick="uploader.stop()">Stop upload</button>


<div id="log">Progress indication</div>

<script>
  function log(html) {
    document.getElementById('log').innerHTML = html;
    console.log(html);
  }

  function onProgress(loaded, total) {
    log("progress " + loaded + ' / ' + total);
  }

  let uploader;

  document.forms.upload.onsubmit = async function(e) {
    e.preventDefault();

    let file = this.elements.myfile.files[0];
    if (!file) return;

    uploader = new Uploader({file, onProgress});

    try {
      let uploaded = await uploader.upload();

      if (uploaded) {
        log('success');
      } else {
        log('stopped');
      }

    } catch(err) {
      console.error(err);
      log('error');
    }
  };

</script>

正如我們所見,現代網路方法在功能上接近檔案管理員,例如控制標頭、進度指標、傳送檔案部分等。

我們可以實作可繼續上傳的功能,以及更多功能。

教學課程地圖

留言

在留言前請先閱讀…
  • 如果你有建議要如何改進 - 請 提交 GitHub 議題 或發起拉取請求,而不是留言。
  • 如果你無法理解文章中的某個部分 – 請詳細說明。
  • 若要插入少數幾個字元的程式碼,請使用 <code> 標籤,若要插入多行程式碼,請將它們包覆在 <pre> 標籤中,若要插入超過 10 行的程式碼,請使用沙盒 (plnkrjsbincodepen…)