【Vue】使用Axios请求下载后端返回的文件流，并能够提示后端报错信息_axios 下载文件-CSDN博客

安宇雨 - 随手采集
2024-06-13 09:57:25
随手采集
0000-未整理-等待研究

【需求】使用Axios请求下载后端返回的文件流，下载失败时提示信息不写死，按照后端返回的信息进行提示。

一、需求分析

看到这个需求的时候，有人可能会很疑惑，这不是直接就能获取到吗，直接message.error()弹框就完事了，有什么问题。
我们先来模拟一下，点击按钮下载文件，请求后端接口，后端返回文件流，前端通常会设置响应类型为blob， responseType: 'blob'，如：

// 下载文件
export function HandleDownLoadFile(params) {
    return request({
        url: '/xxxx/download',
        method: 'get',
        params,
        responseType: 'blob'
    });
}

我们打印响应数据看看是什么，可以发现res.data是一个Blob格式的数据，和正常的格式已经不同了，后端返回的message也获取不到了。

文件流返回示例
正常数据返回示例

二、解决问题

首先我我们先看下请求成功和失败的返回结果有无不同。
请求下载一个文件，请求成功时返回的是一个文件流，type是对应文件类型，例如：text/xml，正常导出文件；而请求失败的时候返回的是json ，type为application/json，不会处理错误信息，而是直接导出包含错误信息的文件。
但是无论成功还是失败，返回的结果都是blob格式的文件流。

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

在这里插入图片描述
在axios响应拦截器中，对二进制数据单独处理，如果type为application/json说明下载失败，那么弹出对应错误信息，然后返回Null，否则下载成功，正常返回res.data。

// 响应拦截器
service.interceptors.response.use(res => {
    ...
    // 二进制数据处理
    if (res.request.responseType === 'blob' || res.request.responseType === 'arraybuffer') {
        if (res.data.type === 'application/json') {
            const reader = new FileReader();
            reader.onload = () => {
            // TODO 错误处理
                this.$message.error(
                    `Error: ${JSON.parse(reader.result).message}！`
                );
            };
            reader.readAsText(res.data);
            return null;
        } else {
            return res.data;
        }
    }
    ...
}

然后在通用下载函数中，首先进行判断，如果file存在，才开始下载操作。

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

关键在于借助FileReader对象实现，FileReader.readAsText(data)开始读取指定的Blob中的内容。一旦完成，result属性中将包含一个字符串以表示所读取的文件内容。
读取操作完成时触发FileReader.onload()，在这里通过reader.result拿到读取的文件内容（即后端返回值），然后对其json序列化，即可拿到后端返回的message，然后进行相应的展示即可。
即下面这段代码：

if (res.data.type === 'application/json') {
    const reader = new FileReader();
    reader.readAsText(res.data);
    reader.onload = () => {
    // TODO 错误处理
        this.$message.error(
            `Error: ${JSON.parse(reader.result).message}！`
        );
    };
    return null;
}

至此，问题解决。