使用excel表单实现批量导入导出

291 阅读2分钟

本文已参与[新人创作礼]活动,一起开启掘金创作之路

一.下包

"xlsx": "^0.14.1"
yarn add xlsx@0.14.1

二.导入部分

1.注册公共组件

hr/src/components/UploadExcel/index.vue

<template>
  <div>
    <input
      ref="excel-upload-input"
      class="excel-upload-input"
      type="file"
      accept=".xlsx, .xls"
      @change="handleClick"
    />
    <div
      class="drop"
      @drop="handleDrop"
      @dragover="handleDragover"
      @dragenter="handleDragover"
    >
      Drop excel file here or
      <el-button
        :loading="loading"
        style="margin-left: 16px"
        size="mini"
        type="primary"
        @click="handleUpload"
      >
        Browse
      </el-button>
    </div>
  </div>
</template>

<script>
import XLSX from "xlsx";

export default {
  name:'UploadExcel',
  props: {
    beforeUpload: Function, // eslint-disable-line
    onSuccess: Function, // eslint-disable-line
  },
  data() {
    return {
      loading: false,
      excelData: {
        header: null,
        results: null,
      },
    };
  },
  methods: {
    generateData({ header, results }) {
      this.excelData.header = header;
      this.excelData.results = results;
      this.onSuccess && this.onSuccess(this.excelData);
    },
    handleDrop(e) {
      e.stopPropagation();
      e.preventDefault();
      if (this.loading) return;
      const files = e.dataTransfer.files;
      if (files.length !== 1) {
        this.$message.error("Only support uploading one file!");
        return;
      }
      const rawFile = files[0]; // only use files[0]

      if (!this.isExcel(rawFile)) {
        this.$message.error(
          "Only supports upload .xlsx, .xls, .csv suffix files"
        );
        return false;
      }
      this.upload(rawFile);
      e.stopPropagation();
      e.preventDefault();
    },
    handleDragover(e) {
      e.stopPropagation();
      e.preventDefault();
      e.dataTransfer.dropEffect = "copy";
    },
    handleUpload() {
      this.$refs["excel-upload-input"].click();
    },
    handleClick(e) {
      const files = e.target.files;
      const rawFile = files[0]; // only use files[0]
      if (!rawFile) return;
      this.upload(rawFile);
    },
    upload(rawFile) {
      this.$refs["excel-upload-input"].value = null; // fix can't select the same excel

      if (!this.beforeUpload) {
        this.readerData(rawFile);
        return;
      }
      const before = this.beforeUpload(rawFile);
      if (before) {
        this.readerData(rawFile);
      }
    },
    readerData(rawFile) {
      this.loading = true;
      return new Promise((resolve, reject) => {
        const reader = new FileReader();
        reader.onload = (e) => {
          const data = e.target.result;
          const workbook = XLSX.read(data, { type: "array" });
          const firstSheetName = workbook.SheetNames[0];
          const worksheet = workbook.Sheets[firstSheetName];
          const header = this.getHeaderRow(worksheet);
          const results = XLSX.utils.sheet_to_json(worksheet);
          this.generateData({ header, results });
          this.loading = false;
          resolve();
        };
        reader.readAsArrayBuffer(rawFile);
      });
    },
    getHeaderRow(sheet) {
      const headers = [];
      const range = XLSX.utils.decode_range(sheet["!ref"]);
      let C;
      const R = range.s.r;
      /* start in the first row */
      for (C = range.s.c; C <= range.e.c; ++C) {
        /* walk every column in the range */
        const cell = sheet[XLSX.utils.encode_cell({ c: C, r: R })];
        /* find the cell in the first row */
        let hdr = "UNKNOWN " + C; // <-- replace with your desired default
        if (cell && cell.t) hdr = XLSX.utils.format_cell(cell);
        headers.push(hdr);
      }
      return headers;
    },
    isExcel(file) {
      return /\.(xlsx|xls|csv)$/.test(file.name);
    },
  },
};
</script>

<style scoped>
.excel-upload-input {
  display: none;
  z-index: -9999;
}
.drop {
  border: 2px dashed #bbb;
  width: 600px;
  height: 160px;
  line-height: 160px;
  margin: 0 auto;
  font-size: 24px;
  border-radius: 5px;
  text-align: center;
  color: #bbb;
  position: relative;
}
</style>

2.添加相应路由跳转


  children: [
     ......
    {
      name: "employees", // 给路由规则加一个name
      path: "", // 这里当二级路由的path什么都不写的时候 表示当前路由为默认路由直接渲染对
      应组件
      component: () => import("路径"),
      // 路由原信息  其实就是存储数据的对象 我们可以在这里放置一些信息
      meta: { title: "标题", icon: "图标" },
    }
  ],

3.注册跳转事件

引导者

hr/src/views/employees/employees.vue

<el-button size="small" type="primary" 
@click="$router.push('/employees/import')">导入</el-button>

4.接口请求

/**
 * @description: 导入excel
 * @param {*} data
 * @return {*}
 */
export function importEmployee(data) {
  return request({
    url: "/sys/user/batch",
    method: "post",
    data,
  });
}

5.创建excel组件

src\views\employees\components\import.vue

注意

中文标签名无法读取需要转为英文
<template>
  <div>
    <UploadExcel :onsuccess="handleSuccess" />
  </div>
</template>

<script>
import { importEmployee } from '@/api/employees'
import { formatExcelDate } from '@/utils'
export default {
  name: 'Import',
  data() {
    return {}
  },
  computed: {},
  created() {},
  methods: {
      //导入事件
    async handleSuccess({ results, header }) {
      /*
      results:tbody 表体
      header:thead 表头
      1-获取表头和表体  results, header
      2-发送请求
        2-1 封装api接口函数
        2-2 调用函数
          2-2-1 需要处理传递的参数==results
          2-2-2 将数组中的中文字段全部转换成英文字段
        2-3 成功后:调回员工列表页面
      */
      /* 处理数据 */
      /* 处理数据 */
      const mapInfo = {
        入职日期: 'timeOfEntry',
        手机号: 'mobile',
        姓名: 'username',
        转正日期: 'correctionTime',
        工号: 'workNumber',
        部门: 'departmentName',
        聘用形式: 'formOfEmployment'
      }
      // console.log(keys, 7);
      var newResults = results.map((item) => {
        /* 3-定义一个空对象,重新定义数组中的每一项 */
        var obj = {}
        /* 1-获取中文键数组 */
        var chKeys = Object.keys(mapInfo)
        // ['入职日期', '手机号', '姓名', '转正日期', '工号', '部门', '聘用形式']
        chKeys.forEach((key) => {
          /* 2-获取英文键 */
          var enKey = mapInfo[key]
          /* 4-重新定义数组中每一项的值 */
          /* 5-解决excel时间转换问题 formatExcelDate */
          if (enKey === 'timeOfEntry' || enKey === 'correctionTime') {
            obj[enKey] = new Date(formatExcelDate(item[key]))
          } else {
            obj[enKey] = item[key]
          }
        })
        return obj
      })
      //console.log(newResults, 9988)
      const res = await importEmployee(newResults)
    }
  }
}
</script>
<style lang="less" scoped></style>

6.excel与js时间转换(excel组件需引入)

注意

excel和js初始时间不同需要调整时差

hr/src/utils/index.js

/* js和excel时间转换 */
export function formatExcelDate(numb, format = '/') {
  const time = new Date(
    (numb - 25567) * 24 * 3600000 -
      5 * 60 * 1000 -
      43 * 1000 -
      24 * 3600000 -
      8 * 3600000
  )
  time.setYear(time.getFullYear())
  const year = time.getFullYear() + ''
  const month = time.getMonth() + 1 + ''
  const date = time.getDate() + ''
  if (format && format.length === 1) {
    return year + format + month + format + date
  }
  return (
    year + (month < 10 ? '0' + month : month) + (date < 10 ? '0' + date : date)
  )
}

三.导出部分

引导者

hr/src/views/employees/employees.vue

注意

1.data为二维数组

2.tHeader表头需重新设置(头部需要与data数据对应)

3.可实现多表头和合并单元格
    /* 导出 */
    handleDownload() {
      // this.downloadLoading = true
      import('@/vendor/Export2Excel').then(async(excel) => {
      // 设置表头
        // const tHeader = ['Id123', 'Title', 'Author', 'Readings', 'Date']
        // const list = this.tableData
        const res = await getEmployeeList({ page: 1, size: this.total })
        const list = res.data.rows
        const data = this.formatJson(list)
        const tHeader = this.header
        excel.export_json_to_excel({
          multiHeader: [
            ['大前端', '', '', '', '', '', '', '', '', ''],
            ['前端', '', '', '', '', '', '', '', '', '']
          ], // 设置多表头
          merges: ['A1:J1', 'A2:B2'], // 合并列
          header: tHeader,
          data
          // data: [
          //   ['11111111111111111111', '2', '3', '4', '5'],
          //   ['1', '2', '3', '4', '5'],
          //   ['1', '2', '3', '4', '5'],
          //   ['1', '2', '3', '4', '5'],
          //   ['1', '2', '3', '4', '5']
          // ],
          filename: 'web72', // 设置文件名
          autoWidth: this.autoWidth
        // autoWidth: true, //设置表格宽度自适应的 默认是:true
        // bookType: "txt", //设置文件格式
        })
        // this.downloadLoading = false
      })
    },
    formatJson(list) {
      const map = {
        id: '编号',
        password: '密码',
        mobile: '手机号',
        username: '姓名',
        timeOfEntry: '入职日期',
        formOfEmployment: '聘用形式',
        correctionTime: '转正日期',
        workNumber: '工号',
        departmentName: '部门',
        staffPhoto: '头像地址'
      }
      // 目的:将以为list数组转换成二维数组
      return list.map((item) => {
        /* 4-定义一个收集数据的对象 */
        var obj = {}
        /* 1-根据需求筛选出想要的几个数据===获取字段  map */
        /* 2-获取所有的英文键 */
        // ['id', 'password', 'mobile', 'username', 'timeOfEntry', 'formOfEmployment', 'correctionTime', 'workNumber', 'departmentName', 'staffPhoto']
        var enKey = Object.keys(map)
        /* 3-获取每一个英文键所对应的值 */
        enKey.forEach((key) => {
          /* 5-获取中文键 */
          var zhKey = map[key] // 编号
          obj[zhKey] = item[key] // {编号:值}==>{编号:65c2,密码:1111112233}
        })
        /* obj
        {
          入职日期: "2018-11-02"
          头像地址: "https:jingwork-1310903985.cos.ap-nanjing.myqcloud.com/daji.jpg"
          姓名: "管理员"
          密码: "e10adc3949ba59abbe56e057f20f883e"
          工号: "9002"
          手机号: "13800000002"
          编号: "604f764971f93f3ac8f365c2"
          聘用形式: "1"
          转正日期: "2018-11-30"
          部门: "总裁办"
        }
        */

        /* 6-获取所有obj中的值 */
        // console.log(obj)//数组中变量值
        var valueArr = Object.values(obj) // ["2018-11-02","管理员","9002"]
        // console.log(valueArr, 9); []
        this.haeder = Object.keys(obj)
        return valueArr
      })
    }
  }

注册导出组件

src\vendor\Export2Excel.js

/* eslint-disable */
import { saveAs } from '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,
  filename,
  merges = [],
  autoWidth = true,
  bookType = 'xlsx'
} = {}) {
  /* original data */
  filename = filename || 'excel-list'
  data = [...data]
  data.unshift(header);

  for (let i = multiHeader.length - 1; i > -1; i--) {
    data.unshift(multiHeader[i])
  }

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

  if (merges.length > 0) {
    if (!ws['!merges']) ws['!merges'] = [];
    merges.forEach(item => {
      ws['!merges'].push(XLSX.utils.decode_range(item))
    })
  }

  if (autoWidth) {
    /*设置worksheet每列的最大宽度*/
    const colWidth = data.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 = colWidth[0];
    for (let i = 1; i < colWidth.length; i++) {
      for (let j = 0; j < colWidth[i].length; j++) {
        if (result[j]['wch'] < colWidth[i][j]['wch']) {
          result[j]['wch'] = colWidth[i][j]['wch'];
        }
      }
    }
    ws['!cols'] = result;
  }

  /* add worksheet to workbook */
  wb.SheetNames.push(ws_name);
  wb.Sheets[ws_name] = ws;

  var wbout = XLSX.write(wb, {
    bookType: bookType,
    bookSST: false,
    type: 'binary'
  });
  saveAs(new Blob([s2ab(wbout)], {
    type: "application/octet-stream"
  }), `${filename}.${bookType}`);
}

注册导出组件

src\vendor\Export2Zip.js

/* eslint-disable */
import { saveAs } from 'file-saver'
import JSZip from 'jszip'

export function export_txt_to_zip(th, jsonData, txtName, zipName) {
  const zip = new JSZip()
  const txt_name = txtName || 'file'
  const zip_name = zipName || 'file'
  const data = jsonData
  let txtData = `${th}\r\n`
  data.forEach((row) => {
    let tempStr = ''
    tempStr = row.toString()
    txtData += `${tempStr}\r\n`
  })
  zip.file(`${txt_name}.txt`, txtData)
  zip.generateAsync({
    type: "blob"
  }).then((blob) => {
    saveAs(blob, `${zip_name}.zip`)
  }, (err) => {
    alert('导出失败')
  })
}