vue3 excel文件导入

文章目录

前言
使用
在vue文件中的使用

前言

最近写小组官网涉及到了excel文件导入的功能场景是导入小组成员年级班级邮箱组别姓名等基本信息的excel表格用于展示各组信息

使用

先下载js库

javascript 复制代码

npm install xlsx

为了提高代码的复用性我将它写成了一个通用的函数

typescript 复制代码

import apiClient from "@/api/axios";
import * as XLSX from "xlsx";

interface UserData {
  姓名: string;
  学号: string;
  邮箱: string;
  班级: string;
  年级: string;
  组别: string;
  电话: string;
  QQ: string;
}

// 验证文件后缀
function validateFileExtension(fileName: string): boolean {
  return fileName.toLowerCase().endsWith(".xlsx");
}

// 验证Excel字段
async function validateExcelFields(file: File): Promise<string | boolean> {
  return new Promise((resolve, reject) => {
    const reader = new FileReader();
    reader.onload = (e) => {
      try {
        const data = new Uint8Array(e.target?.result as ArrayBuffer);
        const workbook = XLSX.read(data, { type: "array" });
        const firstSheet = workbook.Sheets[workbook.SheetNames[0]];
        const jsonData = XLSX.utils.sheet_to_json<UserData>(firstSheet);

        if (jsonData.length === 0) {
          reject("Excel文件内容为空");
          return;
        }

        const requiredFields = [
          "姓名",
          "学号",
          "班级",
          "年级",
          "组别",
          "电话",
          "QQ",
        ];

        const missingFields = requiredFields.filter(
          (field) => !(field in jsonData[0]),
        );

        if (missingFields.length > 0) {
          reject(`文件缺少必要字段`);
          return;
        }

        resolve(true);
      } catch (error) {
        reject("文件解析失败");
      }
    };
    reader.onerror = () => reject("文件读取失败");
    reader.readAsArrayBuffer(file);
  });
}

//批量导入
export async function processFiles(file: File) {
  if (!validateFileExtension(file.name)) {
    throw "请上传.xlsx格式的文件";
  }
  try {
    const validationResult = await validateExcelFields(file);
    if (validationResult !== true) {
      throw validationResult as string;
    }
    const formData = new FormData();
    formData.append("file", file);

    return await apiClient.post("/userManager/teamInfo/addUsers", formData, {
      headers: {
        "Content-Type": "multipart/form-data",
      },
    });
  } catch (error) {
    // 修改此处：将返回改为抛出
    if (error instanceof Error) {
      throw error.message;
    }
    throw typeof error === "string" ? error : "未知错误";
  }
}

// 模拟非.xlsx 文件
const nonXlsxFile = new File([], "example.txt", { type: "text/plain" });
processFiles(nonXlsxFile).then((result) => {
  console.log(result);
});

该文件可以在用户上传时检查上传的文件后缀是否为xlsx 以及如果上传的文件后缀是xlsx

那么检查表格中是否有该有的字段如果没有则直接拦截不发送请求

在vue文件中的使用

typescript 复制代码

const handleXlsx = (e: Event) => {
  const target = e.target as HTMLInputElement;
  if (target.files) {
    processFiles(target.files[0])
      .then((response) => {
        showAlert("上传成功", "pass");
        updateData(grade.value, group.value);
        target.value = "";
      })
      .catch((error) => {
        showAlert(error, "error");
      });
  }
};