前端实现获取后端返回的文件流并下载三种方法

 更新时间:2025年04月09日 09:27:36   作者:m0_74823524  
文件下载是最常见的流形式返回数据的应用场景之一,通过流形式返回文件内容,可以避免将整个文件加载到内存中,从而减少内存消耗,这篇文章主要介绍了前端实现获取后端返回的文件流并下载的三种方法,需要的朋友可以参考下

在前端开发中,有时需要从后端获取文件流,并将其下载到本地。本文介绍如何在前端实现此功能的不同的实现方法,并分析其优缺点

方法一:使用Axios实现文件流下载

使用Axios实现文件流下载的方法,本人亲测可以实现

import axios from 'axios';
import { getToken } from '@/utils/auth'

handleExport() {
  // 接口调用获取文件
  axios({
    method: 'get',
    responseType: 'blob', // 指定响应类型为blob
    url: this.GLOBAL.baseURL + '/api/v1/business/user/export',
    data: this.queryParams, // 导入文件一般都用FormData格式数据
    headers: { 'Authorization': 'Bearer ' + getToken() } // 传递token进行身份验证
  }).then(res => {
    if (res.code === 200) {
      // 导入成功
      this.downloadBinaryFile(res.data, '导入失败后下载的报错文件')
    } else {
      // 输出失败信息
    }
  }).catch(error => {
    console.error('下载失败', error);
  });
},
    
/**
 * 将二进制文件下载到本地,保存为excel文件
 * @param {*} binFile 二进制文件流
 * @param {*} fileName 下载后的文件名
 * @param {*} blobType 文件格式,默认为 "application/vnd.ms-excel"
 */
downloadBinaryFile(binFile, fileName, blobType = "application/vnd.ms-excel") {
  // 创建 Blob 对象,包含二进制文件流和文件类型
  const blobObj = new Blob([binFile], { type: blobType });
  
  // 创建下载链接元素
  const downloadLink = document.createElement('a');
  
  // 处理不同浏览器的 URL 兼容性
  let url = window.URL || window.webkitURL; 
  url = url.createObjectURL(blobObj); // 创建文件 URL
  
  // 设置下载链接属性
  downloadLink.href = url;
  downloadLink.download = fileName;
  
  // 将下载链接添加到文档中并触发点击事件
  document.body.appendChild(downloadLink);
  downloadLink.click();
  
  // 移除下载链接并释放 URL 对象
  document.body.removeChild(downloadLink);
  window.URL.revokeObjectURL(url);
}

实现的效果

优点

  • 支持传递Token进行身份验证,安全性较高
  • 支持POST请求,可以将参数放在请求体中,避免URL长度限制及参数暴露

缺点

  • 实现相对复杂,需要手动创建和管理Blob对象及下载链接

方法二:使用封装的Request工具实现文件流下载

接下来介绍使用封装的Request工具实现文件流下载的方法

import request from '@/utils/request'

// 日志管理收藏、浏览、下载导出接口
export function exportUserOperateAdmin(data, headers) {
  return request({
    url: '/business/user/export',
    method: 'get',
    data: data,
    headers: headers
  })
}

// 调用导出接口
exportUserOperateAdmin(this.queryParams, { responseType: 'blob' }).then(
  response => {
    console.log(response)
    const url = window.URL.createObjectURL(new Blob([response.data])) // 创建下载链接
    const link = document.createElement('a')
    link.href = url
    link.download = '全文导入模板.xlsx' // 设置文件名
    document.body.appendChild(link)
    link.click() // 触发下载
    document.body.removeChild(link) // 下载后移除元素
  }
).catch(error => {
  console.error('下载失败', error)
  this.loading = false // 停止加载,隐藏加载状态
})

优点

  • 封装后的Request工具调用简单,代码更简洁
  • 支持传递Token进行身份验证,安全性较高

缺点

  • 实现相对简单,但仍需手动处理Blob对象及下载链接

方法三:直接通过URL跳转下载

最后介绍直接通过URL跳转实现文件下载的方法

const baseurl = this.GLOBAL.baseURL
// 拼接上导出的地址,如果接口还需要其他参数,都可以直接拼接上
let url = baseurl + '/api/v1/business/user/export';
console.log(url)
alert(url)
// 第二个参数'_self'表示在当前页下载,不打开新的页面
window.open(url, '_self')

优点

  • 实现简单,不需要处理Blob对象及下载链接
  • 适合下载无需身份验证或参数简单的文件

缺点

  • 无法传递Token进行身份验证,安全性较低
  • 参数放在URL中不安全,且可能会导致URL过长
  • 处理中文参数可能会出现乱码问题

结论

以上三种方法各有优缺点,实际开发中可以根据具体需求选择合适的方法。

如果需要传递Token进行身份验证并确保下载安全性,推荐使用方法一或方法二

如果只是简单下载无需验证的文件,可以考虑使用方法三

到此这篇关于前端实现获取后端返回的文件流并下载三种方法的文章就介绍到这了,更多相关前端获取后端返回文件流下载内容请搜索脚本之家以前的文章或继续浏览下面的相关文章希望大家以后多多支持脚本之家!

相关文章

  • JS中的回调函数(callback)讲解

    JS中的回调函数(callback)讲解

    回调函数是一段可执行的代码段,它作为一个参数传递给其他的代码,其作用是在需要的时候方便调用这段(回调函数)代码,这篇文章主要介绍了JS中的 回调函数(callback),需要的朋友可以参考下
    2022-12-12
  • Javascript仿京东放大镜的效果

    Javascript仿京东放大镜的效果

    本文主要介绍了Javascript仿京东放大镜效果的实例。具有很好的参考价值,下面跟着小编一起来看下吧
    2017-03-03
  • JavaScript中利用Array和Object实现Map的方法

    JavaScript中利用Array和Object实现Map的方法

    这篇文章主要介绍了JavaScript中利用Array和Object实现Map的方法,实例分析了javascript实现map的添加、获取、移除、清空、遍历等操作技巧,具有一定参考借鉴价值,需要的朋友可以参考下
    2015-07-07
  • javascript异步编程

    javascript异步编程

    如果编程加入了时间的概念就一切变得非常复杂。通常我们的程序是飞快地解析执行,一毫秒紧接着一毫秒,从上至下地执行,这称之为同步。但如果我们想让后台的程序不等前面的程序执行,就执行呢,于是就有了异步的概念。
    2010-06-06
  • css值转换成数值请抛弃parseInt

    css值转换成数值请抛弃parseInt

    绝大多数人喜欢用parseInt()把css中的字符串值转换成数值
    2011-10-10
  • JavaScript实现刮刮乐效果

    JavaScript实现刮刮乐效果

    这篇文章主要为大家详细介绍了JavaScript实现刮刮乐效果,文中示例代码介绍的非常详细,具有一定的参考价值,感兴趣的小伙伴们可以参考一下
    2020-11-11
  • Bootstrap基本组件学习笔记之面板(14)

    Bootstrap基本组件学习笔记之面板(14)

    这篇文章主要为大家详细介绍了Bootstrap基本组件学习笔记之面板,具有一定的参考价值,感兴趣的小伙伴们可以参考一下
    2016-12-12
  • 微信小程序scroll-view实现滚动到锚点左侧导航栏点餐功能(点击种类,滚动到锚点)

    微信小程序scroll-view实现滚动到锚点左侧导航栏点餐功能(点击种类,滚动到锚点)

    这篇文章主要介绍了微信小程序scroll-view左侧导航栏点餐功能实现,点击种类,滚动到锚点;滚动到锚点,种类选中,本文通过实例代码给大家介绍的非常详细,对大家的学习或工作具有一定的参考借鉴价值,需要的朋友可以参考下
    2020-06-06
  • 编写一个javascript元循环求值器的方法

    编写一个javascript元循环求值器的方法

    这篇文章主要介绍了编写一个javascript元循环求值器的方法,文中通过示例代码介绍的非常详细,对大家的学习或者工作具有一定的参考学习价值,需要的朋友们下面随着小编来一起学习学习吧
    2020-04-04
  • 微信小程序使用picker组件出现的问题探究

    微信小程序使用picker组件出现的问题探究

    这篇文章主要介绍了微信小程序自定义可搜索的picker组件,主要包括自定义可搜索的picker组件的代码以及调用实例,这里的搜索框使用的是vant微信小程序组件库,picker使用的微信小程序的原生组件,需要的朋友可以参考下
    2023-01-01

最新评论