前端使用axios实现下载文件功能的详细过程

 更新时间:2022年08月01日 13:16:40   作者:柯晓楠  
项目中经常会遇到需要导出列表内容,或者下载文件之类的需求,下面这篇文章主要给大家介绍了关于前端使用axios实现下载文件功能的相关资料,文中通过实例代码介绍的非常详细,需要的朋友可以参考下

1、需求描述

在前后端分离开发的项目中,前端无论使用Vue或React哪种框架,发送HTTP请求都会使用Ajax异步请求的方式。在很多项目中都会选择使用 axios 发送请求。但是在使用 axios 实现下载功能时,往往会出现以下问题。

当前端直接使用 axios 去请求下载文件的 api 接口时,状态码返回200,但是获取的数据却是一堆乱码,效果如下:

2、问题分析

下载其实是浏览器的内置事件,浏览器的 GET请求(frame、a)、 POST请求(form)具有如下特点:

  • response 会交由浏览器处理;
  • response 内容可以为二进制文件、字符串等。

但是AJAX请求不一样:

  • response 会交由 Javascript 处理;
  • response 内容只能接收字符串才能继续处理。

因此,AJAX本身无法触发浏览器的下载功能。

3、解决方案

要在 axios 的 config 配置 responseType: ‘blob’ (非常关键),服务端读取文件,以 content-type: ‘application/octet-stream’ 的格式返回前端,前端接收到数据后使用 Blob 来接收数据,并且创建a标签进行下载。

一个对象的类型取决于 responseType 的值,当值为 “blob”时表示 response 是一个包含二进制数据的 Blob 对象。
在使用 axios 发起请求前,首先了解一下 responseType 这个属性是如何在 axios 中使用的。以 axios 最常用的 get 和 post 请求为例,这两种请求方式在传递参数的时候也是不同的:
在get请求当中,config 是第二个参数,而到了 post 里 config 变成了第三个参数,这是传递 responseType 第一个需要注意的地方。

4、代码实现

后端实现以 express 为例:

// 这里以express举例
const fs = require('fs')
const express = require('express')
const bodyParser = require('body-parser')

const app = express()
app.use(bodyParser.urlencoded({extended: false}))
app.use(bodyParser.json())

// 以post提交举例
app.post('/info/download', function(req, res) {
    const filePath = './myfile/test.zip'
    const fileName = 'test.zip'
    
    res.set({
        'content-type': 'application/octet-stream',
        'content-disposition': 'attachment;filename=' + encodeURI(fileName)
    })

    fs.createReadStream(filePath).pipe(res)
})

app.listen(3000)

前端在使用 axios 请求下载文件 api 接口时,一定要区分不同请求方法的使用,语法如下:

// axios设置reponseType的方式应该类似下面
const url = '/info/download'

// get、delete、head 等请求
axios.get(url, {params: {}, responseType: 'blob'})
    .then((res) => {})
    .catch((err) => {})

// post、put、patch 等请求
axios.post(url, {...params}, {responseType: 'blob'})
    .then((res) => {})
    .catch((err) => {})

前端解析数据流,主要使用 Blob 对象来进行接收,示例代码如下:

// 以之前的post请求举例
axios.post(url, {...someData}, {responseType: 'blob'})
    .then((res) => {
        const { data, headers } = res
        const fileName = headers['content-disposition'].replace(/\w+;filename=(.*)/, '$1')
        // 此处当返回json文件时需要先对data进行JSON.stringify处理,其他类型文件不用做处理
        //const blob = new Blob([JSON.stringify(data)], ...)
        const blob = new Blob([data], {type: headers['content-type']})
        let dom = document.createElement('a')
        let url = window.URL.createObjectURL(blob)
        dom.href = url
        dom.download = decodeURI(fileName)
        dom.style.display = 'none'
        document.body.appendChild(dom)
        dom.click()
        dom.parentNode.removeChild(dom)
        window.URL.revokeObjectURL(url)
    }).catch((err) => {})

如果后台返回的流文件是一张图片的话,前端需要将这张图片直接展示出来,例如登录时的图片验证码,示例代码如下:

axios.post(url, {...someData}, {responseType: 'blob'})
    .then((res) => {
        const { data } = res
        const reader = new FileReader()
        reader.readAsDataURL(data)
        reader.onload = (ev) => {
            const img = new Image()
            img.src = ev.target.result
            document.body.appendChild(img)
        }
    }).catch((err) => {})

总结

到此这篇关于前端使用axios实现下载文件功能的文章就介绍到这了,更多相关axios下载文件功能内容请搜索脚本之家以前的文章或继续浏览下面的相关文章希望大家以后多多支持脚本之家!

相关文章

  • 探究JavaScript中的五种事件处理程序方式

    探究JavaScript中的五种事件处理程序方式

    本篇文章主要介绍了JavaScript中的五种事件处理程序方式,具有一定的参考价值,有需要的可以了解一下。
    2016-12-12
  • JavaScript Promise多并发问题的解决方法详解

    JavaScript Promise多并发问题的解决方法详解

    提起控制并发,大家应该不陌生,这篇文章主要来和大家介绍一下JavaScript如何解决Promise多并发问题,感兴趣的小伙伴可以跟随小编一起学习一下
    2023-09-09
  • 一文了解你不知道的JavaScript生成器篇

    一文了解你不知道的JavaScript生成器篇

    ES6引入了一个新的函数类型,发现它并不符合这种运行到结束的特性。这类新的函数被称为生成器。生成器的出现是我们知道原来有时代码并不会顺利的运行,可以通过暂停的方式进行异步回调,让我们摒弃了此前的认知。本文就来聊聊JavaScript中生成器的相关知识
    2022-11-11
  • js实现简单的放大镜效果

    js实现简单的放大镜效果

    这篇文章主要为大家详细介绍了js实现简单的放大镜效果,可随意更改,放大区域的大小、比例,文中示例代码介绍的非常详细,具有一定的参考价值,感兴趣的小伙伴们可以参考一下
    2021-09-09
  • 在JavaScript中通过URL传递汉字的方法

    在JavaScript中通过URL传递汉字的方法

    在JavaScript中通过URL传递汉字的方法...
    2007-04-04
  • 可浮动QQ在线客服

    可浮动QQ在线客服

    比较漂亮的qq在线客服代码,推荐使用
    2008-10-10
  • JavaScript上传文件时不用刷新页面方法总结(推荐)

    JavaScript上传文件时不用刷新页面方法总结(推荐)

    这篇文章主要介绍了JavaScript上传文件时不用刷新页面方法,用js+css代码详细介绍了操作过程,需要的朋友可以参考下
    2017-08-08
  • JS简易计算器实例讲解

    JS简易计算器实例讲解

    这篇文章主要为大家详细介绍了JS简易计算器实例,文中示例代码介绍的非常详细,具有一定的参考价值,感兴趣的小伙伴们可以参考一下
    2020-06-06
  • 深入了解javascript 数组的sort方法

    深入了解javascript 数组的sort方法

    在javascript中,数组对象有一个有趣的方法sort,它接收一个类型为函数的参数作为排序的依据。这意味着开发者只需要关注如何比较两个值的大小,而不用管排序这件事内部是如何实现的
    2018-06-06
  • Javascript中arguments用法实例分析

    Javascript中arguments用法实例分析

    这篇文章主要介绍了Javascript中arguments用法,实例分析了javascript利用arguments实现模拟重载功能,需要的朋友可以参考下
    2015-06-06

最新评论