文件批量压缩下载

预计阅读时间: 4 分钟

🚀:前言需求

  近期开发后台管理系统时,有一个【 批 量 下 载】的业务需求。要求是:能批量下载用户提交的文件附件;后台用户列表展示的是前端用户的投稿信息记录,前端稿件投递都以附件的方式借助阿里云 OSS 直接上传至了云存储中,数据只是记录的用户上传附件的文件路径。

  最初擦下载附件是采用“a”标签点击跳转的方式进行文件的下载和保存,但是此方式操作起来相对麻烦,为了实现后台管理员提出的要求,决定采用批量下载附件的方式来进行文件的重命名和压缩存储。此方式不仅解决了下载文件繁琐的问题,同时,还一并完善了下载文件重命名的问题。

🍉:安装插件

npm
yarn
pnpm
bun
1npm install jszip

【 注 】:生成压缩文件,详细用法请点击上述超链接。

npm
yarn
pnpm
bun
1npm install file-saver

【 注 】:保存文件用的,可以保存流文件、canvas、文本等。

🍎:使用方法

  • 引入依赖
引入依赖
1import axios from "axios";
2import JSZip from "jszip";
3import { saveAs } from "file-saver";
  • 生成二进制文件流
生成文件流
1const getFile = url = >{
2	return new Promise((resolve, reject) = >{
3		axios.get(url, {
4			responseType: "arraybuffer"
5		}).then(res = >{
6			resolve(res.data);
7		}).
8		catch(err = >{
9			reject(err.toString());
10		});
11	});
12};

注:此次需要借助 axios 将 URL 流文件转换为二进制流文件;在 vue 项目中,若使用绑定在 vue 上的 axios 实例,在请求生成 arraybuffer 文件时会报请求跨域的错误!!!

  • 文件处理&文件导出
文件导出
1let list = [{
2	name: "我是自定义文件名",
3	url: "https://xxxxxxxxx.docx"
4}];
5
6// 创建JSZip实例
7const zip = new JSZip(),
8// promise对象
9promises = [];
10// 文件后缀名
11let suffix = "";
12list.forEach(el = >{
13	// 获取文件后缀名
14	suffix = el.url.substring(el.url.lastIndexOf("."));
15	// 生成promise实例
16	const promise = getFile(el.url).then(res = >{
17		zip.file(el.name + suffix, res);
18	});
19	promises.push(promise);
20});
21// 异步处理
22Promise.all(promises).then(() = >{
23	// 生成二进制流
24	zip.generateAsync({
25		type: "blob"
26	}).then(content = >{
27		saveAs(content, "压缩文件.zip");
28		/* 保存文件 */
29	});
30});

注:此次是批量将 URL 格式的附件经过处理生成压缩包导出到本地。

🙅‍:补充(保存 URL 文件)

最初,保存 URL 类型的文件大多采用“a”标签跳转的形式进行下载和保存,有时前端请求流式文件生成文件时大多也是采用动态创建“a”标签的形式进行前端的文件下载。此方式相对来说,每次都要写一些动态创建标签的方法。当完成这次文件的批量导出时候,忽然想到“file-saver”的“saveAs”属性可以用来保存文件。

保存 URL 文件
1FileSaver saveAs(Blob/File/Url, optional DOMString filename, optional Object { autoBom })
注意:

  传递{ autoBom: true }如果你想 FileSaver.js 自动提供 Unicode 文本编码提示。请注意,只有在您的 Blob 类型已charset=utf-8设置的情况下才能执行此操作。

🐒:总结

  文件处理,在后台管理系统中还是比较常见的,使用的频率相对来说也是比较高的。此次笔记只为记录开发过程中遇到的问题以及处理问题的方法和思路。此次之所以会想到此中办法,主要是无意间翻看到了 Angular 的一个中文网站 ng-alain,无意间在该网站的组件模块中看到了 zip 文件下载的组件。因此想着在 vue 项目中尝试着使用 jszip 等依赖来实现文件链接的批量打包下载以及文件的重命名保存等功能。