前端处理axios请求下载后端返回的文件流代码实例

 更新时间:2024年07月20日 14:53:53   作者:大力99  
使用axios可以很方便地获取后端返回的文件流数据,并在前端直接在浏览器下载,这篇文章主要给大家介绍了关于前端处理axios请求下载后端返回的文件流的相关资料,需要的朋友可以参考下

需求:

点击按钮下载文件,请求后端接口,后端返回文件流,如果遇到错误信息并不能简单的res.message拿到错误提示,而且想要正常下载前端也需要做些处理。

1.请求接口要加上响应类型为blob, responseType: ‘blob’,如:

function logsDownload(params) {
 return axios.get('xxx/xxx/xxx',{
   params,
   responseType: 'blob'
 })
}

2.定义一个下载的方法

function download(fileName ='log', type: 'txt' | 'json, file:Blob) {
   const blob = new Blob([file]);
    // 获取heads中的filename文件名
    const downloadElement = document.createElement('a');
    // 创建下载的链接
    const href = window.URL.createObjectURL(blob);
    downloadElement.href = href;
    // 下载后文件名
    downloadElement.download = `${fileName}.${type}`
    document.body.appendChild(downloadElement);
    // 点击下载
    downloadElement.click();
    // 下载完成移除元素
    document.body.removeChild(downloadElement);
    // 释放掉blob对象
    window.URL.revokeObjectURL(href);
}

3.借助FileReader对象实现,FileReader.readAsText(data)开始读取指定的Blob中的内容。

result属性中将包含一个字符串以表示所读取的文件内容。

读取操作完成时触发FileReader.onload(),在这里通过reader.result拿到读取的文件内容(即后端返回值),然后对其json序列化,即

可拿到后端返回的message,然后进行相应的展示即可。

// 定义一个读取文件的方法
async function readFileAsText (file:File){
      const fileReader = new FileReader()
      let text
      await new Promise(resolve=>{
         fileReader.onLoad = ()=>{
            text = fileReader.result
            resolve(true)
         }
        fileReader.readAsText(file, 'utf8')
      })
      return text || ''
 }

4.请求成功和失败的返回结果是不同

请求下载一个文件,请求成功时返回的是一个文件流,type是对应文件类型,例如:text/xml,正常导出文件; 而请求失败的时候返回的是json ,type为application/json,不会处理错误信息,而是直接导出包含错误信息的文件。

但是无论成功还是失败,返回的结果都是blob格式的文件流。

因此可以通过返回的blob数据type类型进行区分,如果type是文件类型,导出文件,如果type是json则把blob数据转为string,处理错误信息。

在响应拦截器那里加入以下,需要判断如果时文件流直接返回的情况

// 响应拦截器
banseInstance.interceptors.response.use(response => {
  ...
  // 文件流直接返回
  if (response .request.responseType === 'blob' ) {
      if (response .data.type === 'application/json') {
        const res = await readFileAsText(response.data)

        ElMessage.error(JSON.parse(res).message || '下载失败')
        return false;
     } else {
       return response .data;
     }
  }
 ...
}

点击按钮下载

  const handleDown = () => {
    const fileName = 'xxxx'
    const file = await logsDownload(params)
    if (file) {
     download(fileName, 'txt', file)
     ElMessage.success('下载成功')
    }
  }

总结 

到此这篇关于前端处理axios请求下载后端返回的文件流的文章就介绍到这了,更多相关axios请求下载后端返回文件流内容请搜索脚本之家以前的文章或继续浏览下面的相关文章希望大家以后多多支持脚本之家!

相关文章

  • Vue+Echarts报错Cannot set properties of undefined (setting ‘plate‘)

    Vue+Echarts报错Cannot set properties of undefined (settin

    这篇文章主要介绍了Vue+Echarts报错Cannot set properties of undefined (setting ‘plate‘)的问题及解决方案,具有很好的参考价值,希望对大家有所帮助。如有错误或未考虑完全的地方,望不吝赐教
    2022-08-08
  • vue调试工具没有Pinia模块的简单解决办法

    vue调试工具没有Pinia模块的简单解决办法

    Pinia是Vue的存储库,它允许您跨组件/页面共享状态,这篇文章主要给大家介绍了关于vue调试工具没有Pinia模块的简单解决办法,文中通过图文介绍的非常详细,需要的朋友可以参考下
    2024-02-02
  • 如何解决vue与传统jquery插件冲突

    如何解决vue与传统jquery插件冲突

    本篇文章主要介绍了如何解决vue与传统jquery插件冲突,小编觉得挺不错的,现在分享给大家,也给大家做个参考。一起跟随小编过来看看吧
    2017-03-03
  • Vue项目总结之webpack常规打包优化方案

    Vue项目总结之webpack常规打包优化方案

    这篇文章主要介绍了vue项目总结之webpack常规打包优化方案,本文给大家介绍的非常详细,具有一定的参考借鉴价值,需要的朋友可以参考下
    2019-06-06
  • Vue.js中自定义Markdown插件实现References解析(推荐)

    Vue.js中自定义Markdown插件实现References解析(推荐)

    本文主要写的是,如何编写一个插件来解析<references>标签,并将其转换为HTML,这种方法可以应用于其他自定义标签和功能,为Vue.js应用程序中的Markdown渲染提供了极大的灵活性,感兴趣的朋友跟随小编一起看看吧
    2024-07-07
  • vue中keep-alive组件使用和一些基础配置方法

    vue中keep-alive组件使用和一些基础配置方法

    本文主要介绍了Vue中keep-alive组件的使用方法和一些基础配置,keep-alive是Vue中的一个抽象组件,可以缓存组件实例,提高性能,本文给大家介绍vue中keep-alive组件使用和一些基础配置方法,感兴趣的朋友一起看看吧
    2024-10-10
  • vue实现购物车小案例

    vue实现购物车小案例

    这篇文章主要为大家详细介绍了vue实现购物车小案例,文中示例代码介绍的非常详细,具有一定的参考价值,感兴趣的小伙伴们可以参考一下
    2019-09-09
  • vue里的data要用return返回的原因浅析

    vue里的data要用return返回的原因浅析

    这篇文章主要介绍了vue里的data要用return返回的原因浅析,需要的朋友可以参考下
    2019-05-05
  • 基于vue hash模式微信分享#号的解决

    基于vue hash模式微信分享#号的解决

    这篇文章主要介绍了基于vue hash模式微信分享#号的解决,具有很好的参考价值,希望对大家有所帮助。一起跟随小编过来看看吧
    2020-09-09
  • vue中echarts图表大小适应窗口大小且不需要刷新案例

    vue中echarts图表大小适应窗口大小且不需要刷新案例

    这篇文章主要介绍了vue中echarts图表大小适应窗口大小且不需要刷新案例,具有很好的参考价值,希望对大家有所帮助。一起跟随小编过来看看吧
    2020-07-07

最新评论