最近工作中遇到一个需求,大致需求就是将Excel文件在导入时解析为json格式转换数据结构再传输给后台。这方面的库比较少,比较主流的是js-xlsx,官网地址为sheetjs官网,但是文档都写得不太清楚,坑也比较多,这里我做一个简单的介绍与运用与避坑指南。

先介绍几个基本概念:

workbook 对象,指的是整份 Excel 文档。我们在使用 js-xlsx 读取 Excel 文档之后就会获得 workbook
对象。

worksheet 对象,指的是 Excel 文档中的表。我们知道一份 Excel 文档中可以包含很多张表,而每张表对应的就是 worksheet 对象。

废话不多说直接上这里演示下网页中使用

<!DOCTYPE html>
<html>
    <head>
        <meta charset="UTF-8">
        <title></title>
        <script src="http://oss.sheetjs.com/js-xlsx/xlsx.full.min.js"></script>
    </head>

    <body>
        <input type="file"onchange="importf(this)" />
        <div id="demo"></div>
        <script>
            /*
            FileReader共有4种读取方法:
            1.readAsArrayBuffer(file):将文件读取为ArrayBuffer。
            2.readAsBinaryString(file):将文件读取为二进制字符串
            3.readAsDataURL(file):将文件读取为Data URL
            4.readAsText(file, [encoding]):将文件读取为文本,encoding缺省值为'UTF-8'
                         */
            var wb;//读取完成的数据
            var rABS = true; //是否将文件读取为二进制字符串
            function importf(obj) {//导入
                if(!obj.files) {
                    return;
                }
                var f = obj.files[0];
                console.log(f);
                var reader = new FileReader();
                reader.onload = function(e) {
                    var data = e.target.result;
                    if(rABS) {
                        wb = XLSX.read(btoa(fixdata(data)), {//手动转化
                            type: 'base64'
                        });
                    } else {
                        wb = XLSX.read(data, {
                            type: 'binary'
                        });
                    }
                    //wb.SheetNames[0]是获取Sheets中第一个Sheet的名字
                    //wb.Sheets[Sheet名]获取第一个Sheet的数据
                    console.log(JSON.stringify(XLSX.utils.sheet_to_json(wb.Sheets[wb.SheetNames[0]])));
                };
                if(rABS) {
                    reader.readAsArrayBuffer(f);
                } else {
                    reader.readAsBinaryString(f);
                }
            }
            function fixdata(data) { //文件流转BinaryString
                var o = "",
                    l = 0,
                    w = 10240;
                for(; l < data.byteLength / w; ++l) 
                o += String.fromCharCode.apply(null, new Uint8Array(data.slice(l * w, l * w + w)));
                o += String.fromCharCode.apply(null, new Uint8Array(data.slice(l * w)));
                return o;
            }

            var rABS = true; // true: readAsBinaryString ; false: readAsArrayBuffer
            function handleFile(e) {
                var files = e.target.files, f = files[0];
                var reader = new FileReader();
                reader.onload = function(e) {
                    var data = e.target.result;
                    if(!rABS) data = new Uint8Array(data);
                    var workbook = XLSX.read(data, {type: rABS ? 'binary' : 'array'});
                };
                if(rABS) reader.readAsBinaryString(f); 
                else reader.readAsArrayBuffer(f);
            }
            input_dom_element.addEventListener('change', handleFile, false);

        </script>
    </body>

</html>

这里演示下在react+antd组合下使用

import { Button, Icon } from 'antd';
const XLSX = require('XLSX');//必须使用CommonJs规范引入,如果使用import引入则找不到read 方法

<Button onClick={this.handle_click_send_file}>
    <input type="file" accept=".csv, application/vnd.openxmlformats-officedocument.spreadsheetml.sheet, application/vnd.ms-excel"
       style={{display: 'none'}}
       ref={(input) => { input ? this.file_input = input : null; }}
       onChange={this.handle_file_change}
    />
    <Icon type="upload" />导入三级
</Button>

  handle_click_send_file = () => {
    this.file_input.click();
  }

  handle_file_change = () => {
    this.asyncReaderFile(this.file_input, XLSX).then((res) => {
      console.log(res); //在回调函数中输出结果
    });
  }

asyncReaderFile = (event, XLSX) => {
    const files = event.files || [];
    const file = files[0]; //获取第一个Blob对象
    return new Promise((resolve, reject) => {
      const reader = new FileReader();
      reader.readAsBinaryString(file); //readAsBinaryString(file):将文件读取为二进制字符串
      reader.onload = function(e) {
        const data = e.target.result;
        //XLSX.read获得 workbook对象,指的是整份Excel文档,并将其解析为二进制字符串
        const wb = XLSX.read(data, {
          type: 'binary',
        });
        //wb.SheetNames[0]是获取第一个表名
        //wb.Sheets[表名]获取第一个表的数据
        //XLSX.utils.sheet_to_json生成一个对象数组,JSON.stringify解析为json对象
        const json = XLSX.utils.sheet_to_json(wb.Sheets[wb.SheetNames[0]]);
        //这里将解析出的json数据转换下格式
        const resData = json.map((obj) => {
          let words = '';
          for (const i in obj) {
            words += obj[i] + '/';
          }
          return words;
        });
        resolve(resData);
      };
    });
  };

这里主要的一个坑就是不能使用inport 引用!因为这个库很早之前就做出来了,用的是CommonJs规范,因此不能用import方式引用;另一个需要注意的点是在浏览器中需要使用read方式解析出workbook对象,在Node环境中则需要使用readFile解析出workbook对象。

还有很多其他用法,具体的详情可以看下文档npm-xlsx