前端实现文件的断点续传

早就听说过断点续传这种东西，前端也可以实现一下

断点续传在前端的实现主要依赖着HTML5的新特性，所以一般来说在老旧浏览器上支持度是不高的

本文通过断点续传的简单例子(前端文件提交+后端PHP文件接收)，理解其大致的实现过程

还是先以图片为例，看看最后的样子

一、一些知识准备

断点续传，既然有断，那就应该有文件分割的过程，一段一段的传。

以前文件无法分割，但随着HTML5新特性的引入，类似普通字符串、数组的分割，我们可以可以使用slice方法来分割文件。

所以断点续传的最基本实现也就是：前端通过FileList对象获取到相应的文件，按照指定的分割方式将大文件分段，然后一段一段地传给后端，后端再按顺序一段段将文件进行拼接。

而我们需要对FileList对象进行修改再提交，在之前的文章中知晓了这种提交的一些注意点，因为FileList对象不能直接更改，所以不能直接通过表单的.submit()方法上传提交，需要结合FormData对象生成一个新的数据，通过Ajax进行上传操作。

二、实现过程

这个例子实现了文件断点续传的基本功能，不过手动的“暂停上传”操作还未实现成功，可以在上传过程中刷新页面来模拟上传的中断，体验“断点续传”、

有可能还有其他一些小bug，但基本逻辑大致如此。

1. 前端实现

首先选择文件，列出选中的文件列表信息，然后可以自定义的做上传操作

(1)所以先设置好页面DOM结构

1. <!-- 上传的表单 --> 
2.  
3. <form method="post" id="myForm" action="/fileTest.php" enctype="multipart/form-data"> 
4.  
5.     <input type="file" id="myFile" multiple=""> 
6.  
7.     <!-- 上传的文件列表 --> 
8.  
9.     <table id="upload-list"> 
10.  
11.         <thead> 
12.  
13.             <tr> 
14.  
15.                 <th width="35%">文件名</th> 
16.  
17.                 <th width="15%">文件类型</th> 
18.  
19.                 <th width="15%">文件大小</th> 
20.  
21.                 <th width="20%">上传进度</th> 
22.  
23.                 <th width="15%"> 
24.  
25.                     <input type="button" id="upload-all-btn" value="全部上传"> 
26.  
27.                 </th> 
28.  
29.             </tr> 
30.  
31.         </thead> 
32.  
33.         <tbody></tbody> 
34.  
35.     </table> 
36.  
37. </form> 
38.  
39. <!-- 上传文件列表中每个文件的信息模版 --> 

这里一并将CSS样式扔出来

1. body { 
2.  
3.     font-family: Arial; 
4.  
5. } 
6.  
7. form { 
8.  
9.     margin: 50px auto; 
10.  
11.     width: 600px; 
12.  
13. } 
14.  
15. input[type="button"] { 
16.  
17.     cursor: pointer; 
18.  
19. } 
20.  
21. table { 
22.  
23.     display: none; 
24.  
25.     margin-top: 15px; 
26.  
27.     border: 1px solid #ddd; 
28.  
29.     border-collapse: collapse; 
30.  
31. } 
32.  
33. table th { 
34.  
35.     color: #666; 
36.  
37. } 
38.  
39. table td, table th { 
40.  
41.     padding: 5px; 
42.  
43.     border: 1px solid #ddd; 
44.  
45.     text-align: center; 
46.  
47.     font-size: 14px; 
48.  
49. } 

(2)接下来是JS的实现解析

通过FileList对象我们能获取到文件的一些信息

其中的size就是文件的大小，文件的分分割分片需要依赖这个

这里的size是字节数，所以在界面显示文件大小时，可以这样转化

1. // 计算文件大小 
2.  
3. size = file.size > 1024 
4.  
5.     ? file.size / 1024  > 1024 
6.  
7.     ? file.size / (1024 * 1024) > 1024 
8.  
9.     ? (file.size / (1024 * 1024 * 1024)).toFixed(2) + 'GB' 
10.  
11.     : (file.size / (1024 * 1024)).toFixed(2) + 'MB' 
12.  
13.     : (file.size / 1024).toFixed(2) + 'KB' 
14.  
15.     : (file.size).toFixed(2) + 'B'; 

选择文件后显示文件的信息，在模版中替换一下数据

1. // 更新文件信息列表 
2.  
3. uploadItem.push(uploadItemTpl 
4.  
5.     .replace(/{{fileName}}/g, file.name) 
6.  
7.     .replace('{{fileType}}', file.type || file.name.match(/\.\w+$/) + '文件') 
8.  
9.     .replace('{{fileSize}}', size) 
10.  
11.     .replace('{{progress}}', progress) 
12.  
13.     .replace('{{totalSize}}', file.size) 
14.  
15.     .replace('{{uploadVal}}', uploadVal) 
16.  
17. ); 

不过，在显示文件信息的时候，可能这个文件之前之前已经上传过了，为了断点续传，需要判断并在界面上做出提示

通过查询本地看是否有相应的数据(这里的做法是当本地记录的是已经上传100%时，就直接是重新上传而不是继续上传了)

1. // 初始通过本地记录，判断该文件是否曾经上传过 
2.  
3. percent = window.localStorage.getItem(file.name + '_p'); 
4.  
5.   
6.  
7. if (percent && percent !== '100.0') { 
8.  
9.     progress = '已上传 ' + percent + '%'; 
10.  
11.     uploadVal = '继续上传'; 
12.  
13. } 

显示了文件信息列表

点击开始上传，可以上传相应的文件

上传文件的时候需要就将文件进行分片分段

比如这里配置的每段1024B，总共chunks段(用来判断是否为末段)，第chunk段，当前已上传的百分比percent等

需要提一下的是这个暂停上传的操作，其实我还没实现出来，暂停不了无奈ing…

接下来是分段过程

1. // 设置分片的开始结尾 
2.  
3. var blobFrom = chunk * eachSize, // 分段开始 
4.  
5.     blobTo = (chunk + 1) * eachSize > totalSize ? totalSize : (chunk + 1) * eachSize, // 分段结尾 
6.  
7.     percent = (100 * blobTo / totalSize).toFixed(1), // 已上传的百分比 
8.  
9.     timeout = 5000, // 超时时间 
10.  
11.     fd = new FormData($('#myForm')[0]); 
12.  
13. fd.append('theFile', findTheFile(fileName).slice(blobFrom, blobTo)); // 分好段的文件 
14.  
15. fd.append('fileName', fileName); // 文件名 
16.  
17. fd.append('totalSize', totalSize); // 文件总大小 
18.  
19. fd.append('isLastChunk', isLastChunk); // 是否为末段 
20.  
21. fd.append('isFirstUpload', times === 'first' ? 1 : 0); // 是否是第一段（第一次上传） 

1. // 上传之前查询是否以及上传过分片 
2.  
3. chunk = window.localStorage.getItem(fileName + '_chunk') || 0; 
4.  
5. chunk = parseInt(chunk, 10); 

文件应该支持覆盖上传，所以如果文件以及上传完了，现在再上传，应该重置数据以支持覆盖(不然后端就直接追加blob数据了)

1. // 如果第一次上传就为末分片，即文件已经上传完成，则重新覆盖上传 
2.  
3. if (times === 'first' && isLastChunk === 1) { 
4.  
5.     window.localStorage.setItem(fileName + '_chunk', 0); 
6.  
7.     chunk = 0; 
8.  
9.     isLastChunk = 0; 
10.  
11. } 

这个times其实就是个参数，因为要在上一分段传完之后再传下一分段，所以这里的做法是在回调中继续调用这个上传操作

接下来就是真正的文件上传操作了，用Ajax上传，因为用到了FormData对象，所以不要忘了在$.ajax({}加上这个配置processData: false

上传了一个分段，通过返回的结果判断是否上传完毕，是否继续上传

1. success: function (rs) { 
2.  
3.     rs = JSON.parse(rs); 
4.  
5.     // 上传成功 
6.  
7.     if (rs.status === 200) { 
8.  
9.         // 记录已经上传的百分比 
10.  
11.         window.localStorage.setItem(fileName + '_p', percent); 
12.  
13.         // 已经上传完毕 
14.  
15.         if (chunk === (chunks - 1)) { 
16.  
17.             $progress.text(msg['done']); 
18.  
19.             $this.val('已经上传').prop('disabled', true).css('cursor', 'not-allowed'); 
20.  
21.             if (!$('#upload-list').find('.upload-item-btn:not(:disabled)').length) { 
22.  
23.                 $('#upload-all-btn').val('已经上传').prop('disabled', true).css('cursor', 'not-allowed'); 
24.  
25.             } 
26.  
27.         } else { 
28.  
29.             // 记录已经上传的分片 
30.  
31.             window.localStorage.setItem(fileName + '_chunk', ++chunk); 
32.  
33.             $progress.text(msg['in'] + percent + '%'); 
34.  
35.             // 这样设置可以暂停，但点击后动态的设置就暂停不了.. 
36.  
37.             // if (chunk == 10) { 
38.  
39.             //     isPaused = 1; 
40.  
41.             // } 
42.  
43.             console.log(isPaused); 
44.  
45.             if (!isPaused) { 
46.  
47.                 startUpload(); 
48.  
49.             } 
50.  
51.         } 
52.  
53.     } 
54.  
55.     // 上传失败，上传失败分很多种情况，具体按实际来设置 
56.  
57.     else if (rs.status === 500) { 
58.  
59.         $progress.text(msg['failed']); 
60.  
61.     } 
62.  
63. }, 
64.  
65. error: function () { 
66.  
67.     $progress.text(msg['failed']); 
68.  
69. } 

继续下一分段的上传时，就进行了递归操作，按顺序地上传下一分段

截个图..

这是完整的JS逻辑，代码有点儿注释了应该不难看懂吧哈哈

1. // 全部上传操作 
2.  
3. $(document).on('click', '#upload-all-btn', function () { 
4.  
5.     // 未选择文件 
6.  
7.     if (!$('#myFile').val()) { 
8.  
9.         $('#myFile').focus(); 
10.  
11.     } 
12.  
13.     // 模拟点击其他可上传的文件 
14.  
15.     else { 
16.  
17.         $('#upload-list .upload-item-btn').each(function () { 
18.  
19.             $(this).click(); 
20.  
21.         }); 
22.  
23.     } 
24.  
25. }); 
26.  
27. // 选择文件-显示文件信息 
28.  
29. $('#myFile').change(function (e) { 
30.  
31.     var file, 
32.  
33.         uploadItem = [], 
34.  
35.         uploadItemTpl = $('#file-upload-tpl').html(), 
36.  
37.         size, 
38.  
39.         percent, 
40.  
41.         progress = '未上传', 
42.  
43.         uploadVal = '开始上传'; 
44.  
45.     for (var i = 0, j = this.files.length; i < j; ++i) { 
46.  
47.         file = this.files[i]; 
48.  
49.         percent = undefined; 
50.  
51.         progress = '未上传'; 
52.  
53.         uploadVal = '开始上传'; 
54.  
55.         // 计算文件大小 
56.  
57.         size = file.size > 1024 ? file.size / 1024 > 1024 ? file.size / (1024 * 1024) > 1024 ? (file.size / 
58.  
59.             (1024 * 1024 * 1024)).toFixed(2) + 'GB' : (file.size / (1024 * 1024)).toFixed(2) + 'MB' : (file 
60.  
61.             .size / 1024).toFixed(2) + 'KB' : (file.size).toFixed(2) + 'B'; 
62.  
63.         // 初始通过本地记录，判断该文件是否曾经上传过 
64.  
65.         percent = window.localStorage.getItem(file.name + '_p'); 
66.  
67.         if (percent && percent !== '100.0') { 
68.  
69.             progress = '已上传 ' + percent + '%'; 
70.  
71.             uploadVal = '继续上传'; 
72.  
73.         } 
74.  
75.         // 更新文件信息列表 
76.  
77.         uploadItem.push(uploadItemTpl 
78.  
79.             .replace(/{{fileName}}/g, file.name) 
80.  
81.             .replace('{{fileType}}', file.type || file.name.match(/\.\w+$/) + '文件') 
82.  
83.             .replace('{{fileSize}}', size) 
84.  
85.             .replace('{{progress}}', progress) 
86.  
87.             .replace('{{totalSize}}', file.size) 
88.  
89.             .replace('{{uploadVal}}', uploadVal)); 
90.  
91.     } 
92.  
93.     $('#upload-list').children('tbody').html(uploadItem.join('')) 
94.  
95.         .end().show(); 
96.  
97. }); 
98.  
99. /** 
100.  
101. * 上传文件时，提取相应匹配的文件项 
102.  
103. * @param  {String} fileName   需要匹配的文件名 
104.  
105. * @return {FileList}          匹配的文件项目 
106.  
107. */ 
108.  
109. function findTheFile(fileName) { 
110.  
111.     var files = $('#myFile')[0].files, 
112.  
113.         theFile; 
114.  
115.     for (var i = 0, j = files.length; i < j; ++i) { 
116.  
117.         if (files[i].name === fileName) { 
118.  
119.             theFile = files[i]; 
120.  
121.             break; 
122.  
123.         } 
124.  
125.     } 
126.  
127.     return theFile ? theFile : []; 
128.  
129. } 
130.  
131. // 上传文件 
132.  
133. $(document).on('click', '.upload-item-btn', function () { 
134.  
135.     var $this = $(this), 
136.  
137.         state = $this.attr('data-state'), 
138.  
139.         msg = { 
140.  
141.             done: '上传成功', 
142.  
143.             failed: '上传失败', 
144.  
145.             in : '上传中...', 
146.  
147.             paused: '暂停中...' 
148.  
149.         }, 
150.  
151.         fileName = $this.attr('data-name'), 
152.  
153.         $progress = $this.closest('tr').find('.upload-progress'), 
154.  
155.         eachSize = 1024, 
156.  
157.         totalSize = $this.attr('data-size'), 
158.  
159.         chunks = Math.ceil(totalSize / eachSize), 
160.  
161.         percent, 
162.  
163.         chunk, 
164.  
165.         // 暂停上传操作 
166.  
167.         isPaused = 0; 
168.  
169.     // 进行暂停上传操作 
170.  
171.     // 未实现，这里通过动态的设置isPaused值并不能阻止下方ajax请求的调用 
172.  
173.     if (state === 'uploading') { 
174.  
175.         $this.val('继续上传').attr('data-state', 'paused'); 
176.  
177.         $progress.text(msg['paused'] + percent + '%'); 
178.  
179.         isPaused = 1; 
180.  
181.         console.log('暂停：', isPaused); 
182.  
183.     } 
184.  
185.     // 进行开始/继续上传操作 
186.  
187.     else if (state === 'paused' || state === 'default') { 
188.  
189.         $this.val('暂停上传').attr('data-state', 'uploading'); 
190.  
191.         isPaused = 0; 
192.  
193.     } 
194.  
195.     // 第一次点击上传 
196.  
197.     startUpload('first'); 
198.  
199.     // 上传操作 times: 第几次 
200.  
201.     function startUpload(times) { 
202.  
203.         // 上传之前查询是否以及上传过分片 
204.  
205.         chunk = window.localStorage.getItem(fileName + '_chunk') || 0; 
206.  
207.         chunk = parseInt(chunk, 10); 
208.  
209.         // 判断是否为末分片 
210.  
211.         var isLastChunk = (chunk == (chunks - 1) ? 1 : 0); 
212.  
213.         // 如果第一次上传就为末分片，即文件已经上传完成，则重新覆盖上传 
214.  
215.         if (times === 'first' && isLastChunk === 1) { 
216.  
217.             window.localStorage.setItem(fileName + '_chunk', 0); 
218.  
219.             chunk = 0; 
220.  
221.             isLastChunk = 0; 
222.  
223.         } 
224.  
225.         // 设置分片的开始结尾 
226.  
227.         var blobFrom = chunk * eachSize, // 分段开始 
228.  
229.             blobTo = (chunk + 1) * eachSize > totalSize ? totalSize : (chunk + 1) * eachSize, // 分段结尾 
230.  
231.             percent = (100 * blobTo / totalSize).toFixed(1), // 已上传的百分比 
232.  
233.             timeout = 5000, // 超时时间 
234.  
235.             fd = new FormData($('#myForm')[0]); 
236.  
237.         fd.append('theFile', findTheFile(fileName).slice(blobFrom, blobTo)); // 分好段的文件 
238.  
239.         fd.append('fileName', fileName); // 文件名 
240.  
241.         fd.append('totalSize', totalSize); // 文件总大小 
242.  
243.         fd.append('isLastChunk', isLastChunk); // 是否为末段 
244.  
245.         fd.append('isFirstUpload', times === 'first' ? 1 : 0); // 是否是第一段（第一次上传） 
246.  
247.         // 上传 
248.  
249.         $.ajax({ 
250.  
251.             type: 'post', 
252.  
253.             url: '/fileTest.php', 
254.  
255.             data: fd, 
256.  
257.             processData: false, 
258.  
259.             contentType: false, 
260.  
261.             timeout: timeout, 
262.  
263.             success: function (rs) { 
264.  
265.                 rs = JSON.parse(rs); 
266.  
267.                 // 上传成功 
268.  
269.                 if (rs.status === 200) { 
270.  
271.                     // 记录已经上传的百分比 
272.  
273.                     window.localStorage.setItem(fileName + '_p', percent); 
274.  
275.                     // 已经上传完毕 
276.  
277.                     if (chunk === (chunks - 1)) { 
278.  
279.                         $progress.text(msg['done']); 
280.  
281.                         $this.val('已经上传').prop('disabled', true).css('cursor', 'not-allowed'); 
282.  
283.                         if (!$('#upload-list').find('.upload-item-btn:not(:disabled)').length) { 
284.  
285.                             $('#upload-all-btn').val('已经上传').prop('disabled', true).css('cursor', 
286.  
287.                                 'not-allowed'); 
288.  
289.                         } 
290.  
291.                     } else { 
292.  
293.                         // 记录已经上传的分片 
294.  
295.                         window.localStorage.setItem(fileName + '_chunk', ++chunk); 
296.  
297.                         $progress.text(msg['in'] + percent + '%'); 
298.  
299.                         // 这样设置可以暂停，但点击后动态的设置就暂停不了.. 
300.  
301.                         // if (chunk == 10) { 
302.  
303.                         //     isPaused = 1; 
304.  
305.                         // } 
306.  
307.                         console.log(isPaused); 
308.  
309.                         if (!isPaused) { 
310.  
311.                             startUpload(); 
312.  
313.                         } 
314.  
315.                     } 
316.  
317.                 } 
318.  
319.                 // 上传失败，上传失败分很多种情况，具体按实际来设置 
320.  
321.                 else if (rs.status === 500) { 
322.  
323.                     $progress.text(msg['failed']); 
324.  
325.                 } 
326.  
327.             }, 
328.  
329.             error: function () { 
330.  
331.                 $progress.text(msg['failed']); 
332.  
333.             } 
334.  
335.         }); 
336.  
337.     } 
338.  
339. }); 

2. 后端实现

这里的后端实现还是比较简单的，主要用依赖了 file_put_contents、file_get_contents 这两个方法

要注意一下，通过FormData对象上传的文件对象，在PHP中也是通过$_FILES全局对象获取的，还有为了避免上传后文件中文的乱码，用一下iconv

断点续传支持文件的覆盖，所以如果已经存在完整的文件，就将其删除

1. // 如果第一次上传的时候，该文件已经存在，则删除文件重新上传 
2.  
3. if ($isFirstUpload == '1' && file_exists('upload/'.$fileName) && filesize('upload/'.$fileName) == $totalSize) { 
4.  
5.     unlink('upload/'.$fileName); 
6.  
7. } 

使用上述的两个方法，进行文件信息的追加，别忘了加上 FILE_APPEND 这个参数~

1. // 继续追加文件数据 
2.  
3. if (!file_put_contents('upload/'.$fileName, file_get_contents($_FILES['theFile']['tmp_name']), FILE_APPEND)) { 
4.  
5.     $status = 501; 
6.  
7. } else { 
8.  
9.     // 在上传的最后片段时，检测文件是否完整（大小是否一致） 
10.  
11.     if ($isLastChunk === '1') { 
12.  
13.         if (filesize('upload/'.$fileName) == $totalSize) { 
14.  
15.             $status = 200; 
16.  
17.         } else { 
18.  
19.             $status = 502; 
20.  
21.         } 
22.  
23.     } else { 
24.  
25.         $status = 200; 
26.  
27.     } 
28.  
29. } 

一般在传完后都需要进行文件的校验吧，所以这里简单校验了文件大小是否一致

根据实际需求的不同有不同的错误处理方法，这里就先不多处理了

完整的PHP部分

1. <?php 
2.  
3.     header('Content-type: text/plain; charset=utf-8'); 
4.  
5.   
6.  
7.     $files = $_FILES['theFile']; 
8.  
9.     $fileName = iconv('utf-8', 'gbk', $_REQUEST['fileName']); 
10.  
11.     $totalSize = $_REQUEST['totalSize']; 
12.  
13.     $isLastChunk = $_REQUEST['isLastChunk']; 
14.  
15.     $isFirstUpload = $_REQUEST['isFirstUpload']; 
16.  
17.   
18.  
19.     if ($_FILES['theFile']['error'] > 0) { 
20.  
21.         $status = 500; 
22.  
23.     } else { 
24.  
25.         // 此处为一般的文件上传操作 
26.  
27.         // if (!move_uploaded_file($_FILES['theFile']['tmp_name'], 'upload/'. $_FILES['theFile']['name'])) { 
28.  
29.         //     $status = 501; 
30.  
31.         // } else { 
32.  
33.         //     $status = 200; 
34.  
35.         // } 
36.  
37.   
38.  
39.         // 以下部分为文件断点续传操作 
40.  
41.         // 如果第一次上传的时候，该文件已经存在，则删除文件重新上传 
42.  
43.         if ($isFirstUpload == '1' && file_exists('upload/'. $fileName) && filesize('upload/'. $fileName) == $totalSize) { 
44.  
45.             unlink('upload/'. $fileName); 
46.  
47.         } 
48.  
49.   
50.  
51.         // 否则继续追加文件数据 
52.  
53.         if (!file_put_contents('upload/'. $fileName, file_get_contents($_FILES['theFile']['tmp_name']), FILE_APPEND)) { 
54.  
55.             $status = 501; 
56.  
57.         } else { 
58.  
59.             // 在上传的最后片段时，检测文件是否完整（大小是否一致） 
60.  
61.             if ($isLastChunk === '1') { 
62.  
63.                 if (filesize('upload/'. $fileName) == $totalSize) { 
64.  
65.                     $status = 200; 
66.  
67.                 } else { 
68.  
69.                     $status = 502; 
70.  
71.                 } 
72.  
73.             } else { 
74.  
75.                 $status = 200; 
76.  
77.             } 
78.  
79.         } 
80.  
81.     } 
82.  
83.   
84.  
85.     echo json_encode(array( 
86.  
87.         'status' => $status, 
88.  
89.         'totalSize' => filesize('upload/'. $fileName), 
90.  
91.         'isLastChunk' => $isLastChunk 
92.  
93.     )); 
94.  
95.   
96.  
97. ?> 

先到这儿~

作者：佚名

来源：51CTO