js-xlsx使用

時間 2019-11-07

原文原文鏈接

1.js-xlsx 介紹html

由SheetJS出品的js-xlsx是一款很是方便的只須要純JS便可讀取和導出excel的工具庫，功能強大，支持格式衆多，支持xls、xlsx、ods(一種OpenOffice專有表格文件格式)等十幾種格式。本文所有都是以xlsx格式爲例。前端

官方github：github.com/SheetJS/js-…node

本文配套demo在線演示地址：demo.haoji.me/2017/02/08-…git

本文同步首發於個人我的博客和博客園。github

1.1. 兼容性json

兼容性以下圖：數組

1.2. 如何使用網絡

dist目錄下有不少個JS文件，通常狀況下用xlsx.core.min.js就夠了，xlsx.full.min.js則是包含了全部功能模塊。app

直接script標籤引入便可：dom

讀取excel

讀取excel主要是經過XLSX.read(data, {type: type});方法來實現，返回一個叫WorkBook的對象，type主要取值以下：

base64: 以base64方式讀取；

binary: BinaryString格式(byte n is data.charCodeAt(n))

string: UTF8編碼的字符串；

buffer: nodejs Buffer；

array: Uint8Array，8位無符號數組；

file: 文件的路徑（僅nodejs下支持）；

2.1. 獲取workbook對象

2.1.1. 讀取本地文件

直接上代碼：

// 讀取本地excel文件functionreadWorkbookFromLocalFile(file, callback){varreader =newFileReader(); reader.onload =function(e){vardata = e.target.result;varworkbook = XLSX.read(data, {type:'binary'});if(callback) callback(workbook); }; reader.readAsBinaryString(file);}

2.1.2. 讀取網絡文件

// 從網絡上讀取某個excel文件，url必須同域，不然報錯functionreadWorkbookFromRemoteFile(url, callback){varxhr =newXMLHttpRequest(); xhr.open('get', url,true); xhr.responseType ='arraybuffer'; xhr.onload =function(e){if(xhr.status ==200) {vardata =newUint8Array(xhr.response)varworkbook = XLSX.read(data, {type:'array'});if(callback) callback(workbook); } }; xhr.send();}

2.2. 詳解 workbook

2.2.1. Workbook Object

workbook裏面有什麼東西呢，咱們打印出來看一下：

能夠看到，SheetNames裏面保存了全部的sheet名字，而後Sheets則保存了每一個sheet的具體內容（咱們稱之爲Sheet Object）。每個sheet是經過相似A1這樣的鍵值保存每一個單元格的內容，咱們稱之爲單元格對象（Cell Object）：

2.2.2. Sheet Object

每個Sheet Object表示一張表格，只要不是!開頭的都表示普通cell，不然，表示一些特殊含義，具體以下：

sheet['!ref']：表示全部單元格的範圍，例如從A1到F8則記錄爲A1:F8；

sheet[!merges]：存放一些單元格合併信息，是一個數組，每一個數組由包含s和e構成的對象組成，s表示開始，e表示結束，r表示行，c表示列；

等等；

關於單元格合併，看懂下面這張圖基本上就沒問題了：

結果以下：

2.2.3. 單元格對象

每個單元格是一個對象（Cell Object），主要有t、v、r、h、w等字段（詳見這裏）：

t：表示內容類型，s表示string類型，n表示number類型，b表示boolean類型，d表示date類型，等等

v：表示原始值；

f：表示公式，如B2+B3；

h：HTML內容

w：格式化後的內容

r：富文本內容rich text

等等

2.2.4. 讀取workbook

普通方法：

// 讀取 excel文件functionoutputWorkbook(workbook){varsheetNames = workbook.SheetNames;// 工做表名稱集合sheetNames.forEach(name=>{varworksheet = workbook.Sheets[name];// 只能經過工做表名稱來獲取指定工做表for(varkeyinworksheet) {// v是讀取單元格的原始值console.log(key, key[0] ==='!'? worksheet[key] : worksheet[key].v); } });}

根據!ref肯定excel的範圍，再根據!merges肯定單元格合併（若是有），最後輸出整個table，比較麻煩，幸運的是，插件自身已經寫好工具類XLSX.utils給咱們直接使用，無需咱們本身遍歷，工具類輸出主要包括以下：

有些不經常使用，經常使用的主要是：

XLSX.utils.sheet_to_csv：生成CSV格式

XLSX.utils.sheet_to_txt：生成純文本格式

XLSX.utils.sheet_to_html：生成HTML格式

XLSX.utils.sheet_to_json：輸出JSON格式

經常使用的主要是sheet_to_csv或者sheet_to_html，轉csv的話會忽略格式、單元格合併等信息，因此複雜表格可能不適用。轉html的話會保留單元格合併，可是生成的是<html></html>代碼，而不是<table></table>，須要對錶格進行一些定製時不太方便，因此具體仍是要視狀況來採用合適的工具類。

這裏寫一個採用轉csv方式輸出結果的簡單示例，可點擊這裏查看在線DEMO：

functionreadWorkbook(workbook){varsheetNames = workbook.SheetNames;// 工做表名稱集合varworksheet = workbook.Sheets[sheetNames[0]];// 這裏咱們只讀取第一張sheetvarcsv = XLSX.utils.sheet_to_csv(worksheet);document.getElementById('result').innerHTML = csv2table(csv);}// 將csv轉換成簡單的表格，會忽略單元格合併，在第一行和第一列追加相似excel的索引functioncsv2table(csv){varhtml ='<table>';varrows = csv.split('\n'); rows.pop();// 最後一行沒用的rows.forEach(function(row, idx){varcolumns = row.split(','); columns.unshift(idx+1);// 添加行索引if(idx ==0) {// 添加列索引html +='<tr>';for(vari=0; i

導出excel

導出分爲2種，一種是基於現有excel修改，一種是全新生成，前者比較簡單，咱們這裏着重講後者。

3.1. 本身手寫代碼生成

導出excel文件，主要是如何生成一個sheet，咱們這裏寫一個最簡單的csv轉excel示例：

// csv轉sheet對象functioncsv2sheet(csv){varsheet = {};// 將要生成的sheetcsv = csv.split('\n'); csv.forEach(function(row, i){ row = row.split(',');if(i ==0) sheet['!ref'] ='A1:'+String.fromCharCode(65+row.length-1)+(csv.length-1); row.forEach(function(col, j){ sheet[String.fromCharCode(65+j)+(i+1)] = {v: col}; }); });returnsheet;}// 將一個sheet轉成最終的excel文件的blob對象，而後利用URL.createObjectURL下載functionsheet2blob(sheet, sheetName){ sheetName = sheetName ||'sheet1';varworkbook = {SheetNames: [sheetName],Sheets: {} }; workbook.Sheets[sheetName] = sheet;// 生成excel的配置項varwopts = {bookType:'xlsx',// 要生成的文件類型bookSST:false,// 是否生成Shared String Table，官方解釋是，若是開啓生成速度會降低，但在低版本IOS設備上有更好的兼容性type:'binary'};varwbout = XLSX.write(workbook, wopts);varblob =newBlob([s2ab(wbout)], {type:"application/octet-stream"});// 字符串轉ArrayBufferfunctions2ab(s){varbuf =newArrayBuffer(s.length);varview =newUint8Array(buf);for(vari=0; i!=s.length; ++i) view[i] = s.charCodeAt(i) &0xFF;returnbuf; }returnblob;}

拿到上面的blob對象就能夠直接下載了，參考我以前在JS彈出下載對話框裏面封裝好的openDownloadDialog方法：

/**

* 通用的打開下載對話框方法，沒有測試過具體兼容性

* @param url 下載地址，也能夠是一個blob對象，必選

* @param saveName 保存文件名，可選

*/functionopenDownloadDialog(url, saveName){if(typeofurl =='object'&& urlinstanceofBlob) { url = URL.createObjectURL(url);// 建立blob地址}varaLink =document.createElement('a'); aLink.href = url; aLink.download = saveName ||'';// HTML5新增的屬性，指定保存文件名，能夠不要後綴，注意，file:///模式下不會生效varevent;if(window.MouseEvent) event =newMouseEvent('click');else{ event =document.createEvent('MouseEvents'); event.initMouseEvent('click',true,false,window,0,0,0,0,0,false,false,false,false,0,null); } aLink.dispatchEvent(event);}

因此，最終下載實現以下：

// 傳入csv，執行後就會彈出下載框functionexportExcel(csv){varsheet = csv2sheet(csv);varblob = sheet2blob(sheet); openDownloadDialog(blob,'導出.xlsx')；}

3.2. 利用官方工具類生成

其實上面這些代碼都不須要咱們手寫，官方已經提供好了現成的工具類給咱們使用，主要包括：

aoa_to_sheet: 這個工具類最強大也最實用了，將一個二維數組轉成sheet，會自動處理number、string、boolean、date等類型數據；

table_to_sheet: 將一個table dom直接轉成sheet，會自動識別colspan和rowspan並將其轉成對應的單元格合併；

json_to_sheet: 將一個由對象組成的數組轉成sheet；

aoa_to_sheet示例：

varaoa = [ ['姓名','性別','年齡','註冊時間'], ['張三','男',18,newDate()], ['李四','女',22,newDate()]];varsheet = XLSX.utils.aoa_to_sheet(aoa);openDownloadDialog(sheet2blob(sheet),'導出.xlsx');

table_to_sheet就更簡單了，直接XLSX.utils.table_to_sheet($('table')[0])便可；

3.3. 處理單元格合併

通常來講，前端生成excel而不是csv最主要目的都是爲了解決csv不能實現單元格合併的問題，要否則直接導出csv文件就行了，何須引入幾百kb的插件。

假設咱們要生成以下格式的excel文件，其中A1-C1進行單元格合併：

代碼以下：

varaoa = [ ['主要信息',null,null,'其它信息'],// 特別注意合併的地方後面預留2個null['姓名','性別','年齡','註冊時間'], ['張三','男',18,newDate()], ['李四','女',22,newDate()]];varsheet = XLSX.utils.aoa_to_sheet(aoa);sheet['!merges'] = [// 設置A1-C1的單元格合併{s: {r:0,c:0},e: {r:0,c:2}}];openDownloadDialog(sheet2blob(sheet),'單元格合併示例.xlsx');

須要注意的地方就是被合併的單元格要用null預留出位置，不然後面的內容（本例中是第四列其它信息）會被覆蓋。

3.4. 自定義樣式

普通版本不支持定義字體、顏色、背景色等，有這個功能須要的可使用pro版，好像是要收費的，由於官網沒看到下載地址。