六步實現JavaScript大型文件并行下載？

發布時間：2023-07-02 22:05:05 作者：網友整理

前言

相信有些小伙伴已經了解大文件上傳的解決方案，在上傳大文件時，為了提高上傳效率，一般會使用 Blob.slice 方法對大文件按照指定的大小進行切割，然后再開啟多線程進行分塊上傳，等所有分塊都成功上傳后，再通知服務端進行分塊合并。

var blob = instanceOfBlob.slice([start [, end [, contentType]]]};

備注：在某些瀏覽器和版本上具有供應商前綴：例如：Firefox 12 及更早版本的 blob.mozSlice() 和 Safari 中的 blob.webkitSlice(). slice() 方法的舊版本，沒有供應商前綴，具有不同的語義，并且已過時。

那么對大文件下載來說，能否采用類似的思想呢？在服務端支持 Range 請求首部的條件下，也是可以實現多線程分塊下載的功能，具體如下圖所示：

看完上圖相信對大文件下載的方案，已經有了一定的了解。接下來，我們先來介紹 HTTP Range 請求。

1.HTTP Range 請求

HTTP 協議 Range 請求允許服務器只發送 HTTP 消息的一部分到客戶端。Range 請求在傳送大的媒體文件，或者與文件下載的斷點續傳功能搭配使用時非常有用。如果在響應中存在 Accept-Ranges 首部（并且它的值不為 "none"），那么表示該服務器支持 Range 請求。

在一個 Range 首部中，可以一次性請求多個部分，服務器會以 multipart 文件的形式將其返回。如果服務器返回的是 Range 響應，需要使用 206 Partial Content 狀態碼。假如所請求的 Range 不合法，那么服務器會返回 416 Range Not Satisfiable 狀態碼，表示客戶端錯誤。服務器允許忽略 Range 首部，從而返回整個文件，狀態碼用 200 。

Range 語法

Range: <unit>=<range-start>-
Range: <unit>=<range-start>-<range-end>
Range: <unit>=<range-start>-<range-end>, <range-start>-<range-end>
Range: <unit>=<range-start>-<range-end>, <range-start>-<range-end>, <range-start>-<range-end>

unit：Range 請求所采用的單位，通常是字節（bytes）
<range-start>：一個整數，表示在特定單位下，Range 的起始值
<range-end>：一個整數，表示在特定單位下，Range 的結束值。這個值是可選的，如果不存在，表示此 Range 一直延伸到文檔結束。

單一 Range

curl https://www.baidu.com/img/PCtm_d9c8750bed0b3c7d089fa7d55720d6cf.png -i -H "Range: bytes=0-1023"

輸出結果如下：

多重 Range

curl http://www.baidu.com -i -H "Range: bytes=0-50, 100-150"

輸出結果如下：

2 HTTP Range 大文件下載

2.1 定義輔助函數

2.1.1 getContentLength 函數

顧名思義, getContentLength 函數用于獲取文件的長度。在該函數中，通過發送 HEAD 請求，然后從響應頭中讀取 Content-Length 的信息，進而獲取當前 url 對應文件的內容長度。

function getContentLength(url) {
  return new Promise((resolve, reject) => {
    let xhr = new XMLHttpRequest();
    xhr.open('HEAD', url);
    // 發送HEAD請求
    xhr.send();
    xhr.onload = function () {
      resolve(~~xhr.getResponseHeader('Content-Length'));
      //   獲取文件長度
    };
    xhr.onerror = reject;
  });
}

2.1.2 asyncPool 函數

asyncPool 函數用于實現異步任務的并發控制。該函數接收 3 個參數：

poolLimit（數字類型）：表示限制的并發數
array（數組類型）：表示任務數組；
iteratorFn（函數類型）：表示迭代函數，用于實現對每個任務項進行處理，該函數會返回一個 Promise 對象或異步函數。

async function asyncPool(poolLimit, array, iteratorFn) {
  const ret = [];
  // 存儲所有的異步任務
  const executing = [];
  // 存儲正在執行的異步任務
  for (const item of array) {
    const p = Promise.resolve().then(() => iteratorFn(item, array));
    ret.push(p);
    if (poolLimit <= array.length) {
      const e = p.then(() => executing.splice(executing.indexOf(e), 1));
      executing.push(e);
      if (executing.length >= poolLimit) {
        // 等待較快的任務執行完成
        await Promise.race(executing);
      }
    }
  }
  return Promise.all(ret);
}

2.1.3 getBinaryContent 函數

getBinaryContent 函數用于根據傳入的參數發起 Range 請求，從而下載指定 Range 內的文件數據塊：

function getBinaryContent(url, start, end, i) {
  return new Promise((resolve, reject) => {
    try {
      let xhr = new XMLHttpRequest();
      xhr.open('GET', url, true);
      xhr.setRequestHeader('range', `bytes=${start}-${end}`);
      // 請求頭上設置Range請求信息
      xhr.responseType = 'arraybuffer';
      // 設置返回的類型為arraybuffer
      xhr.onload = function () {
        resolve({
          index: i, // 文件塊的索引
          buffer: xhr.response, // Range請求對應的數據
        });
      };
      xhr.send();
    } catch (err) {
      reject(new Error(err));
    }
  });
}

需要注意的是：ArrayBuffer 對象用來表示通用的、固定長度的原始二進制數據緩沖區。不能直接操作 ArrayBuffer 的內容，而是要通過類型數組對象或 DataView 對象來操作，它們會將緩沖區中的數據表示為特定的格式，并通過這些格式來讀寫緩沖區的內容。

2.1.4 concatenate 函數

由于不能直接操作 ArrayBuffer 對象，所以需要先把 ArrayBuffer 對象轉換為 Uint8Array 對象，然后在執行合并操作。以下定義的 concatenate 函數就是為了合并已下載的文件數據塊，具體代碼如下所示：

function concatenate(arrays) {
  if (!arrays.length) return null;
  let totalLength = arrays.reduce((acc, value) => acc + value.length, 0);
  let result = new Uint8Array(totalLength);
  let length = 0;
  for (let array of arrays) {
    result.set(array, length);
    length += array.length;
  }
  return result;
}

2.1.5 saveAs 函數

saveAs 函數用于實現客戶端文件保存的功能，這里只是一個簡單的實現。在實際項目中，可以考慮直接使用 FileSaver.js，具體使用可以閱讀文末參考文獻。

function saveAs({ name, buffers, mime = 'Application/octet-stream' }) {
  const blob = new Blob([buffers], { type: mime });
  // 創建Blob
  const blobUrl = URL.createObjectURL(blob);
  // 實例化
  const a = document.createElement('a');
  a.download = name || Math.random();
  a.href = blobUrl;
  a.click();
  URL.revokeObjectURL(blob);
}

在 saveAs 函數中，使用了 Blob 和 Object URL。其中 Object URL 是一種偽協議，允許 Blob 和 File 對象用作圖像，下載二進制數據鏈接等的 URL 源。在瀏覽器中，使用 URL.createObjectURL 方法來創建 Object URL，該方法接收一個 Blob 對象，并為其創建一個唯一的 URL，其形式為 blob:<origin>/<uuid>，對應的示例如下：

blob:https://example.org/40a5fb5a-d56d-4a33-b4e2-0acf6a8e5f641

瀏覽器內部為每個通過 URL.createObjectURL 生成的 URL 存儲了一個 URL → Blob 映射。因此，此類 URL 較短，但可以訪問 Blob。生成的 URL 僅在當前文檔打開的狀態下才有效。

2.1.6 定義 download 函數

download 函數用于實現下載操作，它支持 3 個參數：

url（字符串類型）：預下載資源的地址
chunkSize（數字類型）：分塊的大小，單位為字節
poolLimit（數字類型）：表示限制的并發數

async function download({ url, chunkSize, poolLimit = 1 }) {
  const contentLength = await getContentLength(url);
  const chunks =
    typeof chunkSize === 'number' ? Math.ceil(contentLength / chunkSize) : 1;
  const results = await asyncPool(
    poolLimit,
    [...new Array(chunks).keys()],
    (i) => {
      let start = i * chunkSize;
      let end = i + 1 == chunks ? contentLength - 1 : (i + 1) * chunkSize - 1;
      return getBinaryContent(url, start, end, i);
    }
  );
  const sortedBuffers = results.map((item) => new Uint8Array(item.buffer));
  return concatenate(sortedBuffers);
}

2.2 大文件下載使用示例

基于定義的輔助函數，就可以輕松地實現大文件并行下載，具體代碼如下所示：

function multiThreadedDownload() {
  const url = document.querySelector('#fileUrl').value;
  if (!url || !/https?/.test(url)) return;
  console.log('multi threaded download start: ' + +new Date());
  download({
    url,
    chunkSize: 0.1 * 1024 * 1024,
    poolLimit: 6,
  }).then((buffers) => {
    console.log('multi threaded download end: ' + +new Date());
    saveAs({ buffers, name: 'myzip', mime: 'application/zip' });
  });
}

完整代碼請查看文末參考文獻。

3.總結

本文介紹了在 JAVAScript 中如何利用 async-pool 這個庫提供的 asyncPool 函數來實現大文件的并行下載。除了介紹 asyncPool 函數之外，文章還介紹了如何通過 HEAD 請求獲取文件大小、如何發起 HTTP Range 請求及在客戶端如何保存文件等相關知識。其實利用 asyncPool 函數不僅可以實現大文件的并行下載，而且還可以實現大文件的并行上傳，感興趣的小伙伴可以自行嘗試一下。