Resumen de la implementación front-end de la descarga de archivos (incluidas las descargas de paquetes comprimidos)

El método de descarga predeterminado y más simple es: window.open (ruta API de la interfaz backend) , pero este método tiene desventajas: debido a que es un nuevo método de apertura de ventana, la pantalla frontal parpadeará cada vez.

Además, si utiliza el método window.open (URL de archivo):

• PDF, documentos office, psd: descarga directa.
• Imágenes y texto: al obtener una vista previa en una nueva ventana, no se descargarán; y cuando se obtiene una vista previa del texto, a veces aparecen caracteres chinos confusos.

1. Descargar según la URL del archivo

Principio de implementación: descarga a través de una etiqueta.

/**
 * @method 下载单个文件（文件类型可任意：.png、txt、office文档、.psd等）
 * @param { String } url - 文件的http完整路径, 如：http: //xxx.png
 * @param { String } fileName - 文件名，注意是要带文件后缀名，如：xxx.png
 * @doc https://blog.csdn.net/weixin_39547158/article/details/110851570
 */
export function downloadFile(url: string, fileName: string) {
  return new Promise((resolve, reject) => {
    const xhr = new XMLHttpRequest();
    xhr.open('GET', url, true);
    xhr.responseType = 'blob';
    xhr.upload.onprogress = (e) => {
      if (e.lengthComputable) {
        let progress = e.loaded / e.total;
        console.log('文件上传进度是', progress);
      }
    };
    xhr.onload = function () {
      const url = window.URL.createObjectURL(xhr.response);
      const eleLink = document.createElement('a');
      eleLink.href = url;
      eleLink.download = `${fileName}`;
      eleLink.style.display = 'none';
      document.body.appendChild(eleLink);
      eleLink.click();
      document.body.removeChild(eleLink);
      resolve('success');
    };
    xhr.onerror = (e) => {
      console.log('请求错误回调', e);
      message.warning('下载文件失败')
      reject(e);
    };
    xhr.send();
  });
}

2. Archivo de Excel: llame a la interfaz en segundo plano para devolver el flujo del archivo y el front-end descarga el archivo.

Principio de implementación: llame a la interfaz de backend y devuelva el blob, y el front-end utiliza la biblioteca de ahorro de archivos para implementar la descarga.

// 下载excel文件
import { saveAs } from 'file-saver';

const downloadTemplate = async () => {
  try {
    const params = { ... } // 传参
    const res = await generateDownStreamReconciliationUsingGET(params);
    // res为返回结果
    if (res) {
      const blob = new Blob([res], { type: 'application/vnd.ms-excel' });
      FileSaver.saveAs(blob, '对账单.xlsx');
      console.log('对账单下载成功')
    }
  } catch (e) {
    console.log(e);
  } finally {
    console.log('finally')
  }
};

// 生成对账excel模板表格API
export async function generateDownStreamReconciliationUsingGET(
  params: API.generateDownStreamReconciliationUsingGETParams,
  options?: { [key: string]: any },
) {
  return request<any>(
    `${process.env.APP_HOST_WAYBILL}/xxx/generateDownStreamReconciliation`,
    {
      method: 'GET',
      responseType: 'blob',  // 必须写该行，否则：后台返回的是string，不是blob且文件下载后，会出现打不开问题。
      params: {
        ...params,
      },
      ...(options || {}),
    },
  );
}

3. Descarga de URL de varios archivos, descarga de paquetes comprimidos generados por el front-end

Principio de implementación: biblioteca jszip + biblioteca de ahorro de archivos

import { getBlobOfUrl } from '@/services/common';
import { saveAs } from 'file-saver';
import JSZip from 'jszip';
import { message } from 'antd';

/**
 * @method 同时下载多文件,并生成一个压缩包
 * @param { Object[] } fileInfoList - 文件列表
 * @param { String } urlField - 文件URL的字段名
 * @param { String } fileNameField - 文件名的字段名
 * @param { String } folderName - 压缩包 & 文件夹名称
 */
export function downloadAsZip(
  fileInfoList: any[],
  folderName = '文件压缩包',
  urlField = 'filePath',
  fileNameField = 'name',
) {
  return new Promise((resolve, reject) => {
    const zip = new JSZip();
    // const folder = zip.folder(folderName); // 创建文件夹
    const promisesList = fileInfoList.map((item) => {
      return getBlobOfUrl(item[urlField])
        .then((data) => {
          // console.log(data); // Blob
          // folder.file(item[fileNameField], data, { binary: true }); // 往文件夹中存放文件
          zip.file(item[fileNameField], data, { binary: true }); // 不创建文件夹
        })
        .catch((e) => {
          console.log(e);
          message.warning(e?.message || '获取文件流失败')
        });
    });
    Promise.all(promisesList)
      .then(() => {
        zip
          .generateAsync({ type: 'blob' })
          .then((content) => {
            saveAs(content, folderName);
            resolve('success');
          })
          .catch((e) => {
            message.warning(e?.message || '生成压缩包失败')
            reject(e);
          });
      })
      .catch((e) => {
        message.warning(e?.message || '批量获取文件流失败')
        reject(e);
      });
  });
}

import { request } from 'umi';

/**
 * @method 根据文件URL获取blob数据流的API
 * @param { String } fileUrl - 文件完整路径，如：http://xxx.png
 */
export function getBlobOfUrl(fileUrl: string) {
  return request(fileUrl, {
    method: 'GET',
    responseType: 'blob', // 设置后台返回的内容类型为blob
    params: {
      notAuthorization: true,
    },
  });
}