前端vue导入导出excel文件

652 阅读2分钟

准备工作

依赖三个npm包

npm i xlsx file-saver script-loader

依赖文件 (导出需要)

src下创建excel文件夹 Blob.js 和 Export2Excel.js

  • Bolb.js
/* eslint-disable */
/* Blob.js
 * A Blob implementation.
 * 2018-01-12
 *
 * By Eli Grey, http://eligrey.com
 * By Devin Samarin, https://github.com/dsamarin
 * License: MIT
 *   See https://github.com/eligrey/Blob.js/blob/master/LICENSE.md
 */

/* global self, unescape */
/* jslint bitwise: true, regexp: true, confusion: true, es5: true, vars: true, white: true,
  plusplus: true */

/*! @source http://purl.eligrey.com/github/Blob.js/blob/master/Blob.js */

(function (view) {
	"use strict";

	view.URL = view.URL || view.webkitURL;

	if (view.Blob && view.URL) {
		try {
			new Blob;
			return;
		} catch (e) { }
	}

	// Internally we use a BlobBuilder implementation to base Blob off of
	// in order to support older browsers that only have BlobBuilder
	var BlobBuilder = view.BlobBuilder || view.WebKitBlobBuilder || view.MozBlobBuilder || (function (view) {
		var
			get_class = function (object) {
				return Object.prototype.toString.call(object).match(/^\[object\s(.*)\]$/)[1];
			}
			, FakeBlobBuilder = function BlobBuilder () {
				this.data = [];
			}
			, FakeBlob = function Blob (data, type, encoding) {
				this.data = data;
				this.size = data.length;
				this.type = type;
				this.encoding = encoding;
			}
			, FBB_proto = FakeBlobBuilder.prototype
			, FB_proto = FakeBlob.prototype
			, FileReaderSync = view.FileReaderSync
			, FileException = function (type) {
				this.code = this[this.name = type];
			}
			, file_ex_codes = (
				"NOT_FOUND_ERR SECURITY_ERR ABORT_ERR NOT_READABLE_ERR ENCODING_ERR "
				+ "NO_MODIFICATION_ALLOWED_ERR INVALID_STATE_ERR SYNTAX_ERR"
			).split(" ")
			, file_ex_code = file_ex_codes.length
			, real_URL = view.URL || view.webkitURL || view
			, real_create_object_URL = real_URL.createObjectURL
			, real_revoke_object_URL = real_URL.revokeObjectURL
			, URL = real_URL
			, btoa = view.btoa
			, atob = view.atob

			, ArrayBuffer = view.ArrayBuffer
			, Uint8Array = view.Uint8Array

			, origin = /^[\w-]+:\/*\[?[\w\.:-]+\]?(?::[0-9]+)?/
			;
		FakeBlob.fake = FB_proto.fake = true;
		while (file_ex_code--) {
			FileException.prototype[file_ex_codes[file_ex_code]] = file_ex_code + 1;
		}
		// Polyfill URL
		if (!real_URL.createObjectURL) {
			URL = view.URL = function (uri) {
				var
					uri_info = document.createElementNS("http://www.w3.org/1999/xhtml", "a")
					, uri_origin
					;
				uri_info.href = uri;
				if (!("origin" in uri_info)) {
					if (uri_info.protocol.toLowerCase() === "data:") {
						uri_info.origin = null;
					} else {
						uri_origin = uri.match(origin);
						uri_info.origin = uri_origin && uri_origin[1];
					}
				}
				return uri_info;
			};
		}
		URL.createObjectURL = function (blob) {
			var
				type = blob.type
				, data_URI_header
				;
			if (type === null) {
				type = "application/octet-stream";
			}
			if (blob instanceof FakeBlob) {
				data_URI_header = "data:" + type;
				if (blob.encoding === "base64") {
					return data_URI_header + ";base64," + blob.data;
				} else if (blob.encoding === "URI") {
					return data_URI_header + "," + decodeURIComponent(blob.data);
				} if (btoa) {
					return data_URI_header + ";base64," + btoa(blob.data);
				} else {
					return data_URI_header + "," + encodeURIComponent(blob.data);
				}
			} else if (real_create_object_URL) {
				return real_create_object_URL.call(real_URL, blob);
			}
		};
		URL.revokeObjectURL = function (object_URL) {
			if (object_URL.substring(0, 5) !== "data:" && real_revoke_object_URL) {
				real_revoke_object_URL.call(real_URL, object_URL);
			}
		};
		FBB_proto.append = function (data/*, endings*/) {
			var bb = this.data;
			// decode data to a binary string
			if (Uint8Array && (data instanceof ArrayBuffer || data instanceof Uint8Array)) {
				var
					str = ""
					, buf = new Uint8Array(data)
					, i = 0
					, buf_len = buf.length
					;
				for (; i < buf_len; i++) {
					str += String.fromCharCode(buf[i]);
				}
				bb.push(str);
			} else if (get_class(data) === "Blob" || get_class(data) === "File") {
				if (FileReaderSync) {
					var fr = new FileReaderSync;
					bb.push(fr.readAsBinaryString(data));
				} else {
					// async FileReader won't work as BlobBuilder is sync
					throw new FileException("NOT_READABLE_ERR");
				}
			} else if (data instanceof FakeBlob) {
				if (data.encoding === "base64" && atob) {
					bb.push(atob(data.data));
				} else if (data.encoding === "URI") {
					bb.push(decodeURIComponent(data.data));
				} else if (data.encoding === "raw") {
					bb.push(data.data);
				}
			} else {
				if (typeof data !== "string") {
					data += ""; // convert unsupported types to strings
				}
				// decode UTF-16 to binary string
				bb.push(unescape(encodeURIComponent(data)));
			}
		};
		FBB_proto.getBlob = function (type) {
			if (!arguments.length) {
				type = null;
			}
			return new FakeBlob(this.data.join(""), type, "raw");
		};
		FBB_proto.toString = function () {
			return "[object BlobBuilder]";
		};
		FB_proto.slice = function (start, end, type) {
			var args = arguments.length;
			if (args < 3) {
				type = null;
			}
			return new FakeBlob(
				this.data.slice(start, args > 1 ? end : this.data.length)
				, type
				, this.encoding
			);
		};
		FB_proto.toString = function () {
			return "[object Blob]";
		};
		FB_proto.close = function () {
			this.size = 0;
			delete this.data;
		};
		return FakeBlobBuilder;
	}(view));

	view.Blob = function (blobParts, options) {
		var type = options ? (options.type || "") : "";
		var builder = new BlobBuilder();
		if (blobParts) {
			for (var i = 0, len = blobParts.length; i < len; i++) {
				if (Uint8Array && blobParts[i] instanceof Uint8Array) {
					builder.append(blobParts[i].buffer);
				}
				else {
					builder.append(blobParts[i]);
				}
			}
		}
		var blob = builder.getBlob(type);
		if (!blob.slice && blob.webkitSlice) {
			blob.slice = blob.webkitSlice;
		}
		return blob;
	};

	var getPrototypeOf = Object.getPrototypeOf || function (object) {
		return object.__proto__;
	};
	view.Blob.prototype = getPrototypeOf(new view.Blob());
}(
	typeof self !== "undefined" && self
	|| typeof window !== "undefined" && window
	|| this
));

  • Export2Excel.js
/* eslint-disable */
require('script-loader!file-saver');
// require('script-loader!@/vendor/Blob');
require('./Blob');
require('script-loader!xlsx/dist/xlsx.core.min');
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);
    console.log('a')
    var oo = generateArray(theTable);
    var ranges = oo[1];

    /* original data */
    var data = oo[0];
    var ws_name = "SheetJS";
    console.log(data);

    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")
}

function formatJson (jsonData) {
    console.log(jsonData)
}
export function export_json_to_excel (th, jsonData, defaultTitle) {

    /* original data */

    var data = jsonData;
    data.unshift(th);
    var ws_name = "SheetJS";

    var wb = new Workbook(), ws = sheet_from_array_of_arrays(data);


    /* 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' });
    var title = defaultTitle || '列表'
    saveAs(new Blob([s2ab(wbout)], { type: "application/octet-stream" }), title + ".xlsx")
}

导出excel文件

 <template>
  <div class="hello">
    <el-button @click="outExe">导出</el-button>
  </div>
</template>
 
<script>
export default {
  data () {
    return {
      excelData: [
      { userId: 1, name: '小白', age: '18', status: "上学" },
      { userId: 2, name: '小黑', age: '22', status: "待业" },
      { userId: 3, name: '小红', age: '28', status: "就业" }
      ]
    };
  },
  methods: {
    // 导出确认框
    outExe () {
      this.$confirm("此操作将导出excel文件, 是否继续?", "提示", {
        confirmButtonText: "确定",
        cancelButtonText: "取消",
        type: "warning"
      })
        .then(() => {
          this.export2Excel();
        })
        .catch(() => { });
    },
    // 导出方法
    export2Excel () {
      const that = this;
      const tHeader = {
        "userId":"用户Id",
        "name":"姓名",
        "age":"年龄",
        "status":"身份",
      };
       // 按需导入
      import('@/excel/Export2Excel').then(async excel => {
        const dataArr = that.formatJson(Object.keys(tHeader),  that.excelData);
        // console.log(dataArr);
        // 配置导出文件格式以及数据  tHeader表头   dataArr数据  文件名字可用变量
        excel.export_json_to_excel(Object.values(tHeader), dataArr, `测试导出excel`);
      })
    },
    // 处理数据格式[[],[]]  
    formatJson (headerKeys, jsonData) {
     // return jsonData.map(v => Object.values(v)); // excel表头和数据顺序必须一致
      return jsonData.map(v => headerKeys.map(j => v[j])); // 跟定义的表头顺序保持一致
    }
  }
  
};
</script>
<style scoped>
</style>

导入excel (会过滤空值)

  • excel表中如果某一行的某一个单元格值为空 那么当前行的数据会过滤掉这一项
  • ArrayBuffer读取文件
importExcel (fileObj) {
      console.log(fileObj) // 文件对象
      var reader = new FileReader()
      // 自动触发
      reader.onload = function (e) {
        console.log(reader.result); //ArrayBuffer对象
        let binary = "";
        const bytes = new Uint8Array(reader.result);
        for (let i = 0; i < bytes.byteLength; i++) {
          binary += String.fromCharCode(bytes[i]);
        }
        const XLSX = require("xlsx");
        const wb = XLSX.read(binary, {
          type: "binary"
        });
        const outdata = XLSX.utils.sheet_to_json(wb.Sheets[wb.SheetNames[0]]);
        console.log(outdata);
        console.log([...outdata]); // 数据
      };
      reader.readAsArrayBuffer(fileObj)
    },
  • 二进制读取文件
// 不推荐  因为从 2012 年 7 月 12 日起,该方法已从 W3C 工作草案废除。
importExcel (fileObj) {
      console.log(fileObj)
      var reader = new FileReader()
      reader.onload = function (e) {
        console.log(reader.result); // 二进制字符串
        const XLSX = require("xlsx");
        const wb = XLSX.read(reader.result, {
          type: "binary"
        });
        const outdata = XLSX.utils.sheet_to_json(wb.Sheets[wb.SheetNames[0]])
        console.log([...outdata]);
      };
      reader.readAsBinaryString(fileObj)
    },

导入excel (保留空字段)

importExcel (fileObj) {
      console.log(fileObj) // 文件对象
      var reader = new FileReader()
      // 自动触发
      reader.onload = function (e) {
        console.log(reader.result); //ArrayBuffer对象
        let binary = "";
        const bytes = new Uint8Array(reader.result);
        for (let i = 0; i < bytes.byteLength; i++) {
          binary += String.fromCharCode(bytes[i]);
        }
        const XLSX = require("xlsx");
        const wb = XLSX.read(binary, {
          type: "binary"
        });
        const outdata = XLSX.utils.sheet_to_json(wb.Sheets[wb.SheetNames[0]],{ header: 1, defval: '' });  // defval 空值给的默认值
        let data = [...outdata]
       const keyData = data.splice(0, 1)[0]
        const excelData = data.map(row => {
          return row.reduce((obj, item, i) => {
            obj[keyData[i]] = item
            return obj
          }, {})
        })
        console.log(excelData);
      };
      
      reader.readAsArrayBuffer(fileObj)
    },

导出进阶

  • 合并单元格, 设置单元格宽高
  1. 替换 Export2Excel.js 中的 export_json_to_excel 函数
export function export_json_to_excel (th, jsonData, defaultTitle, config) {
    /* original data */

    var data = jsonData;
    data.unshift(th);
    var ws_name = "SheetJS";

    var wb = new Workbook(), ws = sheet_from_array_of_arrays(data);
    // 合并单元格
    if (config.merges && config.merges.length > 0) {
        if (!ws['!merges']) ws['!merges'] = [];
        config.merges.forEach(item => {
            ws['!merges'].push(XLSX.utils.decode_range(item))
        })
    }
    // 单元格宽度
    if (config.cols) {
        ws["!cols"] = config.cols
    }
    // 单元格高度
    if (config.rows) {
        ws["!rows"] = config.rows
    }
    /* 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' });
    var title = defaultTitle || '列表'
    saveAs(new Blob([s2ab(wbout)], { type: "application/octet-stream" }), title + ".xlsx")
}
  1. 封装工具函数
// 导出Excel
export const exportExcel = (excelHead, excelData, fileName, config) => {
// '@/excel/Export2Excel.js' 具体路径请根据项目配置
  import('@/excel/Export2Excel.js').then(async excel => {
    excel.export_json_to_excel(excelHead, excelData, fileName, config)
    // 成功提示 这里使用的Element-ui
    // config.successMsg ? Message.success(config.successMsg) : Message.success('导出Excel成功')
    // 导出成功回调函数
    config.successCallback && config.successCallback()
  }).catch(() => {
    // 失败提示
    config.errorMsg ? Message.error(config.errorMsg) : Message.error('导出失败')
    // 导出失败回调
    config.errorCallback && config.errorCallback()
  })
}
  1. 使用示例
 const excelHead = ['用户信息', '', '', '用户地址']
const excelData = [
    ['姓名', '年龄', '性别'],
    ['张三', '18', '男', '北京市'],
    ['小芳', '17', '女', '上海市']
]
const fileName = 'userInfo'
exportExcel(excelHead, excelData, fileName, {
    merges:['A1:C1'], // 需要合并的单元格
    cols: [{ wch: 10 }, { wch: 30 }, { wch: 10 }, { wch: 50 }], // 宽
    rows: [{ hpt: 25 }, { hpt: 25 }, { hpt: 25 }, { hpt: 25 }], // 高
    successMsg:'导出成功',
    successCallback:()=>{
        console.log('导入成功')
    }
})
// 合并单元格可以先导出普通的表格再根据合并需求设置 excelHead, excelData, 和 merges 格式
// 单元格内容居中有时间会研究 有大佬搞定的也可以分享  
// 也可以参考大佬的这个方案: https://juejin.cn/post/7044756905884909598#heading-6
  1. 导出效果

Snipaste_2022-07-19_17-41-58.jpg