export-to-exceljs-util 1.0.0

package/.babelrc

@@ -0,0 +1,3 @@
+{
+  "presets": ["@babel/preset-env"]
+}

package/defaultExport.js

@@ -0,0 +1,210 @@
+import ExcelJS from "exceljs";
+import { ExcelExporter } from "./index";
+import { saveAs } from "file-saver";
+const fontStyle = {
+  name: "Arial",
+  size: 10,
+  bold: true, // 设置文字加粗
+  color: { argb: "FF000000" },
+};
+const alignmentStyle = (vertical = "middle", horizontal = "center") => {
+  return {
+    vertical,
+    horizontal,
+  };
+};
+
+const borderStyle = {
+  top: { style: "thin" },
+  left: { style: "thin" },
+  bottom: { style: "thin" },
+  right: { style: "thin" },
+};
+export default class DefaultExport extends ExcelExporter {
+  constructor() {
+    super();
+  }
+  async export() {
+    const workbook = new ExcelJS.Workbook();
+    const worksheet = workbook.addWorksheet("Sheet1");
+    // 设置表头样式
+    this.generateHeaders(worksheet, this.columns);
+
+    // 填充数据
+    this.fillData(worksheet);
+
+    // 自动调整列宽
+    // autoFitColumns(worksheet);
+
+    // 处理描述信息
+    this.generateDescribe(worksheet);
+    const buffer = await workbook.xlsx.writeBuffer();
+    const blob = new Blob([buffer], {
+      type: "application/octet-stream",
+    });
+    saveAs(blob, this.filename);
+  }
+  generateHeaders(
+    worksheet,
+    columns,
+    rowIndex = 1,
+    colIndexStart = 1,
+    maxDepth = null
+  ) {
+    let maxRowIndex = rowIndex;
+    let colIndex = colIndexStart;
+
+    // 计算整个表头的最大深度（用于单级表头行合并）
+    if (maxDepth === null) {
+      maxDepth = this.getMaxDepth(columns);
+    }
+
+    columns.forEach((column) => {
+      const currentRowIndex = rowIndex;
+      const currentColIndex = colIndex;
+
+      // 计算列的跨度和行的跨度
+      const colSpan = this.getColSpan(column);
+      const rowSpan = this.getRowSpan(column, maxDepth - rowIndex + 1);
+
+      // 设置表头单元格值并应用样式
+      const cell = worksheet.getCell(currentRowIndex, currentColIndex);
+      cell.value = column.title;
+      cell.alignment = alignmentStyle();
+      cell.border = borderStyle;
+      cell.font = fontStyle;
+      cell.fill = {
+        type: "pattern",
+        pattern: "solid",
+        fgColor: { argb: "87CEEB" },
+      };
+
+      // 合并单元格处理
+      if (colSpan > 1) {
+        worksheet.mergeCells(
+          currentRowIndex,
+          currentColIndex,
+          currentRowIndex,
+          currentColIndex + colSpan - 1
+        );
+      }
+
+      // 处理跨行合并的情况
+      if (rowSpan > 1) {
+        worksheet.mergeCells(
+          currentRowIndex,
+          currentColIndex,
+          currentRowIndex + rowSpan - 1,
+          currentColIndex
+        );
+      }
+
+      // 处理子列
+      if (column.children && column.children.length > 0) {
+        const childMaxRowIndex = this.generateHeaders(
+          worksheet,
+          column.children,
+          currentRowIndex + 1,
+          currentColIndex,
+          maxDepth
+        );
+        maxRowIndex = Math.max(maxRowIndex, childMaxRowIndex);
+      } else {
+        maxRowIndex = Math.max(maxRowIndex, currentRowIndex + rowSpan - 1);
+      }
+
+      colIndex += colSpan;
+    });
+
+    return maxRowIndex;
+  }
+
+  getColSpan(column) {
+    if (!column.children || column.children.length === 0) {
+      return 1;
+    }
+    return column.children.reduce(
+      (sum, child) => sum + this.getColSpan(child),
+      0
+    );
+  }
+
+  getRowSpan(column, remainingDepth) {
+    if (!column.children || column.children.length === 0) {
+      return remainingDepth;
+    }
+    return 1;
+  }
+
+  getMaxDepth(columns) {
+    return columns.reduce((max, column) => {
+      const depth = column.children ? 1 + this.getMaxDepth(column.children) : 1;
+      return Math.max(max, depth);
+    }, 1);
+  }
+
+  extractValues(rowData, column) {
+    if (column.children && column.children.length > 0) {
+      return column.children.flatMap((child) =>
+        this.extractValues(rowData, child)
+      );
+    } else {
+      return [rowData[column.key]];
+    }
+  }
+  fillData(worksheet) {
+    this.data.forEach((rowData) => {
+      const row = worksheet.addRow(
+        this.columns.flatMap((col) => this.extractValues(rowData, col))
+      );
+      row.eachCell((cell) => {
+        cell.alignment = alignmentStyle();
+      });
+    });
+  }
+
+  autoFitColumns(worksheet) {
+    worksheet.columns.forEach((column) => {
+      let maxLength = 0;
+      column.eachCell({ includeEmpty: true }, (cell) => {
+        const columnLength = cell.value ? cell.value.toString().length : 10;
+        if (columnLength > maxLength) {
+          maxLength = columnLength;
+        }
+      });
+      column.width = maxLength < 10 ? maxLength + 5 : maxLength;
+    });
+  }
+
+  generateDescribe(worksheet) {
+    if (this.describe.length > 0) {
+      // 定义开始的位置
+      const startCell = this.data.length + 7;
+      const endCell = startCell + this.describe.length + 9;
+      worksheet.mergeCells(`A${startCell}:E${endCell}`);
+
+      // 在表格底部加上文字解释
+      let combinedText = this.describe.join("\n");
+      const mergedCells = [
+        `A${startCell}`,
+        `B${startCell}`,
+        `C${startCell}`,
+        `D${startCell}`,
+        `E${startCell}`,
+      ];
+
+      // 设置每个合并单元格的自动换行属性
+      mergedCells.forEach((cell) => {
+        const currentCell = worksheet.getCell(cell);
+        currentCell.value = combinedText;
+        currentCell.font = fontStyle;
+        currentCell.alignment = {
+          vertical: "top",
+          horizontal: "left",
+          wrapText: true, // 设置自动换行
+        };
+      });
+      worksheet.getCell(`A${startCell}`).border = borderStyle;
+    }
+  }
+}

package/index.js

@@ -0,0 +1,57 @@
+import { saveAs } from "file-saver";
+import { retainTitleAndKey } from './utils/index';
+import DefaultExport from "./defaultExport.js";
+
+class ExcelExporter {
+  constructor(columns, data, filename = "export.xlsx", describe) {
+    this.columns = columns;
+    this.data = data;
+    this.filename = filename;
+    this.describe = describe;
+  }
+
+  async exportToExcel() {
+    try {
+      if (this.data.length > 10000) {
+        await this.exportLargeDataSet();
+      } else {
+        await this.exportSmallDataSet();
+      }
+    } catch (error) {
+      console.error("Export failed:", error);
+    }
+  }
+
+  async exportLargeDataSet() {
+    const formatColumns= retainTitleAndKey(this.columns);
+    const writeBufferWorker = new Worker("/writeBufferWorker.js");
+    writeBufferWorker.postMessage({
+      columns: formatColumns,
+      data: this.data,
+      describe: this.describe,
+      filename: this.filename,
+    });
+
+    writeBufferWorker.onmessage = (e) => {
+      const { buffer, filename } = e.data;
+      const blob = new Blob([buffer], { type: "application/octet-stream" });
+      saveAs(blob, filename);
+    };
+
+    writeBufferWorker.onerror = (error) => {
+      console.error("Worker error:", error);
+    };
+  }
+
+  async exportSmallDataSet() {
+    const defaultExport = new DefaultExport(
+      this.columns,
+      this.data,
+      this.filename,
+      this.describe
+    );
+    defaultExport.export();
+  }
+}
+
+export default ExcelExporter;

package/package.json

@@ -0,0 +1,18 @@
+{
+  "name": "export-to-exceljs-util",
+  "version": "1.0.0",
+  "description": "使用exceljs导出excel文件",
+  "main": "index.js",
+  "scripts": {
+    "test": "echo \"Error: no test specified\" && exit 1"
+  },
+  "author": "zjp",
+  "license": "ISC",
+  "dependencies": {
+    "@babel/cli": "^7.26.4",
+    "@babel/core": "^7.26.0",
+    "@babel/preset-env": "^7.26.0",
+    "exceljs": "^4.4.0",
+    "file-saver": "^2.0.5"
+  }
+}

package/utils/index.js

@@ -0,0 +1,23 @@
+export function retainTitleAndKey(items) {
+  return items.map((item) => {
+    // 如果项目是一个数组，递归调用这个函数
+    if (Array.isArray(item)) {
+      return retainTitleAndKey(item);
+    }
+    // 如果项目是一个对象，处理 title, key 和 children 属性
+    if (typeof item === "object" && item !== null) {
+      // 创建一个新对象，只包含 title 和 key 属性
+      let newItem = {
+        title: item.title,
+        key: item.key,
+      };
+      // 如果存在 children 属性，递归处理它
+      if (item.children && Array.isArray(item.children)) {
+        newItem.children = retainTitleAndKey(item.children);
+      }
+      return newItem;
+    }
+    // 如果项目既不是数组也不是对象，直接返回它
+    return item;
+  });
+}

package/writeBufferWorker.js

@@ -0,0 +1,200 @@
+importScripts("https://cdn.bootcdn.net/ajax/libs/exceljs/4.4.0/exceljs.min.js");
+
+self.onmessage = async function (e) {
+  const { data, columns, describe, filename } = e.data;
+  const workbook = new ExcelJS.Workbook();
+  const worksheet = workbook.addWorksheet("Sheet1");
+  // 设置表头样式
+  generateHeaders(worksheet, columns);
+
+  // 填充数据
+  fillData(worksheet, data, columns);
+
+  // 自动调整列宽
+  // autoFitColumns(worksheet);
+
+  // 处理描述信息
+  generateDescribe(worksheet, describe, data);
+
+  const buffer = await workbook.xlsx.writeBuffer();
+  self.postMessage({ buffer, filename });
+};
+const fontStyle = {
+  name: "Arial",
+  size: 10,
+  bold: true, // 设置文字加粗
+  color: { argb: "FF000000" },
+};
+const alignmentStyle = (vertical = "middle", horizontal = "center") => {
+  return {
+    vertical,
+    horizontal,
+  };
+};
+
+const borderStyle = {
+  top: { style: "thin" },
+  left: { style: "thin" },
+  bottom: { style: "thin" },
+  right: { style: "thin" },
+};
+
+function generateHeaders(
+  worksheet,
+  columns,
+  rowIndex = 1,
+  colIndexStart = 1,
+  maxDepth = null
+) {
+  let maxRowIndex = rowIndex;
+  let colIndex = colIndexStart;
+
+  // 计算整个表头的最大深度（用于单级表头行合并）
+  if (maxDepth === null) {
+    maxDepth = getMaxDepth(columns);
+  }
+
+  columns.forEach((column) => {
+    const currentRowIndex = rowIndex;
+    const currentColIndex = colIndex;
+
+    // 计算列的跨度和行的跨度
+    const colSpan = getColSpan(column);
+    const rowSpan = getRowSpan(column, maxDepth - rowIndex + 1);
+
+    // 设置表头单元格值并应用样式
+    const cell = worksheet.getCell(currentRowIndex, currentColIndex);
+    cell.value = column.title;
+    cell.alignment = alignmentStyle();
+    cell.border = borderStyle;
+    cell.font = fontStyle;
+    cell.fill = {
+      type: "pattern",
+      pattern: "solid",
+      fgColor: { argb: "87CEEB" },
+    };
+
+    // 合并单元格处理
+    if (colSpan > 1) {
+      worksheet.mergeCells(
+        currentRowIndex,
+        currentColIndex,
+        currentRowIndex,
+        currentColIndex + colSpan - 1
+      );
+    }
+
+    // 处理跨行合并的情况
+    if (rowSpan > 1) {
+      worksheet.mergeCells(
+        currentRowIndex,
+        currentColIndex,
+        currentRowIndex + rowSpan - 1,
+        currentColIndex
+      );
+    }
+
+    // 处理子列
+    if (column.children && column.children.length > 0) {
+      const childMaxRowIndex = generateHeaders(
+        worksheet,
+        column.children,
+        currentRowIndex + 1,
+        currentColIndex,
+        maxDepth
+      );
+      maxRowIndex = Math.max(maxRowIndex, childMaxRowIndex);
+    } else {
+      maxRowIndex = Math.max(maxRowIndex, currentRowIndex + rowSpan - 1);
+    }
+
+    colIndex += colSpan;
+  });
+
+  return maxRowIndex;
+}
+
+function getColSpan(column) {
+  if (!column.children || column.children.length === 0) {
+    return 1;
+  }
+  return column.children.reduce((sum, child) => sum + getColSpan(child), 0);
+}
+
+function getRowSpan(column, remainingDepth) {
+  if (!column.children || column.children.length === 0) {
+    return remainingDepth;
+  }
+  return 1;
+}
+
+function getMaxDepth(columns) {
+  return columns.reduce((max, column) => {
+    const depth = column.children ? 1 + getMaxDepth(column.children) : 1;
+    return Math.max(max, depth);
+  }, 1);
+}
+
+function fillData(worksheet, data, columns) {
+  data.forEach((rowData) => {
+    const row = worksheet.addRow(
+      columns.flatMap((col) => extractValues(rowData, col))
+    );
+    row.eachCell((cell) => {
+      cell.alignment = alignmentStyle();
+    });
+  });
+}
+
+function autoFitColumns(worksheet) {
+  worksheet.columns.forEach((column) => {
+    let maxLength = 0;
+    column.eachCell({ includeEmpty: true }, (cell) => {
+      const columnLength = cell.value ? cell.value.toString().length : 10;
+      if (columnLength > maxLength) {
+        maxLength = columnLength;
+      }
+    });
+    column.width = maxLength < 10 ? maxLength + 5 : maxLength;
+  });
+}
+
+function generateDescribe(worksheet, describe, data) {
+  if (describe.length > 0) {
+    // 定义开始的位置
+    const startCell = data.length + 7;
+    const endCell = startCell + describe.length + 9;
+    worksheet.mergeCells(`A${startCell}:E${endCell}`);
+
+    // 在表格底部加上文字解释
+    let combinedText = describe.join("\n");
+    const mergedCells = [
+      `A${startCell}`,
+      `B${startCell}`,
+      `C${startCell}`,
+      `D${startCell}`,
+      `E${startCell}`,
+    ];
+
+    // 设置每个合并单元格的自动换行属性
+    mergedCells.forEach((cell) => {
+      const currentCell = worksheet.getCell(cell);
+      currentCell.value = combinedText;
+      currentCell.font = fontStyle;
+      currentCell.alignment = {
+        vertical: "top",
+        horizontal: "left",
+        wrapText: true, // 设置自动换行
+      };
+    });
+    worksheet.getCell(`A${startCell}`).border = borderStyle;
+  }
+}
+
+function extractValues(rowData, column) {
+  if (column.children && column.children.length > 0) {
+    return column.children.flatMap((child) => extractValues(rowData, child));
+  } else {
+    return [rowData[column.key]];
+  }
+}

package/yarn-error.log

@@ -0,0 +1,50 @@
+Arguments: 
+  C:\Program Files\nodejs\node.exe C:\Users\zhujp\AppData\Roaming\npm\node_modules\yarn\bin\yarn.js add @babel/cli @babel/core @babel/preset - env
+
+PATH: 
+  C:\Windows\System32\HWAudioDriverLibs;C:\Windows\system32;C:\Windows;C:\Windows\System32\Wbem;C:\Windows\System32\WindowsPowerShell\v1.0\;C:\Windows\System32\OpenSSH\;C:\Windows\system32\config\systemprofile\AppData\Local\Microsoft\WindowsApps;C:\Program Files\nodejs\;D:\InstallPath\Git\cmd;C:\WINDOWS\system32;C:\WINDOWS;C:\WINDOWS\System32\Wbem;C:\WINDOWS\System32\WindowsPowerShell\v1.0\;C:\WINDOWS\System32\OpenSSH\;C:\nvm;C:\Program Files\nodejs;C:\Users\zhujp\AppData\Local\Programs\Python\Python312;C:\Program Files\MySQL\MySQL Server 9.1\bin;C:\Users\zhujp\AppData\Local\Programs\Python\Python312\Scripts\;C:\Users\zhujp\AppData\Local\Programs\Python\Python312\;C:\Users\zhujp\AppData\Local\Microsoft\WindowsApps;C:\Users\zhujp\AppData\Roaming\npm;C:\Users\zhujp\AppData\Local\Programs\Microsoft VS Code\bin;C:\nvm;C:\Program Files\nodejs;
+
+Yarn version: 
+  1.22.19
+
+Node version: 
+  16.20.2
+
+Platform: 
+  win32 x64
+
+Trace: 
+  Error: https://registry.npmmirror.com/@babel%2fpreset: Not found
+      at Request.params.callback [as _callback] (C:\Users\zhujp\AppData\Roaming\npm\node_modules\yarn\lib\cli.js:66145:18)
+      at Request.self.callback (C:\Users\zhujp\AppData\Roaming\npm\node_modules\yarn\lib\cli.js:140890:22)
+      at Request.emit (node:events:513:28)
+      at Request.<anonymous> (C:\Users\zhujp\AppData\Roaming\npm\node_modules\yarn\lib\cli.js:141862:10)
+      at Request.emit (node:events:513:28)
+      at IncomingMessage.<anonymous> (C:\Users\zhujp\AppData\Roaming\npm\node_modules\yarn\lib\cli.js:141784:12)
+      at Object.onceWrapper (node:events:627:28)
+      at IncomingMessage.emit (node:events:525:35)
+      at endReadableNT (node:internal/streams/readable:1358:12)
+      at processTicksAndRejections (node:internal/process/task_queues:83:21)
+
+npm manifest: 
+  {
+    "name": "excel-export",
+    "version": "1.0.0",
+    "description": "使用exceljs导出excel文件",
+    "main": "index.js",
+    "scripts": {
+      "test": "echo \"Error: no test specified\" && exit 1"
+    },
+    "author": "",
+    "license": "ISC",
+    "dependencies": {
+      "exceljs": "^4.4.0",
+      "file-saver": "^2.0.5"
+    }
+  }
+
+yarn manifest: 
+  No manifest
+
+Lockfile: 
+  No lockfile