使用 JSZip 将备忘录打包为 ZIP:在静态网页中制作 2-3 个文件的实验

プログラミング・Web開発カテゴリを表すパンダのイラスト 编程・Web开发

关于本文
本文是通过利用生成式 AI 的自动生成流程创建的。我们参考了 JSZip 的官方信息,并准备了一个静态教材,可以在浏览器中通过简短的虚拟备忘录创建 ZIP。

验证状态:🧪 输入处理已测试・浏览器中的 ZIP 生成未确认
我们在 Node.js 中确认了固定文件名和输入限制等 9 项逻辑测试。GitHub Pages 的访问、实际的 ZIP 生成、下载和解压尚未确认。

使用 JSZip 将备忘录打包为 ZIP:在静态网页中制作 2-3 个文件的实验

当您想将多个文本打包为一个 ZIP 时,是否有必要将其全部上传到服务器?如果只是处理简短的文章,完全可以在浏览器中生成 ZIP。通过使用 JavaScript 库 JSZip,无需从头实现 ZIP 的内部结构或压缩处理,只需指定文件名和内容即可将其打包。

本次的教材不仅仅是制作一个输出 ZIP 的按钮。创建文件的处理、用户的下载操作以及保存后的管理是为了让大家体验到这些其实是不同的流程。这里不会读取现有文件,只会使用虚拟的备忘录。

首先进行操作:在线演示

当演示界面打开后,请检查作为初始值准备的虚拟备忘录,并点击“创建 ZIP”。在创建的 ZIP 中,设计包含用于说明的README.txt以及存储输入的memo.txt。这就是最初的2个文件。

接着选择“也包含清单.txt”,然后再次按按钮。checklist.txt添加了3个文件这便是预期的结果。屏幕上会显示包含的文件名和ZIP的大小(字节数)。实际下载时,请点击另外显示的“下载ZIP”链接。

请区分这个顺序。ZIP生成的完成并不意味着保存到设备上的操作已完成。保存位置也受用户浏览器设置的影响。我们并未将其设计为仅生成就显示“已保存到电脑”的样式。

实验条件

项目内容
使用的库JSZip v3.10.2
分发架构通过 GitHub Pages 静态分发 HTML、CSS 和 JavaScript
运行时外部 CDN不需要。库已vendor/打包在内
输入200字以内的虚拟文本
ZIP文件的内容README.txt、memo.txt,可选地checklist.txt
读取现有文件不进行
外部API及数据库不使用
执行确认9条输入检查与文件名逻辑。ZIP二进制生成尚未确认

所谓“静态网站”,并不意味着显示内容永远不变。即使服务器分发的文件是静态的,浏览器也可以执行JavaScript来动态改变ZIP的内容和大小。打开本次演示的网络通信与点击按钮之后的ZIP生成处理是两码事。

JSZip负责什么

要向ZIP中添加内容zip.file(name, content)。通过它,你可以注册要放入ZIP中的文件。这并不是向Windows资源管理器等直接写入文件的命令。

const zip = new JSZip();
zip.file("README.txt", "架空の説明文\\n");
zip.file("memo.txt", "架空の作業メモ\\n");

const blob = await zip.generateAsync({
  type: "blob",
  compression: "DEFLATE"
});

generateAsync()开始生成整个ZIP,并异步返回结果。type: "blob"用于指定以浏览器易于处理的Blob格式接收。compression: "DEFLATE"用于指定压缩格式。由于库的处理是异步的,因此在生成完成之前,切勿启用保存链接,这一点非常重要。

顺便一提,把相同的文件打包两次并不意味着大小会变成两倍。ZIP中包含标头等管理信息,而且文本重复得越多,有时反而越容易被压缩。压缩后的大小因输入内容而异,因此本文不会将特定的字节数断定为实际测量值。

Blob与临时下载URL

一旦生成了ZIP的Blob,就可以通过URL.createObjectURL(blob)在浏览器内创建一个临时URL,并将其赋给链接的href分配给。链接的download属性中,请指定daily-code-demo.zip教学材料的固定名称。

如果再次生成ZIP,为了避免保留之前的临时URL,请通过URL.revokeObjectURL()进行释放。我们还在代码中加入了在离开页面时尝试释放的处理。不过,关于所使用浏览器或操作系统的内存释放细节,本次未在实机上进行验证。

如果在浏览器中遇到“生成成功但找不到文件”的情况,请首先确认是否点击了下载链接,以及保存位置被设置在哪里。切勿混淆“ZIP是否成功生成”与“是否成功保存在终端设备上”这两个问题。

固定文件名的原因

虽然本次用户可以修改备忘录的内容,但包含在ZIP中的文件名并非自由输入。只有固定的README.txt、memo.txt以及添加时的checklist.txt这3种。这不仅是为了简化教学材料操作说明,也是为了避免处理不必要的文件名和路径。

例如,即使在输入框中写入../secret.txt,该字符串也只会成为memo.txt中的文本,而不会用作ZIP内部的路径名。如果直接从输入内容组装ZIP的名称,就必须考虑路径分隔符、绝对路径以及解压到非预期文件夹等其他风险。

此外,教学材料的输入处理会拒绝字符串以外的内容,并且在超过200个字符时也会返回错误。虽然界面上也有maxlength,但我们不仅依赖它,还在逻辑层面进行了检查。界面上的输入限制与程序内部的边界检查是不同的。这样一来,即使将来增加其他按钮或调用方,逻辑的前提条件也会更加清晰易懂。

只更改一个条件并进行观察

请先在复选框未勾选的状态下制作ZIP,然后再将其更改为勾选状态。其中的文件名将从2个变为3个。这是因为添加了checklist.txt的部分。另一方面,在比较增加备忘录长度时,文件数量保持不变,但内容和压缩后的大小会发生变化。

这种区别在构建实际业务的导出功能时也非常重要。我们需要确保能够分别确认:是文件数量增加了,还是各自的内容变大了,亦或是用户选择的选项增了。如果同时改变多个条件,就会分不清到底是哪个因素导致了ZIP内容的变化。

另外,本次测试确认的内容包括“数量为2/3的文件名列表”、“边界值”、“空字符”、“拒绝字符串以外的内容”、“处理包含表情符号的200个字符”等。这并不证明ZIP二进制文件实际上是在浏览器中生成并解压的。

无法运行时的故障排查

观察到的问题确认点处理方法
页面无法打开GitHub Pages的发布设置与URL从README确认HTML和文件布局
生成按钮无法使用vendor/jszip.min.js是否成功加载检查分发文件的相对路径
输入被拒绝是否超过了200个字符恢复为虚构的短文并重试
没有下载链接ZIP 生成是否成功检查显示的提示信息和控制台(Console)
找不到下载的文件检查保存位置以及浏览器的确认画面检查浏览器的下载历史记录
感觉 ZIP 体积偏大输入文本、附加文件、压缩格式使用相同的短文进行对比以缩小排查范围

如果直接用浏览器打开本地的 HTML 文件,JavaScript 模块可能会因 CORS 限制而无法加载。file://请按照教程 README 中的步骤,通过静态 HTTP 服务器打开。无需添加新的数据库或生产环境 PHP 服务器。

引入实际业务前的注意事项

JSZip 非常方便,但它并不自动保证 ZIP 加密、恶意软件扫描或发送方权限管理的安全。本次演示仅用于打包简短的虚拟字符串。请勿输入真实存在的客户名称或合同内容。也应避免仅凭将机密文件打包成 ZIP 就认为可以安全共享。如果在业务中使用,应考虑输出目标的白名单、大小上限、字符编码、文件名规范化、生成后的读回验证以及保存位置的访问权限。在浏览器内批量生成大容量文件时,还会面临内存占用和处理时间的问题。切勿认为可以将本次 200 个字符的小型实验直接扩展用于生成巨型备份。

如果在业务中使用,应考虑输出目标的白名单、大小上限、字符编码、文件名规范化、生成后的读回验证以及保存位置的访问权限。在浏览器内批量生成大容量文件时,还会面临内存占用和处理时间的问题。切勿认为可以将本次 200 个字符的小型实验直接扩展用于生成巨型备份。

此外,生成的 ZIP 中包含的文本可由接收方解压后阅读。库能够生成 ZIP 格式的文件与能够保护机密信息是两码事。为了实现安全的 文件共享,必须另外设计收发保护和访问管理机制。

总结

通过引入 JSZip,即使在静态网页中也可以构建将多个文本打包为 ZIP 的功能。请先用 2 项内容进行制作,然后尝试仅改变复选框使其变为 3 项。注册文件、生成 ZIP、进行保存操作只要理清这几个角色的区别,就更容易理解库的使用方法了。

官方资料与示例

验证与未确认项

在 Node.js v22.16.0 环境下,运行了与 GitHub 教材及 Git blob SHA 相匹配的输入函数与测试,9 项测试全部通过。已确认固定版本的 JSZip v3.10.2 及其许可证文件的 Git blob SHA 与分发源一致。GitHub Pages 的访问、ZIP 二进制文件的实际生成/保存/解压、实际浏览器界面以及 WordPress 上的显示效果尚未确认。

文档信息

文章??
使用 JSZip 将备忘录打包为 ZIP:在静态网页中制作 2-3 个文件的实验
?布日期
更新日期
来源
https://papanda925.com/?p=18679&lang=zh

?可: ?于本站?有相??利的正文及原??表,除非?有?明,可依据 CC BY 4.0 使用。本文可能包含使用生成式AI?建或??的内容。若代??有?可声明,或?接的GitHub???定了?可,?代?以??可?准。引用内容、第三方?料、?片及商?不在本?可范?内。 使用政策

标题和URL已复制