关于前端:如何做大文件上传

背景

文件上传是个十分广泛的场景，特地是在一些资源管理相干的业务中(比方网盘)。在文件比拟大的时候，一般的上传形式可能会遇到以下四个问题。

1. 文件上传超时：起因是前端申请框架认限度最大申请时长，或者是 nginx（或其它代理 / 网关）限度了最大申请时长。
2. 文件大小超限：起因在于后端对单个申请大小做了限度，个别 nginx 和 server 都会做这个限度。
3. 上传耗时久。
4. 因为各种网络起因上传失败，且失败之后须要从头开始。

对于前两点，虽说能够通过肯定的配置来解决，但有时候也不会那么顺利，毕竟调大这些参数会对后盾造成肯定的压力，须要兼顾理论场景。只是上传慢的话忍一忍是能够承受的，然而失败后重头开始，在网络环境差的时候几乎就是劫难。

思路

针对遇到的这些问题，有比拟成熟的解决方案。该计划能够简答的概括为 切片上传 + 秒传。

切片上传是指将一个大文件切割为若干个小文件，分为多个申请顺次上传，后盾再将文件碎片拼接为一个残缺的文件，即便某个碎片上传失败，也不会影响其它文件碎片，只须要从新上传失败的局部就能够了。而且多个申请一起发送文件，进步了传输速度的下限。

秒传指的是文件在传输之前计算其内容的散列值，也就是 Hash 值，将该值传到后盾，如果后盾存在 Hash 值统一的文件，认为该文件上传实现。

该计划很奇妙的解决了上述提出的一系列问题，也是目前资源管理类零碎的通用解决方案。

本文会梳理大文件上传中的一些知识点，并根据上述计划，实现一个切片上传 + 秒传的前后端，前端我用 react 实现，后盾用的 java。相干代码我放在 github 上。

最终实现的成果如下：

文件上传原理

最开始 XMLHttpRequest 是不反对传输二进制文件的。文件只能应用表单的形式上传，咱们须要写一个 Form，而后将 enctype 设置为 multipart/form-data。此时的 Content-Type 为 multipart/form-data，并且会主动跟一个 boundary 字符串，该字符串用于隔离不同的字段。

POST /file/uploadSingle HTTP/1.1
Host: localhost:8080
Connection: keep-alive
Content-Length: 9253791
Content-Type: multipart/form-data; boundary=----WebKitFormBoundaryZ6BFzaoozLLGdTBE

所以 multipart/form-data 既能够上传文件，也能够上传键值对，每个元素由 boundary 分隔放在申请的 body 中。

------WebKitFormBoundaryZ6BFzaoozLLGdTBE
Content-Disposition: form-data; name="file"; filename="BCompare.zip"
Content-Type: application/zip

------WebKitFormBoundaryZ6BFzaoozLLGdTBE--

起初 XMLHttpRequest 降级为 Level 2 之后，新增了 FormData 对象，用于模仿表单数据，并且反对发送和接管二进制数据。咱们目前应用的文件上传根本都是基于 XMLHttpRequest Level 2。应用 XMLHttpRequest 后文件上传的报文和上述的统一。写法如下。

let xhr = new XMLHttpRequest();
xhr.upload.onprogress = onProgress;
xhr.onload = () => {};
xhr.onabort = () => {};
xhr.onerror = err => {};
xhr.open(method, url, true);
xhr.send(data);

须要留神的是，xhr.send(data)中 data 参数的数据类型会影响申请头部 content-type 的值。咱们上传文件，data 的类型是 FormData，此时 content-type 默认值为 multipart/form-data; boundary=[xxx]。当然，但如果用 xhr.setRequestHeader() 手动设置了中 content-type 的值，以用户设定的为准。因而，在上传文件场景下，不用设置 content-type 的值，浏览器会依据文件类型主动配置。

文件切片

文件切片和外围是应用 Blob 对象的 slice 办法。

咱们应用 <input type=”file”> 的形式取得一个 File 对象。File 继承于 Blob。所以咱们也能够应用 slice 办法对文件进行切割。Blob 对象的 slice 办法会返回一个新的 Blob 对象，蕴含了源 Blob 对象中制订范畴内的数据。

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

start 和 end 代表 Blob 里的下标，示意被拷贝进新的 Blob 的字节的起始地位和完结地位。contentType 会给新的 Blob 赋予一个新的文档类型，很少应用。

在分片上传场景中，咱们个别会规定一个切边大小，依据这个大小对文件进行宰割。除了这种固定大小的计划外，还有的文章中会 依据以后的网络状况动静的调整切片的大小，相似于 TCP 的拥塞管制。本文为了简略，实用固定大小的切片。代码如下。我定义了 FileChunk 对象，这个对象中除了蕴含切片自身外，还额定寄存了一些数据，比方切边在源文件中的起止地位，这么做是为了不便后盾拿到切片数据后做文件合并的。

const CHUNK_SIZE = 10 * 1024 * 1024;

// 生成文件切片
function createFileChunk(file, blockSize = CHUNK_SIZE) {const fileChunkList = [];
  const {name, size} = file;
  let cur = 0;

  while (cur < size) {
    let end = cur + blockSize;

    if (end > size) {end = size;}

    // 调用 slice 办法进行文件切割
    fileChunkList.push(new FileChunk(file.slice(cur, end), name, cur, end, size),
    );
    cur += blockSize;
  }

  ...

  return fileChunkList;
}

class FileChunk {constructor(chunk, fileName, start, end, total) {
    // 切片对象
    this.chunk = chunk;
    // 文件名称
    this.fileName = fileName;
    // 切片起始地位
    this.start = start;
    // 切片完结地位
    this.end = end;
    // 文件总大小
    this.total = total;
    // 切片名称
    this.chunkName = '';
    // 整体文件 Hash
    this.fileHash = '';
    // 索引
    this.index = 0;
    // 文件切片总数
    this.chunkNum = 0;
    // 文件状态 'READY', 'UPLOADING', 'SUCCESS', 'ERROR'
    this.status = 'READY';
  }
}

文件合并文件合并计划有这么几种。

1. 前端发送切片实现后，发送一个合并申请，后端收到申请后，将之前上传的切片文件合并。
2. 后盾记录切片文件上传数据，当后盾检测到切片上传实现后，主动实现合并。
3. 创立一个和源文件大小雷同的文件，依据切片文件的起止地位间接将切片写入对应地位。

这三种计划中，前两种都是比拟通用的计划，且都是可行的，计划一的代价在于多发了一次申请，极小的概率会呈现文件上传胜利，然而合并申请发送失败的状况，益处就是流程比拟清晰。计划二比计划一少了一次申请，代价是每次上传完结后须要判断以后切片是否是最初一个切片，须要在数据库中保护切片的状态。

计划三比拟好的，相当于间接省略了文件合并的步骤，速度比拟快。然而不必语言的实现难度不同。如果没有适合的 API 的话，本人实现的难度很大。因为我后盾是用 java 编写的。咱们能够充分利用 java 中的 RandomAccessFile 这个类。

RandomAccessFile 既能够读取文件内容，也能够向文件输入数据。它最大的特点就是 反对“随机拜访”的形式，程序快能够间接跳转到文件的任意中央来读写数据。在切片上传场景下，因为申请是并行发送的，后盾会一次性收到大量的切片文件。每个切片文件都携带了以后切片在总文件中的地位信息，咱们应用 RandomAccessFile 的 seek 办法定位到切片的起始地位，而后将切片从这个地位开始写入。这也是 RandomAccessFile 的一个重要应用场景。

  * 上传切片文件
  * @param chunk      切片文件
  * @param fileChunk  切片文件的信息
  * @return true | false
  */
@PostMapping("/uploadChunk")
@ResponseBody
public Boolean upload(@RequestParam("chunk") MultipartFile chunk,
                      FileChunk fileChunk) throws IOException {String fullPath = filePath + fileChunk.getFileName();

    // 模块写入对应的地位
    try(RandomAccessFile rf = new RandomAccessFile(fullPath,
            "rw")) {rf.seek(fileChunk.getStart());
        rf.write(chunk.getBytes());
    } catch (Exception e) {LOGGER.error(e.getMessage());

        return false;
    }

    ...

    return true;
}

显示进度

旧版的 XMLHttpRequest 是不反对显示进度的，降级为 Level 2 之后，有一个 progress 事件，用来返回进度信息。这也是为什么该场景下举荐应用 xhr，而不应用 fetch 的起因。fetch 不提供相干的接口，咱们无奈取得文件的上传进度。

咱们能够通过 onprogress 事件来实时显示进度，默认状况下这个事件每 50ms 触发一次。须要留神的是，上传过程和下载过程触发的是不同对象的 onprogress 事件：上传触发的是 xhr.upload 对象的 onprogress 事件，下载触发的是 xhr 对象的 onprogress 事件。

xhr.onprogress = updateProgress;
xhr.upload.onprogress = updateProgress;

这个事件有一些属性。event.total 是须要传输的总字节，event.loaded 是曾经传输的字节。

function updateProgress(event) {if (event.lengthComputable) {var completedPercent = event.loaded / event.total;}
 }

因为在切片上传场景下，咱们取得的是单个切片的上传进度，所以个别须要将单个的进度进行累加，用于计算总的进度，具体代码就不贴了。当然，咱们也能够兼顾两种形式。我在大圣老师的文章中找到一种很好的显示进度的形式。将每个切片算作是一个小方块，通过色彩示意进度，十分直观。

断点续传

切片上传有一个很好的个性就是上传过程能够中断，不论是人为的暂停还是因为网络环境导致的链接的中断，都只会影响到以后的切片，而不会导致整体文件的失败，下次开始上传的时候能够从失败的切片持续上传。

咱们为以后的上传操作减少一个进行按钮，用于模仿网络谬误导致的上传失败。一个申请能被勾销的前提是，咱们须要将未收到响应的申请保留在一个列表中，而后顺次调用每个 xhr 对象的 abort 办法。调用这个办法后，xhr 对象会进行触发事件，将申请的 status 置为 0，并且无法访问任何与响应无关的属性。

// 勾销上传操作
pause = () => {this.requestList.forEach(xhr => xhr?.abort());
  this.requestList = [];};

从后端的角度看，一个上传申请被勾销，意味着以后浏览器不会再向后端传输数据流，后端此时会报错，如下，错误信息也很分明，就是文件还没到开端就被客户端中断。以后文件切片写入失败。

java.io.EOFException: Unexpected EOF read on the socket

接下来就是如何实现断点续传，关键点是 后端须要记录文件文件切片的信息。用户在上传一个文件之前，先询问服务器，以后文件是否存在曾经上传完毕的切片，如果存在的话，须要返回切片信息。前端依据返回的信息，调整以后的进度，上传未实现的切片。

具体的做法是，切片上传实现后，后端记录以后切片的详细信息。

@PostMapping("/uploadChunk")
@ResponseBody
public Boolean upload(@RequestParam("chunk") MultipartFile chunk,
                      FileChunk fileChunk) {String fullPath = filePath + fileChunk.getFileName();

    // 存储文件
    ...

    // chunk 记录到数据库
    uploadService.addChunk(fileChunk);

    ...
}

前端在文件上传之前，多加一个步骤，那就是从后端取得曾经存在的切片文件。这里咱们先用文件名来查问，这只是长期计划，文件名并不能作为文件的惟一标记，后续咱们会改为应用文件 Hash 的形式来查问。

upload = file => {
  // 1. 文件切片
  const chunkList = createFileChunk(file);
  // 2. 判断后端是或曾经存在该文件
  this.getExistFileChunk(file.name).then(res => {
      // 标记曾经实现上传的
      this.chunkList.forEach(chunk => {
        uploadedChunkList.forEach(uploadedChunk => {if (uploadedChunk.chunkName === chunk.chunkName) {this.markAsSuccess(chunk);
          }
        });
      });
      // 上传切片
      this.uploadChunks(chunkList);
    }
  });

  return this;
};

如果存在曾经上传好的切片，将这些切片的状态更新为胜利，批改进度为 100，后续发送申请的时候会过滤掉状态为胜利的切片。

// 标记为上传实现
markAsSuccess = fileChunk => {
  fileChunk.status = 'SUCCESS';
  const chunkSize = fileChunk.chunk.size;

  fileChunk.progress = {
    percentage: 100,
    loaded: chunkSize,
    total: chunkSize,
  };
};

如此，就实现了一个文件的断点续传工作，演示如下。

限度申请个数

我在尝试将一个 5G 大小的文件上传的时候，发现前端浏览器呈现卡死景象，起因是切片文件过多，浏览器一次性创立了太多了 xhr 申请。这是没有必要的，拿 chrome 浏览器来说，默认的并发数量只有 6，过多的申请并不会晋升上传速度，反而是给浏览器带来了微小的累赘。因而，咱们有必要限度前端申请个数。

思路比较简单，先创立最大并发数的申请，而后在申请的回调函数中再次创立申请，直到全副申请都收回为止。

const MAX_REQUEST_NUM = 4;

// 限度申请并发数
requestWithLimit = (
    fileChunkList,
    max = MAX_REQUEST_NUM,
  ) => {return new Promise((resolve, reject) => {
      // 切片数量
       const requestNum = fileChunkList.filter(fileChunk => {return fileChunk.status === 'READY';}).length;

      // 发送胜利数量
      let counter = 0;

      const request = () => {
        // max 限度了最大并发数
        while (counter < requestNum && max > 0) {
          max--;

          // 期待发送的切片
          const fileChunk = fileChunkList.find(chunk => {return chunk.status === 'READY';});

          const formData = fileChunk.toFormData();

          fileChunk.status = 'UPLOADING';
          ajax4Upload({
            method: 'POST',
            url: this.uploadUrl,
            data: formData
          })
            .then(() => {
              fileChunk.status = 'SUCCESS';

              // 开释通道
              max++;
              counter++;
              if (counter === requestNum) {resolve();
              } else {request();
              }
            })
            .catch(e => {reject(e);
            });
        }
      };

      request();});
  };

并发重试

切片上传的过程中，咱们有可能因为各种起因导致某个切片上传失败，比方网络抖动、后端文件过程占用等等。对于这种状况，最好的计划就是为切片上传减少一个失败重试机制。因为切片不大，重试的代价很小，咱们 设定一个最大重试次数，如果在次数内仍然没有上传胜利，认为上传失败。

具体的做法就是革新 requestWithLimit 办法。

定义一个 retryArr 数组，用于记录文件上传失败的次数。革新 catch 办法，一个文件切片上传报错时候，先判断 retryArr 中给切片的谬误次数是否达到最大值，如果没有的话，清空以后切片上传进度，从新申请。相应的，咱们之前只上传处于 READY 状态的切片，当初要略微调整下，处于 ERROR 状态的切片也取得上传资格。

const MAX_RETRY_NUM = 3;

requestWithLimit = (
  fileChunkList,
  max = MAX_REQUEST_NUM,
  retry = MAX_RETRY_NUM,
) => {return new Promise((resolve, reject) => {

    ...

    // 记录文件上传失败的次数
    const retryArr = [];

    const request = () => {while (counter < requestNum && max > 0) {
        max--;

        // READY 或者 ERROR
        const fileChunk = fileChunkList.find(chunk => {return chunk.status === 'ERROR' || chunk.status === 'READY';});

        ...

        ajax4Upload({
          method: 'POST',
          url: this.uploadUrl,
          data: formData,
          onProgress: this.onProgressHandler.bind(this, fileChunk),
          requestList: this.requestList,
        })
          .then(() => {...})
          .catch(e => {
              fileChunk.status = 'ERROR';
              // 触发重试机制
              if (typeof retryArr[fileChunk.index] !== 'number') {retryArr[fileChunk.index] = 0;
              }

              // 次数累加
              retryArr[fileChunk.index]++;

              // 一个申请报错超过最大重试次数
              if (retryArr[fileChunk.index] >= retry) {return reject();
              }

              // 清空进度条
              fileChunk.progress = {};
              // 开释以后占用的通道，然而 counter 不累加
              max++;

              request();});
      }
    };

    request();});
};

后盾坐下设置，每个切片第一次上传肯定失败，会触发重传机制，如下所示。每个切片都会上传两次，发现进度显示的有点魔性，抽空优化吧。

秒传

秒传指的是文件如果在后盾曾经存了一份，就没必要再次上传了，间接返回上传胜利。在体量比拟大的利用场景下，秒传是个必要的性能，既能进步用户上传体验，又能节约本人的硬盘资源。

秒传的关键在于计算文件的唯一性标识。

文件的不同不是命名的差别，而是内容的差别，所以咱们将整个文件的二进制码作为入参，计算 Hash 值，将其作为文件的唯一性标识。一般而言，这样做就够了，然而摘要算法是存在碰撞概率的，咱们如果想要再谨严点的话，能够将文件大小也作为掂量指标，只有 文件摘要和文件大小同时相等，才认为是雷同的文件。

文件 Hash 值的计算是 CPU 密集型工作，线程在计算 Hash 值的过程中，页面处于假死状态。所以，该工作肯定不能在以后线程进行，咱们 应用 Web Worker 执行计算工作。

Web Worker 是 HTML5 规范的一部分，它容许一段 JavaScript 程序运行在主线程之外的另外一个线程中。这样计算工作就不会影响到以后线程的渲染工作。

目前网上有很多 Web Worker 应用计划，我应用的前端框架是 umi，间接配置下就好了。

export default defineConfig({
  workerLoader: {
    worker: 'Worker',
    esModule: true,
  },
});

Web Worker 是一段独自的 JS 程序，它和以后线程间应用 postMessage 的形式进行通信。

import Worker from './hash.worker.js';

// 生成文件 hash（web-worker）function calculateFileHash(fileChunkList) {
  return new Promise(resolve => {const worker = new Worker();

    worker.postMessage({fileChunkList, type: 'HASH'});
    worker.onmessage = e => {const { hash} = e.data;
      if (hash) {resolve(hash);
      }
    };
  });
}

如何疾速计算文件的 md5 值呢？咱们应用 js-spark-md5 这个库

js-spark-md5 是号称全宇宙最快的前端类包。我在本机测下来，计算 1G 文件大略 15 秒，的确很快。因为是在 Web Worker 中计算，须要将 spark-md5.min.js 放到动态资源目录下，不便援用。

self.importScripts('spark-md5.min.js'); // 导入脚本

// 全量 Hash
postHashMsg = fileChunkList => {const spark = new self.SparkMD5.ArrayBuffer();
  let count = 0;

  const loadNext = index => {const reader = new FileReader();
    reader.readAsArrayBuffer(fileChunkList[index].chunk);

    reader.onload = e => {
      count++;
      spark.append(e.target.result);
      if (count === fileChunkList.length) {
        self.postMessage({hash: spark.end(),
        });
        self.close();} else {
        // 递归计算下一个切片
        loadNext(count);
      }
    };
  };
  loadNext(0);
};

self.onmessage = e => {const { fileChunkList, type} = e.data;

  if (type === 'HASH') {postHashMsg(fileChunkList);
  }
};

此时前端上传文件的流程是这样的。

1. 文件切片。
2. 计算全量 Hash。
3. 判断文件是否合乎秒传条件，如果不满足，判断是否满足断点续传条件。
4. 文件上传。

后端也做下调整，上传文件的接口，须要在文件全副上传完毕后，记录下文件的详细信息，包含 md5 值，作为后续文件秒传的根据。

/**
  * 上传切片文件
  * @param chunk      切片文件
  * @param fileChunk  切片文件的源数据
  * @return true | false
  */
@PostMapping("/uploadChunk")
@ResponseBody
public Boolean upload(@RequestParam("chunk") MultipartFile chunk,
                      FileChunk fileChunk) {

  ...

  // 文件全副上传实现
  Integer chunkSize = uploadService.getChunkNumByContentHash(fileChunk.getFileHash());
  if (chunkSize.equals(fileChunk.getChunkNum())) {
      // 删除 chunk 记录
      uploadService.removeChunkRecord(fileChunk.getFileHash());

      // 减少 file 记录
      FileModel fileModel = new FileModel(fileChunk.getFileName(),
              fileChunk.getFullPath(),
              fileChunk.getFileHash(),
              fileChunk.getTotal(),
              "SUCCESS");
      uploadService.addFile(fileModel);
  }
}

判断秒传和断点续传的代码能够合并为一个接口，作为文件上传的前置接口。

秒传性能因为须要计算 Hash 值，会导致整体上传速度变慢，然而和大文件上传须要的耗时以及耗费的流量比起来，是一种性价比很高的抉择。

如果感觉文件计算全量 Hash 比较慢的话，还有一种形式就是计算抽样 Hash，缩小计算的字节数能够大幅度缩小耗时，然而抽样 Hash 的后果不能作为文件的唯一性标识，抽样 Hash 的值如果和后端统一，前端再计算全量 Hash，如果和后端不统一，那么这个文件肯定无奈秒传，此时能够间接将文件上传，当然，上传之后还是须要计算全量 Hash 值的。这种计划在文件反复率较少的场景下是很好的，它能极大缩小了前端的计算量，进步了速度，相当于转移了一部分工作到后端，也是不错的抉择。

总结

断点续传的重点是文件的切割与合并，整个上传流程须要前后端配合好，细节较多。秒传的要害是如何疾速计算大文件的摘要信息。咱们最初再梳理下文件上传的残缺流程。

1. 取得文件后，应用 Blob 对象的 slice 办法对其进行切割，并封装一些上传须要的数据，文件切割的速度很快，不影响主线程渲染。
2. 计算整个文件的 MD5 值，大文件比拟耗时，咱们将这部分工作放在 Web Worker 中执行。
3. 取得文件的 MD5 值之后，咱们将 MD5 值以及文件大小发送到后端，后端查问是否存在该文件，如果不存在的话，查问是否存在该文件的切片文件，如果存在，返回切片文件的详细信息。
4. 依据后端返回后果，顺次判断是否满足“秒传”或是“断点续传”的条件。如果满足，更新文件切片的状态与文件进度。
5. 依据文件切片的状态，发送上传申请，因为存在并发限度，咱们限度 request 创立个数，防止页面卡死。
6. 对于上传失败的文件，设置最大重试次数，将其持续退出到上传工作中，超过最大重试次数的才认为上传失败。
7. 后端收到文件后，首先保留文件，保留胜利后记录切片信息，判断以后切片是否是最初一个切片，如果是最初一个切片，记录文件信息，认为文件上传胜利，清空切片记录。

目前还有一些能够优化的点。

1. 多人上传同一个文件，只有其中一人上传胜利即可认为其他人上传胜利。
2. 拥塞管制，动静计算文件切片大小，大圣老师文章中曾经实现。
3. 进度条优化，进度条在断点续传和失败重传会呈现倒退的情景，

文章和代码都参考了如下几位大神的我的项目，倡议大家看看。

1. 字节跳面试官，我也实现了大文件上传和断点续传
2. 写给老手前端的各种文件上传攻略，从小图片到大文件断点续传

如果您感觉有所播种，就点个赞吧！

残缺的代码放在了 GitHub 上。别离是用 java 实现的 server 端，以及用 react 实现的前端。对着代码看文章，了解会深一些。