JavaScript 如何在线解压 ZIP 文件?

本文转载自微信公众号「全栈修仙之路」,作者阿宝哥。转载本文请联系全栈修仙之路公众号。 

成都创新互联公司企业建站,十年网站建设经验,专注于网站建设技术,精于网页设计,有多年建站和网站代运营经验,设计师为客户打造网络企业风格,提供周到的建站售前咨询和贴心的售后服务。对于成都做网站、成都网站建设、成都外贸网站建设中不同领域进行深入了解和探索,创新互联在网站建设中充分了解客户行业的需求,以灵动的思维在网页中充分展现,通过对客户行业精准市场调研,为客户提供的解决方案。

相信大家对 ZIP 文件都不会陌生,当你要打开本地的 ZIP 文件时,你就需要先安装支持解压 ZIP 文件的解压软件。但如果预解压的 ZIP 文件在服务器上,我们应该如何处理呢?

最简单的一种方案就是把文件下载到本地,然后使用支持 ZIP 格式的解压软件进行解压。那么能不能在线解压 ZIP 文件呢?答案是可以的,接下来阿宝哥将介绍浏览器解压和服务器解压两种在线解压 ZIP 文件的方案。

在介绍在线解压 ZIP 文件的两种方案前,我们先来简单了解一下 ZIP 文件格式。

一、ZIP 格式简介

ZIP 文件格式是一种数据压缩和文档储存的文件格式,原名 Deflate,发明者为菲尔·卡茨(Phil Katz),他于 1989 年 1 月公布了该格式的资料。ZIP 通常使用后缀名 “.zip”,它的 MIME 格式为 “application/zip”。目前,ZIP 格式属于几种主流的压缩格式之一,其竞争者包括RAR 格式以及开放源码的 7z 格式。

ZIP 是一种相当简单的分别压缩每个文件的存档格式,分别压缩文件允许不必读取另外的数据而检索独立的文件。理论上,这种格式允许对不同的文件使用不同的算法。然而,在实际上,ZIP 大多数都是在使用卡茨(Katz)的 DEFLATE 算法。

简单介绍完 ZIP 格式,接下来阿宝哥先来介绍基于 JSZip 这个库的浏览器解压方案。

二、浏览器解压方案

JSZip 是一个用于创建、读取和编辑 .zip 文件的 JavaScript 库,该库支持大多数浏览器,具体的兼容性如下图所示:

其实有了 JSZip 这个库的帮助,要实现浏览器端在线解压 ZIP 文件的功能并不难。因为官方已经为我们提供了 解压本地文件、解压远程文件和生成 ZIP 文件 的完整示例。好的,废话不多说,下面我们来一步步实现在线解压 ZIP 文件的功能。

2.1 定义工具类

浏览器端在线解压 ZIP 文件的功能,可以拆分为 下载 ZIP 文件、解析 ZIP 文件和展示 ZIP 文件 3 个小功能。考虑到功能复用性,阿宝哥把下载 ZIP 文件和解析 ZIP 文件的逻辑封装在 ExeJSZip 类中:

 
 
 
 
  1. class ExeJSZip { 
  2.   // 用于获取url地址对应的文件内容 
  3.   getBinaryContent(url, progressFn = () => {}) { 
  4.     return new Promise((resolve, reject) => { 
  5.       if (typeof url !== "string" || !/https?:/.test(url)) 
  6.         reject(new Error("url 参数不合法")); 
  7.       JSZipUtils.getBinaryContent(url, { // JSZipUtils来自于jszip-utils这个库 
  8.         progress: progressFn, 
  9.         callback: (err, data) => { 
  10.           if (err) { 
  11.             reject(err); 
  12.           } else { 
  13.             resolve(data); 
  14.           } 
  15.         }, 
  16.       }); 
  17.     }); 
  18.   } 
  19.    
  20.   // 遍历Zip文件 
  21.   async iterateZipFile(data, iterationFn) { 
  22.     if (typeof iterationFn !== "function") { 
  23.       throw new Error("iterationFn 不是函数类型"); 
  24.     } 
  25.     let zip; 
  26.     try { 
  27.       zip = await JSZip.loadAsync(data); // JSZip来自于jszip这个库 
  28.       zip.forEach(iterationFn); 
  29.       return zip; 
  30.     } catch (error) { 
  31.       throw new error(); 
  32.     } 
  33.   } 

2.2 在线解压 ZIP 文件

利用 ExeJSZip 类的实例,我们就可以很容易实现在线解压 ZIP 文件的功能:

html 代码

 
 
 
 
  1.  

  2.    
  3.    
  4.  
  5. 在线解压 
  6.  
  7.  

JS 代码

 
 
 
 
  1. const zipUrlEle = document.querySelector("#zipUrl"); 
  2. const statusEle = document.querySelector("#status"); 
  3. const fileList = document.querySelector("#fileList"); 
  4. const exeJSZip = new ExeJSZip(); 
  5.  
  6. // 执行在线解压操作 
  7. async function unzipOnline() { 
  8.   fileList.innerHTML = ""; 
  9.   statusEle.innerText = "开始下载文件..."; 
  10.   const data = await exeJSZip.getBinaryContent( 
  11.     zipUrlEle.value, 
  12.     handleProgress 
  13.   ); 
  14.   let items = ""; 
  15.   await exeJSZip.iterateZipFile(data, (relativePath, zipEntry) => { 
  16.     items += ` 
  17.       ${zipEntry.name}
  18. `; 
  19.   }); 
  20.   statusEle.innerText = "ZIP文件解压成功"; 
  21.   fileList.innerHTML = items; 
  22.  
  23. // 处理下载进度 
  24. function handleProgress(progressData) { 
  25.   const { percent, loaded, total } = progressData; 
  26.   if (loaded === total) { 
  27.     statusEle.innerText = "文件已下载,努力解压中"; 
  28.   } 

好了,在浏览器端如何通过 JSZip 这个库来实现在线解压 ZIP 文件的功能已经介绍完了,我们来看一下以上示例的运行结果:

现在我们已经可以在线解压 ZIP 文件了,这时有的小伙伴可能会问,能否预览解压后的文件呢?答案是可以的,因为 JSZip 这个库为我们提供了 file API,通过这个 API 我们就可以读取指定文件中的内容。比如这样使用 zip.file("amount.txt").async("arraybuffer") ,之后我们就可以执行对应的操作来实现文件预览的功能。

需要注意的是,基于 JSZip 的方案并不是完美的,它存在一些限制。比如它不支持解压加密的 ZIP 文件,当解压较大的文件时,在 IE 10 以下的浏览器可能会出现闪退问题。此外,它还有一些其它的限制,这里阿宝哥就不详细说明了。感兴趣的小伙伴,可以阅读 Limitations of JSZip 文章中的相关内容。

既然浏览器解压方案存在一些弊端,特别是在线解压大文件的情形,要解决该问题,我们可以考虑使用服务器解压方案。

三、服务器解压方案

服务器解压方案就是允许用户通过文件 ID 或文件名进行在线解压,接下来阿宝哥将基于 koa 和 node-stream-zip 这两个库来介绍如何实现服务器在线解压 ZIP 文件的功能。如果你对 koa 还不了解的话,建议你先大致阅读一下 koa 的官方文档。

 
 
 
 
  1. const path = require("path"); 
  2. const Koa = require("koa"); 
  3. const cors = require("@koa/cors"); 
  4. const Router = require("@koa/router"); 
  5. const StreamZip = require("node-stream-zip"); 
  6.  
  7. const app = new Koa(); 
  8. const router = new Router(); 
  9. const ZIP_HOME = path.join(__dirname, "zip"); // ZIP文件的根目录 
  10. const UnzipCaches = new Map(); // 保存已解压的文件信息 
  11.  
  12. router.get("/", async (ctx) => { 
  13.   ctx.body = "服务端在线解压ZIP文件示例(阿宝哥)"; 
  14. }); 
  15.  
  16. // 注册中间件 
  17. app.use(cors()); 
  18. app.use(router.routes()).use(router.allowedMethods()); 
  19.  
  20. app.listen(3000, () => { 
  21.   console.log("app starting at port 3000"); 
  22. }); 

在以上代码中,我们使用了 @koa/cors 和 @koa/router 两个中间件并创建了一个简单的 Koa 应用程序。基于上述的代码,我们来注册一个用于处理在线解压指定文件名的路由。

3.1 根据文件名解压指定 ZIP 文件

app.js

 
 
 
 
  1. router.get("/unzip/:name", async (ctx) => { 
  2.   const fileName = ctx.params.name; 
  3.   let filteredEntries; 
  4.   try { 
  5.     if (UnzipCaches.has(fileName)) { // 优先从缓存中获取 
  6.       filteredEntries = UnzipCaches.get(fileName); 
  7.     } else { 
  8.       const zip = new StreamZip.async({ file: path.join(ZIP_HOME, fileName) }); 
  9.       const entries = await zip.entries(); 
  10.       filteredEntries = Object.values(entries).map((entry) => { 
  11.         return { 
  12.           name: entry.name, 
  13.           size: entry.size, 
  14.           dir: entry.isDirectory, 
  15.         }; 
  16.       }); 
  17.       await zip.close(); 
  18.       UnzipCaches.set(fileName, filteredEntries); 
  19.     } 
  20.     ctx.body = { 
  21.       status: "success", 
  22.       entries: filteredEntries, 
  23.     }; 
  24.   } catch (error) { 
  25.     ctx.body = { 
  26.       status: "error", 
  27.       msg: `在线解压${fileName}文件失败`, 
  28.     }; 
  29.   } 
  30. }); 

在以上代码中,我们通过 ZIP_HOME 和 fileName 获得文件的最终路径,然后使用 StreamZip 对象来执行解压操作。为了避免重复执行解压操作,阿宝哥定义了一个 UnzipCaches 缓存对象,用来保存已解压的文件信息。定义好上述路由,下面我们来验证一下对应的功能。

3.2 在线解压 ZIP 文件

html 代码

 
 
 
 
  1.  

  2.    
  3.    
  4.  
  5. 在线解压 
  6.  
  7.  

JS 代码

 
 
 
 
  1. const fileList = document.querySelector("#fileList"); 
  2. const fileNameEle = document.querySelector("#fileName"); 
  3.  
  4. const request = axios.create({ 
  5.   baseURL: "http://localhost:3000/", 
  6.   timeout: 10000, 
  7. }); 
  8.  
  9. async function unzipOnline() { 
  10.   const fileName = fileNameEle.value; 
  11.   if(!fileName) return; 
  12.   const response = await request.get(`unzip/${fileName}`); 
  13.   if (response.data && response.data.status === "success") { 
  14.     const entries = response.data.entries; 
  15.     let items = ""; 
  16.     entries.forEach((zipEntry) => { 
  17.       items += `${ 
  18.         zipEntry.name 
  19.       }
  20. `; 
  21.     }); 
  22.     fileList.innerHTML = items; 
  23.   } 

以上示例成功运行后的结果如下图所示:

现在我们已经实现根据文件名解压指定 ZIP 文件,那么我们可以预览压缩文件中指定路径的文件么?答案也是可以的,利用 zip 对象提供的 entryData(entry: string | ZipEntry): Promise 方法就可以读取指定路径下文件的内容。

3.3 预览 ZIP 文件中指定路径的文件

app.js

 
 
 
 
  1. router.get("/unzip/:name/entry", async (ctx) => { 
  2.   const fileName = ctx.params.name; // ZIP压缩文件名 
  3.   const entryPath = ctx.query.path; // 文件的路径 
  4.   try { 
  5.     const zip = new StreamZip.async({ file: path.join(ZIP_HOME, fileName) }); 
  6.     const entryData = await zip.entryData(entryPath); 
  7.     await zip.close(); 
  8.     ctx.body = { 
  9.       status: "success", 
  10.       entryData: entryData, 
  11.     }; 
  12.   } catch (error) { 
  13.     ctx.body = { 
  14.       status: "error", 
  15.       msg: `读取${fileName}中${entryPath}文件失败`, 
  16.     }; 
  17.   } 
  18. }); 

在以上代码中,我们通过 zip.entryData 方法来读取指定路径的文件内容,它返回的是一个 Buffer 对象。当前端接收到该数据时,还需要把接收到的 Buffer 对象转换为 ArrayBuffer 对象,对应的处理方式如下所示:

 
 
 
 
  1. function toArrayBuffer(buf) { 
  2.   let ab = new ArrayBuffer(buf.length); 
  3.   let view = new Uint8Array(ab); 
  4.   for (let i = 0; i < buf.length; ++i) { 
  5.     view[i] = buf[i]; 
  6.   } 
  7.   return ab; 

定义完 toArrayBuffer 函数之后,我们就可以通过调用 app.js 定义的 API 来实现预览功能,具体的代码如下所示:

 
 
 
 
  1. async function previewZipFile(path) { 
  2.   const fileName = fileNameEle.value; // 获取文件名 
  3.   const response = await request.get( 
  4.     `unzip/${fileName}/entry?path=${path}` 
  5.   ); 
  6.   if (response.data && response.data.status === "success") { 
  7.     const { entryData } = response.data; 
  8.     const entryBuffer = toArrayBuffer(entryData.data); 
  9.     const blob = new Blob([entryBuffer]); 
  10.     // 使用URL.createObjectURL或blob.text()读取文件信息 
  11.   } 

由于完整的示例代码内容比较多,阿宝哥就不放具体的代码了。感兴趣的小伙伴,可以访问以下地址浏览示例代码。

https://gist.github.com/semlinker/3bb9634f4e4ec7b6ab4008a688583115

注意:以上代码仅供参考,请根据实际业务进行调整。

四、总结

本文阿宝哥介绍了在线解压 ZIP 文件的两种方案,在实际项目中,建议使用服务器解压的方案。这样不仅可以解决浏览器的兼容性问题,而且也可以解决大文件在线解压的问题,同时也方便后期扩展支持其它的压缩格式。

五、参考资源

维基百科 ZIP 格式

Limitations of JSZip

本文题目:JavaScript 如何在线解压 ZIP 文件?
网站URL:http://www.shufengxianlan.com/qtweb/news10/299860.html

网站建设、网络推广公司-创新互联,是专注品牌与效果的网站制作,网络营销seo公司;服务项目有等

广告

声明:本网站发布的内容(图片、视频和文字)以用户投稿、用户转载内容为主,如果涉及侵权请尽快告知,我们将会在第一时间删除。文章观点不代表本网站立场,如需处理请联系客服。电话:028-86922220;邮箱:631063699@qq.com。内容未经允许不得转载,或转载时需注明来源: 创新互联