龙空技术网

六步实现JavaScript大型文件并行下载?

高级前端进阶 1907

前言:

今天同学们对“js判断文件下载完成”都比较注意,咱们都想要分析一些“js判断文件下载完成”的相关资讯。那么小编在网上网罗了一些关于“js判断文件下载完成””的相关文章,希望你们能喜欢,我们快快来了解一下吧!

大家好,很高兴又见面了,我是"高级前端进阶",由我带着大家一起关注前端前沿、深入前端底层技术,大家一起进步,也欢迎大家关注、点赞、收藏、转发!

高级前端进阶

前言

相信有些小伙伴已经了解大文件上传的解决方案,在上传大文件时,为了提高上传效率,一般会使用 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  -i -H "Range: bytes=0-1023"

输出结果如下:

多重 Range

curl  -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:

浏览器内部为每个通过 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 函数不仅可以实现大文件的并行下载,而且还可以实现大文件的并行上传,感兴趣的小伙伴可以自行尝试一下。

参考资料

标签: #js判断文件下载完成 #html多附件上传 #js传输文件 #点击下载文件js #js下载文档