xlsx库实现纯前端导入导出Excel

前言

最近做了前端导入、导出 Excel 的需求，用到了js-xlsx这个库，该库文档提供的用例很少，并不是很友好。本文总结一下我是如何实现需求的。

需求

提供一个 Excel 文件，将里面的内容转成 JSON 导入数据
提供一个 JSON 文件，生成 Excel 文件并导出

导入与导出既可以前端做，也可以后端做。本文主要探讨前端通过SheetJS/js-xlsx这个库实现 Excel 导入、导出功能。

技术选型

市面上的报表类产品大抵可以分为以下两种：

云文档类型产品
控件类型产品

像 SheetJS/js-xlsx、LuckySheet、Handsontable、SpreadJS 都是标准的纯前端表格控件且都支持 Excel 的功能特性和 JSON 数据绑定。

最后选择 SheetJS/js-xlsx 这个库主要因为以下两个原因：

社区版开源免费。也可选择性能增强的专业版，专业版提供样式和专业支持的附加功能。
有 30k star，维护频率高，笔者在写这篇文章时（5 月 10 日）该项目的上一次提交在 5 月 9 日。

基础知识

新建一个 Excel 文档，这个文档就是workbook，而一个workbook 下可以有多个sheet。

SheetJS/js-xlsx

安装

$ yarn add xlsx@0.16.9
复制代码

建议跟上版本号，我第一次装的时候没跟上版本号没有安装成功。

常用的数据表格式(Common Spreadsheet Format)

js-xlsx符合常用的数据表格式(CSF)。

一般结构

单元格地址对象的存储格式为{c:C, r:R}，其中C和R分别代表的是 0 索引列和行号。例如单元格地址B5用对象{c:1, r:4}表示。

单元格范围对象存储格式为{s:S, e:E}，其中S是第一个单元格，E是最后一个单元格。范围是包含关系。例如范围 A3:B7用对象{s:{c:0, r:2}, e:{c:1, r:6}}表示。

单元格对象

单元格对象是纯粹的 JS 对象，它的 keys 和 values 遵循下列的约定：

Key	Description
`v`	原始值(查看数据类型部分获取更多的信息)
`w`	格式化文本(如果可以使用)
`t`	内行: `b` Boolean, `e` Error, `n` Number, `d` Date, `s` Text, `z` Stub
`f`	单元格公式编码为 A1 样式的字符串(如果可以使用)
`F`	如果公式是数组公式，则包围数组的范围(如果可以使用)
`r`	富文本编码 (如果可以使用)
`h`	富文本渲染成 HTML (如果可以使用)
`c`	与单元格关联的注释
`z`	与单元格关联的数字格式字符串(如果有必要)
`l`	单元格的超链接对象 (`.Target` 长联接, `.Tooltip` 是提示消息)
`s`	单元格的样式/主题 (如果可以使用)

如果w文本可以使用，内置的导出工具(比如 CSV 导出方法)就会使用它。要想改变单元格的值，在打算导出之前确保删除cell.w(或者设置 cell.w为undefined)。工具函数会根据数字格式(cell.z)和原始值(如果可用)重新生成w文本。

真实的数组公式存储在数组范围中第一个单元个的f字段内。此范围内的其他单元格会省略f字段。

更多详细信息请查看文档

前端导入 Excel 数据

/**
 * 将 file 转为一个 CSF 的 JSON
 * @param {File} file
 * @returns sheet
 */
const analyseExcelToJson = (file) => {
  return new Promise((resolve, reject) => {
    if (file instanceof File) {
      const reader = new FileReader();

      reader.onloadend = (progressEvent) => {
        const arrayBuffer = reader.result;

        const options = { type: 'array' };
        const workbook = XLSX.read(arrayBuffer, options);

        const sheetName = workbook.SheetNames;
        const sheet = workbook.Sheets[sheetName];

        resolve(sheet);
      };
      reader.readAsArrayBuffer(file);
    } else {
      reject(new Error('入参不是 File 类型'));
    }
  });
};
复制代码

这里先用FileReader将file转换成ArrayBuffer，再用xlsx.read()转换成workbook。由于FileReader是异步读取，所以用promise处理了一下。最终可以看到 Excel 处理后生成了这样的一

所以需要对analyseExcelToJson这个方法做一些修改，修改后如下：

/**
 * 将 file 转为一个 CSF 的 JSON
 * @param {File} file
 * @returns sheets
 */
const analyseExcelToJson = (file) => {
  return new Promise((resolve, reject) => {
    if (file instanceof File) {
      const reader = new FileReader();

      reader.onloadend = (progressEvent) => {
        const arrayBuffer = reader.result;

        const options = { type: 'array' };
        const workbook = XLSX.read(arrayBuffer, options);

        const sheetNames = workbook.SheetNames;
        const result = sheetNames.map((sheetName) => workbook.Sheets[sheetName]);
        resolve(result);
      };
      reader.readAsArrayBuffer(file);
    } else {
      reject(new Error('入参不是 File 类型'));
    }
  });
};
复制代码

读取数据按钮方法如下：

由于我用了Promise.all用来处理读取多个 Excel，所以看到外面又用数组包了一层。至此，简单的前端导入 Excel 数据已经全部实现了。

顺带一提，如果想要在页面中展示sheet，可以使用XLSX.utils.sheet_to_html。

前端导出 Excel 文件

导出一般分为两种：

数据导出 Excel
页面表格导出 Excel

数据导出 Excel

前端在写前端导入 Excel 数据方法，最后返回的其实是workbook中sheet的集合。那么导出 Excel 文件便是将sheet拼成一个workbook导出即可。另外，导出的难点在于写成 Excel 之后要立马下载，而XLSX.writeFile直接帮我们实现这一步了。

/**
 *
 * @param {Array} sheets sheet的集合
 * @param {String} fileName 下载时文件名称
 */
const exportExcelBySheets = (sheets, fileName = 'example.xlsx') => {
  const SheetNames = [];
  const Sheets = {};
  const workbook = { SheetNames, Sheets };

  sheets.forEach((sheet, i) => {
    const name = `sheet${i + 1}`;
    SheetNames.push(name);
    Sheets[name] = sheet;
  });

  return XLSX.writeFile(workbook, fileName, { type: 'binary' });
};
复制代码

假设数据并非CSF而是如下的二维数组：

const ddArray = [
  ['S', 'h', 'e', 'e', 't', 'J', 'S'],
  [1, 2, 3, 4, 5],
];
复制代码

可以使用方法如下：

/**
 *
 * @param {Array} workSheetData 二维数组
 * @param {String} fileName 下载时文件名称
 */
const exportExcelByDoubleDimensArray = (workSheetData, fileName = 'example.xlsx') => {
  const ws = XLSX.utils.aoa_to_sheet(workSheetData);
  const workSheetName = 'MySheet';
  const workbook = XLSX.utils.book_new();

  XLSX.utils.book_append_sheet(workbook, ws, workSheetName);
  return XLSX.writeFile(workbook, fileName, { type: 'binary' });
};
复制代码

页面表格导出 Excel

将页面中的表格导出 Excel,应该是更加常见的情况。我们增加一个 Element-ui 的基础表格如下：

导出方法如下：

/**
 * 将 table 转换成 Excel 导出
 * @param {*} el table 的根 dom 元素
 * @param {*} fileName 下载时文件名称
 */
const exportExcelByTable = (el, fileName = 'example.xlsx') => {
  if (!el) {
    throw new Error('没有获取到表格的根 dom 元素');
  }
  const options = { raw: true };
  const workbook = XLSX.utils.table_to_book(el, options);

  return XLSX.writeFile(workbook, fileName, { type: 'binary' });
};
复制代码

页面中使用的话，通过ref拿到组件实例，将$el即Vue 实例的根 DOM 元素作为入参即可。

exportExcelByTable(this.$refs.table.$el);
复制代码

踩坑

只用简单表格作为示例的话，似乎一切都很完美。然而,我在使用Element-ui table做复杂表格时，踩了一些坑。

当且不仅当表的内容为input、select这类组件而非普通的数据时，导出的 Excel 内容为空
将表头合并后，导出 Excel 仍能看到被合并的表头那一列。
使用fixed属性固定列时，导出的 Excel 数据会重复。

由于XLSX.utils.table_to_book这个方法实际上是将dom元素转化为workbook，这些坑都可以归类为获取到的 dom元素不对。

表头合并

为了更好理解，我先讲表头合并的问题。由于Element-ui table并没有提供表头合并的方法，我实际是通过修改rowspan和colspan来实现跨行跨列，再使用display: none;这个css属性将原先位置的元素隐藏。如下图所示：

图中“ID”的colspan为 2，“姓名”被我设置了display: none;。如果直接用我们之前表格导出 Excel 的方法，会发现虽然导出"ID"正确地变为了两列，但是“姓名”列并没有隐藏。由此可以得出结论：display: none;并不会影响 Excel 的获取。

所以我在项目中对于被隐藏的表头会添加cell-hide这个css类来隐藏被合并的表头。

.cell-hide {
  display: none;
}
复制代码

然后在下载报表前，将合并的表头dom删除。

document.querySelectorAll('.cell-hide').forEach((item) => {
  item.parentNode.removeChild(item);
});

// 下面就可以正常下载了
复制代码

内容为组件

同样利用**display: none;并不会影响 Excel 的获取**的特性可以解决问题 1，只需在table-column中通过插槽增加被隐藏的dom，就可以正常拿到值了。代码如下:

<el-table ref="table" :data="tableData" style="width: 600px; margin: 0 auto">
      <el-table-column prop="date" label="日期" width="180"> </el-table-column>
      <el-table-column prop="name" label="姓名" width="180"> </el-table-column>
      <el-table-column prop="address" label="地址">
        <template slot="header">
          <span>地址</span>
        </template>
        <template slot-scope>
          <el-input :value="123" />
          <span style="display: none">123</span>
        </template>
      </el-table-column>
    </el-table>
复制代码

使用fixed属性固定表格列

先来看下，如果完全不处理，直接使用导出会是什么结果。以下面的 table2 为例，“日期”列被固定，导出的 excel 内容重复。

exportExcelByTable(this.$refs.table2.$el);
复制代码

原因还是出在dom上，打印出 table 和 table2 的dom比较发现，table2 多了css类为el-table__fixed的这个节点。

我的处理方法是先克隆节点，确保后续操作不会影响页面中的 table2。通过遍历克隆出的新节点，找到.el-table__fixed这个节点并删除，最后返回新节点，发现可以输出正常的 Excel 文件。具体代码如下：

 exportExcelByTable2() {
   const newEl = this.removeFixedDom(this.$refs.table2.$el);
   exportExcelByTable(newEl);
 }

 removeFixedDom(el) {
   const newEl = el.cloneNode(true);

   newEl.childNodes.forEach((node) => {
     if (node.className === 'el-table__fixed') {
       node.parentNode.removeChild(node);
     }
   });
   return newEl;
 }
复制代码

总结

js-xlsx这个库功能很强大且使用简单，足以应付一般的导出导出需求，如果有美化导出 Excel 样式的需求需要选择 pro 版本。开发的难度主要在于阅读提供用例不足且冗长的文档。使用时注意维护好Workbook和Sheet对象即可，LuckySheet、SpreadJS 也是类似的思路。