Bootstrap

前端实现流文件下载

在现代Web开发中,经常会遇到需要从服务器下载文件的情况。有时候这些文件是事先存储好的,可以通过简单的URL链接直接下载;但有时候,我们需要从数据流中动态生成文件并将其提供给用户。本篇博客将介绍如何在前端实现流文件下载的完整指南。

了解流文件下载

流文件下载是一种在前端从数据流中动态生成文件并下载的方法。这对于一些特殊的场景非常有用,比如生成PDF文档、导出Excel表格或下载服务器端生成的图像等。

基本原理

在前端实现流文件下载的基本原理如下:

从服务器获取数据流。
将数据流转换成Blob对象。
创建一个URL指向该Blob对象。
创建一个a标签,设置其href属性为该URL,download属性为文件名。
模拟点击a标签,触发文件下载。
完成下载后,释放URL对象。
代码实现
下面是一段简单的JavaScript代码,实现了从数据流中下载文件的功能:

/**
 * data: 下载文件
 * fileName: 文件名
 * type: 下载文件类型
 */
export function downloadHandler(data, fileName, type) {
  // 匹配任意文件类型:type : "application/octet-stream"
  const blob = new Blob([data], { type: type || 'application/octet-stream' });
  const downloadElement = document.createElement('a');
  const href = window.URL.createObjectURL(blob);
  downloadElement.href = href;
  downloadElement.download = fileName;
  document.body.appendChild(downloadElement);
  downloadElement.click();
  document.body.removeChild(downloadElement);
  window.URL.revokeObjectURL(href);
}

这段代码中,我们首先将数据流转换成Blob对象,然后创建一个a标签,设置其href属性为Blob对象的URL,download属性为文件名。接着将a标签添加到页面中,模拟点击a标签实现文件下载。下载完成后,移除a标签,并释放URL对象。

示例

假设我们有一个后端接口 /api/download,用于提供文件下载服务。我们可以使用fetch API从该接口获取数据流,并通过我们实现的downloadHandler函数实现文件下载。

fetch('/api/download')
  .then(response => response.blob())
  .then(blob => {
    downloadHandler(blob, 'example.pdf', 'application/pdf');
  })
  .catch(error => {
    console.error('文件下载失败:', error);
  });

;