使用JavaScript下载csv文件

前端可以使用JavaScript在客户端下载包含页面数据的文件,这里以下载CSV格式文件为例,代码如下:

function downloadData(data, filename, type) {
    var file = new Blob(["\ufeff" + data], { type: type });
    if (window.navigator.msSaveOrOpenBlob)
      // IE10+
      window.navigator.msSaveOrOpenBlob(file, filename);
    else {
      // Others
      var a = document.createElement("a"),
        url = URL.createObjectURL(file);
      a.href = url;
      a.download = filename;
      document.body.appendChild(a);
      a.click();
      setTimeout(function() {
        document.body.removeChild(a);
        window.URL.revokeObjectURL(url);
      }, 0);
    }
  }

让我们解释一下这段代码:

(一)downloadData 函数

首先,downloadData函数接收三个参数:

  1. data:需要下载的数据(注意数据格式需要符合csv格式规范);
  2. filename:需要下载的文件名,注意需要添加符合数据格式的文件名的后缀,这提示了操作系统应该以何种方式打开;
  3. type:代表了将会被放入到Blob对象中的数组内容的MIME类型;

(二)Blob 构造函数

接着,我们来解析下面这条语句:

var file = new Blob(["\ufeff" + data], { type: type });

可以看到,我们使用了Blob构造函数,创建了一个Blob实例对象fileBlob构造函数有什么用呢?它接收的两个参数是什么?让我们在下面一一作答:

① Blob 构造函数的作用

Blob构造函数会根据传入的数组参数构造出一个新的Blob对象实例,该对象实例的值由以下两步生成:

  1. Blob构造函数会将第一个参数,即一个数组内的所有值串联起来;
  2. Blob会将被串联的值转换为二进制编码的数据然后返回;

注意,Blob对象实例的值是不可变的,它只有两个只读的属性:size:表示对象中所包含数据的大小(单位是字节),以及type:值是一个字符串,表示该对象实例所包含数据的MIME类型(即我们传入Blob构造函数的第二个参数中指定的type值,默认为"")。

② Blob 构造函数接收的参数

Blob构造函数接收的第一个参数为数组类型,数组内的所有值会在实例化时被串联。若传入数组的值中有DOMString类型的值,则会被编码为UTF-8格式。而为了让导出的CSV格式文件在Excel中打开时,中文不出现乱码,需要在数组的首位添加一个BOM(Byte Order Mark “字节次序标记”)头\ufeff

BOM是一个不可见的字符,它是ES5新增的空白符,在Unicode3.2之前,\uFEFF表示“零宽不换行空格(Zero Width No-Break Space)”,但在Unicode3.2之后,新增了\u2060表示零宽不换行空格,\uFEFF就只用来表示字节次序的标记了。而在Microsoft中,其记事本程序发明了一种UTF-8变体(Python 2.5称为“utf-8-sig”)以提高可检测到UTF-8编码的可靠性,该编码要求在任何Unicode字符被写入之前都需要编写一个UTF-8编码的BOM(看起来像是一个字节序列:0xef,0xbb,0xbf)。

Blob构造函数接收的第二个参数是一个对象,该对象有以下两个属性:

  1. type:默认值为"",它表示第一个参数内,数组内容的MIME类型;
  2. options:这个属性目前还没有被很好的支持,所以不用管它;

总之,我们通过new Blob()获得了一个Blob类型的二进制文件。


(三)下载文件

接着我们要做的便是下载我们生成好的文件了,有两种方式,第一种方式最简单,因为IE浏览器直接提供了下载文件的接口window.navigator.msSaveOrOpenBlob(file, filename);,正如函数签名所示,我们只需要向函数中传入我们生成好的二进制文件,以及文件名就可以让浏览器自动下载文件了。

抛下IE浏览器,要实现文件下载就稍微麻烦些,我们需要通过创建一个a标签,并模拟点击这个a标签实现文件下载,让我们将与之相关的代码贴在下面:

var a = document.createElement("a"),
     url = URL.createObjectURL(file);
a.href = url;
a.download = filename;
document.body.appendChild(a);
a.click();
setTimeout(function() {
  document.body.removeChild(a);
  window.URL.revokeObjectURL(url);
}, 0);

注意这段代码的第二行,我们会发现一个新的API:URL.createObjectURL()函数,这个函数接收一个参数,一个Blob对象,并为该对象生成一个指向该对象的URL对象,需要注意的是只要当下文档没有被关闭,该URL对象就会一直存储在内存中不会被回收,因此一旦确定不再需要该URL对象,一定要及时使用URL.revokeObjectURL()清理。

以上,我们就解释了在前端以CSV格式下载数据的方法和原理,需要注意的是,该段代码只适用于IE10及以上的现代浏览器,因为无论是Blob构造函数还是URL.createObjectURL()API都只有这些浏览器提供支持。

时间: 2024-08-29 06:52:01

使用JavaScript下载csv文件的相关文章

利用php CI force_download($filename, $data) 下载.csv 文件解决文件名乱码,文件内容乱码

利用php CI force_download($filename, $data) 下载.csv 文件解决文件名乱码,文件内容乱码.做了很久终于知道了很好的解决方案. 1.加载辅助函数 $this->load->helper('download'); //下载辅助函数 $this->load->helper('string'); //字符编码转换辅助翻书 2.force_download($filename, $data)通过它的代码可以知道$data 必须是字符串,如果不是字符串

下载CSV文件到本机(SAP_CONVERT_TO_TEX_FORMAT)

CSV文件是逗号分隔符格式的文件.将内表数据下载成CSV文件到本机上要先将内表中的数据通过函数SAP_CONVERT_TO_TEX_FORMAT转换成CSV格式,然后再下载到本机. REPORT z_download_csv. TYPE-POOLS: truxs. *&---------------------------------------------------------------------* *& Data Types *&---------------------

108.生成和下载csv文件

生成CSV文件 有时候我们做的网站,需要将一些数据,生成一个csv文件返回浏览器,并且是作为附件的形式下载下来. 生成小的csv文件: 生成一个小的csv文件,我们用Python内置的csv模块来处理csv文件,并且使用HttpResponse来将csv文件返回回去.==采用python内置的csv模块创建csv文件示例代码如下:== from .models import User import csv from django.template import loader, Context d

JavaScript实现csv文件的导出[不兼容IE]

直接上代码: <!DOCTYPE html> <html lang="en" xmlns="http://www.w3.org/1999/xhtml">     <head>         <meta charset="utf-8" />         <title>javascript</title>         <meta name="genera

108:生成和下载csv文件

生成CSV文件: 有时候我们做的网站,需要将一些数据,生成有一个CSV文件给浏览器,并且是作为附件的形式下载下来.以下将讲解如何生成CSV文件. 生成小的CSV文件: 这里将用一个生成小的CSV文件为例,来把生成CSV文件的技术要点讲到位.我们用Python内置的csv模块来处理csv文件,并且使用HttpResponse来将csv文件返回回去.示例代码如下: from django.http import HttpResponse, JsonResponse import json, csv

将php数据下载csv文件

<?php $sales = array( array( 'Northeast', '2005-01-01', '2005-02-01', 12.54 ), array( 'Northwest', '2005-01-01', '2005-02-01', 546.33 ), array( 'Southeast', '2005-01-01', '2005-02-01', 93.26 ), array( 'Southeast', '2005-01-01', '2005-02-01', 945.21 )

js操作一般文件和csv文件

js操作一般文件和csv文件 将文本文件读成字符串 <input type="file" id="upload"> document.getElementById("upload").addEventListener("change", function() { var files = this.files; if(files.length == 0) { console.log("没有文件")

使用PHP生成并导出CSV文件

CSV文件是以纯文本形式存储的,一般以逗号为分隔符.这里主要简单介绍下如何导出CSV文件. 一.浏览器导出CSV文件格式 /** * 导出CSV文件 */ function exportCsv() { // 需要导出的内容 $data = [ ['name' => '张三', 'score' => '80'], ['name' => '李四', 'score' => '90'], ['name' => '王五', 'score' => '60'], ]; // 文件名,

如何用 JavaScript 下载文件

简介 我们知道,下载文件是一个非常常见的需求,但由于浏览器的安全策略的限制,我们通常只能通过一个额外的页面,访问某个文件的 url 来实现下载功能,但是这种用户体验非常不好.幸好,HTML 5 里面为 <a> 标签添加了一个 download 的属性,我们可以轻易的利用它来实现下载功能,再也不需要用以前的笨办法了. 原理 我们先看看 download 的使用方法: <a href="http://somehost/somefile.zip" download=&quo