js将后端返回的文件流导出为excel,并自定义下载文件名

一. 需求

后台管理系统,常会出现导出excel表格功能;点击导出按钮,请求后端接口,需要将接口返回的文件流导出为excel,实现前端下载excel文件。
但是,返回的数据获取 response 时出现乱码,如图:
在这里插入图片描述

二. 实现思路

  1. 调用后端下载接口,获取传递过来的二进制数据流
  2. 创建<a>标签
  3. 创建下载链接;将Blob对象转化为一个URL资源地址,这个地址是一个本地地址
  4. 将a标签添加到body中
  5. 添加点击事件,进行下载
  6. 下载完成后移除a标签

三. 了解概念

在写代码之前,先来了解几个概念。当然也可以跳过这部分,直接看代码。

1)responseType
responseType 的作用就是设置ajax数据响应的类型,你告诉服务器,让服务器返回什么样的数据类型给你
服务器响应的数据类型,可以是 arraybuffer, blob, document, json, text, stream,默认是’json’

2)Blob() 构造函数
Blob() 构造函数文档

Blob() 构造函数返回一个新的 Blob 对象,blob 的内容由参数数组中给出的值的串联组成。(通俗点说,Blob对象可以看做是一个存储二进制数据的容器)

语法:

var aBlob = new Blob( array, options );

参数:

  1. array 是一个由ArrayBuffer, ArrayBufferView, Blob, DOMString 等对象构成的 Array ,或者其他类似对象的混合体,它将会被放进 Blob。
  2. options 是一个可选的,它可能会指定如下两个属性:
    1)type,默认值为 “”,它代表了将会被放入到 blob 中的数组内容的 MIME 类型。比如:type: ‘application/x-excel’ 或 type: ‘text/plain’
    2)endings,默认值为"transparent",用于指定包含行结束符\n的字符串如何被写入。它是以下两个值中的一个:“native”,代表行结束符会被更改为适合宿主操作系统文件系统的换行符,或者 “transparent”,代表会保持 blob 中保存的结束符不变 非标准

示例:

var aFileParts = ['<a id="a"><b id="b">hey!</b></a>']; // 一个包含 DOMString 的数组
var MyBlob = new Blob(aFileParts, {type : 'text/html'}); // 得到 blob对象
console.log(MyBlob, 'MyBlob')

打印结果:
在这里插入图片描述

3)URL.createObjectURL()
官方文档介绍 URL.createObjectURL()

通过创建URL对象指定文件的下载链接。

语法:

objectURL = URL.createObjectURL(object);
//参数object:用于创建 URL 的 File 对象、Blob 对象或者 MediaSource 对象。​
//返回值:包含了一个对象 URL,该 URL 可用于指定源 object的内容。

示例:

  const aFileParts = ['<a id="a"><b id="b">hey!</b></a>'] // 一个包含 DOMString 的数组
  const MyBlob = new Blob(aFileParts, { type: 'text/html' }) // 得到 blob
  const objectURL = window.URL.createObjectURL(MyBlob)  // 创建新的URL表示指定的File对象或者Blob对象。
  console.log(objectURL, 'objectURL')
  window.URL.revokeObjectURL(objectURL); // 释放内存

打印结果:
在这里插入图片描述

注意内存管理

在每次调用 createObjectURL() 方法时,都会创建一个新的 URL 对象,即使你已经用相同的对象作为参数创建过。当不再需要这些 URL 对象时,每个对象必须通过调用 URL.revokeObjectURL() 方法来释放。
浏览器在 document 卸载的时候,会自动释放它们,但是为了获得最佳性能和内存使用状况,你应该在安全的时机主动释放掉它们。

四. 代码实现

在src/utils下新建tool.js(代码如下),封装成一个方法暴露出去,方便其他页面调用。

import XEUtils from 'xe-utils'

export function exportCsv(csv:any, title:string) {
  const t = XEUtils.toDateString(Date.now(), 'yyyy-MM-dd')  // 当前日期
  const filename = `${t + title}.csv` // 拼接文件名

  const blob = new Blob([csv])  //创建一个新的 Blob 对象
  const url = window.URL.createObjectURL(blob)  //  把一个blob对象转化为一个Blob URL,创建下载链接
  const downloadLink = document.createElement('a')  // 生成一个a标签
  downloadLink.href = url
  downloadLink.download = filename  // // dowload属性指定下载后文件名
  document.body.appendChild(downloadLink) //将a标签添加到body中
  downloadLink.click() // 点击下载
  document.body.removeChild(downloadLink)  // 下载完成后移除元素
  window.URL.revokeObjectURL(url); // 释放掉blob对象
}

其次就是 调用接口了
在调用接口 封装了 axios
所以 在请求后台接口时,要在请求头上要注意加上 responseType: 'blob'

import request from '@/request/http.ts'
GETMONEYLISTDOWN({ // 资金记录导出接口
    page = 0,
    size = 10,
  }) {
    return request({
      method: 'post',
      responseType: 'blob', //注意 需要规定后台返回文件流格式
      data: Object.assign(
        {
          page,
          pagesize: size,
          method: 'Money.Moneylist'
        },
        tokenQuery()
      )
    })
  },
// 页面调用
import { exportCsv } from '@/utils/tool.ts'

function downLoad(e) {
  tableLoading.value = true
  const params = Object.assign(apiParams, e)
  moneyApi.GETMONEYLISTDOWN(Object.assign({}, params)).then(res => {
  // 传入二进制流data和文件名
    exportCsv(res.data, '资金记录')
    tableLoading.value = false
  }).catch(error => {
    tableLoading.value = false
    console.log(error)
  })
}

可参考:
excel导出-将后端返回的文件流导出为excel

  • 11
    点赞
  • 36
    收藏
    觉得还不错? 一键收藏
  • 打赏
    打赏
  • 1
    评论
您好!对于后端返回文件并由前端导出的需求,您可以按照以下步骤进行操作: 1. 后端传输文件:在后端,您可以使用合适的编程语言和框架,将文件的形式返回前端。根据您使用的具体技术栈,可能会有不同的方法来实现这一点。 2. 前端接收文件前端需要通过合适的方式接收后端返回文件。通常情况下,可以使用浏览器的内置 API(如 Fetch API 或 XMLHttpRequest)来发起请求并接收文件。 3. 将文件导出:一旦前端成功接收到文件,您可以使用合适的 JavaScript 库或框架来处理并导出文件。常见的方法是创建一个 `<a>` 标签,并为其设置 `href` 属性为文件的 URL,再调用 `click()` 方法以触发下载。 以下是一个简单的示例,演示了如何在前端导出后端返回文件(以 CSV 文件为例): ```javascript // 后端返回文件 fetch('/api/getFile', { method: 'GET', }) .then(response => response.blob()) // 将响应转换为 Blob 对象 .then(blob => { // 创建下载链接 const downloadLink = document.createElement('a'); downloadLink.href = window.URL.createObjectURL(blob); downloadLink.download = 'file.csv'; // 设置下载文件的名称 // 触发下载 downloadLink.click(); }) .catch(error => { console.error('导出文件失败:', error); }); ``` 请注意,这只是一个示例,并不能适用于所有情况。根据您的实际需求和技术栈,可能需要进行适当的调整和修改。希望对您有所帮助!如果您有任何进一步的问题,请随时提问。
评论 1
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

当前余额3.43前往充值 >
需支付:10.00
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包

打赏作者

铁锤妹妹@

你的鼓励将是我创作的最大动力

¥1 ¥2 ¥4 ¥6 ¥10 ¥20
扫码支付:¥1
获取中
扫码支付

您的余额不足,请更换扫码支付或充值

打赏作者

实付
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明:

1.余额是钱包充值的虚拟货币,按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载,可以购买VIP、付费专栏及课程。

余额充值