• JS前端创建CSV或Excel文件并浏览器导出下载


    长期以来,在做文件下载功能的时候都是前端通过ajax把需要生成的文件的内容参数传递给后端,后端通过Java语言将文件生成在服务器,然后返回一个文件下载的连接地址url。前端通过location.href = url或者window.open(url),完成文件的下载。

    前端似乎在这个过程中没有产生什么较大的作用,无非是发送请求和打开页面的作用。以前就在寻找这样的文件下载方式,今天终于在业务需要的压力下找到了对应的解决方案。

    HTML与文件下载

    如果希望在前端直接出发某些资源的下载,最方便快捷的方法就是使用HTML5原生的download属性, 例如:

    <a href="large.jpg" download>下载</a>

    但显然,如果纯粹利用HTML属性来实现文件的下载(而不是浏览器打开或浏览),对于动态内容,就无能为力。

    例如,我们对于页面进行分享的时候,希望分享图片是页面内容的实时截图,此时,这个图片就是动态的,纯HTML显然无法满足我们的需求,借助JS和其他一些HTML5特性,例如,将页面元素转换到canvas上,然后在转成图片进行下载。

    单只是完成图片的下载不能满足日常业务的需求,对于业务需求是远远不够的。

    借助HTML5 Blob实现文本信息文件下载

    如果对Blob不了解,可以先看看张鑫旭的理解DOMString、Document、FormData、Blob、File、ArrayBuffer数据类型一文。

    原理其实很简单,我们可以将文本或者JS字符串借助Blob转换成二进制,然后,作为a元素的href属性,配合download属性,实现下载。

    代码也比较简单,如下示例(兼容Chrome和FireFox):

    var funDownload = function(content, filename){
        // 创建隐藏的可下载链接
        var eleLink = document.createElement('a');
        eleLink.download = filename;
        eleLink.style.display = 'none';
        // 字符内容转变成blob地址
        var blob = new Blob([content]);
        eleLink.href = URL.createObjectURL(blob);
        // 触发点击
        document.body.appendChild(eleLink);
        eleLink.click();
        // 然后移除
        document.body.removeChild(eleLink);
    };

    其中,content指需要下载的文本或者字符串内容,filename指下载到系统中的文件名称。

    借助Base64实现任一文件下载

    对于非文本文件,也是可以直接JS触发下载的,例如,如果我们想下载一张图片,可以把这张图片转换成Base64格式,然后下载。

    代码示例:

    var funDownload = function(domImg, filename){
        // 创建隐藏的可下载链接
        var eleLink = document.createElement('a');
        eleLink.download = filename;
        eleLink.style.display = 'none';
        // 图片base64地址
        var canvas = document.createElement('canvas');
        var context = canvas.getContext('2d');
        var width = domImg.natureWidth;
        var height = domImg.natureHeight;
        context.drawImage(domImg, 0, 0);
        // 如果是PNG图片,则context.toDataURL('image/png');
        eleLink.href = context.toDataURL('image/jpeg');
        // 触发点击
        document.body.appendChild(eleLink);
        eleLink.click();
        // 移除
        document.body.removeChild(eleLink);
    };

    不止是.html文件,.txt,.json等只要内容是文本的文件,都可以利用这种小技巧实现下载。

    在Chrome浏览器下,模拟点击创建的a元素及时不append到页面中,也是可以触发下载的,但是在FireFox浏览器中却不行,因此,上面的funcDownload()方法有一个appendChild和removeChild的处理,就是为了兼容FireFox浏览器。

    继续说实现在下CSV文件的方法

    我们通过ajax从后端请求到的数据一般都是json格式,也就是说需要把json数据转成csv格式的数据,经过寻找终于找到了一个比较好用的json转csv的工具

    直接上示例代码:

    <!DOCTYPE html>
    <html>
    <head>
        <meta charset="utf-8">
        <meta http-equiv="X-UA-Compatible" content="IE=edge">
        <title>Download</title>
        <link rel="stylesheet" href="">
    </head>
    <body>
        <div class="demo">
            <p><input type="button" value="作为test.html文件下载"></p>
        </div>
        <script src="json2csv.js" type="text/javascript" charset="utf-8"></script>
        <script type="text/javascript" charset="utf-8">
            // 示例数据
            var fields = ['car', 'price', 'color'];
            var myCars = [
              {
                "car": "Audi",
                "price": 40000,
                "color": "blue"
              }, {
                "car": "BMW",
                "price": 35000,
                "color": "black"
              }, {
                "car": "Porsche",
                "price": 60000,
                "color": "green"
              }
            ];
            // json数据转csv格式
            var csv = json2csv({ data: myCars, fields: fields });
    
            var eleButton = document.querySelector('input[type="button"]');
    
            // 下载文件方法
            var funDownload = function (content, filename) {
                var eleLink = document.createElement('a');
                eleLink.download = filename;
                eleLink.style.display = 'none';
                // 字符内容转变成blob地址
                var blob = new Blob([content]);
                eleLink.href = URL.createObjectURL(blob);
                // 触发点击
                document.body.appendChild(eleLink);
                eleLink.click();
                // 然后移除
                document.body.removeChild(eleLink);
            };
    
            if ('download' in document.createElement('a')) {
                // 作为test.html文件下载
                eleButton.addEventListener('click', function () {
                    funDownload(csv, 'test.csv');    
                });
            } else {
                eleButton.onclick = function () {
                    alert('浏览器不支持');    
                };
            }
        </script>
    </body>
    </html>

    其中的json2csv.js文件可以在这里下载,或者获取源码

    内容参考来源

    1.下载功能主要参考张鑫旭的博客中的一片文章:小tip:JS前端创建html或json文件并浏览器导出下载

    2.json2cav的代码参考来源为:https://github.com/zemirco/json2csv

    image

  • 相关阅读:
    为什么要选择忍者站群?
    SDCMS1.31 如何发布?
    强大的忍者站群
    出现未能加载“OpenWebKitSharp”是什么原因?
    wordpress发布模块如何使用?
    忍者站群做了百度竞价,岂不是跟站群相违背吗?
    点点博客的发布模块,如何使用?
    为什么有时候明明提示登陆成功,却无法获取分类或无法发布?
    被百度K了,怎么办?
    笔记0611
  • 原文地址:https://www.cnblogs.com/webbest/p/8080873.html
Copyright © 2020-2023  润新知