file-saver:前端文件下载的 JavaScript 库使用指南

2025/3/21
file-saver 是一个用于在浏览器端保存文件的 JavaScript 库,支持生成和下载多种文件格式,如文本、JSON、CSV、图片、PDF 等。本文详细介绍其安装、基本用法、兼容性及与其他工具(如 jszip)的结合使用。

file-saver 是一个用于在浏览器端保存文件的 JavaScript 库,通常用于生成和下载文件,而不依赖服务器。它常用于处理 Blob 对象,并提供了一种简便的方法来触发文件下载。


1. 安装

你可以使用 npm 或 yarn 安装 file-saver

npm install file-saver
# 或者
yarn add file-saver

2. 基本用法

import { saveAs } from "file-saver";

const blob = new Blob(["Hello, world!"], { type: "text/plain;charset=utf-8" });
saveAs(blob, "hello.txt");

上述代码会创建一个包含 "Hello, world!" 的文本文件,并在浏览器中触发下载,文件名为 hello.txt


3. 适用于不同文件类型

file-saver 支持保存各种格式的文件,只需指定正确的 MIME 类型:

保存文本文件(.txt

const textBlob = new Blob(["This is a text file"], { type: "text/plain" });
saveAs(textBlob, "example.txt");

保存 JSON 文件(.json

const jsonBlob = new Blob([JSON.stringify({ key: "value" }, null, 2)], { type: "application/json" });
saveAs(jsonBlob, "data.json");

保存 CSV 文件(.csv

const csvData = "Name,Age,Location\nAlice,25,USA\nBob,30,Canada";
const csvBlob = new Blob([csvData], { type: "text/csv;charset=utf-8" });
saveAs(csvBlob, "data.csv");

保存图片文件(.png, .jpg

fetch("https://example.com/image.png")
  .then((res) => res.blob())
  .then((blob) => saveAs(blob, "image.png"));

保存 PDF 文件(.pdf

fetch("https://example.com/sample.pdf")
  .then((res) => res.blob())
  .then((blob) => saveAs(blob, "document.pdf"));

4. 处理文件 URL

如果你有一个文件的 URL,可以直接下载:

saveAs("https://example.com/sample.pdf", "download.pdf");

但是,某些浏览器(如 Safari)可能不会下载跨域文件,因此推荐先 fetch 文件再 saveAs


5. 与 canvas 结合使用

可以从 canvas 生成图片并下载:

const canvas = document.createElement("canvas");
const ctx = canvas.getContext("2d");
ctx.fillStyle = "red";
ctx.fillRect(10, 10, 100, 100);

canvas.toBlob((blob) => {
  saveAs(blob, "canvas-image.png");
});

6. 兼容性

file-saver 兼容现代主流浏览器,包括 Chrome、Firefox、Edge、Safari(需适配)。但 不支持 IE,除非使用 polyfill(如 blob.js)。


7. 相关补充

  • file-saver 依赖 Blob,在 Safari 需要 toBlob 兼容处理。
  • 可与 jszip 结合,先打包 ZIP,再用 file-saver 下载。
  • 支持 saveAs(data: Blob | File | string, filename: string, disableAutoBOM?: boolean) 形式调用。

8. 示例:将 file-saverjszip 结合

import { saveAs } from "file-saver";
import JSZip from "jszip";

const zip = new JSZip();
zip.file("hello.txt", "Hello, world!");
zip.file("data.json", JSON.stringify({ key: "value" }, null, 2));

zip.generateAsync({ type: "blob" }).then((blob) => {
  saveAs(blob, "archive.zip");
});

9. 总结

  • file-saver 适用于前端文件下载,尤其是 Blob、URL 文件等。
  • 适用于文本、JSON、CSV、图片、PDF、ZIP 等格式。
  • 结合 jszip 还能下载多个文件打包成 ZIP。

这是一个简单易用的下载工具,适用于前端开发。你有具体的应用场景或问题吗?

上次更新:

相关文章

Node-Cache 完全指南 | Node.js 内存缓存模块使用教程

本文详细介绍了 Node-Cache 模块,这是一个简单高效的 Node.js 内存缓存解决方案,包括安装方法、基本使用、主要功能、高级特性、配置选项以及实际应用场景。

·前端开发

npx完全指南:前端开发必备工具详解 | 20年架构师深度解析

本文由20年前端架构师深入解析npx工具,涵盖其核心功能、优势、高级用法、最佳实践及与npm/yarn的区别比较,帮助开发者掌握这一现代前端开发利器。

·前端开发

Astro 静态站点生成器:构建高性能网站的最佳选择

Astro 是一个专注于构建快速、轻量级网站的静态站点生成器,支持多种前端框架,采用岛屿架构减少 JavaScript 加载,提升性能。

·前端开发

Weex 跨平台移动开发框架:核心特性与使用指南

Weex 是由阿里巴巴开源的跨平台移动开发框架,支持使用 Vue.js 或 Rax 构建高性能的 iOS、Android 和 Web 应用。本文详细解析了 Weex 的核心特性、架构、工作流程、组件和模块、开发工具、优缺点、应用场景及未来发展。

·前端开发

ECharts 与 DataV 数据可视化工具对比分析 | 选择指南

本文详细对比了 ECharts 和 DataV 两个常用的数据可视化工具,包括它们的设计目标、优缺点、使用场景和技术栈,帮助读者根据具体需求选择合适的工具。

·前端开发

前端部署后通知用户刷新页面的常见方案 | 单页应用更新提示

本文介绍了在前端部署后通知用户刷新页面的几种常见方案,包括WebSocket实时通知、轮询检查版本、Service Worker版本控制、版本号对比、自动刷新、使用框架内置功能以及第三方库。每种方案的优缺点和示例代码均有详细说明。

·前端开发

file-saver:前端文件下载的 JavaScript 库使用指南

file-saver 是一个用于在浏览器端保存文件的 JavaScript 库,支持生成和下载多种文件格式,如文本、JSON、CSV、图片、PDF 等。本文详细介绍其安装、基本用法、兼容性及与其他工具(如 jszip)的结合使用。

·前端开发

MSW(Mock Service Worker):API 模拟工具的核心优势与使用指南

MSW(Mock Service Worker)是一个用于浏览器和 Node.js 的 API 模拟工具,通过 Service Worker 拦截网络请求,支持 REST 和 GraphQL,适用于开发、测试和调试场景。本文详细介绍 MSW 的核心优势、快速上手步骤、高级用法、适用场景及与其他 Mock 工具的对比。

·前端开发

Preact:轻量级 JavaScript 库,React 的高性能替代方案

Preact 是一个轻量级的 JavaScript 库,提供与 React 相似的 API 和开发体验,但体积更小(约 3-4KB,gzip 后)。它专注于高性能和低资源消耗,特别适合对性能敏感或需要快速加载的 Web 应用。

·前端开发

WASI标准与WebAssembly跨平台生态的未来趋势分析 | 技术深度解析

本文深入探讨了WASI(WebAssembly System Interface)标准的背景、意义及其对WebAssembly跨平台生态的影响。文章分析了WASI在服务器端应用、边缘计算和IoT设备中的应用,以及技术栈和工具链的演进,最后展望了WASI对未来前端开发的影响和最佳实践建议。

·前端开发