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

本文介绍了如何在前端处理点击按钮下载文件的需求,包括使用axios请求后端接口、处理文件流、正确识别并处理后端返回的错误信息,以及利用FileReader解析JSON错误。还提到了在响应拦截器中判断文件类型以提供不同的下载行为。
摘要由CSDN通过智能技术生成

需求:点击按钮下载文件,请求后端接口,后端返回文件流,如果遇到错误信息并不能简单的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;
     }
  }
 ...
}

  1. 点击按钮下载
  const handleDown = () => {
    const fileName = 'xxxx'
    const file = await logsDownload(params)
    if (file) {
     download(fileName, 'txt', file)
     ElMessage.success('下载成功')
    }
  }
  • 11
    点赞
  • 5
    收藏
    觉得还不错? 一键收藏
  • 0
    评论
前端下载 Excel 文件后端需要返回文件,可以按照以下步骤进行处理: 1. 后端根据前端请求参数,生成 Excel 文件,并将文件返回前端。 2. 前端通过 AJAX 发送请求请求后端生成 Excel 文件的接口。 3. 后端在接收到请求后,使用相关的库(如 Apache POI)生成 Excel 文件,并将文件返回前端。 4. 前端在接收到后端返回文件后,使用 Blob 对象创建一个 URL,并将该 URL 赋给一个 a 标签的 href 属性。 5. 前端再使用 JavaScript 触发该 a 标签的 click 事件,即可下载 Excel 文件。 以下是一个示例的后端代码,使用了 Spring Boot 和 Apache POI 库: ```java @GetMapping("/downloadExcel") public ResponseEntity<byte[]> downloadExcel() throws IOException { // 创建 Excel 工作簿 Workbook workbook = new XSSFWorkbook(); Sheet sheet = workbook.createSheet("Sheet1"); // 创建表头 Row header = sheet.createRow(0); header.createCell(0).setCellValue("姓名"); header.createCell(1).setCellValue("年龄"); // 创建数据行 Row dataRow = sheet.createRow(1); dataRow.createCell(0).setCellValue("张三"); dataRow.createCell(1).setCellValue(20); // 将 Excel 文件写入字节数组输出 ByteArrayOutputStream outputStream = new ByteArrayOutputStream(); workbook.write(outputStream); // 设置响应头 HttpHeaders headers = new HttpHeaders(); headers.add("Content-Disposition", "attachment;filename=test.xlsx"); headers.setContentType(MediaType.APPLICATION_OCTET_STREAM); // 返回响应实体 return new ResponseEntity<>(outputStream.toByteArray(), headers, HttpStatus.OK); } ``` 在前端中,可以使用以下代码实现下载: ```javascript axios.get('/downloadExcel', { responseType: 'blob' }).then(res => { const blob = new Blob([res.data], { type: 'application/vnd.ms-excel' }) const url = URL.createObjectURL(blob) const a = document.createElement('a') a.href = url a.download = 'test.xlsx' a.click() URL.revokeObjectURL(url) }) ```

“相关推荐”对你有帮助么?

  • 非常没帮助
  • 没帮助
  • 一般
  • 有帮助
  • 非常有帮助
提交
评论
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

当前余额3.43前往充值 >
需支付:10.00
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明:

1.余额是钱包充值的虚拟货币,按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载,可以购买VIP、付费专栏及课程。

余额充值