填坑:前端导出csv文件

在前后端分离的情况下,通常前端浏览器提供用户文件下载的功能的实现方式如下:

  1. 前端请求后端api
  2. 后端根据前端的请求生成一个文件
  3. 后端返回一个下载的url地址
  4. 前端利用a标签的download属性,实现用户的点击下载。

在jquery中的dataTable有非常方便的导出csv的功能,但是jquery对于现在的web来说太重了,我也不需要其中的大部分功能,所以我实现了一个简单的csv文件生成导出的模块,方便日常使用。

是否应该在前端导出csv文件?

对用用户需要简单的导出表格中数据的功能,通过前端实现,一方面可以减少一次api的请求,提升响应速度,另一方面,有时候客户可能确实需要这样一个在前端导出csv文件的功能,比如用户需要选中表格中某几行数据进行导出,显然在前端可以更便捷灵活的操作。

demo

本文中,我将实现一个将表格数据转换为csv的格式,并生成一个指定文件名的csv文件,供用户下载的功能。

我将该功能进行了封装发布到了npm上
csv-exportor
demo实现基于前端框架vue2.0,但是事实上适用于任何前端框架。
示例demo
源代码github地址

具体实现

本身的实现其实不难,但是遇到了挺多的坑,所以总结一下。

将表格数据转换为csv格式

这里为了方便起见,我使用了库comma-separated-values,无论性能还是使用都没什么问题。

import CSV from 'comma-separated-values';
// data为表格数据,options可配置表头等信息,返回编码后的csv
const encoded = new CSV(data, options).encode();

如何生成文件?

前端如何生成二进制文件?

  • Blob
    使用Blob对象类型。实际上,File对象就是继承自Blob,所以在大多数地方,Blob和File是可以共用的。我们可以通过Blob来生成二进制流。

  • URL
    现代浏览器提供了方法URL.createObjectURL用来创建data url

所以我们可以使用Blob和URL来封装我们格式化的csv数据,得到dataUrl。

如何下载文件?

为了实现点击一个按钮,下载导出csv文件的功能,我们可以利用a标签来完成。

  1. 动态创建一个隐藏的a标签
  2. href 属性 = 上一步生成的dataUrl
  3. download 属性 = 指定文件名
  4. 模拟点击a标签
  5. 释放URL对象
  6. 成功实现文件下载

具体实现如下:

import CSV from 'comma-separated-values';

/**
 * generate data url of the generated csv file
 * @param {*} data 
 * @param {*} options 
 * @returns {String} dataUrl of generated csv file 
 */
function genUrl(data, options) {
  const encoded = new CSV(data, options).encode();
  const dataBlob = new Blob([`\ufeff${encoded}`], { type: 'text/plain;charset=utf-8' });
  return window.URL.createObjectURL(dataBlob);
}

/**
 * generate csv file from data, and automatically download the file for browser
 * @param {*} data 
 * @param {*} options 
 * @param {*} fileName 
 */
function downloadCsv(data, options, fileName) {
  const url = genUrl(data, options);
  const a = document.createElement('a');
  a.href = url;
  a.download = fileName;
  a.click();
  window.URL.revokeObjectURL(url);
}

export default {
  genUrl,
  downloadCsv,
};

遇到的问题

在过程中遇到的问题,其实大部分和excel对csv的呈现有关,但是考虑到用户在导出csv之后都是用excel打开的,所以不得不好好填坑了。

中文编码

最初在生成csv之后,使用文本编辑器都是可以正常显示的,使用的是UTF-8的编码,但是用excel打开csv文件就会乱码

解决方法

excel不能识别无BOM的UTF-8编码,需要转为带BOM的UTF-8编码,就是在文件头加上\ufeff即可

  const dataBlob = new Blob([`\ufeff${encoded}`], { type: 'text/plain;charset=utf-8' });

文本自动转数字

excel打开csv的时候会自动把内容是数字的文本转换为数字,这导致了手机号会被用科学计数法显示,以及一些0开头的数字会被自动删除前面的0。

解决方法

现在暂时没有完美的解决方法,只能在csv的数字文本前加一个单引号,如"'0012","'0013"
单引号表示的语义是【这个单元格是一个数字, 但是我想要用文本的方式来呈现】
但是excel不会自动去掉这些单引号,需要在excel中进行一步额外的操作
全局替换文件中的单引号为单引号
即可。

最后编辑于
©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 195,898评论 5 462
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 82,401评论 2 373
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 143,058评论 0 325
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 52,539评论 1 267
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 61,382评论 5 358
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 46,319评论 1 273
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 36,706评论 3 386
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 35,370评论 0 254
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 39,664评论 1 294
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 34,715评论 2 312
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 36,476评论 1 326
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 32,326评论 3 313
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 37,730评论 3 299
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 29,003评论 0 19
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 30,275评论 1 251
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 41,683评论 2 342
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 40,877评论 2 335

推荐阅读更多精彩内容