使用JSZip实现在浏览器中操作文件与文件夹

1. 引言

浏览器中如何创建文件夹、写入文件呢?

答曰:可以借助JSZip这个库来实现在浏览器内存中创建文件与文件夹,最后只需下载这个.zip文件,就是最终得结果

类似的使用场景如下:

  • 在线下载很多图片,希望这些图片能分类保存到各个文件夹并最终下载成一个zip文件
  • 在线下载很多文档,希望这些文档能分类保存到各个文件夹并最终下载成一个zip文件

本质上都是希望浏览器能创建文件夹和创建文件,最终保存成一个文件来提供下载

JSZip的GitHub站点:Stuk/jszip: Create, read and edit .zip files with Javascript (github.com)

一个可用的中文站点:JSZip参考手册 (asprain.cn)

下面主要记录一下基础使用,详细的API请参考上述文档

2. 使用

2.1 安装

使用NPM:

shell 复制代码
npm install jszip

使用在线CDN:

html 复制代码
<script src="https://cdn.bootcdn.net/ajax/libs/jszip/3.10.1/jszip.js"></script>
  • 为了可以代码可以快速复现,笔者这里使用CDN的方式引入

2.2 创建zip实例

一个JSZip实例是读写.zip文件的基础

javascript 复制代码
const zip = new JSZip();

2.3 读取zip文件

读取官方的示例文件text.zip

javascript 复制代码
const zip = new JSZip();

fetch("https://stuk.github.io/jszip/test/ref/text.zip")       // 1) fetch the url
    .then(function (response) {                       // 2) filter on 200 OK
        if (response.status === 200 || response.status === 0) {
            return Promise.resolve(response.blob());
        } else {
            return Promise.reject(new Error(response.statusText));
        }
    })
    .then(data => zip.loadAsync(data))                            // 3) 加载数据
    .then(function (zip) {
        zip.forEach(function (relativePath, file) {  	// 4) 遍历压缩包内的文件
           console.log(`path: ${relativePath}, file: ${file.name}`)
           // 输出:path: Hello.txt, file: Hello.txt
        });
})

因为Hello.txt是个文本文件,可以直接使用string的方式读取内部的数据

javascript 复制代码
const zip = new JSZip();

fetch("https://stuk.github.io/jszip/test/ref/text.zip")       // 1) fetch the url
    .then(function (response) {                       // 2) filter on 200 OK
        if (response.status === 200 || response.status === 0) {
            return Promise.resolve(response.blob());
        } else {
            return Promise.reject(new Error(response.statusText));
        }
    })
    .then(data => zip.loadAsync(data))                            // 3) chain with the zip promise
    .then(function (zip) {
        return zip.file("Hello.txt").async("string"); // 4) 读取Hello.txt文件
    })
    .then(function success(text) {
        console.log(text); // 输出:Hello World
    }, function error(e) {
        console.error(e);
    });

2.4 创建zip文件

写入文件与数据

javascript 复制代码
zip.file("file.txt", "content");
new Promise((resolve, reject) => {
    resolve(zip.file("file.txt").async("string"))
}).then(data => {
    console.log(data); // 输出:content
})

写入指定文件夹下的指定文件

javascript 复制代码
zip.file("text/file.txt", "content");
zip.forEach(function (relativePath, file) {
    console.log(`path: ${relativePath}, file: ${file.name}`)
    // 输出:path: text/file.txt, file: text/file.txt
});

最后的目录结构可以参考下图

2.5 下载zip文件

这里将上面的file.txt下载为zip,使用a链接的方式

javascript 复制代码
zip.generateAsync({ type: "blob" }).then(function (content) {
    document.body.appendChild(document.createElement("a"));
    document.querySelector("a").href = URL.createObjectURL(content);
    document.querySelector("a").download = "test.zip";
    document.querySelector("a").click();
});

完整的代码如下:

html 复制代码
<!DOCTYPE html>
<html lang="en">

<head>
    <meta charset="UTF-8">
    <meta name="viewport" content="width=device-width, initial-scale=1.0">
    <title>Document</title>
    <script src="https://cdn.bootcdn.net/ajax/libs/jszip/3.10.1/jszip.js"></script>
</head>

<body>

    <script>
        const zip = new JSZip();

        // fetch("https://stuk.github.io/jszip/test/ref/text.zip")       // 1) fetch the url
        //     .then(function (response) {                       // 2) filter on 200 OK
        //         if (response.status === 200 || response.status === 0) {
        //             return Promise.resolve(response.blob());
        //         } else {
        //             return Promise.reject(new Error(response.statusText));
        //         }
        //     })
        //     .then(data => zip.loadAsync(data))                            // 3) chain with the zip promise
        //     .then(function (zip) {
        //         return zip.file("Hello.txt").async("string"); // 4) chain with the text content
        //     })
        //     .then(function success(text) {
        //         console.log(text);
        //     }, function error(e) {
        //         console.error(e);
        //     });
        zip.file("text/file.txt", "content");
        zip.forEach(function (relativePath, file) { 
           console.log(`path: ${relativePath}, file: ${file.name}`)
        });

        zip.generateAsync({ type: "blob" }).then(function (content) {
            document.body.appendChild(document.createElement("a"));
            document.querySelector("a").href = URL.createObjectURL(content);
            document.querySelector("a").download = "test.zip";
            document.querySelector("a").click();
        });
    </script>

</body>

</html>

3. 参考资料

[1] How to use JSZip (stuk.github.io)

[2] JSZip参考手册 (asprain.cn)

相关推荐
angelanana4 天前
【V8引擎blog翻译-191】迭代器助手
浏览器·v8
摇光937 天前
[前端面试]浏览器
前端·面试·职场和发展·浏览器
蓝黑202018 天前
Firefox火狐浏览器打开B站视频时默认静音
firefox·浏览器
cxylay18 天前
【PDF文件】默认被某种软件打开,如何进行修改?
edge·pdf·浏览器·pdf默认打开方式·微软pdf·pdf解决问题
shandianchengzi19 天前
【记录】Windows|Windows 修改字体大全(Windows 桌面、VSCode、浏览器)
windows·vscode·浏览器·字体·美化
金色的暴发户20 天前
从输入url到页面渲染?你还在这么回答吗
前端·面试·浏览器
trayvontang22 天前
JavaScript下载文件(简单模式、跨域问题、文件压缩)
jszip·js文件下载·文件下载跨域·javascript文件下载·跨域设置·oss跨域设置·js文件压缩
WangConvey24 天前
Vue检测获取最新资源 解决浏览器缓存问题
javascript·vue.js·缓存·浏览器·浏览器缓存
x-cmd25 天前
x-cmd pkg | carbonyl - 终端图形浏览器,浏览像素版网页
运维·性能优化·rust·嵌入式·终端·浏览器·命令行
aoi1 个月前
打开新窗口时 debugger 拦截,以查看调用栈排查问题
前端·javascript·浏览器