如何正确导出 API 返回的 Excel 文件(XLS/XLSX)到浏览器下载

浅磊吖_1527

浅磊吖_1527

2026-09-11

650人浏览

原创

如何正确导出 API 返回的 Excel 文件(XLS/XLSX)到浏览器下载

本文详解前端调用后端 excel 导出接口时出现乱码/字符流问题的根本原因与解决方案,重点在于正确设置 blob mime 类型及 axios 响应配置,确保浏览器识别并触发文件下载。

本文详解前端调用后端 excel 导出接口时出现乱码/字符流问题的根本原因与解决方案,重点在于正确设置 blob mime 类型及 axios 响应配置,确保浏览器识别并触发文件下载。

在使用 JavaScript 调用后端 Excel 导出 API 时,常见现象是:响应体看似“成功”,但实际接收到的是一串不可读的二进制字符(如 PK\x03\x04... 的原始字节序列),而非预期的 .xlsx 文件;而通过 Swagger UI 点击下载却能正常打开——这明确指向前端对响应数据的解析与构造方式有误,而非后端接口本身的问题。

核心问题在于:Blob 构造时未指定正确的 MIME 类型(type)。Excel 文件(.xlsx 或 .xls)需显式声明为 application/vnd.openxmlformats-officedocument.spreadsheetml.sheet(XLSX)或 application/vnd.ms-excel(XLS)。若省略 type 或设为默认空字符串,浏览器会将 Blob 视为纯文本或未知类型,导致 URL.createObjectURL() 生成的链接无法被正确识别为 Excel 文件,进而触发错误的渲染逻辑(例如尝试以 UTF-8 解析二进制流),最终显示乱码。

✅ 正确做法是在创建 Blob 实例时显式传入 MIME 类型:

function downloadDocFile(data: Blob, ext = 'xlsx', name = 'Export'): void {
  // ✅ 关键修复:指定准确的 MIME 类型
  const mimeType = ext === 'xlsx' 
    ? 'application/vnd.openxmlformats-officedocument.spreadsheetml.sheet'
    : 'application/vnd.ms-excel';

  const downloadUrl = window.URL.createObjectURL(
    new Blob([data], { type: mimeType })
  );

  const link = document.createElement('a');
  link.href = downloadUrl;
  link.setAttribute('download', `${name}-${DateTime.now().toLocaleString()}.${ext}`);
  document.body.appendChild(link);
  link.click();
  document.body.removeChild(link); // 推荐使用 removeChild 替代 remove,兼容性更佳
  window.URL.revokeObjectURL(downloadUrl); // ✅ 及时释放内存引用
}

同时,确保 Axios(或你所用的 HTTP 客户端)请求中正确配置 responseType: 'blob' —— 这一点你的代码已正确实现。但需注意:Axios 的 post(url, config) 写法有歧义。当前代码:

pyspark-to-excel
pyspark-to-excel

将 PySpark .show() 输出转为 Tab 分隔文本,方便粘贴 Excel。触发词:pyspark、数据转excel、表格整理、venus数据、show输出、复制到excel、数据格式化。

下载
.post(url, { responseType: 'blob' })

⚠️ 实际上是将 { responseType: 'blob' } 当作 请求体(body) 发送了!正确写法应为三参数形式,显式分离 data 和 config:

function handleExport() {
  loading.show();
  const url = `/bill-of-material/${bomItems.value[0]?.billOfMaterialId}/available-kits/export-xls`;

  getApiInstance('kitting')
    .post(url, {}, { responseType: 'blob' }) // ✅ 第二个参数为 body(空对象),第三个为 config
    .then((response) => {
      if (response?.data) {
        downloadDocFile(response.data); // 注意:data 在 response.data 中,非 response
      }
      loading.hide();
    })
    .catch((error) => {
      console.error('Export failed:', error);
      loading.hide();
    });
}

? 补充说明:

  • 对于 .xlsx 文件,优先使用 application/vnd.openxmlformats-officedocument.spreadsheetml.sheet(更标准);
  • 若后端返回的是旧版 .xls,则用 application/vnd.ms-excel;
  • 务必调用 window.URL.revokeObjectURL(downloadUrl) 清理对象 URL,避免内存泄漏;
  • 建议添加 .catch() 处理网络或格式错误,提升健壮性;
  • Swagger 能正常下载,是因为它自动根据 Content-Type 响应头构造下载行为,而前端需手动补全该语义。

遵循以上修正,即可彻底解决“API 返回乱码、Swagger 正常”的典型导出异常,确保 Excel 文件在浏览器中可靠下载与打开。

大量免费API接口:立即使用
涵盖生活服务API、金融科技API、企业工商API、等相关的API接口服务。免费API接口可安全、合规地连接上下游,为数据API应用能力赋能!

相关文章

PHP速学视频免费教程(入门到精通)
PHP速学视频免费教程(入门到精通)

PHP怎么学习?PHP怎么入门?PHP在哪学?PHP怎么学才快?不用担心,这里为大家提供了PHP速学教程(入门到精通),有需要的小伙伴保存下载就能学习啦!

下载

本站声明:本文内容由网友自发贡献,版权归原作者所有,本站不承担相应法律责任。如您发现有涉嫌抄袭侵权的内容,请联系admin@php.cn

相关专题

更多
js获取数组长度的方法
js获取数组长度的方法

在js中,可以利用array对象的length属性来获取数组长度,该属性可设置或返回数组中元素的数目,只需要使用“array.length”语句即可返回表示数组对象的元素个数的数值,也就是长度值。php中文网还提供JavaScript数组的相关下载、相关课程等内容,供大家免费下载使用。

2023.06.20

4266

5

js刷新当前页面
js刷新当前页面

js刷新当前页面的方法:1、reload方法,该方法强迫浏览器刷新当前页面,语法为“location.reload([bForceGet]) ”;2、replace方法,该方法通过指定URL替换当前缓存在历史里(客户端)的项目,因此当使用replace方法之后,不能通过“前进”和“后退”来访问已经被替换的URL,语法为“location.replace(URL) ”。php中文网为大家带来了js刷新当前页面的相关知识、以及相关文章等内容

2023.07.04

1089

3

js四舍五入
js四舍五入

js四舍五入的方法:1、tofixed方法,可把 Number 四舍五入为指定小数位数的数字;2、round() 方法,可把一个数字舍入为最接近的整数。php中文网为大家带来了js四舍五入的相关知识、以及相关文章等内容

2023.07.04

4184

6

js删除节点的方法
js删除节点的方法

js删除节点的方法有:1、removeChild()方法,用于从父节点中移除指定的子节点,它需要两个参数,第一个参数是要删除的子节点,第二个参数是父节点;2、parentNode.removeChild()方法,可以直接通过父节点调用来删除子节点;3、remove()方法,可以直接删除节点,而无需指定父节点;4、innerHTML属性,用于删除节点的内容。

2023.09.01

860

4

JavaScript转义字符
JavaScript转义字符

JavaScript中的转义字符是反斜杠和引号,可以在字符串中表示特殊字符或改变字符的含义。本专题为大家提供转义字符相关的文章、下载、课程内容,供大家免费下载体验。

2023.09.04

1736

5

js生成随机数的方法
js生成随机数的方法

js生成随机数的方法有:1、使用random函数生成0-1之间的随机数;2、使用random函数和特定范围来生成随机整数;3、使用random函数和round函数生成0-99之间的随机整数;4、使用random函数和其他函数生成更复杂的随机数;5、使用random函数和其他函数生成范围内的随机小数;6、使用random函数和其他函数生成范围内的随机整数或小数。

2023.09.04

3105

4

如何启用JavaScript
如何启用JavaScript

JavaScript启用方法有内联脚本、内部脚本、外部脚本和异步加载。详细介绍:1、内联脚本是将JavaScript代码直接嵌入到HTML标签中;2、内部脚本是将JavaScript代码放置在HTML文件的`<script>`标签中;3、外部脚本是将JavaScript代码放置在一个独立的文件;4、外部脚本是将JavaScript代码放置在一个独立的文件。

2023.09.12

4033

6

Js中Symbol类详解
Js中Symbol类详解

javascript中的Symbol数据类型是一种基本数据类型,用于表示独一无二的值。Symbol的特点:1、独一无二,每个Symbol值都是唯一的,不会与其他任何值相等;2、不可变性,Symbol值一旦创建,就不能修改或者重新赋值;3、隐藏性,Symbol值不会被隐式转换为其他类型;4、无法枚举,Symbol值作为对象的属性名时,默认是不可枚举的。

2023.09.20

2600

5

java访问控制修饰符介绍
java访问控制修饰符介绍

java访问控制修饰符有四种,分别是public、protected、private、默认访问修饰符。详细介绍:1、public,public是最宽松的访问控制修饰符,被修饰的类、方法和变量可以被任何其他类访问,当一个类、方法或变量被声明为public时,它们可以在任何地方被访问,无论是同一个包中的类还是不同包中的类;2、protected修饰符等等。

2023.09.20

848

7

热门下载

更多
网站特效
/
网站源码
/
网站素材
/
前端模板

精品课程

更多
相关推荐
/
热门推荐
/
最新课程
Excel 教程
Excel 教程

共162课时 | 43.5万人学习

成为PHP架构师-自制PHP框架
成为PHP架构师-自制PHP框架

共28课时 | 3.5万人学习