小知识,大挑战!本文正在参与“程序员必备小知识”创作活动。
A journey of a thousand miles begins with single step
背景
在上篇文章中说到,Vue
使用 Export2Excel
进行导出 excel
文件。但是随着业务需求的增加,简单的导出已经不能满足客户的需求,客户提出需要在一个excel中导出数据的汇总表和各种明细数据,于是,我对 Export2Excel
进行了修改使其满足可以导出多Sheet
的 excel
的功能,并对其功能进行简单的封装。
本文需要在上文的基础上进行优化,如果没有阅读上文,需要先安装下面的依赖包。
# use npm
npm install file-saver -S
npm install xlsx -S
npm install script-loader -D
# use yarn
yarn add file-saver xlsx
yarn add file-saver script-loader --dev
引入 Export2Excel
文件
在网上下载在Export2Excel.js
文件,放在自己项目中合适的位置。
代码地址:gitee.com/yunxii/vue-… Export2Excel.js
进行一些修改,修改后命名为 Export2MultipleSheetExcel.js
详细代码如下:
//Export2MultipleSheetExcel
// 导出多sheet表格专用
/* eslint-disable */
require("script-loader!file-saver")
import XLSX from "xlsx"
function generateArray(table) {
var out = []
var rows = table.querySelectorAll("tr")
var ranges = []
for (var R = 0; R < rows.length; ++R) {
var outRow = []
var row = rows[R]
var columns = row.querySelectorAll("td")
for (var C = 0; C < columns.length; ++C) {
var cell = columns[C]
var colspan = cell.getAttribute("colspan")
var rowspan = cell.getAttribute("rowspan")
var cellValue = cell.innerText
if (cellValue !== "" && cellValue == +cellValue) cellValue = +cellValue
//Skip ranges
ranges.forEach(function(range) {
if (
R >= range.s.r &&
R <= range.e.r &&
outRow.length >= range.s.c &&
outRow.length <= range.e.c
) {
for (var i = 0; i <= range.e.c - range.s.c; ++i) outRow.push(null)
}
})
//Handle Row Span
if (rowspan || colspan) {
rowspan = rowspan || 1
colspan = colspan || 1
ranges.push({
s: {
r: R,
c: outRow.length
},
e: {
r: R + rowspan - 1,
c: outRow.length + colspan - 1
}
})
}
//Handle Value
outRow.push(cellValue !== "" ? cellValue : null)
//Handle Colspan
if (colspan) for (var k = 0; k < colspan - 1; ++k) outRow.push(null)
}
out.push(outRow)
}
return [out, ranges]
}
function datenum(v, date1904) {
if (date1904) v += 1462
var epoch = Date.parse(v)
return (epoch - new Date(Date.UTC(1899, 11, 30))) / (24 * 60 * 60 * 1000)
}
function sheet_from_array_of_arrays(data, opts) {
var ws = {}
var range = {
s: {
c: 10000000,
r: 10000000
},
e: {
c: 0,
r: 0
}
}
for (var R = 0; R != data.length; ++R) {
for (var C = 0; C != data[R].length; ++C) {
if (range.s.r > R) range.s.r = R
if (range.s.c > C) range.s.c = C
if (range.e.r < R) range.e.r = R
if (range.e.c < C) range.e.c = C
var cell = {
v: data[R][C]
}
if (cell.v == null) continue
var cell_ref = XLSX.utils.encode_cell({
c: C,
r: R
})
if (typeof cell.v === "number") cell.t = "n"
else if (typeof cell.v === "boolean") cell.t = "b"
else if (cell.v instanceof Date) {
cell.t = "n"
cell.z = XLSX.SSF._table[14]
cell.v = datenum(cell.v)
} else cell.t = "s"
ws[cell_ref] = cell
}
}
if (range.s.c < 10000000) ws["!ref"] = XLSX.utils.encode_range(range)
return ws
}
function Workbook() {
if (!(this instanceof Workbook)) return new Workbook()
this.SheetNames = []
this.Sheets = {}
}
function s2ab(s) {
var buf = new ArrayBuffer(s.length)
var view = new Uint8Array(buf)
for (var i = 0; i != s.length; ++i) view[i] = s.charCodeAt(i) & 0xff
return buf
}
export function export_table_to_excel(id) {
var theTable = document.getElementById(id)
var oo = generateArray(theTable)
var ranges = oo[1]
/* original data */
var data = oo[0]
var ws_name = "SheetJS"
var wb = new Workbook(),
ws = sheet_from_array_of_arrays(data)
/* add ranges to worksheet */
// ws['!cols'] = ['apple', 'banan'];
ws["!merges"] = ranges
/* add worksheet to workbook */
wb.SheetNames.push(ws_name)
wb.Sheets[ws_name] = ws
var wbout = XLSX.write(wb, {
bookType: "xlsx",
bookSST: false,
type: "binary"
})
saveAs(
new Blob([s2ab(wbout)], {
type: "application/octet-stream"
}),
"test.xlsx"
)
}
//主要修改此函数内的方法
export function export_json_to_excel({
multiHeader = [],
header,
data,
sheetname,
filename,
merges = [],
autoWidth = true,
bookType = "xlsx"
} = {}) {
/* original data */
filename = filename || "excel-list"
data = [...data]
for (var i = 0; i < header.length; i++) {
data[i].unshift(header[i])
}
// data.unshift(header)
for (let i = multiHeader.length - 1; i > -1; i--) {
data.unshift(multiHeader[i])
}
var ws_name = sheetname
var wb = new Workbook(),
ws = []
for (var j = 0; j < header.length; j++) {
ws.push(sheet_from_array_of_arrays(data[j]))
}
if (merges.length > 0) {
if (!ws["!merges"]) ws["!merges"] = []
merges.forEach(item => {
ws["!merges"].push(XLSX.utils.decode_range(item))
})
}
// console.log("width", autoWidth)
if (autoWidth) {
/*设置worksheet每列的最大宽度*/
var colWidth = []
for (var k = 0; k < header.length; k++) {
colWidth.push(
data[k].map(row =>
row.map(val => {
/*先判断是否为null/undefined*/
if (val == null) {
return {
wch: 10
}
} else if (val.toString().charCodeAt(0) > 255) {
/*再判断是否为中文*/
return {
wch: val.toString().length * 2
}
} else {
return {
wch: val.toString().length
}
}
})
)
)
}
/*以第一行为初始值*/
let result = []
for (var k = 0; k < colWidth.length; k++) {
result[k] = colWidth[k][0]
for (let i = 1; i < colWidth[k].length; i++) {
for (let j = 0; j < colWidth[k][i].length; j++) {
if (result[k][j]["wch"] < colWidth[k][i][j]["wch"]) {
result[k][j]["wch"] = colWidth[k][i][j]["wch"]
}
}
}
}
// 分别给sheet表设置宽度
for (var l = 0; l < result.length; l++) {
ws[l]["!cols"] = result[l]
}
}
/* add worksheet to workbook */
for (var k = 0; k < header.length; k++) {
wb.SheetNames.push(ws_name[k])
wb.Sheets[ws_name[k]] = ws[k]
}
var wbout = XLSX.write(wb, {
bookType: bookType,
bookSST: false,
type: "binary"
})
saveAs(
new Blob([s2ab(wbout)], {
type: "application/octet-stream"
}),
`${filename}.${bookType}`
)
}
封装
在项目 utils
下创建multipleSheetExport.js
,在此文件中封装一个函数并进行导出,在需要使用该功能的时候直接引入该方法,然后调用就可以完成多 Sheet
导出需求。
详细代码如下:
/**
* multipleSheetExport
* tableJson 导出数据
* filenames 导出表的名字
* autowidth 表格宽度自动
* bookTypes Xlsx & csv & txt
*
* @param {(Object)} tableJson
* @param {string} filenames
* @param {boolean} autowidth
* @param {string} bookTypes
*/
export function multipleSheetExport (tableJson, filenames, autowidth, bookTypes) {
import('@/vendor/Export2MultipleSheetExcel').then(excel => {
var tHeader = []
var dataArr = []
var sheetnames = []
for (var i in tableJson) {
tHeader.push(tableJson[i].tHeader)
dataArr.push(formatJson(tableJson[i].filterVal, tableJson[i].tableDatas))
sheetnames.push(tableJson[i].sheetName)
}
excel.export_json_to_excel({
header: tHeader,
data: dataArr,
sheetname: sheetnames,
filename: filenames,
autoWidth: autowidth,
bookType: bookTypes
})
})
}
function formatJson(filterVal, jsonData) {
return jsonData.map(v => filterVal.map(j => v[j]))
}
使用
在项目中创建一个 vue
文件, 配置好路由方便测试,项目中使用的是elementUI
组件库
在模板中
<template>
<!-- 本页面仅为多sheet到导出参考案例 -->
<div class="multiple-sheet-export-to-excel">
<el-button type="primary" @click="onDownload">多sheet点击导出案例</el-button>
</div>
</template>
在script
中引入导出的方法和所需要的数据
import { data } from '@/views/funs/data'
import { multipleSheetExport } from '@/utils/multipleSheetExport'
const excelDatas = [
{
// sheet表一头部
tHeader: ['ID', '标题', '作者', '页面浏览量', '时间'],
// 表一的数据字段
filterVal: ['id', 'title', 'author', 'pageviews', 'display_time'],
// 表一的整体json数据
tableDatas: data.LIST,
// 表一的sheet名字
sheetName: 'sheetName1'
},
{
tHeader: ['序号', '标题', '作者', '服务'],
filterVal: ['id', 'title', 'author', 'reviewer'],
tableDatas: data.LIST,
sheetName: 'sheetName2'
},
{
tHeader: ['序号', '名字', '描述'],
filterVal: ['userId', 'userName', 'userDescription'],
tableDatas: data.ROLESlIST,
sheetName: 'sheetName3'
}
]
在 methods
中定义模板中绑定事件对应的方法,在方法中调用多 Sheet
导出的方法完成需求
onDownload () {
multipleSheetExport(excelDatas, '数据表格', true, 'xlsx')
}
效果如下
案例代码
Export2MultipleSheetExcel
案例代码:gitee.com/yunxii/vue-…