post方法下载文件,需做哪些特殊处理

POST方法与GET方法下载的区别:

  • GET用于获取数据,POST用于提交数据。但文件下载通常属于获取资源,所以理想情况下应使用GET。然而,当参数较长或包含敏感信息时,使用POST更合适。

  • 对于文件下载,使用GET时,可以直接通过链接下载(例如window.open),不需要复杂的前端处理。

  • 使用POST时,不能直接用链接,必须通过表单提交或AJAX请求(如本例),然后将返回的文件通过Blob方式处理并触发下载。

导出流程​:通过Axios发送POST请求获取二进制Excel文件 → 创建临时URL → 模拟点击下载 → 清理资源

js 复制代码
    import axios from 'axios';
    
    <Button loading={loading} type="primary" onClick={exportStatistics}>下载报表</Button>
                
    const exportStatistics = async () => {
    const baseURL = `${window.location.protocol}//${process.conf.ip}${process.conf.nginx ? '/gateway' : ''}`
    const source = axios.CancelToken.source();
    try {
      if (!filterRef.current?.getFilterParam) {
        return;
      }
      const filterParams = filterRef.current.getFilterParam();
      setLoading(true);
      const payload = JSON.stringify({
        plantIdList: filterParams.plantIdList,
        indexList: filterParams.indexList,
      });
      const response = await axios.post(
        `${baseURL}/statistics/data/export`,
        payload,
        {
          headers: {
            'Content-Type': 'application/json',
            Accept: 'application/vnd.openxmlformats-officedocument.spreadsheetml.sheet',
          },
          responseType: 'blob', // 指定响应类型为二进制数据
          cancelToken: source.token,
          transformResponse: [data => data], // 禁用自动转换
        },
      );
      const blob = response.data ? response.data : response;
      const url = URL.createObjectURL(blob);
      const a = document.createElement('a');
      a.href = url;
      a.download = `指标统计报表_${moment().format('YYYY-MM-DD HH:mm:ss')}.xlsx`;
      a.style.display = 'none';
      document.body.appendChild(a);
      a.click();
      setTimeout(() => {
        document.body.removeChild(a);
        URL.revokeObjectURL(url);
        source.cancel(); // 取消请求令牌
      }, 100);
    } catch (error) {
      console.error('导出失败:', error);
    } finally {
      setLoading(false);
    }
  };

特殊处理及原因:

  1. responseType: 'blob'​:

    • 因为响应是二进制文件(Excel),所以需要将响应类型设置为blob,以便正确处理。
  2. transformResponse: [data => data]​:

    • 默认情况下,axios会根据响应类型转换数据,但这里我们不需要转换,所以覆盖默认转换器,直接返回原始数据。
  3. 创建临时URL和隐藏的a标签:

    • 由于我们无法直接保存来自AJAX请求的文件,因此将Blob数据转换为一个URL,并模拟点击一个下载链接来触发浏览器下载。
  4. 使用取消令牌:

    • 允许在组件卸载等情况下取消请求,避免内存泄漏和潜在的错误。
  5. setTimeout清理资源:

    • 在下载开始后移除临时创建的a标签和URL,释放资源。使用setTimeout是为了确保下载已经启动。
  6. 错误处理:

    • 捕获请求过程中可能出现的错误,例如网络问题或后端错误。
  7. 设置加载状态:

    • 在开始请求时设置加载状态,在请求结束后(无论成功或失败)清除状态,以提供用户反馈。
相关推荐
全栈前端老曹34 分钟前
【MongoDB】Node.js 集成 —— Mongoose ORM、Schema 设计、Model 操作
前端·javascript·数据库·mongodb·node.js·nosql·全栈
低代码布道师1 小时前
Next.js 16 全栈实战(一):从零打造“教培管家”系统——环境与脚手架搭建
开发语言·javascript·ecmascript
一位搞嵌入式的 genius2 小时前
深入 JavaScript 函数式编程:从基础到实战(含面试题解析)
前端·javascript·函数式
choke2332 小时前
[特殊字符] Python 文件与路径操作
java·前端·javascript
wuhen_n3 小时前
JavaScript内置数据结构
开发语言·前端·javascript·数据结构
鹿心肺语3 小时前
前端HTML转PDF的两种主流方案深度解析
前端·javascript
一个懒人懒人4 小时前
Promise async/await与fetch的概念
前端·javascript·html
早點睡3905 小时前
高级进阶 ReactNative for Harmony 项目鸿蒙化三方库集成实战:react-native-drag-sort
react native·react.js·harmonyos
C澒5 小时前
Vue 项目渐进式迁移 React:组件库接入与跨框架协同技术方案
前端·vue.js·react.js·架构·系统架构
xiaoxue..5 小时前
合并两个升序链表 与 合并k个升序链表
java·javascript·数据结构·链表·面试