业务中有时候需要获取某个 zip
压缩包内的文件内容展示到前端,在 zip
包体积不是那么大的时候(几MB、十几MB甚至几十MB)并且不涉及压缩包解密的时候,可以考虑纯前端方案。
前端使用Jszip解压zip
安装依赖: npm i jszip
请求 zip
文件并转为 Blob
:
js
const blob = await fetch(url).then((res) => res.blob());
使用 jszip
解压 Blob
:
js
const zip = new JSZip()
const zipData = await zip.loadAsync(zipBlob)
这时候你会得到一个含有 files
列表数据的 zipData
, 这个 files
就是压缩包中的文件列表,这时候的处理就有意思了,下面慢慢说。
如果你的压缩包里面不止一个文件怎么获取
基于上一步,我们拿到了 files
文件列表,这时候如果我们的压缩包里面有很多文件我们怎么全部都拿到呢?我们就需要递归这个列表了:
ts
async function extractNestedZip(zipBlob: Blob) {
const zip = new JSZip()
const zipData = await zip.loadAsync(zipBlob)
const extractedFiles: { name: string, data: unkown }[] = []
// 遍历 ZIP 文件中的所有文件
for (const [name, file] of Object.entries(zipData.files)) {
extractedFiles.push({name, file})
}
return extractedFiles
}
但是事情往往没有这么简单,比如压缩包里面还有压缩包怎么办呢?
嵌套压缩改咋处理
改良 extractNestedZip
方法:
js
async function extractNestedZip(zipBlob: Blob) {
const zip = new JSZip()
const zipData = await zip.loadAsync(zipBlob)
const extractedFiles: { name: string, data: unkown }[] = []
// 遍历 ZIP 文件中的所有文件
for (const [name, file] of Object.entries(zipData.files)) {
if (name.endsWith('.zip') { // 如果是嵌套的压缩包就继续解压
const nestedZipBlob = await file.async('blob')
const nestedFiles = await extractNestedZip(nestedZipBlob)
extractedFiles.push(...nestedFiles)
} else {
extractedFiles.push({name, file})
}
}
return extractedFiles
}
我们现在解决了嵌套的问题。如果压缩包中有文件夹该怎么处理呢?尝试过你会发现如果是文件夹,在 files
中对应的数据就是空的,所以我们应该过滤这种情况:
压缩包中的文件夹要过滤
js
async function extractNestedZip(zipBlob: Blob) {
const zip = new JSZip()
const zipData = await zip.loadAsync(zipBlob)
const extractedFiles: { name: string, data: unkown }[] = []
// 遍历 ZIP 文件中的所有文件
for (const [name, file] of Object.entries(zipData.files)) {
if (name.endsWith('.zip') { // 如果是嵌套的压缩包就继续解压
const nestedZipBlob = await file.async('blob')
const nestedFiles = await extractNestedZip(nestedZipBlob)
extractedFiles.push(...nestedFiles)
} else if (!name.endsWith('/')) { // 我们可以通过判断文件名是否以/结尾来判断这一项是否是文件夹
extractedFiles.push({name, file})
}
}
return extractedFiles
}
现在看了好像一切都没问题了,但是我们最终的文件怎么读到呢?
文本文件和二进制文件要分别处理
如果压缩包中只包含文本类的文件,比如 .json
,.log
之类的,就可以简单的用 file.async('text')
来获取文件内容,但是如果包含 .mp3
,.png
就要注意了,我们接下来优化这些情况:
js
async function extractNestedZip(zipBlob: Blob) {
const zip = new JSZip()
const zipData = await zip.loadAsync(zipBlob)
const extractedFiles: { name: string, data: string | Blob }[] = []
// 遍历 ZIP 文件中的所有文件
for (const [name, file] of Object.entries(zipData.files)) {
if (name.endsWith('.zip')) {
// 如果文件是嵌套的 ZIP 文件,则递归解压
const nestedZipBlob = await file.async('blob')
const nestedFiles: { name: string, data: string | Blob }[] = await extractNestedZip(nestedZipBlob)
extractedFiles.push(...nestedFiles)
}
else {
// 如果文件不是 ZIP 文件,则处理
if (name.endsWith('.jpeg') || name.endsWith('.png') || name.endsWith('.mp3') || name.endsWith('.mp4')) {
const blob = await file.async('blob')
extractedFiles.push({ name, data: blob })
}
else if (!name.endsWith('/')) { // 过滤掉文件夹
const fileData = await file.async('text')
extractedFiles.push({ name, data: fileData })
}
}
}
return extractedFiles
}
我们这里举了些例子,就是判断文件名以什么结尾,如果是常见的媒体格式,就转为 Blob
,不然就转为字符串。这个方案就可以处理压缩包中不同格式的问题,最终我们就拿到了一个 name
是表示压缩包中文件名称,data
是对应文件内容的列表了。
总结
在业务中需要前端场景解压压缩包是比较少见的,但是如果有这类的场景我们就可以借助于 jszip
来做。这次分享的主要是拿到文件之后如何全部拿到压缩包的所有内容的技巧,大家如果有别的问题,欢迎评论区沟通。最后,有用请点赞,喜欢请关注,我是 Senar
,我们下期再见~。
参考链接:
jszip: stuk.github.io/jszip/