node-xlsx - 简单几行代码处理导入、导出 excel 表格数据,免费开源的 javascript 工具库

最近开发的项目上需要把数据导出为 xlsx 文档,找了一圈,发现 node-xlsx 简单好用,分享给各位。

关于 node-xlsx

在 web 开发中,管理后台生成 excel 报表并且下载,一个很常用的功能,很多 javascript 开发者也提供了很多的这方面的工具卡来实现这一功能。今天介绍的 node-xlsx 就是一个基于 node.js 和 SheetJS 、处理 xlsx 格式的工具库。

node-xlsx github 官网
node-xlsx github 官网

node-xlsx 的技术特性

  • 底层基于强大的 SheetJS 构建,对 xlsx 文档的格式兼容性足够好
  • 支持导出和读取 xlsx 文档,一个工具库解决导入导出需求
  • 只有少数几个 api ,使用非常简单

开发上手体验

最近在做电商后台的订单管理部分,需要将订单数据导出给运营同事,也需要导入处理好的订单报表。虽然之前也研究过用纯 javascript 来实现导出 excel 表格,但倒出来的文档的兼容性很难保证。

找了一圈,发现 node-xlsx 这个工具库,刚好能够满足功能的需求:报表字段相对简单,没有过多数据嵌套。

安装和使用

需要注意的是,node-xlsx 是一个 node.js 库,只能通过 npm 安装,在服务端使用:

npm install node-xlsx --save

然后在项目中引入,就可以使用了。下面的代码是通过读取二进制文件或者 buffer 来处理导入的 xlsx 文档:

import xlsx from 'node-xlsx';
// Or var xlsx = require('node-xlsx').default;

// Parse a buffer
const workSheetsFromBuffer = xlsx.parse(fs.readFileSync(`${__dirname}/myFile.xlsx`));
// Parse a file
const workSheetsFromFile = xlsx.parse(`${__dirname}/myFile.xlsx`);

导出为 xlsx 文档

import xlsx from 'node-xlsx';

const data = [
  [1, 2, 3],
  [true, false, null, 'sheetjs'],
  ['foo', 'bar', new Date('2014-02-19T14:30Z'), '0.3'],
  ['baz', null, 'qux'],
];
var buffer = xlsx.build([{name: 'mySheetName', data: data}]); // Returns a buffer

默认数据的第一行就是表头,node-xlsx 还支持设定每一列的宽度和合并单元格,这样基本上就能输出数据报表了,就这么几个 api,使用非常简单!

注意事项

node-xlsx 只能处理结构相对简单的数据文档,如果数据格式比较复杂,可以到 SheetJS 去查询数据格式的处理方法。不过如果想要设置单元格样式这样的功能,node-xlsx 可能就满足不了了。

免费开源说明

node-xlsx 是一个基于 SheetJS 构建的免费工具库,运行在 node.js 服务上,node-xlsx 和 SheetJS 的源码都基于 apache 2.0 开源协议托管在 Github 上,任何个人和公司都可以免费下载使用,也可以用在商业项目上。