前端实现文件的断点续传

gduf0018 8年前
   <p>早就听说过断点续传这种东西,前端也可以实现一下</p>    <p>断点续传在前端的实现主要依赖着HTML5的新特性,所以一般来说在老旧浏览器上支持度是不高的</p>    <p>本文通过断点续传的简单例子(前端文件提交+后端PHP文件接收),理解其大致的实现过程</p>    <p>还是先以图片为例,看看最后的样子</p>    <p style="text-align: center;"><img src="https://simg.open-open.com/show/8827263e702996d6d6a550a6d90fd72b.gif"></p>    <h2><strong>一、一些知识准备</strong></h2>    <p>断点续传,既然有断,那就应该有文件分割的过程,一段一段的传。</p>    <p>以前文件无法分割,但随着HTML5新特性的引入,类似普通字符串、数组的分割,我们可以可以使用slice方法来分割文件。</p>    <p>所以断点续传的最基本实现也就是:前端通过FileList对象获取到相应的文件,按照指定的分割方式将大文件分段,然后一段一段地传给后端,后端再按顺序一段段将文件进行拼接。</p>    <p>而我们需要对FileList对象进行修改再提交,在 之前的文章 中知晓了这种提交的一些注意点,因为FileList对象不能直接更改,所以不能直接通过表单的.submit()方法上传提交,需要结合FormData对象生成一个新的数据,通过Ajax进行上传操作。</p>    <h2><strong>二、实现过程</strong></h2>    <p>这个例子实现了文件断点续传的基本功能,不过手动的“暂停上传”操作还未实现成功,可以在上传过程中刷新页面来模拟上传的中断,体验“断点续传”、</p>    <p>有可能还有其他一些小bug,但基本逻辑大致如此。</p>    <h3><strong>1. 前端实现</strong></h3>    <p>首先选择文件,列出选中的文件列表信息,然后可以自定义的做上传操作</p>    <p>(1)所以先设置好页面DOM结构</p>    <pre>  <code class="language-javascript">       <!-- 上传的表单 -->          <form method="post" id="myForm" action="/fileTest.php" enctype="multipart/form-data">              <input type="file" id="myFile" multiple>              <!-- 上传的文件列表 -->              <table id="upload-list">                  <thead>                      <tr>                          <th width="35%">文件名</th>                          <th width="15%">文件类型</th>                          <th width="15%">文件大小</th>                          <th width="20%">上传进度</th>                          <th width="15%">                              <input type="button" id="upload-all-btn" value="全部上传">                          </th>                      </tr>                  </thead>                  <tbody>                  </tbody>              </table>          </form>          <!-- 上传文件列表中每个文件的信息模版 -->          <script type="text/template" id="file-upload-tpl"> <tr> <td>{{fileName}}</td> <td>{{fileType}}</td> <td>{{fileSize}}</td> <td class="upload-progress">{{progress}}</td> <td> <input type="button" class="upload-item-btn" data-name="{{fileName}}" data-size="{{totalSize}}" data-state="default" value="{{uploadVal}}"> </td> </tr> </script></code></pre>    <p>这里一并将CSS样式扔出来</p>    <pre>  <code class="language-javascript">       <style type="text/css">              body {   font-family: Arial; }              form {    margin: 50px auto;   width: 600px; }                input[type="button"] {   cursor: pointer; }              table {    display: none;   margin-top: 15px;   border: 1px solid #ddd;   border-collapse: collapse; }                table th {   color: #666; }              table td,              table th {    padding: 5px;   border: 1px solid #ddd;   text-align: center;   font-size: 14px; }          </styl</code></pre>    <h3><strong>(2)接下来是JS的实现解析</strong></h3>    <p>通过FileList对象我们能获取到文件的一些信息</p>    <p style="text-align:center"><img src="https://simg.open-open.com/show/d26e3056f98192f83ebb9010c2768496.png"></p>    <p>其中的size就是文件的大小,文件的分分割分片需要依赖这个</p>    <p>这里的size是字节数,所以在界面显示文件大小时,可以这样转化</p>    <pre>  <code class="language-javascript">// 计算文件大小    size = file.size > 1024    ? file.size / 1024  > 1024    ? file.size / (1024 * 1024) > 1024    ? (file.size / (1024 * 1024 * 1024)).toFixed(2) + 'GB'      : (file.size / (1024 * 1024)).toFixed(2) + 'MB'      : (file.size / 1024).toFixed(2) + 'KB'      : (file.size).toFixed(2) + 'B';  </code></pre>    <p>选择文件后显示文件的信息,在模版中替换一下数据</p>    <pre>  <code class="language-javascript">// 更新文件信息列表       uploadItem.push(uploadItemTpl      .replace(/{{fileName}}/g, file.name)      .replace('{{fileType}}', file.type || file.name.match(/\.\w+$/) + '文件')          .replace('{{fileSize}}', size)          .replace('{{progress}}', progress)           .replace('{{totalSize}}', file.size)          .replace('{{uploadVal}}', uploadVal)          );  </code></pre>    <p>不过,在显示文件信息的时候,可能这个文件之前之前已经上传过了,为了断点续传,需要判断并在界面上做出提示。</p>    <p>通过查询本地看是否有相应的数据(这里的做法是当本地记录的是已经上传100%时,就直接是重新上传而不是继续上传了)</p>    <pre>  <code class="language-javascript">    // 初始通过本地记录,判断该文件是否曾经上传过       percent = window.localStorage.getItem(file.name + '_p');         if (percent && percent !== '100.0') {              progress = '已上传 ' + percent + '%';              uploadVal = '继续上传';           }</code></pre>    <p>显示了文件信息列表</p>    <p style="text-align:center"><img src="https://simg.open-open.com/show/cb7d57d7d0b97c576d201a69efde4065.png"></p>    <p>点击开始上传,可以上传相应的文件</p>    <p style="text-align:center"><img src="https://simg.open-open.com/show/2ec03b693f21a9dd4a8142f6db3cf3de.png"></p>    <p>上传文件的时候需要就将文件进行分片分段。</p>    <p>比如这里配置的每段1024B,总共chunks段(用来判断是否为末段),第chunk段,当前已上传的百分比percent等。</p>    <p>需要提一下的是这个暂停上传的操作,其实我还没实现出来,暂停不了无奈ing...</p>    <p style="text-align:center"><img src="https://simg.open-open.com/show/839c3687bbfc849fd1d055166ac18e13.png"></p>    <p style="text-align:center"><img src="https://simg.open-open.com/show/9d0682a946bb7f1d121ff3478715259e.png"></p>    <p>接下来是分段过程</p>    <pre>  <code class="language-javascript">        // 设置分片的开始结尾      var blobFrom = chunk * eachSize, // 分段开始         blobTo = (chunk + 1) * eachSize > totalSize ? totalSize : (chunk + 1) * eachSize, // 分段结尾         percent = (100 * blobTo / totalSize).toFixed(1), // 已上传的百分比          timeout = 5000, // 超时时间          fd = new FormData($('#myForm')[0]);            fd.append('theFile', findTheFile(fileName).slice(blobFrom, blobTo)); // 分好段的文件          fd.append('fileName', fileName); // 文件名          fd.append('totalSize', totalSize); // 文件总大小          fd.append('isLastChunk', isLastChunk); // 是否为末段          fd.append('isFirstUpload', times === 'first' ? 1 : 0); // 是否是第一段(第一次上传)</code></pre>    <pre>  <code class="language-javascript">    // 上传之前查询是否以及上传过分片      chunk = window.localStorage.getItem(fileName + '_chunk') || 0;      chunk = parseInt(chunk, 10);</code></pre>    <p>文件应该支持覆盖上传,所以如果文件以及上传完了,现在再上传,应该重置数据以支持覆盖(不然后端就直接追加 blob数据了)</p>    <pre>  <code class="language-javascript">// 如果第一次上传就为末分片,即文件已经上传完成,则重新覆盖上传      if (times === 'first' && isLastChunk === 1) {        window.localStorage.setItem(fileName + '_chunk', 0);              chunk = 0;              isLastChunk = 0;           }</code></pre>    <p>这个 times 其实就是个参数,因为要在上一分段传完之后再传下一分段,所以这里的做法是在回调中继续调用这个上传操作</p>    <p style="text-align:center"><img src="https://simg.open-open.com/show/2611a34afb97cd1da125226b63d764ad.png"></p>    <p>接下来就是真正的文件上传操作了,用Ajax上传,因为用到了FormData对象,所以不要忘了在$.ajax({}加上这个配置processData: false</p>    <p>上传了一个分段,通过返回的结果判断是否上传完毕,是否继续上传</p>    <pre>  <code class="language-javascript">       success: function(rs) {         rs = JSON.parse(rs);        // 上传成功           if (rs.status === 200) {         // 记录已经上传的百分比              window.localStorage.setItem(fileName + '_p', percent);           // 已经上传完毕          if (chunk === (chunks - 1)) {             $progress.text(msg['done']);             $this.val('已经上传').prop('disabled', true).css('cursor', 'not-allowed');            if (!$('#upload-list').find('.upload-item-btn:not(:disabled)').length) {                  $('#upload-all-btn').val('已经上传').prop('disabled', true).css('cursor', 'not-allowed');               }               } else {             // 记录已经上传的分片              window.localStorage.setItem(fileName + '_chunk', ++chunk);                 $progress.text(msg['in'] + percent + '%');            // 这样设置可以暂停,但点击后动态的设置就暂停不了..                  // if (chunk == 10) {                  //     isPaused = 1;                  // }                  console.log(isPaused);                          if (!isPaused) {                      startUpload();                      }   }                  }           // 上传失败,上传失败分很多种情况,具体按实际来设置                      else if (rs.status === 500) {                      $progress.text(msg['failed']);                      }                  },                error: function() {               $progress.text(msg['failed']);           }</code></pre>    <p>继续下一分段的上传时,就进行了递归操作,按顺序地上传下一分段</p>    <p>截个图..</p>    <p style="text-align:center"><img src="https://simg.open-open.com/show/7bc1c84aec7664aa8ce87da56533d728.png"></p>    <p>这是完整的JS逻辑,代码有点儿注释了应该不难看懂吧哈哈</p>    <p style="text-align:center"><img src="https://simg.open-open.com/show/166643ebea318b6b8d5d1976dffc11c0.jpg"> <img src="https://simg.open-open.com/show/16fde4f038f9e61d870975f100f6827e.jpg"> <img src="https://simg.open-open.com/show/b55d39ac0df6b96121e23e99e1215b5d.jpg"> <img src="https://simg.open-open.com/show/3602d993058d606c07c0820fb194f177.jpg"> <img src="https://simg.open-open.com/show/8f917acce744fd4d7e96ce028242f3da.jpg"> <img src="https://simg.open-open.com/show/cb519817f996f68c9aeb57fe7893f2b0.jpg"> <img src="https://simg.open-open.com/show/baae7a8417e987fc8d01ebe773ca7a4c.jpg"> <img src="https://simg.open-open.com/show/e2534ddfdcc7484456d8014e8ccca15e.jpg"></p>    <h3><strong>2. 后端实现</strong></h3>    <p>这里的后端实现还是比较简单的,主要用依赖了 file_put_contents、file_get_contents 这两个方法</p>    <p style="text-align:center"><img src="https://simg.open-open.com/show/f30c167238e1db9af4a132839a7a4627.png"></p>    <p>要注意一下,通过FormData对象上传的文件对象,在PHP中也是通过$_FILES全局对象获取的,还有为了避免上传后文件中文的乱码,用一下iconv</p>    <p>断点续传支持文件的覆盖,所以如果已经存在完整的文件,就将其删除</p>    <pre>  <code class="language-javascript">                // 如果第一次上传的时候,该文件已经存在,则删除文件重新上传          if ($isFirstUpload == '1' && file_exists('upload/'. $fileName) && filesize('upload/'. $fileName) == $totalSize) {              unlink('upload/'. $fileName);          }</code></pre>    <p>使用上述的两个方法,进行文件信息的追加,别忘了加上 FILE_APPEND 这个参数~</p>    <pre>  <code class="language-javascript">           // 继续追加文件数据          if (!file_put_contents('upload/'. $fileName, file_get_contents($_FILES['theFile']['tmp_name']), FILE_APPEND)) {              $status = 501;          } else {            // 在上传的最后片段时,检测文件是否完整(大小是否一致)              if ($isLastChunk === '1') {                if (filesize('upload/'. $fileName) == $totalSize) {                      $status = 200;                  } else {                      $status = 502;                  }              } else {                  $status = 200;              }          }</code></pre>    <p>一般在传完后都需要进行文件的校验吧,所以这里简单校验了文件大小是否一致。</p>    <p>根据实际需求的不同有不同的错误处理方法,这里就先不多处理了</p>    <p>完整的PHP部分</p>    <pre>  <code class="language-javascript"><?php       header('Content-type: text/plain; charset=utf-8');       $files = $_FILES['theFile'];        $fileName = iconv('utf-8', 'gbk', $_REQUEST['fileName']);             $totalSize = $_REQUEST['totalSize'];                  $isLastChunk = $_REQUEST['isLastChunk'];                       $isFirstUpload = $_REQUEST['isFirstUpload'];    if ($_FILES['theFile']['error'] > 0) {            $status = 500;       } else {         // 此处为一般的文件上传操作           // if (!move_uploaded_file($_FILES['theFile']['tmp_name'], 'upload/'. $_FILES['theFile']['name'])) {           //     $status = 501;           // } else {           //     $status = 200;           // }              // 以下部分为文件断点续传操作           // 如果第一次上传的时候,该文件已经存在,则删除文件重新上传           if ($isFirstUpload == '1' && file_exists('upload/'. $fileName) && filesize('upload/'. $fileName) == $totalSize) {               unlink('upload/'. $fileName);           }            // 否则继续追加文件数据           if (!file_put_contents('upload/'. $fileName, file_get_contents($_FILES['theFile']['tmp_name']), FILE_APPEND)) {                         $status = 501;           } else {             // 在上传的最后片段时,检测文件是否完整(大小是否一致)               if ($isLastChunk === '1') {                 if (filesize('upload/'. $fileName) == $totalSize) {                     $status = 200;                   } else {                          $status = 502;                  }               } else {                          $status = 200;               }           }       }     echo json_encode(array(  'status' => $status, 'totalSize' => filesize('upload/'. $fileName), 'isLastChunk' => $isLastChunk       )); ?></code></pre>    <p> </p>    <p> </p>    <p> </p>    <p> </p>    <p>来自:https://mp.weixin.qq.com/s?__biz=MzAwNjA3NDMyOA==&mid=2659763006&idx=2&sn=99a0ff52ca3c5f4d4f6377fc3a1fdc69&chksm=806e9989b719109fd6a0a5ce0b7863326c81ae74b88ecf7f7cf28cbaf438068c6744a95ec395&scene=0&key=&ascene=7&uin=&devicetype=android-23&version=26031b31&nettype=WIFI</p>    <p> </p>