给我实现一个前端的 Excel 导入和导出功能(一)

简介: 给我实现一个前端的 Excel 导入和导出功能

image.png


前言

负责人 A】:现在报表部分基于接口的 Excel 的导入和导出功能有点慢,前端这边能不能实现一下这个功能,然后我们在比对看看效果!

切图仔 B】: 接口这边不能优化一下吗?比如排查下慢的原因什么的。

负责人 A】:现在后端开发任务比较重,处理的核心任务也多还会涉及一些架构上的调整,所以想着前端这边可以处理一下,然后看看整体效果。

切图仔 B】: OK,试试 就 ~ Shi Shi ~

下面就基于 xlsx 这个第三方库封装一个 <ExcelUpload /> 组件实现表格导入,以及 json 数据导出 Excel 功能的 json2Excel() 工具方法。

选择 xlsx 的原因如下图所示:

image.png

Excel 解析为 JSON

基本内容

组件效果和结构

组件内容是很简单的结构和视图,直接查看如下的页面效果和代码即可:

image.png

<template>
  <input
    type="file"
    ref="excelRef"
    :accept="props.accept"
    @change="onChange"
    class="excel"
  />
  <h1>解析数据:</h1>
  <h2>
    <code>{{ excelData }}</code>
  </h2>
</template>
<script setup lang="ts">
import { reactive, ref } from 'vue'
import * as XLSX from 'xlsx'
interface Props {
  accept: string
}
const props = withDefaults(defineProps<Props>(), {
  accept:
    '.csv, application/vnd.ms-excel, application/vnd.openxmlformats-officedocument.spreadsheetml.sheet',
})
const excelRef: any = ref(null)
const excelData: any[] = reactive([])
const onChange = (event: any) => {
  // 获取文件对象
  const file = event.target.files[0]
  console.log(file)
}
</script>
复制代码

Excel 数据格式

Excel 数据格式有两种,一种是 有表头说明 的,另一种是 无表头说明 的,具体内容如下:

  • 有表头说明
  • image.png
  • 无表头说明
  • image.png

实现 Excel 转 JSON 功能

核心步骤

  • 通过 FileReader 以二进制的方式读取 Excel 文件,即 fileReader.readAsBinaryString(file)
  • 将对应的二进制数据通过 XLSX.read(fileData, {       type: "binary"     }) 方法生成 workbook 对象
  • workbook.SheetNames[0] 获取第一个 Sheet 的名称 wsname,因为表格是有序列表,因此可以有多个 Sheet
    image.png
  • 通过 XLSX.utils.sheet_to_json(workbook.Sheets[wsname]) 方法将对应的 Sheet 内容转换为 JSON 数据

效果演示

  • 有表头说明
     image.png
  • 无表头说明
      image.png

具体代码

// 读取对应表格文件
const readerExcel = (file: File) => {
  const fileReader = new FileReader();
  // 以二进制的方式读取表格内容
  fileReader.readAsBinaryString(file);
  // 表格内容读取完成
  fileReader.onload = (event: any) => {
    try {
      const fileData = event.target.result;
      const workbook = XLSX.read(fileData, {
        type: "binary",
      });
      // 表格是有序列表,因此可以取多个 Sheet,这里取第一个 Sheet
      const wsname = workbook.SheetNames[0];
      // 将表格内容生成 json 数据
      const sheetJson = XLSX.utils.sheet_to_json(workbook.Sheets[wsname]);
      console.log(sheetJson); // 得到的表格 JSON 内容
    } catch (e) {
      console.log(e);
      return false;
    }
  };
};
// 文件变化时触发
const onChange = (event) => {
  // 获取文件对象
  const file = event.target.files[0];
  // 读取文件内容
  readerExcel(file);
  // 清除数据
  clearFile();
};
const clearFile = () => {
  excelRef.value.value = "";
};
复制代码

格式化 JSON 数据

这里需要考虑 有表头说明无表头说明 的情况,为了方便统一处理,作如下规定:

  • 通过将 有表头说明 的数据格式统一转化为 无表头说明 的数据格式
  • 统一将 无表头说明 的数据格式转化为标准的接口入参,即 { key: value },这里需要建立一个 name -> key 的映射关系:
const excelNameToKey = {
  '姓名': "name",
  '年龄': "age",
  '特长': "skill",
  '电话': "telephone",
  '地址': "address",
};
复制代码

格式化如下:

image.png

核心代码如下:

<script setup lang='ts'>
import { reactive, ref } from "vue";
import * as XLSX from "xlsx";
const excelNameToKey = {
  姓名: "name",
  年龄: "age",
  特长: "skill",
  电话: "telephone",
  地址: "address",
};
interface Props {
  accept: string;
}
const props = withDefaults(defineProps<Props>(), {
  accept:
    ".csv, application/vnd.ms-excel, application/vnd.openxmlformats-officedocument.spreadsheetml.sheet",
});
const excelRef: any = ref(null);
const excelData: any[] = reactive([]);
const clearFile = () => {
  excelRef.value.value = "";
};
// 标准化 JSON 数据
const excelDataToJson = (sheetJson: any[]) => {
  if (!sheetJson.length) return;
  let result = sheetJson;
  const hasTableHead = !!sheetJson[0].__EMPTY;
  // 拥有表头的数据,需要取正确的值
  if (hasTableHead) {
    const header = sheetJson.shift();
    const data: any[] = [];
    Object.keys(header).forEach((key) => {
      sheetJson.forEach((item, index) => {
        const obj = data[index] || {};
        obj[header[key]] = item[key];
        data[index] = obj;
      });
    });
    console.log("【】【】", data);
    result = data;
  }
  // 将表格对应的文字转换为 key
  result.forEach((item) => {
    const newItem: any = {};
    Object.keys(item).forEach((key) => {
      newItem.title = key;
      newItem[excelNameToKey[key]] = item[key];
    });
    excelData.push(newItem);
  });
};
// 读取对应表格文件
const readerExcel = (file: File) => {
  const fileReader = new FileReader();
  // 以二进制的方式读取表格内容
  fileReader.readAsBinaryString(file);
  // 表格内容读取完成
  fileReader.onload = (event: any) => {
    try {
      const fileData = event.target.result;
      const workbook = XLSX.read(fileData, {
        type: "binary",
      });
      // 表格是有序列表,因此可以取多个 Sheet,这里取第一个 Sheet
      const wsname = workbook.SheetNames[0];
      // 将表格内容生成 json 数据
      const sheetJson = XLSX.utils.sheet_to_json(workbook.Sheets[wsname]);
      console.log(sheetJson);
      // 标准化 JSON 数据
      excelDataToJson(sheetJson);
    } catch (e) {
      console.log(e);
      return false;
    }
  };
};
// 文件变化时触发
const onChange = (event) => {
  // 获取文件对象
  const file = event.target.files[0];
  // 读取文件内容
  readerExcel(file);
  // 清除数据
  clearFile();
};
</script>


目录
相关文章
|
14天前
|
前端开发 Java easyexcel
SpringBoot操作Excel实现单文件上传、多文件上传、下载、读取内容等功能
SpringBoot操作Excel实现单文件上传、多文件上传、下载、读取内容等功能
54 8
|
13天前
|
Java API Apache
|
17天前
|
存储 Java API
Java实现导出多个excel表打包到zip文件中,供客户端另存为窗口下载
Java实现导出多个excel表打包到zip文件中,供客户端另存为窗口下载
25 4
|
21天前
|
JavaScript 前端开发 数据处理
Vue导出el-table表格为Excel文件的两种方式
Vue导出el-table表格为Excel文件的两种方式
|
20天前
|
前端开发 API
前端界面生成PDF并导出下载
【10月更文挑战第21天】利用合适的第三方库,你可以在前端轻松实现界面生成 PDF 并导出下载的功能,为用户提供更方便的文档分享和保存方式。你还可以根据具体的需求进一步优化和定制生成的 PDF 文件,以满足不同的业务场景要求。
|
1月前
|
easyexcel Java UED
SpringBoot中大量数据导出方案:使用EasyExcel并行导出多个excel文件并压缩zip后下载
在SpringBoot环境中,为了优化大量数据的Excel导出体验,可采用异步方式处理。具体做法是将数据拆分后利用`CompletableFuture`与`ThreadPoolTaskExecutor`并行导出,并使用EasyExcel生成多个Excel文件,最终将其压缩成ZIP文件供下载。此方案提升了导出效率,改善了用户体验。代码示例展示了如何实现这一过程,包括多线程处理、模板导出及资源清理等关键步骤。
|
1月前
|
前端开发 JavaScript
💥【exceljs】纯前端如何实现Excel导出下载和上传解析?
本文介绍了用于处理Excel文件的库——ExcelJS,相较于SheetJS,ExcelJS支持更高级的样式自定义且易于使用。表格对比显示,ExcelJS在样式设置、内存效率及流式操作方面更具优势。主要适用于Node.js环境,也支持浏览器端使用。文中详细展示了如何利用ExcelJS实现前端的Excel导出下载和上传解析功能,并提供了示例代码。此外,还提供了在线调试的仓库链接和运行命令,方便读者实践。
286 5
|
1月前
|
前端开发 JavaScript 编译器
不走弯路,纯前端如何把图片导出成视频!
【10月更文挑战第3天】不走弯路,纯前端如何把图片导出成视频!
42 3
|
30天前
|
前端开发 JavaScript API
前端基于XLSX实现数据导出到Excel表格,以及提示“文件已经被损坏,无法打开”的解决方法
前端基于XLSX实现数据导出到Excel表格,以及提示“文件已经被损坏,无法打开”的解决方法
123 0
|
1月前
|
前端开发 JavaScript Java
导出excel的两个方式:前端vue+XLSX 导出excel,vue+后端POI 导出excel,并进行分析、比较
这篇文章介绍了使用前端Vue框架结合XLSX库和后端结合Apache POI库导出Excel文件的两种方法,并对比分析了它们的优缺点。
226 0