ToB企服应用市场:ToB评测及商务社交产业平台

标题: 前端大文件分片下载办理方案,没用你来砍我 [打印本页]

作者: 大号在练葵花宝典    时间: 2024-6-20 16:28
标题: 前端大文件分片下载办理方案,没用你来砍我
前言

好记性不如烂笔头,站在岸上学不会游泳。这次分享一是为了纪录下忙碌几天的成果,方便以后查阅;二是克制别人走弯路,给别人方便就是给自己方便。
一、背景

客户下载超大文件(1G以上)时,下载非常断开,分析了下有以下原因:
针对上述题目,找到一个合理的办理方案 分片下载,既可不超限亦不必要保持长连接,假如出现网络颠簸断开连接,亦可断点续传。多的不说,直接上干货。
二、代码实现

1.后端

创建下载工具类DownloadUtil.java
  1. import javax.servlet.http.HttpServletRequest;
  2. import javax.servlet.http.HttpServletResponse;
  3. import java.io.*;
  4. import java.net.URLEncoder;
  5. public class DownloadUtil {
  6.     /**
  7.      * 每个分片大小 50M
  8.      */
  9.     private final static int BUFFER_SIZE = 1024 * 1024 * 50;
  10.     public static void downloadByBlock(File file, HttpServletRequest request, HttpServletResponse response) throws IOException {
  11.         // 获取文件名
  12.         String fileName = file.getName();
  13.         // 获取文件大小
  14.         long fileSize = file.length();
  15.         // 设置返回头
  16.         response.setContentType("application/octect-stream;charset=UTF-8");
  17.         response.setHeader("Content-Disposition", "attachment; filename=" + URLEncoder.encode(fileName, "UTF-8"));
  18.         response.setHeader("Accept-Ranges", "bytes");
  19.         // 判断是否包含Range
  20.         String rangeHeader = request.getHeader("Range");
  21.         if (rangeHeader == null) {
  22.             // 返回文件大小信息
  23.             response.setHeader("Content-Length", String.valueOf(fileSize));
  24.             response.setHeader("Buffer-Size", String.valueOf(BUFFER_SIZE));
  25.             response.setHeader("Access-Control-Expose-Headers", "Buffer-Size");
  26.         } else {
  27.             // 分片下载
  28.             long start = 0;
  29.             long end = fileSize - 1;
  30.             String[] range = rangeHeader.split("=")[1].split("-");
  31.             if (range.length == 1) {
  32.                 start = Long.parseLong(range[0]);
  33.                 end = fileSize - 1;
  34.             } else {
  35.                 start = Long.parseLong(range[0]);
  36.                 end = Long.parseLong(range[1]);
  37.             }
  38.             long contentLength = end - start + 1;
  39.             // 返回头里存放每次读取的开始和结束字节
  40.             response.setHeader("Content-Length", String.valueOf(contentLength));
  41.             response.setHeader("Content-Range", "bytes " + start + "-" + end + "/" + fileSize);
  42.             InputStream in = new FileInputStream(file);
  43.             OutputStream out = response.getOutputStream();
  44.             // 跳到第start字节
  45.             in.skip(start);
  46.             byte[] buffer = new byte[BUFFER_SIZE];
  47.             int bytesRead = -1;
  48.             long bytesWritten = 0;
  49.             while ((bytesRead = in.read(buffer)) != -1) {
  50.                 if (bytesWritten + bytesRead > contentLength) {
  51.                     out.write(buffer, 0, (int) (contentLength - bytesWritten));
  52.                     break;
  53.                 } else {
  54.                     out.write(buffer, 0, bytesRead);
  55.                     bytesWritten += bytesRead;
  56.                 }
  57.             }
  58.             in.close();
  59.             out.close();
  60.         }
  61.     }
  62. }
复制代码
后端代码借鉴其他博友 来源
2.前端

前端使用vue脚手架项目作为实例,也可用其他方式实现;
当前实例必要用到的技术:
localforage:localForage 是一个 JavaScript 库,通过简单类似 ​​localStorage​​ API 的异步存储来改进你的 Web 应用程序的离线体验,最最紧张的一点是通过它可以将数据持久化至本地磁盘
streamsaver:用于实如今Web欣赏器中直接将大文件流式传输到用户装备的功能
创建工具类 download.js

  1. import axios from 'axios';
  2. import localForage from 'localforage'
  3. import streamSaver from 'streamsaver'
  4. import store from "@/store/index"
  5. // 基础数据库 存放其他文件的数据库实例名
  6. const baseDataBaseName = "localforageInstance";
  7. // 数据库进度数据主键
  8. const progressKey = "progress";
  9. /**
  10. * @description 分片下载
  11. * @param fileName 文件名
  12. * @param url 下载地址
  13. * @param dataBaseName 数据库名,用于存放分片数据 每个文件唯一
  14. * @param progress 下载进度 type:continue 续传 again重新下载 cancel取消
  15. */
  16. export async function downloadByBlock(fileName, url, dataBaseName, progress) {
  17.         if(progress.type){
  18.                 await controlFile(fileName, progress.type, dataBaseName)
  19.         }
  20.         // 创建基础数据库 用于保存文件信息
  21.         const baseDataBase = createInstance(baseDataBaseName);
  22.         // 判断数据库中是否已存在该文件的下载任务
  23.         let isError = false;
  24.         await getData(dataBaseName, baseDataBase, async(res) => {
  25.                 if(res && !progress.type){
  26.                         alert("已存在下载进度!");
  27.                         isError = true;
  28.                 }
  29.         })
  30.         if(isError){
  31.                 return;
  32.         }
  33.         // 创建数据库 用于存储每个文件的分片数据
  34.         const dataBase = createInstance(dataBaseName);
  35.        
  36.         // 获取文件大小
  37.         const response = await axios.head(url);
  38.         // 文件大小 注意转为数字
  39.         const fileSize = +response.headers['content-length'];
  40.         // 分片大小 注意转为数字
  41.         const chunkSize = +response.headers['buffer-size'];
  42.         // 开始节点
  43.         let start = 0;
  44.         // 结束节点
  45.         let end = chunkSize -1;
  46.         if(fileSize < chunkSize){
  47.                 end = fileSize - 1;
  48.         }
  49.         // 所有分片信息
  50.         let ranges = [];
  51.         // 计算需要多少分片
  52.         const numChunks = Math.ceil(fileSize / chunkSize);
  53.         // 回写文件大小
  54.         progress.fileSize = fileSize;
  55.         progress.url = url;
  56.         // 保存数据库实例  文件信息
  57.         await saveData(dataBaseName, fileName, baseDataBase);
  58.         if(!progress.progress){
  59.                 // 保存整个文件的进度数据(包括文件名 下载地址 文件大小  方便刷新页面后继续断点续传)
  60.                 await saveData(progressKey, progress, dataBase);
  61.         }
  62.        
  63.         // 组装参数 用于准备分片下载文件数据
  64.         for(let i = 0; i < numChunks; i++){
  65.                 // 创建请求控制器  用于控制往后端的请求
  66.                 const controller = new AbortController();
  67.                 const range = `bytes=${start}-${end}`;
  68.                 // 如果是续传 先判断是否已下载
  69.                 if(progress.type == 'continue'){
  70.                         // 先修改状态
  71.                         store.commit('setProgress',{
  72.                                 dataInstance: dataBaseName,
  73.                                 status: 'downloading'
  74.                         })
  75.                         let isContinue = false;
  76.                         await getData(range, dataBase, async function(res){if(res) isContinue = true});
  77.                         if(isContinue){
  78.                                 ranges.push(range);
  79.                                 // 重置开始节点
  80.                                 start = end + 1;
  81.                                 // 重置结束节点
  82.                                 end = Math.min(end + chunkSize, fileSize -1);
  83.                                 continue;
  84.                         }
  85.                 }
  86.                 const config = {
  87.                         headers: {
  88.                                 Range: range
  89.                         },
  90.                         responseType: 'arraybuffer',
  91.                         // 绑定取消请求的信号量
  92.                         signal: controller.signal,
  93.                         // 文件下载进度监听
  94.                         onDownloadProgress: function(pro){
  95.                                 if(progress.type == 'stop' || progress.type == 'cancel'){
  96.                                         // 终止请求
  97.                                         controller.abort();
  98.                                 }
  99.                                 // 获取当前分片的下载进度 loaded表示已下载的数量 total表示总数量
  100.                                 let downProgress = (pro.loaded / pro.total);
  101.                                 // 计算整个文件的下载进度
  102.                                 downProgress = Math.round((i / numChunks) * 100 + downProgress / numChunks * 100);
  103.                                 store.commit('setProgress',{
  104.                                         dataInstance: dataBaseName,
  105.                                         fileName: fileName,
  106.                                         progress: downProgress,
  107.                                         status: downProgress == 100 ? 'success' : 'downloading'
  108.                                 })
  109.                         }
  110.                 };
  111.                 try{
  112.                         // 开始分片下载
  113.                         const response = await axios.get(url, config);
  114.                         // 【重点1】 以分片名为key保存分片数据至本地磁盘 如果用localstorage 保存至浏览器内存,数据太多会导致浏览器奔溃
  115.                         await saveData(range, response.data, dataBase);
  116.                         // 将分片名保存 方便后面通过key取出分片数据
  117.                         ranges.push(range);
  118.                         // 重置开始节点
  119.                         start = end + 1;
  120.                         // 重置结束节点
  121.                         end = Math.min(end + chunkSize, fileSize -1);
  122.                 } catch (error) {
  123.                         // 如果中途终止请求,会有异常信息 所以在此处理
  124.                         if(error.message == "canceled"){
  125.                                 await controlFile(fileName, progress.type, dataBaseName);
  126.                                 return;
  127.                         }
  128.                 }
  129.         }
  130.         // 下载完成后 开始合并分片数据
  131.         // 流操作
  132.         // 如果项目在内网,连接不了外部网络或者没法连接github,需要把streamSaver模块中的mitm.html和sw.js手动拷贝至项目public目录下,然后重新配置mitm地址即可
  133.         // streamSaver.mitm="http://localhost:8081/mitm.html?version=2.0.0"
  134.         const fileStream = streamSaver.createWriteStream(fileName, {size: fileSize});
  135.         const writer = fileStream.getWriter();
  136.         // 循环分片名
  137.         for(let i = 0;i < ranges.length; i++){
  138.                 let range = ranges[i];
  139.                 // 从数据库获取分片数据
  140.                 await getData(range, dataBase, async function(res){
  141.                         if(res){
  142.                                 // 【重点2】读取流 不能将流数据直接存到浏览器内存中 然后合并,这样同样会使浏览器崩溃
  143.                                 // let 分片数据1 = [];
  144.                                 // let 分片数据2 = [];
  145.                                 // let 分片数据 。。。
  146.                                 // 合并 let array = 分片数据1 + 分片数据2 + ...
  147.                                 // 这种不可取
  148.                                  
  149.                                  // 读出来就直接生成文件往磁盘写 不在内存中停留
  150.                                 const reader = new Blob([res]).stream().getReader();
  151.                                 while(true){
  152.                                         const { done, value } = await reader.read();
  153.                                         if(done) break;
  154.                                         // 写入
  155.                                         writer.write(value);
  156.                                 }
  157.                                 // 判断如果是最后一个分片
  158.                                 if(i == ranges.length-1){
  159.                                         // 结束写入  关闭
  160.                                         writer.close();
  161.                                         // 清空分片数据
  162.                                         dropDataBase(dataBaseName);
  163.                                         // 基础数据库删除文件数据实例 代表当前文件已下载完成 下载进度表删除当前文件
  164.                                         removeData(dataBaseName, baseDataBase);
  165.                                         // 清除store
  166.                                         store.commit('delProgress',{
  167.                                                 dataInstance: dataBaseName
  168.                                         })
  169.                                 }
  170.                         }
  171.                 })
  172.         }
  173. }
  174. /**
  175. * @description 状态控制
  176. * @param fileName 文件名
  177. * @param dataBaseName 数据库名,用于存放分片数据 每个文件唯一
  178. * @param type下载方式 continue 续传 again重新下载 cancel取消
  179. */
  180. async function controlFile(filename, type, dataBaseName){
  181.         if(type == 'continue'){
  182.         }else if(type == 'again'){
  183.                 // 删除分片数据
  184.                 await dropDataBase(dataBaseName);
  185.                 // 基础数据库
  186.                 const baseDataBase = createInstance(baseDataBaseName);
  187.                 // 删除文件实例
  188.                 removeData(dataBaseName, baseDataBase);
  189.         }else if(type == 'cancel'){
  190.                 // 删除分片数据
  191.                 await dropDataBase(dataBaseName);
  192.                 // 基础数据库
  193.                 const baseDataBase = createInstance(baseDataBaseName);
  194.                 // 删除文件实例
  195.                 await removeData(dataBaseName, baseDataBase);
  196.                 // 移除store
  197.                 store.commit('delProgress',{
  198.                         dataInstance: dataBaseName
  199.                 })
  200.         }else if(type == 'stop'){
  201.                 store.commit('setProgress',{
  202.                         dataInstance: dataBaseName,
  203.                         status: 'stopped'
  204.                 })
  205.         }
  206. }
复制代码
localforage 干系方法

  1. /**
  2. * @description 创建数据库实例 每个实例对象都有独立的数据库 不会影响其他实例
  3. * @param dataBasse 数据库名
  4. */
  5. function createInstance(dataBase){
  6.         return localForage.createInstance({
  7.                 name: dataBase
  8.         });
  9. }
  10. /**
  11. * @description 保存数据
  12. * @param name 键名
  13. * @param value 数据
  14. * @param storeName 仓库/数据库实例
  15. */
  16. async function saveData(name, value, storeName){
  17.         await storeName.setItem(name,value).then(()=>{
  18.                 // success
  19.         }).catch(err=>{
  20.                 // err
  21.         })
  22. }
  23. /**
  24. * @description 获取数据
  25. * @param name 键名
  26. * @param storeName 仓库/数据库实例
  27. * @param callback 回调函数
  28. */
  29. async function getData(name, storeName, callback){
  30.         await storeName.getItem(name).then((val)=>{
  31.                 // success
  32.                 callback(val);
  33.         }).catch(err=>{
  34.                 // err
  35.                 callback(false);
  36.         })
  37. }
  38. /**
  39. * @description 移除数据
  40. * @param name 键名
  41. * @param storeName 仓库/数据库实例
  42. */
  43. async function removeData(name, storeName){
  44.         await storeName.removeItem(name).then(()=>{
  45.                 // success
  46.         }).catch(err=>{
  47.                 // err
  48.         })
  49. }
  50. /**
  51. * @description 删除数据库实例
  52. * @param dataBasse 数据库名
  53. */
  54. async function dropDataBase(dataBase){
  55.         await localForage.dropInstance({
  56.                 name: dataBase
  57.         }).then(()=>{
  58.                 // success
  59.         }).catch(err=>{
  60.                 // err
  61.         })
  62. }
复制代码
3.效果展示

localforage数据展示

F12打开管理器,application -> indexedDB

下载进度展示


三、总结

以上就是全部核心代码,当前功能涉及到下载、暂停、续传、取消,也可动态展示下载进度,因为是纯手工敲的,所以可能会有个别错误,见谅。其他细枝末节的代码就不在这陈述,再就是功能代码之前赶得比较急,也没怎么细致整理,有些地方可能有更优的解法,接待各人批评区讨论

免责声明:如果侵犯了您的权益,请联系站长,我们会及时删除侵权内容,谢谢合作!更多信息从访问主页:qidao123.com:ToB企服之家,中国第一个企服评测及商务社交产业平台。




欢迎光临 ToB企服应用市场:ToB评测及商务社交产业平台 (https://dis.qidao123.com/) Powered by Discuz! X3.4