可选数据导出excel文件组件 - 「vue」

1,598 阅读3分钟

背景

小伙伴们是否遇到这样一个需求:请实现数据导出功能,导出的字段可以根据需要选择和生成自己想要的模板进行并导出文件EXCEL表。

还没有遇见?不要紧,我在学校实验室项目就遇见了,害,就让我先来乘风破浪儿叭(害怕)

效果展示

先将原先的功能和完成的功能进行效果展示叭!!

原先

  • 点击导出excel按钮
  • 确认下载excel文件
  • 打开excel文件

完成

  • 点击导出excel按钮
  • 选择需导出的字段
  • 选择需导出的数据条数
  • 确认下载excel文件
  • 打开excel文件

实现

在实现咱们需求前,默认你们已经完成了原先的效果啦(🐶 保命)

哈哈哈哈哈开玩笑开玩笑...(应该不太好笑)

所以咱先一步步完成原先导出excel表格文件的功能叭!

案例是在vue框架下噢

excel导出功能

需要安装插件儿

npm i file-saver xlsx -S-D

npm i script-loader -D

目录结构

-src(源代码目录)

--utils(公共方法目录)

---index.js(入口文件)

---Export2Excel.js(导出excel文件)

--views(页面目录)

--- example.vue(测试页面)

代码实现

这篇文章的重点是如何可选项地导出excel,功能简单附上代码实现即可。

Export2Excel.js

/* 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,
  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}`);
}

index.js

export async function exportExcel(header, data, filename) {
  const excel = await import('@/vendor/Export2Excel')
  excel.export_json_to_excel({
    header,
    data,
    filename
  })
}

example.vue

将导出excel的方法导入即可,配置对应的excel表头以及excel数据

<template>
  <div class="app-container">
    <el-button :loading="downloadLoading" class="filter-item" type="default" @click="handleDownload">
      导出excel
	  </el-button>
    <el-table
      v-loading="listLoading"
      :data="list"
      border
      fit
      highlight-current-row
      style="width: 100%;"
    >
      <el-table-column label="缴费单号" prop="sn" align="center"/>
      <el-table-column label="缴费单名称" prop="name" align="center" />
      <el-table-column label="状态" align="center">
        <template #default="{row}">
          <span>{{ row.status | statusFilter }}</span>
        </template>
      </el-table-column>
      <el-table-column label="缴费金额" prop="amount" align="center"/>
      <el-table-column label="缴费时间" prop="paymentTime" align="center" width="100px"/>
      <el-table-column label="备注" prop="remark" align="center"/>
      <el-table-column label="创建人" prop="creatorName" align="center"/>
    </el-table>
  </div>
</template>

<script>
  const paymentStatusMap = ['良好', '正常', '优秀']
  import { exportExcel } from '@/utils'
  export default {
    name: 'Example',
    filters: {
      statusFilter(status) {
        return paymentStatusMap[status]
      }
    },
    data() {
      return {
        list: [
          {
          	sn: '测试单号',
            name: '1',
            status: 1,
            amount: '1111',
            paymentTime: '2020-12-23',
            remark '备注测试',
            creatorName: '创建人'
        	},
          {
          	sn: '测试单号',
            name: '1',
            status: 1,
            amount: '1111',
            paymentTime: '2020-12-23',
            remark '备注测试',
            creatorName: '创建人'
        	},
          {
          	sn: '测试单号',
            name: '1',
            status: 1,
            amount: '1111',
            paymentTime: '2020-12-23',
            remark '备注测试',
            creatorName: '创建人'
        	},
          {
          	sn: '测试单号',
            name: '1',
            status: 1,
            amount: '1111',
            paymentTime: '2020-12-23',
            remark '备注测试',
            creatorName: '创建人'
        	}   
        ],
        listLoading: false,
        downloadLoading: false,
        statusOptions: paymentStatusMap
      }
    },
    methods: {
      async handleDownload() {
        this.downloadLoading = true
        const header = ['缴费单号', '缴费单名称', '状态', '缴费金额', '缴费时间 ', '备注', '创建人', '创建时间', '更新时间']
        const filterVal = ['sn', 'name', 'status', 'amount', 'paymentTime', 'remark', 'creatorName', 'createTime', 'updateTime']
        const data = this.formatJson(filterVal, this.list)
        await exportExcel(header, data, '测试列表')
        this.downloadLoading = false
      },
      /**
       * @description 格式化
       */
      formatJson(filterVal, jsonData) {
        return jsonData.map(v => filterVal.map(j => {
          if (j === 'status') {
            return paymentStatusMap[v[j]]
          } else {
            return v[j]
          }
        }))
      }
    }
  }
</script>

这样我们就完成了excel的导出功能啦!

接下来如何可选所需字段以及可选条数呢!那咱们接着整活

可选导出功能

利用element-ui的界面和table来封装一个可选excel功能的组件

目录结构

在原先excel导出功能的基础上
-src(源代码目录)

--components(组件目录)

---exportOptionExcel.vue(可选组件)

代码实现

exportOptionExcel.vue

关键字段都有注释噢,UI组件和样式就不多解释啦。感兴趣的小伙伴们可以查看 element-ui官网

<template>
  <div class="excel-option-main">
    <el-popover
      placement="right"
      width="400"
      trigger="click"
      @show="handleExcel">
      <div class="excel-option-container">
        <el-checkbox v-model="checkAll" :indeterminate="isIndeterminate" @change="handleCheckAllChange">全选</el-checkbox>
        <div style="margin: 15px 0;"/>
        <el-checkbox-group v-model="checkedExcel" @change="handleCheckedExcelChange">
          <el-checkbox v-for="(item) in excelOptions" :key="item.key" class="excel-option-checkbox" :label="item">{{ item.value }}</el-checkbox>
        </el-checkbox-group>
      </div>
      <el-button :loading="downloadLoading" class="excel-option-btn" size="small" type="primary" @click="handleDownload">
        确认导出
      </el-button>
      <el-button slot="reference" class="filter-item" type="default">
        导出excel
      </el-button>
    </el-popover>
  </div>
</template>

<script>
  import { exportExcel } from '@/utils'
  export default {
    name: 'ExportOptionExcel',
    props: {
      // 整个table的数据 => 用来切割成表头和数据
      table: {
        type: Object,
        default: () => {}
      },
      // 最后格式化后的数据(结合父组件查看)
      data: {
        type: Array,
        default: () => []
      },
      // 是否开启了element的table勾选功能
      check: {
        type: Boolean,
        default: false
      }
    },
    data() {
      return {
        lock: false,
        downloadLoading: false,
        // 是否全部勾选
        checkAll: false,
        // 已勾选数据
        checkedExcel: [],
        // 可勾选的表头字段
        excelOptions: [],
        // table的数据
        list: [],
        // element的多选框字段(可到官网查看噢)
        isIndeterminate: true
      }
    },
    created() {
      // 组件首次加载 -> 开锁(防止多次添加可勾选的表头字段)
      this.lock = false
    },
    methods: {
      // 全选
      handleCheckAllChange(val) {
        this.checkedExcel = val ? this.excelOptions : []
        this.isIndeterminate = false
      },
      // 勾选字段
      handleCheckedExcelChange(value) {
        const checkedCount = value.length
        this.checkAll = checkedCount === this.excelOptions.length
        this.isIndeterminate = checkedCount > 0 && checkedCount < this.excelOptions.length
      },
      // 点击弹出框 => 初始化组件
      handleExcel() {
        // 防止多次添加可勾选的表头字段
        if (this.lock) return
        // 获取table数据切割表头和对应的prop字段
        this.table.$children.forEach(v => {
          if (!v.label || !v.prop) return
          this.excelOptions.push({ key: v.prop, value: v.label })
        })
        this.list = this.check ? this.table.selection : this.table.data
        // 闭锁
        this.lock = true
      },
      // 确认导出按钮
      async handleDownload() {
        // 判断是否勾选数据
        if (!this.list.length || !this.checkedExcel.length) {
          return this.$message({
            type: 'warning',
            message: '请勾选导出数据'
          })
        }
        this.downloadLoading = true
        const headers = []
        const valueFilter = []
        // 将已勾选的数据提取
        this.checkedExcel.forEach(({ key, value }) => {
          headers.push(value)
          valueFilter.push(key)
        })
        // 格式化数据
        await this.formatJson(valueFilter, this.list)
        // 设置导出的excel文件名
        const { title } = this.$route.meta
        await exportExcel(headers, this.data, `${title}`)
        this.downloadLoading = false
      },
      /**
       * @description 格式化
       */
      async formatJson(valueFilter, listData) {
        await this.$emit('formatJson', valueFilter, listData)
      }
    }
  }
</script>

<style scoped>
.excel-option-main {
  display: inline-block;
  margin-left: 10px;
}

.excel-option-container {
  padding: 10px;
}
.excel-option-checkbox {
  display: inline-block;
  width: 85px;
  height: 30px;
}
.excel-option-btn {
  margin-left: 3%;
}

</style>

example.vue

在需要此功能的父组件中调用子组件

更改的地方加上两个*噢,记得要去掉

<template>
  <div class="app-container">
    
	**<export-option-excel :table.sync="excelTable" :check="true" :data="excelData" @formatJson="formatJson" />**
    
    <el-table
      ** ref="table" **
      v-loading="listLoading"
      :data="list"
      border
      fit
      highlight-current-row
      style="width: 100%;"
    >
      <!-- 可选择是否table开启可选框 => 若开启 => 传入子组件check="true" => 反之则不传 -->
      ** <el-table-column
        type="selection"
        align="center"
        width="55" /> ** 
      <el-table-column label="缴费单号" prop="sn" align="center"/>
      <el-table-column label="缴费单名称" prop="name" align="center" />
      <el-table-column label="状态" align="center">
        <template #default="{row}">
          <span>{{ row.status | statusFilter }}</span>
        </template>
      </el-table-column>
      <el-table-column label="缴费金额" prop="amount" align="center"/>
      <el-table-column label="缴费时间" prop="paymentTime" align="center" width="100px"/>
      <el-table-column label="备注" prop="remark" align="center"/>
      <el-table-column label="创建人" prop="creatorName" align="center"/>
    </el-table>
  </div>
</template>

<script>
  const paymentStatusMap = ['良好', '正常', '优秀']
  // 将导入方法替换为子组件导入
  // import { exportExcel } from '@/utils'
  ** import exportOptionExcel from '@/components/exportOptionExcel' **
  export default {
    name: 'Example',
    ** components: { exportOptionExcel }, **
    filters: {
      statusFilter(status) {
        return paymentStatusMap[status]
      }
    },
    data() {
      return {
        list: [
          {
          	sn: '测试单号',
            name: '1',
            status: 1,
            amount: '1111',
            paymentTime: '2020-12-23',
            remark '备注测试',
            creatorName: '创建人'
        	},
          {
          	sn: '测试单号',
            name: '1',
            status: 1,
            amount: '1111',
            paymentTime: '2020-12-23',
            remark '备注测试',
            creatorName: '创建人'
        	},
          {
          	sn: '测试单号',
            name: '1',
            status: 1,
            amount: '1111',
            paymentTime: '2020-12-23',
            remark '备注测试',
            creatorName: '创建人'
        	},
          {
          	sn: '测试单号',
            name: '1',
            status: 1,
            amount: '1111',
            paymentTime: '2020-12-23',
            remark '备注测试',
            creatorName: '创建人'
        	}   
        ],
        listLoading: false,
        downloadLoading: false,
        statusOptions: paymentStatusMap,
        **         
        excelTable: undefined,	// 初始化传入table数据
        excelData: []	// 格式化后的数据
        **
      }
    },
    async created() {
      // await this.getList()	若是请求后端异步拿到table数据则需要async/await
      ** this.excelTable = this.$refs.table **	// 初始化table数据
    },
    methods: {
      // handleDownload导出excel方法删除掉
      
      // 自定义格式化table的数据 => 回调数据给子组件
      formatJson(filterVal, jsonData) {
        this.excelData = jsonData.map(v => filterVal.map(j => {
          return v[j]
        }))
      }
    }
  }
</script>

最后

自此,咱们的功能需求就完成啦

可以应对最大多数的数据,若有特殊的情况,可以稍加修改噢

有个注意的地方是el-table-column都需加上对应的prop值,这样才不会让可选字段丢失

有了自己封装的可选excel导出组件,就只需要专注如何格式化成自己所需要的数据即可啦

以上!与小伙伴们共同学习。

厚着脸皮的林大人的小屋系列: