JavaScript 中如何實現大文件並行下載？

在 JavaScript 中如何實現併發控制？這篇文章中，阿寶哥詳細分析了 async-pool 這個庫如何利用 Promise.all 和 Promise.race 函數實現異步任務的併發控制。本文阿寶哥將介紹如何利用 async-pool 這個庫提供的 asyncPool 函數來實現大文件的並行下載。

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

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

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

一、HTTP 範圍請求

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

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

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

瞭解完 Range 語法之後，我們來看一下實際的使用示例：

1.1.1 單一範圍

$ curl http://i.imgur.com/z4d4kWk.jpg -i -H "Range: bytes=0-1023"

1.1.2 多重範圍

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

好了，HTTP 範圍請求的相關知識就先介紹到這裏，下面我們步入正題開始介紹如何實現大文件下載。

二、如何實現大文件下載

爲了讓大家能夠更好地理解後面的內容，我們先來看一下整體的流程圖：

瞭解完大文件下載的流程之後，我們先來定義上述流程中涉及的一些輔助函數。

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);
    xhr.send();
    xhr.onload = function () {
      resolve(
        ~~xhr.getResponseHeader("Content-Length") 
      );
    };
    xhr.onerror = reject;
  });
}

2.1.2 定義 asyncPool 函數

在 JavaScript 中如何實現併發控制？這篇文章中，我們介紹了 asyncPool 函數，它用於實現異步任務的併發控制。該函數接收 3 個參數：

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

async function asyncPool(poolLimit, array, iteratorFn) {
  const ret = []; // 存儲所有的異步任務
  const executing = []; // 存儲正在執行的異步任務
  for (const item of array) {
    // 調用iteratorFn函數創建異步任務
    const p = Promise.resolve().then(() => iteratorFn(item, array));
    ret.push(p); // 保存新的異步任務

    // 當poolLimit值小於或等於總任務個數時，進行併發控制
    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 函數用於根據傳入的參數發起範圍請求，從而下載指定範圍內的文件數據塊：

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}`); // 請求頭上設置範圍請求信息
      xhr.responseType = "arraybuffer"; // 設置返回的類型爲arraybuffer
      xhr.onload = function () {
        resolve({
          index: i, // 文件塊的索引
          buffer: xhr.response, // 範圍請求對應的數據
        });
      };
      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 。如果你對 FileSaver.js 的工作原理感興趣的話，可以閱讀聊一聊 15.5K 的 FileSaver，是如何工作的？這篇文章。

function saveAs({ name, buffers, mime = "application/octet-stream" }) {
  const blob = new Blob([buffers], { type: mime });
  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 僅在當前文檔打開的狀態下才有效。

好了，Object URL 的相關內容就先介紹到這裏，如果你進一步瞭解 Blob 和 Object URL 的話，可以閱讀你不知道的 Blob 這篇文章。

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("多線程下載開始: " + +new Date());
  download({
    url,
    chunkSize: 0.1 * 1024 * 1024,
    poolLimit: 6,
  }).then((buffers) => {
    console.log("多線程下載結束: " + +new Date());
    saveAs({ buffers, name: "我的壓縮包", mime: "application/zip" });
  });
}

由於完整的示例代碼內容比較多，阿寶哥就不放具體的代碼了。感興趣的小夥伴，可以訪問以下地址瀏覽示例代碼。

完整的示例代碼：https://gist.github.com/semlinker/837211c039e6311e1e7629e5ee5f0a42

這裏我們來看一下大文件下載示例的運行結果：

三、總結

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

四、參考資源

你不知道的 Blob
MDN - ArrayBuffer
MDN - HTTP 請求範圍
JavaScript 中如何實現併發控制？

本文由 Readfog 進行 AMP 轉碼，版權歸原作者所有。
來源：https://mp.weixin.qq.com/s/E4SdYEkEzurfrnJrBu3bjA