如何在react为文件中下载获取响应

IT技术 javascript reactjs flux reactjs-flux
2021-03-15 17:46:59

这里是代码 actions.js

export function exportRecordToExcel(record) {
    return ({fetch}) => ({
        type: EXPORT_RECORD_TO_EXCEL,
        payload: {
            promise: fetch('/records/export', {
                credentials: 'same-origin',
                method: 'post',
                headers: {'Content-Type': 'application/json'},
                body: JSON.stringify(data)
            }).then(function(response) {
                return response;
            })
        }
    });
}

返回的响应是一个.xlsx文件。我希望用户能够将其保存为文件,但没有任何react。我假设服务器正在返回正确类型的响应,因为在控制台中它说

Content-Disposition:attachment; filename="report.xlsx"

我错过了什么?减速机应该怎么做?

6个回答

浏览器技术目前不支持直接从 Ajax 请求下载文件。解决方法是添加一个隐藏的表单并在后台提交它以使浏览器触发“保存”对话框。

我正在运行一个标准的 Flux 实现,所以我不确定确切的 Redux(Reducer)代码应该是什么,但我刚刚为文件下载创建的工作流程是这样的......

  1. 我有一个名为FileDownload. 这个组件所做的就是渲染一个隐藏的表单,然后在里面componentDidMount,立即提交表单并调用它的onDownloadCompleteprop。
  2. 我有另一个 React 组件,我们称之为Widget,带有一个下载按钮/图标(实际上很多......一个表格中的每个项目)。Widget有相应的动作和存储文件。Widget进口FileDownload
  3. Widget有两种与下载相关的方法:handleDownloadhandleDownloadComplete
  4. Widgetstore 有一个名为downloadPath. null默认设置为当它的值设置为 时null,没有正在进行的文件下载并且Widget组件不会呈现FileDownload组件。
  5. 单击中的按钮/图标Widget调用handleDownload触发downloadFile操作方法downloadFile操作不会发出 Ajax 请求。它将DOWNLOAD_FILE事件分派到商店,并随它一起发送downloadPath要下载的文件。商店保存downloadPath并发出更改事件。
  6. 由于现在有一个downloadPath,Widget将渲染FileDownload传递必要的props,包括downloadPath以及handleDownloadComplete方法作为 的值onDownloadComplete
  7. FileDownload呈现并提交表单时method="GET"(POST 也应该工作) and action={downloadPath},服务器响应现在将触发浏览器的目标下载文件的保存对话框(在 IE 9/10、最新的 Firefox 和 Chrome 中测试)。
  8. 紧跟在表单提交之后,onDownloadComplete/handleDownloadComplete被调用。这会触发另一个调度DOWNLOAD_FILE事件的操作。但是,该时间downloadPath设置为null商店将其另存downloadPathnull并发出更改事件。
  9. 由于不再存在不渲染downloadPathFileDownload组件Widget,因此世界是一个快乐的地方。

Widget.js - 仅部分代码

import FileDownload from './FileDownload';

export default class Widget extends Component {
    constructor(props) {
        super(props);
        this.state = widgetStore.getState().toJS();
    }

    handleDownload(data) {
        widgetActions.downloadFile(data);
    }

    handleDownloadComplete() {
        widgetActions.downloadFile();
    }

    render() {
        const downloadPath = this.state.downloadPath;

        return (

            // button/icon with click bound to this.handleDownload goes here

            {downloadPath &&
                <FileDownload
                    actionPath={downloadPath}
                    onDownloadComplete={this.handleDownloadComplete}
                />
            }
        );
    }

widgetActions.js - 仅部分代码

export function downloadFile(data) {
    let downloadPath = null;

    if (data) {
        downloadPath = `${apiResource}/${data.fileName}`;
    }

    appDispatcher.dispatch({
        actionType: actionTypes.DOWNLOAD_FILE,
        downloadPath
    });
}

widgetStore.js - 仅部分代码

let store = Map({
    downloadPath: null,
    isLoading: false,
    // other store properties
});

class WidgetStore extends Store {
    constructor() {
        super();
        this.dispatchToken = appDispatcher.register(action => {
            switch (action.actionType) {
                case actionTypes.DOWNLOAD_FILE:
                    store = store.merge({
                        downloadPath: action.downloadPath,
                        isLoading: !!action.downloadPath
                    });
                    this.emitChange();
                    break;

FileDownload.js
- 准备好复制和粘贴的完整、功能齐全的代码
- React 0.14.7 with Babel 6.x ["es2015", "react", "stage-0"]
- 表单需要display: none是“隐藏的” "className是为了

import React, {Component, PropTypes} from 'react';
import ReactDOM from 'react-dom';

function getFormInputs() {
    const {queryParams} = this.props;

    if (queryParams === undefined) {
        return null;
    }

    return Object.keys(queryParams).map((name, index) => {
        return (
            <input
                key={index}
                name={name}
                type="hidden"
                value={queryParams[name]}
            />
        );
    });
}

export default class FileDownload extends Component {

    static propTypes = {
        actionPath: PropTypes.string.isRequired,
        method: PropTypes.string,
        onDownloadComplete: PropTypes.func.isRequired,
        queryParams: PropTypes.object
    };

    static defaultProps = {
        method: 'GET'
    };

    componentDidMount() {
        ReactDOM.findDOMNode(this).submit();
        this.props.onDownloadComplete();
    }

    render() {
        const {actionPath, method} = this.props;

        return (
            <form
                action={actionPath}
                className="hidden"
                method={method}
            >
                {getFormInputs.call(this)}
            </form>
        );
    }
}
这导致我重定向。感觉自己很白痴o_O
2021-04-21 17:46:59
@nate 可以将标题信息与此表单提交打包在一起吗?
2021-05-06 17:46:59
这个例子很有帮助,但我仍然不清楚这个实现是如何知道文件是否已经下载的。我看到“onDownloadComplete”在提交后被同步调用,您是否只是假设没有任何错误并且服务器收到请求?
2021-05-11 17:46:59
@Himmel 是的,遗憾的是,这项工作没有提供确认文件下载成功的方法。一种可能的解决方案是在下载之前发送 Ajax 请求(在 Widget.js 中)以确认服务器响应对下载文件路径的 GET 请求。然后,如果成功,则触发下载。您仍然没有确认下载是否成功,但如果该文件不存在或当时存在某种网络错误,您可以处理该错误。您可能还想考虑将表单放入 iframe 并使用 onload 事件读取 iframe 的内容。
2021-05-14 17:46:59
@charlie 这是一个标准的 HTML 表单提交。您可以使用该enctype属性来指定 Content-Type HTTP 标头的三个不同值,但仅此而已。MDN 上发送表单数据页面可能会有所帮助。查看标题为特殊情况:发送文件的部分我们有一个用例,我们首先发送一个 Ajax 请求来生成一个下载文件,然后我们下载。如果您可以使用该选项,您将可以更好地控制 Ajax 请求中的标头。
2021-05-21 17:46:59

您可以使用这两个库下载文件http://danml.com/download.html https://github.com/eligrey/FileSaver.js/#filesaverjs

例子

//  for FileSaver
import FileSaver from 'file-saver';
export function exportRecordToExcel(record) {
      return ({fetch}) => ({
        type: EXPORT_RECORD_TO_EXCEL,
        payload: {
          promise: fetch('/records/export', {
            credentials: 'same-origin',
            method: 'post',
            headers: {'Content-Type': 'application/json'},
            body: JSON.stringify(data)
          }).then(function(response) {
            return response.blob();
          }).then(function(blob) {
            FileSaver.saveAs(blob, 'nameFile.zip');
          })
        }
      });

//  for download 
let download = require('./download.min');
export function exportRecordToExcel(record) {
      return ({fetch}) => ({
        type: EXPORT_RECORD_TO_EXCEL,
        payload: {
          promise: fetch('/records/export', {
            credentials: 'same-origin',
            method: 'post',
            headers: {'Content-Type': 'application/json'},
            body: JSON.stringify(data)
          }).then(function(response) {
            return response.blob();
          }).then(function(blob) {
            download (blob);
          })
        }
      });
感谢分享这个。downloadjs很好用,完美解决了问题。
2021-05-15 17:46:59

我也遇到过同样的问题。我已经通过在空链接上创建一个引用来解决它,如下所示:

linkRef = React.createRef();
render() {
    return (
        <a ref={this.linkRef}/>
    );
}

在我的 fetch 函数中,我做了这样的事情:

fetch(/*your params*/)
    }).then(res => {
        return res.blob();
    }).then(blob => {
        const href = window.URL.createObjectURL(blob);
        const a = this.linkRef.current;
        a.download = 'Lebenslauf.pdf';
        a.href = href;
        a.click();
        a.href = '';
    }).catch(err => console.error(err));

基本上,我已将 blob url(href) 分配给链接,设置下载属性并强制单击链接。据我所知,这是@Nate 提供的答案的“基本”想法。我不知道这样做是否是个好主意……我做到了。

伙计!你刚刚节省了我 2 天的搜索努力......这就是我正在寻找的答案
2021-05-19 17:46:59

这对我有用。

const requestOptions = {
method: 'GET',
headers: { 'Content-Type': 'application/json' }
};

fetch(`${url}`, requestOptions)
.then((res) => {
    return res.blob();
})
.then((blob) => {
    const href = window.URL.createObjectURL(blob);
    const link = document.createElement('a');
    link.href = href;
    link.setAttribute('download', 'config.json'); //or any other extension
    document.body.appendChild(link);
    link.click();
    document.body.removeChild(link);
})
.catch((err) => {
    return Promise.reject({ Error: 'Something Went Wrong', err });
})

我设法使用这种在本地运行良好的代码更轻松地下载了由其余 API URL 生成的文件:

    import React, {Component} from "react";
    import {saveAs} from "file-saver";

    class MyForm extends Component {

    constructor(props) {
        super(props);
        this.handleSubmit = this.handleSubmit.bind(this);
    }

    handleSubmit(event) {
        event.preventDefault();
        const form = event.target;
        let queryParam = buildQueryParams(form.elements);

        let url = 'http://localhost:8080/...whatever?' + queryParam;

        fetch(url, {
            method: 'GET',
            headers: {
                // whatever
            },
        })
            .then(function (response) {
                    return response.blob();
                }
            )
            .then(function(blob) {
                saveAs(blob, "yourFilename.xlsx");
            })
            .catch(error => {
                //whatever
            })
    }

    render() {
        return (
            <form onSubmit={this.handleSubmit} id="whateverFormId">
                <table>
                    <tbody>
                    <tr>
                        <td>
                            <input type="text" key="myText" name="myText" id="myText"/>
                        </td>
                        <td><input key="startDate" name="from" id="startDate" type="date"/></td>
                        <td><input key="endDate" name="to" id="endDate" type="date"/></td>
                    </tr>
                    <tr>
                        <td colSpan="3" align="right">
                            <button>Export</button>
                        </td>
                    </tr>

                    </tbody>
                </table>
            </form>
        );
    }
}

function buildQueryParams(formElements) {
    let queryParam = "";

    //do code here
    
    return queryParam;
}

export default MyForm;
完美的解决方案
2021-05-07 17:46:59