从浏览器下载JSON对象作为文件

时间:2013-11-01 05:42:16

标签: javascript json

我有以下代码让用户下载csv文件中的数据字符串。

exportData = 'data:text/csv;charset=utf-8,';
exportData += 'some csv strings';
encodedUri = encodeURI(exportData);
newWindow = window.open(encodedUri);

如果客户端运行代码,它会生成空白页并开始下载csv文件中的数据,这很正常。

所以我尝试使用像

这样的JSON对象
exportData = 'data:text/json;charset=utf-8,';
exportData += escape(JSON.stringify(jsonObject));
encodedUri = encodeURI(exportData);
newWindow = window.open(encodedUri);

但我只看到一个页面上显示了JSON数据,而不是下载它。

我经历了一些研究和this one声明工作,但我认为我的代码没有任何差别。

我的代码中遗漏了什么?

感谢您阅读我的问题:)

13 个答案:

答案 0 :(得分:159)

这就是我为我的应用程序解决的问题:

HTML:     <a id="downloadAnchorElem" style="display:none"></a>

JS(纯JS,而不是jQuery):

var dataStr = "data:text/json;charset=utf-8," + encodeURIComponent(JSON.stringify(storageObj));
var dlAnchorElem = document.getElementById('downloadAnchorElem');
dlAnchorElem.setAttribute("href",     dataStr     );
dlAnchorElem.setAttribute("download", "scene.json");
dlAnchorElem.click();

在这种情况下,storageObj是您要存储的js对象,“scene.json”只是生成文件的示例名称。

与其他提议的方法相比,这种方法具有以下优点:

  • 不需要点击HTML元素
  • 结果将按您的意愿命名
  • 不需要jQuery

我需要这种行为而不需要明确点击,因为我想在某些时候从js自动触发下载。

JS解决方案(无需HTML):

  function downloadObjectAsJson(exportObj, exportName){
    var dataStr = "data:text/json;charset=utf-8," + encodeURIComponent(JSON.stringify(exportObj));
    var downloadAnchorNode = document.createElement('a');
    downloadAnchorNode.setAttribute("href",     dataStr);
    downloadAnchorNode.setAttribute("download", exportName + ".json");
    document.body.appendChild(downloadAnchorNode); // required for firefox
    downloadAnchorNode.click();
    downloadAnchorNode.remove();
  }

答案 1 :(得分:33)

找到答案。

var obj = {a: 123, b: "4 5 6"};
var data = "text/json;charset=utf-8," + encodeURIComponent(JSON.stringify(obj));

$('<a href="data:' + data + '" download="data.json">download JSON</a>').appendTo('#container');

似乎对我很好。

**所有归功于@ cowboy-ben-alman,他是上述代码的作者**

答案 2 :(得分:23)

这将是一个纯粹的JS版本(改编自牛仔版):

var obj = {a: 123, b: "4 5 6"};
var data = "text/json;charset=utf-8," + encodeURIComponent(JSON.stringify(obj));

var a = document.createElement('a');
a.href = 'data:' + data;
a.download = 'data.json';
a.innerHTML = 'download JSON';

var container = document.getElementById('container');
container.appendChild(a);

http://jsfiddle.net/sz76c083/1

答案 3 :(得分:11)

以下对我有用:

/* function to save JSON to file from browser
* adapted from http://bgrins.github.io/devtools-snippets/#console-save
* @param {Object} data -- json object to save
* @param {String} file -- file name to save to 
*/
function saveJSON(data, filename){

    if(!data) {
        console.error('No data')
        return;
    }

    if(!filename) filename = 'console.json'

    if(typeof data === "object"){
        data = JSON.stringify(data, undefined, 4)
    }

    var blob = new Blob([data], {type: 'text/json'}),
        e    = document.createEvent('MouseEvents'),
        a    = document.createElement('a')

    a.download = filename
    a.href = window.URL.createObjectURL(blob)
    a.dataset.downloadurl =  ['text/json', a.download, a.href].join(':')
    e.initMouseEvent('click', true, false, window, 0, 0, 0, 0, 0, false, false, false, false, 0, null)
    a.dispatchEvent(e)
}

然后像这样调用它

saveJSON(myJsonObject, "saved_data.json");

答案 4 :(得分:9)

您可以尝试使用:

根本不需要处理任何HTML元素。

var data = {
    key: 'value'
};
var fileName = 'myData.json';

// Create a blob of the data
var fileToSave = new Blob([JSON.stringify(data)], {
    type: 'application/json',
    name: fileName
});

// Save the file
saveAs(fileToSave, fileName);

如果你想按照this answer打印JSON,可以使用:

JSON.stringify(data,undefined,2)

答案 5 :(得分:5)

2021 年的 ES6+ 版本;也没有 1MB 的限制:

这是改编自@maia 的版本,针对现代 Javascript 进行了更新,将弃用的 initMouseEvent 替换为 new MouseEvent(),并且代码总体上有所改进:

const saveTemplateAsFile = (filename, jsonToWrite) => {
    const blob = new Blob([jsonToWrite], { type: "text/json" });
    const link = document.createElement("a");

    link.download = filename;
    link.href = window.URL.createObjectURL(blob);
    link.dataset.downloadurl = ["text/json", link.download, link.href].join(":");

    const evt = new MouseEvent("click", {
        view: window,
        bubbles: true,
        cancelable: true,
    });

    link.dispatchEvent(evt);
    link.remove()
};

如果你想传入一个对象:

const myObj = {};
const myObjAsJson = JSON.stringify(myObj);

saveTemplateAsFile(myObjAsJson);

答案 6 :(得分:4)

链接的download属性是新的,Internet Explorer不支持(请参阅兼容性表here)。对于此问题的跨浏览器解决方案,我将查看FileSaver.js

答案 7 :(得分:4)

我最近不得不创建一个按钮,可以下载大型表格的所有值的json文件。我需要这个与IE / Edge / Chrome一起使用。这就是我所做的:

function download(text, name, type)
    {
        var file = new Blob([text], {type: type});
        var isIE = /*@cc_on!@*/false || !!document.documentMode;
        if (isIE)
        {
            window.navigator.msSaveOrOpenBlob(file, name);
        }
        else
        {
            var a = document.createElement('a');
            a.href = URL.createObjectURL(file);
            a.download = name;
            a.click();
        }
     }

download(jsonData, 'Form_Data_.json','application/json');

边缘有文件名和扩展名存在一个问题,但在撰写本文时,这似乎是Edge修复的错误。

希望这有助于某人

答案 8 :(得分:4)

简单,干净的解决方案,适用于仅针对现代浏览器的用户:

function downloadTextFile(text, name) {
  const a = document.createElement('a');
  const type = name.split(".").pop();
  a.href = URL.createObjectURL( new Blob([text], { type:`text/${type === "txt" ? "plain" : type}` }) );
  a.download = name;
  a.click();
}

downloadTextFile(JSON.stringify(myObj), 'myObj.json');

答案 9 :(得分:1)

尝试设置另一种MIME类型: exportData = 'data:application/octet-stream;charset=utf-8,';

但是在保存对话框中可能存在文件名问题。

答案 10 :(得分:1)

反应:将其添加到渲染方法中所需的位置。

•对象状态

<a
  className="pull-right btn btn-primary"
  style={{ margin: 10 }}
  href={`data:text/json;charset=utf-8,${encodeURIComponent(
  JSON.stringify(this.state.objectToDownload)
  )}`}
  download="data.json"
>
  DOWNLOAD DATA AS JSON
</a>

•道具中的对象

<a
  className="pull-right btn btn-primary"
  style={{ margin: 10 }}
  href={`data:text/json;charset=utf-8,${encodeURIComponent(
  JSON.stringify(this.props.objectToDownload)
  )}`}
  download="data.json"
>
  DOWNLOAD DATA AS JSON
</a>

className和style是可选的,请根据需要修改样式。

答案 11 :(得分:0)

如果您更喜欢控制台代码片段,而不是文件名,则可以执行以下操作:

window.open(URL.createObjectURL(
    new Blob([JSON.stringify(JSON)], {
      type: 'application/binary'}
    )
))

答案 12 :(得分:0)

    downloadJsonFile(data, filename: string){
        // Creating a blob object from non-blob data using the Blob constructor
        const blob = new Blob([JSON.stringify(data)], { type: 'application/json' });
        const url = URL.createObjectURL(blob);
        // Create a new anchor element
        const a = document.createElement('a');
        a.href = url;
        a.download = filename || 'download';
        a.click();
        a.remove();
      }

您可以使用Blob轻松自动下载文件,并在第一个参数downloadJsonFile中进行传输。 文件名是您要设置的文件名。